Current Build

Переводит команда Health Samurai . Приглашаем поучаствовать в русификации стандарта FHIR: GitHub , Email.

2.24.0 Data Types

FHIR Infrastructure Work GroupMaturity Level: 4Ballot Status: Partially Normative

Normative Candidate Note: Most of the content on this page is candidate normative content for R4 in the Infrastructure Package. Once normative, it will lose it's Maturity Level, and breaking changes will no longer be made. The few parts of this page that are not normative are clearly marked

В спецификации FHIR приводится набор типов данных, которые используются в элементах ресурсов. Типы данных делятся на четыре категории:

  1. Simple / primitive types, which are single elements with a primitive value (below)
  2. General purpose complex types, which are re-usable clusters of elements (below)
  3. Metadata types: A set of types for use with metadata resources
  4. Special purpose data types - defined elsewhere in the specification for specific usages

This page describes the general purpose data types (categories 1 and 2).

Data Types Summary.

Legend: see Standards Status Colors

A limited set of these data types may appear in extensions. All data types (including primitives) may have extensions, but only the following data types may include Modifier Extensions:

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*instantActual value attribute of the data typevalue : xs:dateTime 0..1timeActual value attribute of the data typevalue : xs:time 0..1dateActual value attribute of the data typevalue : xs:gYear|xs:gYearMonth|xs:date 0..1dateTimeActual value attribute of the data typevalue : xs:gYear|xs:gYearMonth|xs:date|xs:dateTime 0..1decimalActual value attribute of the data typevalue : xs:decimal|xs:double 0..1booleanActual value attribute of the data typevalue : xs:boolean 0..1integerActual value attribute of the data typevalue : xs:int 0..1stringActual value attribute of the data typevalue : xs:string 0..1uriActual value attribute of the data typevalue : xs:anyURI 0..1base64BinaryActual value attribute of the data typevalue : xs:base64Binary 0..1codeidoidunsignedIntpositiveIntmarkdownurlcanonicaluuid

В таблице ниже описываются используемые в данной спецификации примитивные типы. Примитивные типы - это типы, имеющие только value, без дополнительных элементов-потомков, хотя как и все типы, они могут иметь расширения. См. также the Примеры.

Примитивные типы
Имя в FHIR Возможные значения XML-представление JSON-представление
boolean true | false xs:boolean, за исключением того, что 0 и 1 не являются допустимыми значениями JSON boolean (true or false)
Regex: true|false
integer A signed integer in the range −2,147,483,648..2,147,483,647 (32-bit; for larger values, use decimal) xs:int, except that leading 0 digits are not allowed JSON number (with no decimal point)
Regex: [0]|[-+]?[1-9][0-9]*
string Последовательность символов в кодировке Unicode xs:string JSON String
Обратите внимание, что строки не должны превышать 1 МБ в размере. Строка не должна содержать символы Unicode с кодом меньше 32, за исключением u0009 (горизонтальная табуляция), u0010 (возврат каретки) и u0013 (перевод строки)Note that strings SHALL NOT exceed 1MB (1024*1024 characters) in size. Strings SHOULD not contain Unicode character points below 32, except for u0009 (horizontal tab), u0010 (carriage return) and u0013 (line feed). Leading and Trailing whitespace is allowed, but SHOULD be removed when using the XML format. Note: this means that a string that consists only of whitespace could be trimmed to nothing, which would be treated as an invalid element value. Therefore strings SHOULD always contain non-whitespace content
This data type can be bound to a ValueSet
Regex: [ \r\n\t\S]+ (see notes below)
decimal Рациональные числа, имеющие десятичное представление. См. ниже о точности таких чисел union of xs:decimal and xs:double (see below for limitations) A JSON number (see below for limitations)
Regex: -?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?
uri Унифицированный идентификатор ресурса (RFC 3986 ). Примечание: URI чувствительны к регистру. Для UUID (urn:uuid:53fefa32-fcbb-4ff8-8a92-55ee120877b7) используйте нижний регистр xs:anyURI A JSON string - a URI
Regex: \S* (This regex is very permissive, but URIs must be valid. Implementers are welcome to use more specific regex statements for a URI in specific contexts)
URIs могут быть абсолютными или относительными и могут иметь необязательный идентификатор фрагментаURIs can be absolute or relative, and may have an optional fragment identifier
This data type can be bound to a ValueSet
url A Uniform Resource Locator (RFC 1738 ). Note URLs are accessed directly using the specified protocol. Common URL protocols are http{s}:, ftp:, mailto: and mllp:, though many others are defined xs:anyURI A JSON string - a URL
canonical A URI that is refers to a resource by it's canonical URL. The canonical type differs from a uri in that it has special meaning in this specification, and in that it may have a version appended, separated by a vertical bar (|). Note that the type canonical is not used for the actual canonical URLs that are the target of these references, but for the URIs that refer to them, and may have the version suffix in them. Like other URIs, elements of type canonical may also have #fragment references xs:anyURI A JSON string - a canonical URL
base64Binary A stream of bytes, base64 encoded (RFC 4648 ) xs:base64Binary A JSON string - base64 content
Regex: (\s*([0-9a-zA-Z\+\=]){4}\s*)+
There is no specified upper limit to the size of a binary, but systems will have to impose some implementation based limit to the size they support. This should be clearly documented, though there is no computable for this at this time
instant An instant in time in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time SHALL specified at least to the second and SHALL include a time zone. Note: This is intended for when precisely observed times are required(typically system logs etc.), and not human-reported times - for those, use date or dateTime (which can be as precise as instant, but is not required to be). instant is a more constrained dateTime xs:dateTime A JSON string - an xs:dateTime
Примечание: это тип для указания системного времени, а не человеческого (см. date и dateTime ниже).
Regex: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))
date A date, or partial date (e.g. just year or year + month) as used in human communication. The format is YYYY, YYYY-MM, or YYYY-MM-DD, e.g. 2018, 1973-06, or 1905-08-23. There SHALL be no time zone. Dates SHALL be valid dates union of xs:date, xs:gYearMonth, xs:gYear A JSON string - a union of xs:date, xs:gYearMonth, xs:gYear
Regex: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?
dateTime Дата, дата/время или часть даты (например только год или год + месяц) в том представлении, как она используется в человеческой коммуникации. A date, date-time or partial date (e.g. just year or year + month) as used in human communication. The format is YYYY, YYYY-MM, YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+zz:zz, e.g. 2018, 1973-06, 1905-08-23, 2015-02-07T13:28:17-05:00 or 2017-01-01T00:00:00.000Z. If hours and minutes are specified, a time zone SHALL be populated. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored at receiver discretion. Dates SHALL be valid dates. The time "24:00" is not allowed. Leap Seconds are allowed - see below union of xs:dateTime, xs:date, xs:gYearMonth, xs:gYear A JSON string - a union of xs:dateTime, xs:date, xs:gYearMonth, xs:gYear
Regex: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?
time A time during the day, in the format hh:mm:ss. There is no date specified. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored at receiver discretion. The time "24:00" SHALL NOT be used. A time zone SHALL NOT be present. Times can be converted to a Duration since midnight. xs:time A JSON string - an xs:time
Regex: ([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?
code Indicates that the value is taken from a set of controlled strings defined elsewhere (see Using codes for further discussion). Technically, a code is restricted to a string which has at least one character and no leading or trailing whitespace, and where there is no whitespace other than single spaces in the contents xs:token JSON string
Regex: [^\s]+(\s[^\s]+)*
This data type can be bound to a ValueSet
oid An OID represented as a URI (RFC 3001 ); e.g. urn:oid:1.2.3.4.5 xs:anyURI JSON string - uri
Regex: urn:oid:[0-2](\.(0|[1-9][0-9]*))+
id Any combination of upper or lower case ASCII letters ('A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.', with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) xs:string JSON string
Regex: [A-Za-z0-9\-\.]{1,64}
markdown A FHIR string (see above) that may contain markdown syntax for optional processing by a markdown presentation engine, in the GFM extension of CommonMark format (see below) xs:string JSON string
Regex: \s*(\S|\s)* (can't put size limit in the regex - too large)
unsignedInt Any non-negative integer in the range 0..2,147,483,647 xs:nonNegativeInteger JSON number
Regex: [0]|([1-9][0-9]*)
positiveInt Any positive integer in the range 1..2,147,483,647 xs:positiveInteger JSON number
Regex: +?[1-9][0-9]*
uuid A UUID (aka GUID) represented as a URI (RFC 4122 ); e.g. urn:uuid:c757873d-ec9a-4326-a141-556f43239520 xs:anyURI JSON string - uri

Notes:

  • For all the types, the XML, JSON and Turtle representations of the primitive values are the same except for different escaping in XML and JSON
  • For decimal values, the XML special values INF, -INF and NaN are not allowed, and JSON is restricted to the precision limits documented in XML schema for xs:double and xs:decimal
  • The precision of the decimal value has significance:
    • e.g. 0.010 is regarded as different to 0.01, and the original precision should be preserved
    • Implementations SHALL handle decimal values in ways that preserve and respect the precision of the value as represented for presentation purposes
    • Implementations are not required to perform calculations with these numbers differently, though they may choose to do so (i.e. preserve significance)
    • See implementation comments for XML, JSON and RDF
    • In object code, implementations that might meet this constraint are GMP implementations or equivalents to Java BigDecimal that implement arbitrary precision, or a combination of a (64 bit) floating point value with a precision field
    • Note that large and/or highly precise values are extremely rare in medicine. One element where highly precise decimals may be encountered is the Location coordinates. Irrespective of this, the limits documented in XML Schema apply
  • Boolean values can also be represented using coded values (such as HL7 v2 Table 0136). See Observation for one such use
  • Issues with the specified regexes:
    • The regexes are provided to assist with tooling, but are informative, not normative. There are a number of issues with the regexes
    • The string regex has problems with unicode - specifically, it might or might not allow unicode whitespace to some degree depending on unicode support in the regex engine being used. The regexes [\r\n\t\x{0020}-\x{FFFF}]* or [\r\n\t\u0020-\uFFFF]* are better expressions of the constraints on string, but poorly supported (see Regex Tutorial for details). The string regex also applies to markdown as well. The regex does not enforce the length limit
    • The unicode issues also apply to the regex for code
    • The regexes should be qualified with start of string and end of string anchors based on the regex implementation used (e.g. caret '^' and dollar-sign '$' for JavaScript, POSIX, XML and XPath; '\A' and '\Z' for .NET, Java, Python and others; please verify these definitions with the regex implementation used).
    • The regexes may allow a broader set of values than are actually valid (e.g. leap years) so additional validation is always needed
  • Leap second are allowed in the datetime, instant and time types. Note, though, that many systems and libraries do not support leap seconds. Applications reading times SHOULD accept and handle leap seconds gracefully, and applications producing them MAY choose to avoid encoding leap seconds
  • About the id datatype:
    • Ids are case sensitive. UUIDs SHALL be sent using lowercase letters
    • The ID type includes identifiers consistent with ISO 18232 , but also includes other identifier formats as well, and is not case insensitive like ISO 18232.
    • In a typical FHIR URL, like http://example.com/fhir/Patient/1234, the last part "1234" (highlighted in red) is the part that is an id datatype
    • A full UUID is a uri, not an id. UUIDs in URIs SHALL also be represented in lowercase (urn:uuid:59bf0ef4-e89c-4628-9b51-12ae3fdbe22b)
  • About the uri, url and canonical datatypes:
    • They all contain URIs, but differ in how applications resolve the reference
    • Although the url and canonical are specializations of uri, they are never substituted for each other
    • They are all case sensitive for comparison purposes. Applications SHOULD not create URIs that only differ by case
    • A general URI may be either a URL or a canonical URL or some other kind of URI
  • About the markdown datatype:
    • This specification requires and uses the GFM (Github Flavored Markdown) extensions on CommonMark format
    • Note that GFM prohibits Raw HTML
    • Systems are not required to have markdown support, so the content of a string should be readable without markdown processing, per markdown philosophy
    • Markdown content SHALL NOT contain Unicode character points below 32, except for u0009 (horizontal tab), u0010 (carriage return) and u0013 (line feed)
    • Markdown is a string, and subject to the same rules (e.g. length limit)
    • Converting an element that has the type string to markdown in a later version of this FHIR specification is not considered a breaking change (neither is adding markdown as a choice to an optional element that already has a choice of data types)

Все элементы, использующие данные примитивные типы, могут иметь одно или несколько значений, как описано выше, внутреннюю сущность (например xml:id) и расширения. Возьмём, к примеру, элемент с именем "count" и типом "integer".

XML

Значение представляется в XML с помощью атрибута "value":

  <count value="2"/>

The full representation, with id, extensions and value:

  <count id="a1" value="2">
    <extension url="...">
      <valueXX.../>
    </extension>
  </count>

JSON

In JSON, for convenience, the value is represented as the property itself:

  "count" : 2

The full representation, with id, extensions and value, showing the id and extensions in the sibling property:

  "count" : 2
  "_count" : {
    "id" : "a1",
    "extension" : [{
      "url" : "...",
      "valueXXX" : "...."
    }]
  }

RDF

The value is represented in RDF as a relationship with the URI "http://h;7.org/fhir/value". Using the normal prefix, this becomes:

  fhir:Type.count [ fhir:value "2"^^xsd:integer ]

For the types date and DateTime, the type must be specified explicitly. For all other types, it is optional. The full representation, with id, extensions and value:

  fhir:Type.count [
    Element.id "a1";
    fhir:value "2"^^xsd:integer;
    Element.extension [
      fhir:Extension.url "..";
      fhir:Extension.valueXX...
    ]
  ]

Дополнительную информацию см. на страницах описания форматов XML, JSON и Turtle. Когда значение отсутствует и нет расширений, элемент не указывается вообще. This means that in xml, attributes are never present with a length of 0 (value=""), and properties are never a 0 length string or null in JSON ("name" : "" is not valid). (note: there is one specific use of the null in the JSON representation).

В соответствии с XML-схемой пробелы в начале и в конце атрибута value игнорируются для типов boolean, integer, decimal, base64Binary, instant, uri, date, dateTime, oid и uri. Обратите внимание, из этого следует, что библиотеки XML, следующие схеме, дают разные значения атрибутов по сравнению с библиотеками, не соответствующими схеме, во время чтения экземпляров XML. По этой причине атрибут value для этих типов НЕ ДОЛЖЕН иметь пробелы в начале и в конце. Строковые значения могут иметь пробелы в начале и в конце, если они являются частью содержимого их значения. В JSON и Turtle пробелы в строковых значениях всегда являются значимыми. Примитивные типы за исключением string НЕ ДОЛЖНЫ содержать пробелы в начале и в конце.


В XML Эти типы представлены XML-элементами, имеющими элементы-потомки с именем определённых элементов этого типа. Имя элемента задаётся там, где этот тип используется. В JSON тип данных представлен объектом, у которого имена свойств совпадают с XML-элементами. JSON-представление почти ничем не отличается, поэтому только первый пример содержит дополнительное JSON-представление.

Сложные типы данных могут быть "профилированы". Structure Definition типа "constraint" задает набор правил о том, какие элементы ДОЛЖНЫ иметь значения и какие значения являются допустимыми.

UML-диаграмма типов данных

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*QuantityЗначение измеренной величины. Значение включает в себя неявное указание точности в представлении значенияvalue : decimal [0..1]How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value (this element modifies the meaning of other elements)comparator : code [0..1] « How the Quantity should be understood and represented. (Strength=Required)QuantityComparator! »A human-readable form of the unitunit : string [0..1]Идентификация системы, которая обеспечивает кодированную форму единиц измеренияsystem : uri [0..1]A computer processable form of the unit in some unit representation systemcode : code [0..1]AttachmentIdentifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriatecontentType : code [0..1] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)Mime Types! »The human language of the content. The value can be any valid value according to BCP 47language : code [0..1] « Естественный язык. (Strength=Preferred)Common Languages? »The actual data of the attachment - a sequence of bytes, base64 encodeddata : base64Binary [0..1]A location where the data can be accessedurl : url [0..1]The number of bytes of data that make up this attachment (before base64 encoding, if that is done)size : unsignedInt [0..1]The calculated hash of the data using SHA-1. Represented using base64hash : base64Binary [0..1]A label or set of text to display in place of the datatitle : string [0..1]Дата, когда вложение было впервые созданоcreation : dateTime [0..1]RangeНижний предел. Границы включительноlow : Quantity(SimpleQuantity) [0..1]The high limit. The boundary is inclusivehigh : Quantity(SimpleQuantity) [0..1]PeriodНачало периода. Граничное значение входит в периодstart : dateTime [0..1]The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that timeend : dateTime [0..1]RatioЗначение числителяnumerator : Quantity [0..1]Значение знаменателяdenominator : Quantity [0..1]CodeableConceptA reference to a code defined by a terminology systemcoding : Coding [0..*]A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the usertext : string [0..1]CodingИдентификация кодовой системы, которая определяет смысл обозначения в кодеsystem : uri [0..1]Версия кодовой системы, которая была использована при выборе этого кода. Обратите внимание, что поддерживаемая в хорошем состоянии кодовая система не нуждается в указании версии из-за непротиворечивости смысла кодов в разных версиях. Однако в этом нельзя быть постоянно уверенным, и когда непротиворечивость значений не гарантируется, НЕОБХОДИМО указывать версиюversion : string [0..1]Обозначение в синтаксисе, определенном системой. Обозначение может быть стандартным кодом или выражением в синтаксисе, определенном кодовой системой (например посткоординация)code : code [0..1]A representation of the meaning of the code in the system, following the rules of the systemdisplay : string [0..1]Указывает, что этот кодинг был выбран непосредственно пользователем - то есть из списка выбора доступных элементов (кодов или значений для отображения)userSelected : boolean [0..1]AnnotationThe individual responsible for making the annotationauthor[x] : Type [0..1] « Reference(Practitioner|Patient| RelatedPerson|Organization)|string »Indicates when this particular annotation was madetime : dateTime [0..1]The text of the annotation in markdown formattext : markdown [1..1]MoneyNumerical value (with implicit precision)value : decimal [0..1]ISO 4217 Currency Codecurrency : code [0..1] « A code indicating the currency, taken from ISO 4217. (Strength=Required)Currencies! »
ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*IdentifierНазначение этого идентификатора (this element modifies the meaning of other elements)use : code [0..1] « Identifies the purpose for this identifier, if known . (Strength=Required)IdentifierUse! »Кодированный тип идентификатора, который можно использовать для определения, какой идентификатор использовать в конкретных целяхtype : CodeableConcept [0..1] « A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (Strength=Extensible)Identifier Type + »Establishes the namespace for the value - that is, a URL that describes a set values that are uniquesystem : uri [0..1]Часть идентификатора, обычно отображаемая пользователю, которая является уникальной в контексте системыvalue : string [0..1]Временной период, в течение которого идентификатор является/являлся допустимым к использованиюperiod : Period [0..1]Организация, присваивающая/управляющая идентификаторомassigner : Reference [0..1] « Organization »HumanNameIdentifies the purpose for this name (this element modifies the meaning of other elements)use : code [0..1] « The use of a human name. (Strength=Required)NameUse! »Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific partstext : string [0..1]The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his fatherfamily : string [0..1]Given namegiven : string [0..*]Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the nameprefix : string [0..*]Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the namesuffix : string [0..*]Indicates the period of time when this name was valid for the named personperiod : Period [0..1]AddressНазначение этого адреса (this element modifies the meaning of other elements)use : code [0..1] « The use of an address. (Strength=Required)AddressUse! »Различия между физическими адресами (которые можно посетить) и почтовыми адресами (например почтовые ящики и адреса по месту жительства). Большинство адресов являются и теми, и другимиtype : code [0..1] « The type of an address (physical / postal). (Strength=Required)AddressType! »Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific partstext : string [0..1]This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address informationline : string [0..*]The name of the city, town, suburb, village or other community or delivery centercity : string [0..1]The name of the administrative area (county)district : string [0..1]Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes)state : string [0..1]A postal code designating a region defined by the postal servicepostalCode : string [0..1]Страна - нация в общепринятом смыслеcountry : string [0..1]Период времени, в течение которого адрес был/находится в использованииperiod : Period [0..1]ContactPointВид телекоммуникации для этой точки контакта - какая система связи требуется для использования этого контактаsystem : code [0..1] « Telecommunications form for contact point. (Strength=Required)ContactPointSystem! »Фактические детали точки контакта в той форме, которая имеет смысл для указанной системы связи (т. е. номер телефона или адрес электронной почты)value : string [0..1]Определяет назначение точки контакта (this element modifies the meaning of other elements)use : code [0..1] « Use of contact point. (Strength=Required)ContactPointUse! »Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank valuesrank : positiveInt [0..1]Период времени, когда контактная точка была/находится в употребленииperiod : Period [0..1]TimingОпределяет конкретное время, когда происходит событиеevent : dateTime [0..*]A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code)code : CodeableConcept [0..1] « Code for a known / defined timing pattern. (Strength=Preferred)TimingAbbreviation? »RepeatЛибо продолжительность для задания длительности в расписании, диапазон возможной длительности, либо внешние границы начального и/или конечного пределов в расписанииbounds[x] : Type [0..1] « Duration|Range|Period »A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count valuescount : positiveInt [0..1]If present, indicates that the count is a range - so to perform the action between [count] and [countMax] timescountMax : positiveInt [0..1]Сколько это событие будет длиться, когда оно наступит. If durationMax is present, this element indicates the lower bound of the allowed range of the durationduration : decimal [0..1]If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time lengthdurationMax : decimal [0..1]Единицы времени для продолжительности, в UCUM единицахdurationUnit : code [0..1] « A unit of time (units from UCUM). (Strength=Required)UnitsOfTime! »The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequencyfrequency : positiveInt [0..1]If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period rangefrequencyMax : positiveInt [0..1]Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period lengthperiod : decimal [0..1]Если присутствует, указывает, что период является диапазоном от [period] до [periodMax], что позволяет выражать такие понятия, как "do this once every 3-5 days"periodMax : decimal [0..1]Единицы измерения времени для этого периода в UCUM-единицахperiodUnit : code [0..1] « A unit of time (units from UCUM). (Strength=Required)UnitsOfTime! »If one or more days of week is provided, then the action happens only on the specified day(s)dayOfWeek : code [0..*] « (Strength=Required)DaysOfWeek! »Specified time of day for action to take placetimeOfDay : time [0..*]An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occurwhen : code [0..*] « Real world event relating to the schedule. (Strength=Required)EventTiming! »The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the eventoffset : unsignedInt [0..1]SignatureУказание причины, по которой данное лицо подписало этот документ. Это может быть явно включено в качестве части информации о подписи и может быть использовано при определении ответственности за различные действия в отношении документаtype : Coding [1..*] « An indication of the reason that an entity signed the object. (Strength=Preferred)SignatureTypeCodes? »Дата подписания цифровой подписьюwhen : instant [1..1]Ссылка на пригодное для приложения описание человека, который подписал сертификат (например цифровая подпись использовала их закрытый ключ)who : Reference [1..1] « Practitioner|RelatedPerson|Patient|Device| Organization »A reference to an application-usable description of the identity that is represented by the signatureonBehalfOf : Reference [0..1] « Practitioner|RelatedPerson|Patient| Device|Organization »A mime type that indicates the technical format of the target resources signed by the signaturetargetFormat : code [0..1] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)Mime Types! »A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etcsigFormat : code [0..1] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)Mime Types! »The base64 encoding of the Signature content. When signature is not recorded electronically this element would be emptydata : base64Binary [0..1]SampledDataThe base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement seriesorigin : Quantity(SimpleQuantity) [1..1]The length of time between sampling times, measured in millisecondsperiod : decimal [1..1]A correction factor that is applied to the sampled data points before they are added to the originfactor : decimal [0..1]The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit)lowerLimit : decimal [0..1]The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit)upperLimit : decimal [0..1]The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at oncedimensions : positiveInt [1..1]A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal valuedata : string [0..1]BackboneElementMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)modifierExtension : Extension [0..*]A set of rules that describe when the event is scheduledrepeat[0..1]

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

Тип данных, содержащий вложение или ссылку на вложение - дополнительные данные в другом формате. Наиболее частое использование этого типа - включение изображений или отчетов в некотором формате документов, например PDF. Однако он может использоваться для любых данных MIME-типа.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. AttachmentINElementContent in a format defined elsewhere
+ Rule: If the Attachment has data, it SHALL have a contentType
Элементы, определённые в прародителе: id, extension
... contentTypeΣ0..1codeMime type of the content, with charset etc.
MimeType (Required)
... languageΣ0..1codeHuman language of the content (BCP-47)
Language (Preferred but limited to All Languages)
... data0..1base64BinaryData inline, base64ed
... urlΣ0..1urlUri where the data can be found
... sizeΣ0..1unsignedIntNumber of bytes of content (if url provided)
... hashΣ0..1base64BinaryHash of the data (sha-1, base64ed)
... titleΣ0..1stringLabel to display in place of the data
... creationΣ0..1dateTimeДата создания вложения

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <contentType value="[code]"/><!-- 0..1 Mime type of the content, with charset etc. -->
 <language value="[code]"/><!-- 0..1 Human language of the content (BCP-47) -->
 <data value="[base64Binary]"/><!-- 0..1 Data inline, base64ed -->
 <url value="[url]"/><!-- 0..1 Uri where the data can be found -->
 <size value="[unsignedInt]"/><!-- 0..1 Number of bytes of content (if url provided) -->
 <hash value="[base64Binary]"/><!-- 0..1 Hash of the data (sha-1, base64ed) -->
 <title value="[string]"/><!-- 0..1 Label to display in place of the data -->
 <creation value="[dateTime]"/><!-- 0..1 Дата создания вложения -->
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Attachment.contentType [ code ]; # 0..1 Mime type of the content, with charset etc.
  fhir:Attachment.language [ code ]; # 0..1 Human language of the content (BCP-47)
  fhir:Attachment.data [ base64Binary ]; # 0..1 Data inline, base64ed
  fhir:Attachment.url [ url ]; # 0..1 Uri where the data can be found
  fhir:Attachment.size [ unsignedInt ]; # 0..1 Number of bytes of content (if url provided)
  fhir:Attachment.hash [ base64Binary ]; # 0..1 Hash of the data (sha-1, base64ed)
  fhir:Attachment.title [ string ]; # 0..1 Label to display in place of the data
  fhir:Attachment.creation [ dateTime ]; # 0..1 Дата создания вложения
]

Changes since Release 3

Attachment
Attachment.language
  • Change binding strength from extensible to preferred
Attachment.url
  • Type changed from uri to url

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. AttachmentINElementContent in a format defined elsewhere
+ Rule: If the Attachment has data, it SHALL have a contentType
Элементы, определённые в прародителе: id, extension
... contentTypeΣ0..1codeMime type of the content, with charset etc.
MimeType (Required)
... languageΣ0..1codeHuman language of the content (BCP-47)
Language (Preferred but limited to All Languages)
... data0..1base64BinaryData inline, base64ed
... urlΣ0..1urlUri where the data can be found
... sizeΣ0..1unsignedIntNumber of bytes of content (if url provided)
... hashΣ0..1base64BinaryHash of the data (sha-1, base64ed)
... titleΣ0..1stringLabel to display in place of the data
... creationΣ0..1dateTimeДата создания вложения

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <contentType value="[code]"/><!-- 0..1 Mime type of the content, with charset etc. -->
 <language value="[code]"/><!-- 0..1 Human language of the content (BCP-47) -->
 <data value="[base64Binary]"/><!-- 0..1 Data inline, base64ed -->
 <url value="[url]"/><!-- 0..1 Uri where the data can be found -->
 <size value="[unsignedInt]"/><!-- 0..1 Number of bytes of content (if url provided) -->
 <hash value="[base64Binary]"/><!-- 0..1 Hash of the data (sha-1, base64ed) -->
 <title value="[string]"/><!-- 0..1 Label to display in place of the data -->
 <creation value="[dateTime]"/><!-- 0..1 Дата создания вложения -->
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Attachment.contentType [ code ]; # 0..1 Mime type of the content, with charset etc.
  fhir:Attachment.language [ code ]; # 0..1 Human language of the content (BCP-47)
  fhir:Attachment.data [ base64Binary ]; # 0..1 Data inline, base64ed
  fhir:Attachment.url [ url ]; # 0..1 Uri where the data can be found
  fhir:Attachment.size [ unsignedInt ]; # 0..1 Number of bytes of content (if url provided)
  fhir:Attachment.hash [ base64Binary ]; # 0..1 Hash of the data (sha-1, base64ed)
  fhir:Attachment.title [ string ]; # 0..1 Label to display in place of the data
  fhir:Attachment.creation [ dateTime ]; # 0..1 Дата создания вложения
]

Changes since Release 3

Attachment
Attachment.language
  • Change binding strength from extensible to preferred
Attachment.url
  • Type changed from uri to url

See the Full Difference for further information

The actual content of an Attachment can be conveyed directly using the data element or a URL reference can be provided. If both are provided, the reference SHALL point to the same content as found in the data. The reference can never be reused to point to some different data (i.e. the reference is version specific). The URL reference SHALL point to a location that resolves to actual data; some URIs such as cid: meet this requirement. If the URL is a relative reference, it is interpreted in the same way as a resource reference. Само содержимое вложения (Attachment) может быть передано непосредственно с помощью элемента data, либо через указание ссылки в элементе URL. Если приведено и то, и то, ссылка ДОЛЖНА вести на то же самое содержимое, что и в элементе data. Эта ссылка не может быть повторно использована для указания на какие-то другие данные (например относиться только к определенной версии). Ссылка в элементе URL ДОЛЖНА указывать на место, возвращающее сами данные; некоторые URIs, например cid:, отвечают этому требованию. Если в URL указана относительная ссылка, она интерпретируется таким же образом, как и ссылка на ресурс.

The contentType element SHALL always be populated when an Attachment contains data, и MAY be populated when there is a url. It can include charset information and other mime type extensions as appropriate. Если в элементе contentType не указана кодировка, тогда правильный курс действий не определен, хотя некоторые медиа-типы могут указывать кодировку по умолчанию и/или правильная кодировка может определяться проверкой содержимого.

Элемент hash позволяет приложениям проверить, что содержимое, возвращаемое по ссылке в URL, не изменилось. The hash is included so that applications can verify that the content returned by the URL has not changed. The hash and size relate to the data before it is represented in base64 form. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

Attachment data are not constrained, and therefore can be of any content type and encoding. Therefore extra care needs to be taken to validate the content against malicious or malformed content. For more details see Security of Narrative.

В большинстве случаев использования вложения (Attachment), количество элементов >1. Допустимое использование повторов позволяет передавать одно и то же содержание на разных языках и MIME-типах. Указания по интерпретации повторяющихся элементов ДОЛЖНЫ быть приведены в определении повторяющегося элемента ресурса или расширения, ссылающегося на этот тип (or extension that references this type). Элемент language описывает язык вложения с помощью кодов, определенных в BCP (Best Current Practice) 47 . In many cases where Attachment is used, the cardinality is >1. A valid use of repeats is to convey the same content in different mime types and languages. Guidance on the meaning of repeating elements SHALL be provided in the definition of the repeating resource element or extension that references this type. The language element describes the language of the attachment using the codes defined in BCP 47 .

Ограничения

idLevelLocationОпределениеExpression
att-1Rule (base)If the Attachment has data, it SHALL have a contentTypedata.empty() or contentType.exists()

Если ни data, ни URL не заполнены, это значение следует понимать как утверждение о том, что нет доступных данных для указанного mimeType и/или language для такой комбинации language и contentType. If neither data nor a URL is provided, the value should be understood as an assertion that no content for the specified mimeType and/or language is available for the combination of language and contentType.

Контекст использования часто может диктовать правила о том, какой тип вложения (и, следовательно, какой MIME-тип) может быть использован. The context of use may frequently make rules about the kind of attachment (and therefore, the kind of mime types) that can be used.

Terminology Bindings

PathОписаниеТипСсылка
Attachment.contentType The mime type of an attachment. Any valid mime type is allowed.RequiredMime Types
Attachment.language Естественный язык.Preferred, but limited to All LanguagesCommon Languages

Вложение (Attachment) используется в следующих местах: Attachment is used in the following places: RelatedArtifact, ProdCharacteristic, BodyStructure, Claim, ClaimResponse, Communication, CommunicationRequest, Consent, Contract, DiagnosticReport, DocumentReference, ExplanationOfBenefit, HealthcareService, Library, Media, Patient, Person, Practitioner, Questionnaire, QuestionnaireResponse, RelatedPerson, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein and SubstanceSpecification

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

Coding - это представление определенного концепта с помощью символа из определенной "кодовой системы" - см. Использование кодов в ресурсах для получения более подробной информации. A Coding is a representation of a defined concept using a symbol from a defined "code system" - see Using Codes in resources for more details.

This data type can be bound to a ValueSet.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. CodingΣNElementСсылка на код, определенный терминологической системой
Элементы, определённые в прародителе: id, extension
... systemΣ0..1uriIdentity of the terminology system
... versionΣ0..1stringВерсия системы - при необходимости
... codeΣ0..1codeОбозначение в синтаксисе, определенном системой
... displayΣ0..1stringПредставление, определенное системой
... userSelectedΣ0..1booleanЕсли этот кодинг был выбран непосредственно пользователем

doco Документация по этому формату

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*CodingИдентификация кодовой системы, которая определяет смысл обозначения в кодеsystem : uri [0..1]Версия кодовой системы, которая была использована при выборе этого кода. Обратите внимание, что поддерживаемая в хорошем состоянии кодовая система не нуждается в указании версии из-за непротиворечивости смысла кодов в разных версиях. Однако в этом нельзя быть постоянно уверенным, и когда непротиворечивость значений не гарантируется, НЕОБХОДИМО указывать версиюversion : string [0..1]Обозначение в синтаксисе, определенном системой. Обозначение может быть стандартным кодом или выражением в синтаксисе, определенном кодовой системой (например посткоординация)code : code [0..1]A representation of the meaning of the code in the system, following the rules of the systemdisplay : string [0..1]Указывает, что этот кодинг был выбран непосредственно пользователем - то есть из списка выбора доступных элементов (кодов или значений для отображения)userSelected : boolean [0..1]

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Coding.system [ uri ]; # 0..1 Identity of the terminology system
  fhir:Coding.version [ string ]; # 0..1 Версия системы - при необходимости
  fhir:Coding.code [ code ]; # 0..1 Обозначение в синтаксисе, определенном системой
  fhir:Coding.display [ string ]; # 0..1 Представление, определенное системой
  fhir:Coding.userSelected [ boolean ]; # 0..1 Если этот кодинг был выбран непосредственно пользователем
]

Changes since Release 3

Coding
  • No Changes

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. CodingΣNElementСсылка на код, определенный терминологической системой
Элементы, определённые в прародителе: id, extension
... systemΣ0..1uriIdentity of the terminology system
... versionΣ0..1stringВерсия системы - при необходимости
... codeΣ0..1codeОбозначение в синтаксисе, определенном системой
... displayΣ0..1stringПредставление, определенное системой
... userSelectedΣ0..1booleanЕсли этот кодинг был выбран непосредственно пользователем

doco Документация по этому формату

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*CodingИдентификация кодовой системы, которая определяет смысл обозначения в кодеsystem : uri [0..1]Версия кодовой системы, которая была использована при выборе этого кода. Обратите внимание, что поддерживаемая в хорошем состоянии кодовая система не нуждается в указании версии из-за непротиворечивости смысла кодов в разных версиях. Однако в этом нельзя быть постоянно уверенным, и когда непротиворечивость значений не гарантируется, НЕОБХОДИМО указывать версиюversion : string [0..1]Обозначение в синтаксисе, определенном системой. Обозначение может быть стандартным кодом или выражением в синтаксисе, определенном кодовой системой (например посткоординация)code : code [0..1]A representation of the meaning of the code in the system, following the rules of the systemdisplay : string [0..1]Указывает, что этот кодинг был выбран непосредственно пользователем - то есть из списка выбора доступных элементов (кодов или значений для отображения)userSelected : boolean [0..1]

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Coding.system [ uri ]; # 0..1 Identity of the terminology system
  fhir:Coding.version [ string ]; # 0..1 Версия системы - при необходимости
  fhir:Coding.code [ code ]; # 0..1 Обозначение в синтаксисе, определенном системой
  fhir:Coding.display [ string ]; # 0..1 Представление, определенное системой
  fhir:Coding.userSelected [ boolean ]; # 0..1 Если этот кодинг был выбран непосредственно пользователем
]

Changes since Release 3

Coding
  • No Changes

See the Full Difference for further information

Значение Coding определяется кодом. System указывает на источник определения кода наряду с необязательной ссылкой на версию. Элемент display содержит человекочитаемый текст, определенный системой - он не добавляет другого значения. Ссылка на Value Set дает информацию о контексте выбора этого кода. The meaning of the Coding is defined by the code. The system provides the source of the definition of the code, along with an optional version reference. The display is a human display for the text defined by the system - it is not intended for computation.

Система system - это URI, ссылающийся на кодовую систему, определяющую этот код code. Выбор правильной системы важен; для получения более подробной информации по URI кодовой системы см. раздел Managing Terminology System URIs. URI системы НЕ ДОЛЖЕН содержать ссылку на набор значений (например ValueSet.url). Если код взят из ресурса CodeSystem, то корректным значением для URI системы будет CodeSystem.url. The system is a URI that identifies the code system that defines the code. Choosing the correct system is important; for more information about the code system URI, read Managing Terminology System URIs. If the code is taken from a CodeSystem resource, CodeSystem.url is the correct value for the system element. Resolvable URLs are generally preferred by implementers over non-resolvable URNs, particularly opaque URNs such as OIDs (urn:oid:) or UUIDs (urn:uuid:). The system URI SHALL NOT contain a reference to a value set (e.g. ValueSet.url), since value sets just define the set of codes which are intended for use in a specific context, not the meaning of the codes themselves.

Также может быть указана версия кодовой системы. Если значение кодов в кодовой системе остается постоянным в разных версиях, то это не обязательно. Версию НЕОБХОДИМО менять, когда система больше не поддерживает непротиворечивые определения в разных версиях. Если есть ссылка на набор значений (value set), и этот набор значений определяет кодовую систему, и в этом определении указана версия, то эта версия ДОЛЖНА быть такой же, как и в наборе значений (value set). Обратите внимание, что следующим системам указывать версию НЕОБХОДИМО всегда: A code system version may also be supplied. If the meaning of codes within the code system is consistent across releases, this is not required. The version SHOULD be exchanged when the system does not maintain consistent definitions across versions. Note that the following systems SHOULD always have a version specified:

  • Национальные выпуски SNOMED CT (согласованность определений различается в разных странах, и некоторые страны могут принимать свои собственные правила на этот счет)
  • Различные версии ICD (примечание: основные релизы помечены как совершенно разные кодовые системы, но есть различия в версиях)

В общем случае любая классификация (например кодовая система), которая включает концепты с относительными определениями, например "not otherwise coded", потребует указания версии. См. обсуждение версий кодовых систем в ресурсе CodeSystem для дальнейшего обсуждения версионирования.

Если имеется, code ДОЛЖЕН быть синтаксически правильным символом, как это определено системой system. В некоторых кодовых системах, например SNOMED CT, этот символ может быть выражением, составленным из других предопределенных символов (например post-coordination). Обратите внимание, что коды чувствительны к регистру, если в кодовой системе не указано иное. display - это текстовое представление кода, определенное системой system и используемое для отображения значения кода приложением, которое не знает этой системы system. If present, the code SHALL be a syntactically correct symbol as defined by the system. In some code systems such as SNOMED CT, the symbol may be an expression composed of other predefined symbol (e.g. post-coordination). Note that codes are case sensitive unless specified otherwise by the code system. The display is a text representation of the code defined by the system and is used to display the meaning of the code by an application that is not aware of the system.

If the 'display' element is populated, the string used in display SHALL be one of the display strings defined for that code by the code system (code systems may define multiple display strings for a single code). If one of the available display strings is labeled as preferred, it SHOULD be used. If the code system does not define a text representation for display (e.g. SNOMED CT Expressions) then the 'display' element cannot be populated, and the meaning of the code won't be accessible to systems that don't understand the code expression.

В некоторых случая система system может не быть известна - известен только код. В этом случае никакая полезная обработка кода не может быть выполнена, если только система не может быть надежно выведена из контекста. Этой практики следует избегать, где это возможно, так как обмен информации в более широком контексте весьма вероятно возникнет в конце концов, и коды не могут использоваться в отсутствие знания о системе. In some cases, the system might not be known - only the code is known. In this case, no useful processing of the code may be performed unless the system can be safely inferred by the context. This practice should be avoided where possible, as information sharing in a wider context is very likely to arise eventually, and codes cannot be used in the absence of a known system.

Если система присутствует, и нет кода, это следует понимать как отсутствие подходящего кода в системе, где должен быть этот код (in which to represent the code). If the system is present, and there is no code, then this is understood to mean that there is no suitable code in the system in which to represent the code.

Если два codings имеют одинаковые систему system, версию version и код code, значит они имеют одинаковое значение. Если информация о версии отсутствует, или элементы система system, версия version или код code различаются, тогда как их коды связаны, может быть определено обращением к определениям этих систем(ы), и любые мэппинги доступны. If two codings have the same system, version and code then they have the same meaning. If the version information is missing, or the system, version or the code elements differ, then how the codes are related can only be determined by consulting the definitions of the system(s) and any mappings available.

Элемент coding может быть помечен как "выбранный пользователем" ("userSelected"), если пользователь выбрал определенное кодовое значение в интерфейсе пользователя (например пользователь выбирает пункт в списке). Если выбранный пользователем кодинг существует, то он является предпочтительным выбором при выполнении переводов и т. п. A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc.

Ограничения

The context of use (as defined in the resource or applicable profile) usually makes rules about what codes and systems are allowed or required in a particular context by binding the element to a value set.

Coding используется в следующих местах: Meta, DataRequirement, UsageContext, Signature, CodeableConcept, AuditEvent, CapabilityStatement, CodeSystem, Consent, Contract, DocumentReference, Encounter, Endpoint, ExplanationOfBenefit, ImagingStudy, Location, MedicinalProduct, MessageDefinition, MessageHeader, Questionnaire, QuestionnaireResponse, StructureDefinition, TestScript and ValueSet

Implementation Note: This specification defines two types for representing coded values:

  • Coding: простая непосредственная ссылка на код, определенный кодовой системой
  • CodeableConcept: текстовое описание и/или список Codings (т.е. список ссылок на коды, определенные кодовой системой)

Тип данных Coding соответствует простому случаю выбора одиночного кода из списка. Однако этот тип редко используется в спецификациях FHIR; большой опыт обмена кодированными значениями в HL7 показал, что в общем случае системы должны иметь возможность обмениваться несколькими переводами кодов и/или оригинальным текстом. The Coding data type corresponds to the simple case of selecting a single code from a code list. However this type is rarely used in the FHIR specifications; long experience with exchanging coded values in HL7 shows that in the general case, systems need to able to exchange multiple translation codes, and/or an original text.

Тип данных Coding используется, когда есть уверенность в том, что значение должно быть выбрано непосредственно из доступных кодов, и список возможных кодов согласован со всеми участниками. Обычно это не тот случай в контексте FHIR - общей совместимости - таким образом Coding используется главным образом в расширениях, которые обычно предназначены для определения хорошо контролируемых условий использования. The Coding data type is used directly when there is certainty that the value must be selected directly from one of the available codes, and the list of possible codes is agreed to by all participants. This is not usually the case in the context of FHIR - general interoperability - so Coding is mostly used in extensions, which are usually intended to be defined for a well-controlled context of use.

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

CodeableConcept представляет собой значение, которое обычно сопровождается ссылкой на один или несколько справочников или онтологий, но может также определяться предоставлением текста. Это распространенный шаблон представления медицинских данных. A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies but may also be defined by the provision of text. This is a common pattern in healthcare data.

This data type can be bound to a ValueSet.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. CodeableConceptΣNElementConcept - reference to a terminology or just text
Элементы, определённые в прародителе: id, extension
... codingΣ0..*CodingCode defined by a terminology system
... textΣ0..1stringPlain text representation of the concept

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <coding><!-- 0..* Coding Code defined by a terminology system --></coding>
 <text value="[string]"/><!-- 0..1 Plain text representation of the concept -->
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:CodeableConcept.coding [ Coding ], ... ; # 0..* Code defined by a terminology system
  fhir:CodeableConcept.text [ string ]; # 0..1 Plain text representation of the concept
]

Changes since Release 3

CodeableConcept
  • No Changes

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. CodeableConceptΣNElementConcept - reference to a terminology or just text
Элементы, определённые в прародителе: id, extension
... codingΣ0..*CodingCode defined by a terminology system
... textΣ0..1stringPlain text representation of the concept

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <coding><!-- 0..* Coding Code defined by a terminology system --></coding>
 <text value="[string]"/><!-- 0..1 Plain text representation of the concept -->
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:CodeableConcept.coding [ Coding ], ... ; # 0..* Code defined by a terminology system
  fhir:CodeableConcept.text [ string ]; # 0..1 Plain text representation of the concept
]

Changes since Release 3

CodeableConcept
  • No Changes

See the Full Difference for further information

Code Translations

Каждый coding является представлением концепта как описано выше. Концепт может быть закодирован несколько раз в различных кодовых системах (или даже несколько раз в одной и той же кодовой системе, где допустимо несколько форм, например SNOMED CT). Различные кодинги могут иметь слегка различающуюся степень разбиения (структурирования, детализации) из-за различий в определениях лежащих в основе кодов. Порядок кодингов внутри CodeableConcept не имеет значения. Типичное использование CodeableConcept - отправка локального кода, которым был закодирован концепт, и также один или несколько переводов в публично определенные кодовые системы, например LOINC or SNOMED CT. Отправка локальных кодов - полезное и важное в целях отладки и ведения контроля за целостностью. More than one code may be used in CodeableConcept. The concept may be coded multiple times in different code systems (or even multiple times in the same code systems, where multiple forms are possible, such as with SNOMED CT). Each coding (also referred to as a 'translation') is a representation of the concept as described above and may have slightly different granularity due to the differences in the definitions of the underlying codes. There is no meaning associated with the ordering of coding within a CodeableConcept. A typical use of CodeableConcept is to send the local code that the concept was coded with, and also one or more translations to publicly defined code systems such as LOINC or SNOMED CT. Sending local codes is useful and important for the purposes of debugging and integrity auditing.

For example many qualitative laboratory test results values are typically represented with coded presence/absence concepts. Using the coded value for 'negative' with a standard SNOMED CT code translation, valueCodeableConcept would be:


	"valueCodeableConcept": {
		"coding": [
			{
				"system": "http://snomed.info/sct",
				"code": "260385009",
				"display": "Negative"
			}, {
				"system": "https://acme.lab/resultcodes",
				"code": "NEG",
				"display": "Negative"
			}
		],
		"text": "Negative for Chlamydia Trachomatis rRNA"
	}

	

Note that these concepts may be cross mapped using the ConceptMap resource instead of or in addition to being represented as translations directly in the in CodeableConcept.

Using Text in CodeableConcept

The text is the representation of the concept as entered or chosen by the user, and which most closely represents the intended meaning of the user or concept. Very often the text is the same as a display of one of the codings. One or more of the codings may be flagged as the user selected code - the code or concept that the user actually selected directly. Note that in all but a few cases, only one of the codings may be flagged as the coding.userSelected = true - the code or concept that the user actually selected directly. If more than one code is marked as user selected, this means the user explicitly chose multiple codes. When none of the coding elements is marked as user selected, the text (if present)is the preferred source of meaning.

A free text only representation of the concept without any coding elements is permitted if there is no appropriate code and only free text is available (and not prohibited by the implementation). For example using text only, the Observation.valueCodeableConcept element would be:


	"valueCodeableConcept": {
		"text": "uncoded free text result"
	}

			

Ограничения

Контекст использования обычно с помощью привязки элемента к набору данных устанавливает правила о том, какие коды и системы разрешено или требуется использовать в определенной ситуации. The context of use usually makes rules about what codes and systems are allowed or required in a particular context by binding the element to a value set.

CodeableConcept используется в следующих местах: DataRequirement, Dosage, MarketingStatus, Identifier, SubstanceAmount, Population, ProductShelfLife, UsageContext, Timing, ProdCharacteristic, Account, ActivityDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, AuditEvent, Basic, BiologicallyDerivedProduct, BodyStructure, CapabilityStatement, CarePlan, CareTeam, CatalogEntry, ChargeItem, ChargeItemDefinition, Claim, ClaimResponse, ClinicalImpression, CodeSystem, Communication, CommunicationRequest, Composition, ConceptMap, Condition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceDefinition, DeviceMetric, DeviceRequest, DeviceUseStatement, DiagnosticReport, DocumentManifest, DocumentReference, EffectEvidenceSynthesis, Encounter, Endpoint, EpisodeOfCare, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, FamilyMemberHistory, Flag, Goal, GraphDefinition, Group, GuidanceResponse, HealthcareService, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, ImplementationGuide, InsurancePlan, Invoice, Library, List, Location, Measure, MeasureReport, Media, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, MessageDefinition, MessageHeader, MolecularSequence, NamingSystem, NutritionOrder, Observation, ObservationDefinition, OperationDefinition, OperationOutcome, Organization, OrganizationAffiliation, Patient, PaymentNotice, PaymentReconciliation, PlanDefinition, Practitioner, PractitionerRole, Procedure, Provenance, Questionnaire, RelatedPerson, RequestGroup, ResearchDefinition, ResearchElementDefinition, ResearchStudy, RiskAssessment, RiskEvidenceSynthesis, Schedule, SearchParameter, ServiceRequest, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureMap, Substance, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, SupplyDelivery, SupplyRequest, Task, TerminologyCapabilities, TestScript, ValueSet, VerificationResult and VisionPrescription

См. также Примеры, Подробное описание and Мэппинг, Профили и расширения и R2 Conversions.

Измеренная величина (или величина, которая потенциально может быть измерена). A measured amount (or an amount that can potentially be measured).

This data type can be bound to a ValueSet.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. QuantityΣINElementИзмеренная или измеримая величина
+ Rule: If a code for the unit is present, the system SHALL also be present
Элементы, определённые в прародителе: id, extension
... valueΣ0..1decimalЧисленное значение (неявной точности)
... comparator?!Σ0..1code< | <= | >= | > - how to understand the value
QuantityComparator (Required)
... unitΣ0..1stringПредставление единиц измерения
... systemΣI0..1uriСистема, которая определяет кодированную форму единиц измерения
... codeΣ0..1codeКодированная форма единицы измерений

doco Документация по этому формату

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Quantity.value [ decimal ]; # 0..1 Численное значение (неявной точности)
  fhir:Quantity.comparator [ code ]; # 0..1 < | <= | >= | > - how to understand the value
  fhir:Quantity.unit [ string ]; # 0..1 Представление единиц измерения
  fhir:Quantity.system [ uri ]; # 0..1 Система, которая определяет кодированную форму единиц измерения
  fhir:Quantity.code [ code ]; # 0..1 Кодированная форма единицы измерений
]

Changes since Release 3

Quantity
  • No Changes

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. QuantityΣINElementИзмеренная или измеримая величина
+ Rule: If a code for the unit is present, the system SHALL also be present
Элементы, определённые в прародителе: id, extension
... valueΣ0..1decimalЧисленное значение (неявной точности)
... comparator?!Σ0..1code< | <= | >= | > - how to understand the value
QuantityComparator (Required)
... unitΣ0..1stringПредставление единиц измерения
... systemΣI0..1uriСистема, которая определяет кодированную форму единиц измерения
... codeΣ0..1codeКодированная форма единицы измерений

doco Документация по этому формату

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Quantity.value [ decimal ]; # 0..1 Численное значение (неявной точности)
  fhir:Quantity.comparator [ code ]; # 0..1 < | <= | >= | > - how to understand the value
  fhir:Quantity.unit [ string ]; # 0..1 Представление единиц измерения
  fhir:Quantity.system [ uri ]; # 0..1 Система, которая определяет кодированную форму единиц измерения
  fhir:Quantity.code [ code ]; # 0..1 Кодированная форма единицы измерений
]

Changes since Release 3

Quantity
  • No Changes

See the Full Difference for further information

Элемент value содержит числовое значение величины, включая подразумеваемую точность (implicit precision). Если компаратор не указан, то значением является указанное значение (т.е. '='). Элемент comparator не может игнорироваться. The value contains the numerical value of the quantity, including an implicit precision. If no comparator is specified, the value is a point value (i.e. '='). The comparator element can never be ignored.

Элемент unit содержит отображаемую на экране единицу измерения того, что было измерено. Единицы измерений также могут быть закодированы некоторым формальным образом с помощью code и system (см. Coding для получения дополнительной информации о том, как использовать элемент system). The unit element contains a displayable unit that defines what is measured. The unit may additionally be coded in some formal way using the code and the system (see Coding for further information about how to use the system element).

Если единицы измерений можно закодировать с помощью системы UCUM (Unified Code for Units of Measure) и код присутствует, тогда это ДОЛЖЕН быть код UCUM. Если в code указана единица измерения из UCUM, то в целях сравнения величин можно использовать каноническое значение. Обратите внимание, что элемент unit будет часто содержать текст, являющийся допустимой единицей измерения UCUM, но нельзя предполагать, что элемент unit действительно содержит допустимую единицу измерения UCUM. If the unit can be coded in UCUM and a code is provided, it SHOULD be a UCUM code. If a UCUM unit is provided in the code, then a canonical value can be generated for purposes of comparison between quantities. Note that the unit element will often contain text that is a valid UCUM unit, but it cannot be assumed that the unit actually contains a valid UCUM unit.

Constraints

idLevelLocationОпределениеExpression
qty-3Rule (base)If a code for the unit is present, the system SHALL also be presentcode.empty() or system.exists()

Контекст использования часто может указывать, что это за измеренная величина и, следовательно, какие единицы измерений могут применяться. Контекст использования может требовать дополнительный code из определенной system, или value set - см. страницу Using Terminologies для информации о привязке Quantity к value set для ограничивания кодов единиц измерения. Кроме того, контекст использования может требовать code из определенной system. Контекст использования может также ограничивать значения value или range. The context of use may frequently define what kind of measured quantity this is and therefore what kind of unit can be used. The context of use may additionally require a code from a particular system, or a value set - see Using Terminologies for information about binding a Quantity to a value set to constrain the unit codes. The context of use may also restrict the values for the value or comparator.

Terminology Bindings

PathОписаниеТипСсылка
Quantity.comparator How the Quantity should be understood and represented.RequiredQuantityComparator

Quantity используется в следующих местах: Count, SubstanceAmount, Ratio, Distance, Age, Duration, ProductShelfLife, UsageContext, ProdCharacteristic, ChargeItem, Claim, Contract, Device, DeviceDefinition, DeviceRequest, ExplanationOfBenefit, Goal, Group, InsurancePlan, MeasureReport, MedicinalProductIndication, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MolecularSequence, Observation, PlanDefinition, Questionnaire, QuestionnaireResponse, ServiceRequest, SubstanceReferenceInformation, SubstanceSpecification and SupplyRequest

There are several additional data types that are specializations of Quantity that only introduce new restrictions on the existing elements defined as part of the Quantity data type.

The types Age, Distance and Count are marked as Trial Use because they are not used in this specification (though they may be used in extensions). These types may be converted back to a profile (see R2 definitions ).

Type Name Rules Formal Definitions
Distance
idLevelLocationОпределениеExpression
dis-1Rule (base)There SHALL be a code if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM.(code.exists() or value.empty()) and (system.empty() or system = %ucum)

Terminology Bindings

PathОписаниеТипСсылка
Distance Appropriate units for Distance.Extensible, but limited to AllUCUMExpressionForDistanceCommonUCUMCodesForDistance

XML, JSON
Usage: (not used as yet)

Implementation Note: If the duration value is specified as a whole number (e.g. 1 month), then when the duration is added or subtracted to a given date(time), the outcome should be rounded to the nearest natural calendar division - e.g. Feb. 1 + 1 mo = March 1, not March 2 or 3 (since 1 month in is defined in UCUM as 30 days).

Age
idLevelLocationОпределениеExpression
age-1Rule (base)There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.(code.exists() or value.empty()) and (system.empty() or system = %ucum) and (value.empty() or value.hasValue().not() or value > 0)

Terminology Bindings

PathОписаниеТипСсылка
Age Appropriate units for Age.Extensible, but limited to AllUCUMExpressionForTimeCommonUCUMCodesForAge

XML, JSON
Usage: ActivityDefinition, AllergyIntolerance, Condition, FamilyMemberHistory, PlanDefinition, Procedure and RequestGroup
Count
idLevelLocationОпределениеExpression
cnt-3Rule (base)There SHALL be a code with a value of "1" if there is a value. If system is present, it SHALL be UCUM. If present, the value SHALL be a whole number.(code.exists() or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = '1') and (value.empty() or value.hasValue().not() or value.toString().contains('.').not())
XML, JSON
Usage: (not used as yet)
Duration
idLevelLocationОпределениеExpression
drt-1Rule (base)There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.code.exists() implies ((system = %ucum) and value.exists())

Terminology Bindings

PathОписаниеТипСсылка
Duration Appropriate units for Duration.Extensible, but limited to AllUCUMExpressionForTimeCommonUCUMCodesForDuration

XML, JSON
Usage: DataRequirement, Timing, ActivityDefinition, Encounter, EvidenceVariable, Goal, MedicationKnowledge, MedicationRequest, MedicinalProductPharmaceutical, PlanDefinition, RequestGroup, ResearchElementDefinition, Specimen and SpecimenDefinition

In addition to the specializations, there is one constraint on Quantity used in several resources:
Profile Name Rules Formal Definitions
Simple Quantity
idLevelLocationОпределениеExpression
sqty-1Rule(base)The comparator is not used on a SimpleQuantitycomparator.empty())
XML, JSON
Usage: Dosage, SampledData, Range, ActivityDefinition, CarePlan, Claim, ClaimResponse, Contract, Coverage, CoverageEligibilityRequest, ExplanationOfBenefit, Immunization, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, NutritionOrder, Observation, Specimen, SpecimenDefinition, Substance, SupplyDelivery and VisionPrescription

Note that the constraint is different from the other specializations of Quantity because it is not a type, just rules applied where the Quantity type is used. There's another constraint - see Money immediately below.

See also Examples, Detailed Descriptions and Mappings, Profiles & Extensions and R2 Conversions.

An amount of currency.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. MoneyΣNElementAn amount of economic utility in some recognized currency
Элементы, определённые в прародителе: id, extension
... valueΣ0..1decimalNumerical value (with implicit precision)
... currencyΣ0..1codeISO 4217 Currency Code
CurrencyCode (Required)

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <value value="[decimal]"/><!-- 0..1 Numerical value (with implicit precision) -->
 <currency value="[code]"/><!-- 0..1 ISO 4217 Currency Code -->
</[name]>

JSON Template

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Money.value [ decimal ]; # 0..1 Numerical value (with implicit precision)
  fhir:Money.currency [ code ]; # 0..1 ISO 4217 Currency Code
]

Changes since Release 3

Money
Money.value
  • Added Element
Money.currency
  • Added Element

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. MoneyΣNElementAn amount of economic utility in some recognized currency
Элементы, определённые в прародителе: id, extension
... valueΣ0..1decimalNumerical value (with implicit precision)
... currencyΣ0..1codeISO 4217 Currency Code
CurrencyCode (Required)

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <value value="[decimal]"/><!-- 0..1 Numerical value (with implicit precision) -->
 <currency value="[code]"/><!-- 0..1 ISO 4217 Currency Code -->
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Money.value [ decimal ]; # 0..1 Numerical value (with implicit precision)
  fhir:Money.currency [ code ]; # 0..1 ISO 4217 Currency Code
]

Changes since Release 3

Money
Money.value
  • Added Element
Money.currency
  • Added Element

See the Full Difference for further information

The value contains the amount of the currency, including an implicit precision. Precision is always important for financial amounts. The currency element contains an ISO 4217 code for the currency.

Money is used in the following places: ChargeItem, ChargeItemDefinition, Claim, ClaimResponse, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, ExplanationOfBenefit, InsurancePlan, Invoice, MedicationKnowledge, PaymentNotice and PaymentReconciliation

There are also circumstances where a financial amount must be represented as the numerator or denominater in a Ratio, where the type is currency. In this context, the Money amount is represented as a Quantity, using the MoneyQuantity constraint:

Profile Name Rules Formal Definitions
Money Quantity
idLevelLocationОпределениеExpression
sqty-1Rule(base)There SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).(code.exists() or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217'))
XML, JSON
Usage: (not used as yet)

Note that the profile is different from the other specializations because it is not a type, just rules applied where the Quantity type is used to represent Money amounts.

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

Множество упорядоченных значений величины (Quantity), заданное указанием верхнего и нижнего пределов. A set of ordered Quantity values defined by a low and high limit.

Range обозначает множество возможных значений; обычно применяется одно значение из диапазона (например, "выдать пациенту от 2 до 4 таблеток"). Диапазоны обычно используются в указаниях (instructions). A Range specifies a set of possible values; usually, one value from the range applies (e.g. "give the patient between 2 and 4 tablets"). Ranges are typically used in instructions.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. RangeΣINElementРяд значений, ограниченных верхним и нижним
+ Rule: If present, low SHALL have a lower value than high
Элементы, определённые в прародителе: id, extension
... lowΣ0..1SimpleQuantityLow limit
... highΣ0..1SimpleQuantityВерхний предел

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <low><!-- 0..1 Quantity(SimpleQuantity) Low limit --></low>
 <high><!-- 0..1 Quantity(SimpleQuantity) Верхний предел --></high>
</[name]>

JSON Template

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Range.low [ Quantity(SimpleQuantity) ]; # 0..1 Low limit
  fhir:Range.high [ Quantity(SimpleQuantity) ]; # 0..1 Верхний предел
]

Changes since Release 3

Range
  • No Changes

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. RangeΣINElementРяд значений, ограниченных верхним и нижним
+ Rule: If present, low SHALL have a lower value than high
Элементы, определённые в прародителе: id, extension
... lowΣ0..1SimpleQuantityLow limit
... highΣ0..1SimpleQuantityВерхний предел

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <low><!-- 0..1 Quantity(SimpleQuantity) Low limit --></low>
 <high><!-- 0..1 Quantity(SimpleQuantity) Верхний предел --></high>
</[name]>

JSON Template

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Range.low [ Quantity(SimpleQuantity) ]; # 0..1 Low limit
  fhir:Range.high [ Quantity(SimpleQuantity) ]; # 0..1 Верхний предел
]

Changes since Release 3

Range
  • No Changes

See the Full Difference for further information

Элементы unit и code/system в элементах low и high ДОЛЖНЫ совпадать. Если элемент low или high отсутствует, это означает, что нижняя или верхняя граница не известна и, следовательно, ни тот, ни другой не является полным диапазоном (neither is the complete range). The unit and code/system elements of the low or high elements SHALL match. If the low or high elements are missing, the meaning is that the low or high boundaries are not known and therefore neither is the complete range.

Элементы low и high не могут иметь флаг comparator. Обратите внимание, что тип Range не должен использоваться для измерений, выходящих за пределы диапазона: в этом случае следует использовать тип quantity с элементом comparator. The comparator flag on the low or high elements cannot be present. Note that the Range type should not be used to represent out of range measurements: A quantity type with the comparator element should be used instead.

Значения low и high входят в диапазон и предполагается, что они имеют сколь угодно высокую точность. К примеру, диапазон 1.5 - 2.5 включает значения 1.50 и 2.50, но не 1.49 или 2.51. The low and the high values are inclusive and are assumed to have arbitrarily high precision; e.g. the range 1.5 to 2.5 includes 1.50, and 2.50 but not 1.49 or 2.51.

Ограничения

idLevelLocationОпределениеExpression
rng-2Rule (base)If present, low SHALL have a lower value than highlow.empty() or high.empty() or (low <= high)

Range используется в следующих местах: Dosage, SubstanceAmount, Population, UsageContext, Timing, ActivityDefinition, AllergyIntolerance, Condition, DeviceRequest, FamilyMemberHistory, Goal, Group, Observation, ObservationDefinition, PlanDefinition, Procedure, RequestGroup, RiskAssessment, ServiceRequest, SpecimenDefinition, SubstanceReferenceInformation, SubstanceSpecification and SupplyRequest

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

Отношение между двумя значениями количества, выраженное в виде числителя и знаменателя. A relationship between two Quantity values expressed as a numerator and a denominator.

The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. RatioΣINElementОтношение двух значений величины - числитель и знаменатель
+ Rule: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
Элементы, определённые в прародителе: id, extension
... numeratorΣ0..1QuantityЗначение числителя
... denominatorΣ0..1QuantityЗначение знаменателя

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <numerator><!-- 0..1 Quantity Значение числителя --></numerator>
 <denominator><!-- 0..1 Quantity Значение знаменателя --></denominator>
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Ratio.numerator [ Quantity ]; # 0..1 Значение числителя
  fhir:Ratio.denominator [ Quantity ]; # 0..1 Значение знаменателя
]

Changes since Release 3

Ratio
  • No Changes

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. RatioΣINElementОтношение двух значений величины - числитель и знаменатель
+ Rule: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
Элементы, определённые в прародителе: id, extension
... numeratorΣ0..1QuantityЗначение числителя
... denominatorΣ0..1QuantityЗначение знаменателя

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <numerator><!-- 0..1 Quantity Значение числителя --></numerator>
 <denominator><!-- 0..1 Quantity Значение знаменателя --></denominator>
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Ratio.numerator [ Quantity ]; # 0..1 Значение числителя
  fhir:Ratio.denominator [ Quantity ]; # 0..1 Значение знаменателя
]

Changes since Release 3

Ratio
  • No Changes

See the Full Difference for further information

Examples where a Quantity is typically used are rates, densities, concentrations. Examples where a Ratio is used are: titers (e.g. 1:128); concentration ratios where the denominator is significant (e.g. 5mg/10mL); observed frequencies (e.g. 2 repetitions/8 hr), and where the numerator or denominator is an amount of a currency (no UCUM code for $ etc.).

Common factors in the numerator and denominator are not automatically cancelled out. Ratios are not simply "structured numbers" - for example blood pressure measurements (e.g. "120/60") are not ratios.

Правильное соотношение имеет и числитель, и знаменатель; однако это не является обязательным, чтобы можно было использовать недопустимые соотношения с указанием дополнительной информации в расширении. A proper ratio has both a numerator and a denominator; however these are not mandatory in order to allow an invalid ratio with an extension with further information.

Ограничения

idLevelLocationОпределениеExpression
rat-1Rule (base)Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Контекст использования может потребовать определенные типы Quantity для числителя или знаменателя. The context of use may require particular types of Quantity for the numerator or denominator.

Ratio используется в следующих местах: Dosage, Goal, Medication, MedicationAdministration, MedicationKnowledge, MedicinalProductIngredient, MedicinalProductPharmaceutical, NutritionOrder, Observation, ServiceRequest, Substance and SubstanceSpecification

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

Период времени, определенный датой/временем начала и окончания. A time period defined by a start and end date/time.

Период устанавливает диапазон времени. В контексте использования будет указываться, применять ли полный диапазон (например "пациент находился в стационаре больницы данный диапазон времени") или одно значение из указанного периода (например "выдать пациенту между 14 и 16 часами 24-Jun 2013"). A period specifies a range of times. The context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the period applies (e.g. "give to the patient between 2 and 4 pm on 24-Jun 2013").

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. PeriodΣINElementИнтервал времени, заданный датой/временем начала и окончания
+ Rule: Если указана, начальная дата ДОЛЖНА быть меньше, чем дата окончания
Элементы, определённые в прародителе: id, extension
... startΣI0..1dateTimeВремя начала (включительно)
... endΣI0..1dateTimeВремя окончания, граничное значение включительно, если не продолжается

doco Документация по этому формату

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Period.start [ dateTime ]; # 0..1 Время начала (включительно)
  fhir:Period.end [ dateTime ]; # 0..1 Время окончания, граничное значение включительно, если не продолжается
]

Changes since Release 3

Period
  • No Changes

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. PeriodΣINElementИнтервал времени, заданный датой/временем начала и окончания
+ Rule: Если указана, начальная дата ДОЛЖНА быть меньше, чем дата окончания
Элементы, определённые в прародителе: id, extension
... startΣI0..1dateTimeВремя начала (включительно)
... endΣI0..1dateTimeВремя окончания, граничное значение включительно, если не продолжается

doco Документация по этому формату

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Period.start [ dateTime ]; # 0..1 Время начала (включительно)
  fhir:Period.end [ dateTime ]; # 0..1 Время окончания, граничное значение включительно, если не продолжается
]

Changes since Release 3

Period
  • No Changes

See the Full Difference for further information

Если элемент start отсутствует, значит начало периода не известно. Если элемент end отсутствует, значит период продолжается, If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time

Значение end включает в себя любую подходящую дату/время. К примеру, период с 2011-05-23 по 2011-05-27 включает любое время с начала дня 23 мая до конца дня 27 мая. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.

Period используется в следующих местах: Address, DataRequirement, HumanName, ContactPoint, MarketingStatus, Identifier, Timing, Account, ActivityDefinition, AllergyIntolerance, Appointment, AuditEvent, BiologicallyDerivedProduct, CarePlan, CareTeam, CatalogEntry, ChargeItem, ChargeItemDefinition, Claim, ClaimResponse, ClinicalImpression, CommunicationRequest, Composition, Condition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, DeviceRequest, DeviceUseStatement, DiagnosticReport, DocumentReference, EffectEvidenceSynthesis, Encounter, Endpoint, EpisodeOfCare, EventDefinition, Evidence, EvidenceVariable, ExplanationOfBenefit, FamilyMemberHistory, Flag, Group, HealthcareService, InsurancePlan, Library, Measure, MeasureReport, Media, MedicationAdministration, MedicationRequest, MedicationStatement, MedicinalProductAuthorization, NamingSystem, Observation, OrganizationAffiliation, Patient, PaymentReconciliation, PlanDefinition, Practitioner, PractitionerRole, Procedure, Provenance, Questionnaire, RelatedPerson, RequestGroup, ResearchDefinition, ResearchElementDefinition, ResearchStudy, ResearchSubject, RiskAssessment, RiskEvidenceSynthesis, Schedule, ServiceRequest, Specimen, SupplyDelivery, SupplyRequest and Task

Normative Candidate Note: This DataType is not normative - it is still undergoing Trial Use while more experience is gathered.

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

Данные серии измерений, снятые устройством, которые могут иметь верхний и нижний пределы. Этот тип данных также поддерживает несколько измерений. Data that comes from a series of measurements taken by a device, which may have upper and lower limits. The data type also supports more than one dimension in the data.

SampledData обеспечивает удобный способ управления данными, полученными на изделиях, которые измеряют определенное физическое состояние с высокой частотой. Типичное использование - вывод данных с электрокардиографа. В этот тип данных входят серии необработанных десятичных значений (которые по большей части являются простыми целыми), наряду с другими настройками шкалы и коэффициента. Они интерпретируются таким образом, чтобы A SampledData provides a concise way to handle the data produced by devices that sample a particular physical state at a high frequency. A typical use for this is for the output of an ECG or EKG device. The data type includes a series of raw decimal values (which are mostly simple integers), along with adjustments for scale and factor. These are interpreted such that

первоначальное измеренное значение value[i] = SampledData.data[i] * SampledData.scaleFactor + SampledData.origin.value

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. SampledDataTUElementA series of measurements taken by a device
Элементы, определённые в прародителе: id, extension
... originΣ1..1SimpleQuantityZero value and units
... periodΣ1..1decimalNumber of milliseconds between samples
... factorΣ0..1decimalMultiply data by this before adding to origin
... lowerLimitΣ0..1decimalLower limit of detection
... upperLimitΣ0..1decimalUpper limit of detection
... dimensionsΣ1..1positiveIntNumber of sample points at each time point
... data0..1stringDecimal values with spaces, or "E" | "U" | "L"

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <origin><!-- 1..1 Quantity(SimpleQuantity) Zero value and units --></origin>
 <period value="[decimal]"/><!-- 1..1 Number of milliseconds between samples -->
 <factor value="[decimal]"/><!-- 0..1 Multiply data by this before adding to origin -->
 <lowerLimit value="[decimal]"/><!-- 0..1 Lower limit of detection -->
 <upperLimit value="[decimal]"/><!-- 0..1 Upper limit of detection -->
 <dimensions value="[positiveInt]"/><!-- 1..1 Number of sample points at each time point -->
 <data value="[string]"/><!-- 0..1 Decimal values with spaces, or "E" | "U" | "L" -->
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:SampledData.origin [ Quantity(SimpleQuantity) ]; # 1..1 Zero value and units
  fhir:SampledData.period [ decimal ]; # 1..1 Number of milliseconds between samples
  fhir:SampledData.factor [ decimal ]; # 0..1 Multiply data by this before adding to origin
  fhir:SampledData.lowerLimit [ decimal ]; # 0..1 Lower limit of detection
  fhir:SampledData.upperLimit [ decimal ]; # 0..1 Upper limit of detection
  fhir:SampledData.dimensions [ positiveInt ]; # 1..1 Number of sample points at each time point
  fhir:SampledData.data [ string ]; # 0..1 Decimal values with spaces, or "E" | "U" | "L"
]

Changes since Release 3

SampledData
SampledData.factor
  • Default Value "1" removed
SampledData.data
  • Min Cardinality changed from 1 to 0

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. SampledDataTUElementA series of measurements taken by a device
Элементы, определённые в прародителе: id, extension
... originΣ1..1SimpleQuantityZero value and units
... periodΣ1..1decimalNumber of milliseconds between samples
... factorΣ0..1decimalMultiply data by this before adding to origin
... lowerLimitΣ0..1decimalLower limit of detection
... upperLimitΣ0..1decimalUpper limit of detection
... dimensionsΣ1..1positiveIntNumber of sample points at each time point
... data0..1stringDecimal values with spaces, or "E" | "U" | "L"

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <origin><!-- 1..1 Quantity(SimpleQuantity) Zero value and units --></origin>
 <period value="[decimal]"/><!-- 1..1 Number of milliseconds between samples -->
 <factor value="[decimal]"/><!-- 0..1 Multiply data by this before adding to origin -->
 <lowerLimit value="[decimal]"/><!-- 0..1 Lower limit of detection -->
 <upperLimit value="[decimal]"/><!-- 0..1 Upper limit of detection -->
 <dimensions value="[positiveInt]"/><!-- 1..1 Number of sample points at each time point -->
 <data value="[string]"/><!-- 0..1 Decimal values with spaces, or "E" | "U" | "L" -->
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:SampledData.origin [ Quantity(SimpleQuantity) ]; # 1..1 Zero value and units
  fhir:SampledData.period [ decimal ]; # 1..1 Number of milliseconds between samples
  fhir:SampledData.factor [ decimal ]; # 0..1 Multiply data by this before adding to origin
  fhir:SampledData.lowerLimit [ decimal ]; # 0..1 Lower limit of detection
  fhir:SampledData.upperLimit [ decimal ]; # 0..1 Upper limit of detection
  fhir:SampledData.dimensions [ positiveInt ]; # 1..1 Number of sample points at each time point
  fhir:SampledData.data [ string ]; # 0..1 Decimal values with spaces, or "E" | "U" | "L"
]

Changes since Release 3

SampledData
SampledData.factor
  • Default Value "1" removed
SampledData.data
  • Min Cardinality changed from 1 to 0

See the Full Difference for further information

Данные представляют собой множество десятичных значений, разделенных одиночным пробелом (символ Юникода u20). В дополнение к десятичным значениям используются значения "E" (ошибка), "L" (ниже предела обнаружения) и "U" (выше предела обнаружения). Если имеется более одного измерения, различные измерения чередуются - все точки данных для конкретного времени представлены вместе. The digits are a set of decimal values separated by a single space (Unicode character u20). In addition to decimal values, the special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used. If there is more than one dimension, the different dimensions are interlaced - all the data points for a particular time are represented together.

SampledData используется в следующих местах: Observation

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

Числовая или буквенно-числовая строка, ассоциированная с отдельным объектом или сущностью внутри данной системы. Обычно идентификаторы используются, чтобы связать содержимое ресурсов и внешнее содержимое, доступное в других фреймворках или протоколах. Идентификаторы ассоциируются с объектами и могут быть изменены или изъяты из обращения вследствие развития систем, из-за ошибок или с течением времени. A numeric or alphanumeric string that is associated with a single object or entity within a given system. Typically, identifiers are used to connect content in resources to external content available in other frameworks or protocols. Identifiers are associated with objects and may be changed or retired due to human or system process and errors.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. IdentifierΣNElementИдентификатор, предназначенный для вычислений
Элементы, определённые в прародителе: id, extension
... use?!Σ0..1codeusual | official | temp | secondary | old (If known)
IdentifierUse (Required)
... typeΣ0..1CodeableConceptОписание идентификатора
IdentifierType (Extensible)
... systemΣ0..1uriThe namespace for the identifier value
... valueΣ0..1stringЗначение, являющееся уникальным
... periodΣ0..1PeriodВременной период, когда id является/являлся допустимым к использованию
... assignerΣ0..1Reference(Organization)Организация, которая назначила идентификатор (может быть просто текстом)

doco Документация по этому формату

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*IdentifierНазначение этого идентификатора (this element modifies the meaning of other elements)use : code [0..1] « Identifies the purpose for this identifier, if known . (Strength=Required)IdentifierUse! »Кодированный тип идентификатора, который можно использовать для определения, какой идентификатор использовать в конкретных целяхtype : CodeableConcept [0..1] « A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (Strength=Extensible)Identifier Type + »Establishes the namespace for the value - that is, a URL that describes a set values that are uniquesystem : uri [0..1]Часть идентификатора, обычно отображаемая пользователю, которая является уникальной в контексте системыvalue : string [0..1]Временной период, в течение которого идентификатор является/являлся допустимым к использованиюperiod : Period [0..1]Организация, присваивающая/управляющая идентификаторомassigner : Reference [0..1] « Organization »

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Identifier.use [ code ]; # 0..1 usual | official | temp | secondary | old (If known)
  fhir:Identifier.type [ CodeableConcept ]; # 0..1 Описание идентификатора
  fhir:Identifier.system [ uri ]; # 0..1 The namespace for the identifier value
  fhir:Identifier.value [ string ]; # 0..1 Значение, являющееся уникальным
  fhir:Identifier.period [ Period ]; # 0..1 Временной период, когда id является/являлся допустимым к использованию
  fhir:Identifier.assigner [ Reference(Organization) ]; # 0..1 Организация, которая назначила идентификатор (может быть просто текстом)
]

Changes since Release 3

Identifier
Identifier.use
  • Add Code old

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. IdentifierΣNElementИдентификатор, предназначенный для вычислений
Элементы, определённые в прародителе: id, extension
... use?!Σ0..1codeusual | official | temp | secondary | old (If known)
IdentifierUse (Required)
... typeΣ0..1CodeableConceptОписание идентификатора
IdentifierType (Extensible)
... systemΣ0..1uriThe namespace for the identifier value
... valueΣ0..1stringЗначение, являющееся уникальным
... periodΣ0..1PeriodВременной период, когда id является/являлся допустимым к использованию
... assignerΣ0..1Reference(Organization)Организация, которая назначила идентификатор (может быть просто текстом)

doco Документация по этому формату

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*IdentifierНазначение этого идентификатора (this element modifies the meaning of other elements)use : code [0..1] « Identifies the purpose for this identifier, if known . (Strength=Required)IdentifierUse! »Кодированный тип идентификатора, который можно использовать для определения, какой идентификатор использовать в конкретных целяхtype : CodeableConcept [0..1] « A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (Strength=Extensible)Identifier Type + »Establishes the namespace for the value - that is, a URL that describes a set values that are uniquesystem : uri [0..1]Часть идентификатора, обычно отображаемая пользователю, которая является уникальной в контексте системыvalue : string [0..1]Временной период, в течение которого идентификатор является/являлся допустимым к использованиюperiod : Period [0..1]Организация, присваивающая/управляющая идентификаторомassigner : Reference [0..1] « Organization »

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Identifier.use [ code ]; # 0..1 usual | official | temp | secondary | old (If known)
  fhir:Identifier.type [ CodeableConcept ]; # 0..1 Описание идентификатора
  fhir:Identifier.system [ uri ]; # 0..1 The namespace for the identifier value
  fhir:Identifier.value [ string ]; # 0..1 Значение, являющееся уникальным
  fhir:Identifier.period [ Period ]; # 0..1 Временной период, когда id является/являлся допустимым к использованию
  fhir:Identifier.assigner [ Reference(Organization) ]; # 0..1 Организация, которая назначила идентификатор (может быть просто текстом)
]

Changes since Release 3

Identifier
Identifier.use
  • Add Code old

See the Full Difference for further information

The value SHALL be unique within the defined system and have a consistent meaning wherever it appears. Identifier.system is always case sensitive. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Система system - это URI, определяющее множество идентификаторов (т. е. каким образом обеспечивается уникальность значения). Это может быть некоторое приложение или признанный стандарт/спецификация, определяющие доступное множество идентификаторов или способ обеспечения их уникальности. FHIR сразу задаёт URI некоторых полезных или важных систем. Вот несколько примеров пространств имен идентификаторов:

  • http://hl7.org/fhir/sid/us-ssn for United States Social Security Number (SSN) values
  • http://ns.electronichealth.net.au/id/hi/ihi/1.0 for Australian Individual Healthcare Identifier (IHI) numbers
  • urn:ietf:rfc:3986 for when the value of the identifier is itself a globally unique URI

If the system is a URL, it SHOULD resolve. Resolution might be to a web page that describes the identifier system and/or supports look-up of identifiers. Alternatively, it could be to a NamingSystem resource instance. Resolvable URLs are generally preferred by implementers over non-resolvable URNs, particularly opaque URNs such as OIDs (urn:oid:) or UUIDs (urn:uuid:). If used, OIDs and UUIDs may be registered in the HL7 OID registry and SHOULD be registered if the content is shared or exchanged across institutional boundaries.

It is up to the implementer organization to determine an appropriate URL or URN structure that will avoid collisions and to manage that space (and the resolvability of URLs) over time.

Note that the scope of a given identifier system may extend beyond identifiers that might be captured by a single resource. For example, some systems might draw all "order" identifiers from a single namespace, though some might be used on MedicationRequest while others would appear on ServiceRequest.

Если значение идентификатора само по себе является глобально уникальным URI (например OID, UUID или URI без локального окончания), тогда значением системы system ДОЛЖНО быть "urn:ietf:rfc:3986"", а в value должен быть указан сам URI (OIDs и UUIDs с помощью urn:oid: и urn:uuid: - см. примеры). If the identifier value itself is naturally a globally unique URI (e.g. an OID, a UUID, or a URI with no trailing local part), then the system SHALL be "urn:ietf:rfc:3986", and the URI is in the value (OIDs and UUIDs using urn:oid: and urn:uuid: - see note on the V3 mapping and the examples).

В некоторых случаях система может быть не известна - известно только значение (например простое устройство, сканирующее штрих-коды), или система понимается неявно (простой обмен в ограниченном контексте, зачастую обусловленный считывателями штрих-кодов). В этом случае невозможно выполнить полезное сопоставление значения, если только система не может быть с уверенностью выведена из контекста. Приложения должны указывать систему везде, где это возможно, так как со временем растет вероятность совместного использования информации в более широком контексте, а значения без системы по своей природе ограничены в использовании. In some cases, the system might not be known - only the value is known (e.g. a simple device that scans a barcode), or the system is known implicitly (simple exchange in a limited context, often driven by barcode readers). In this case, no useful matching may be performed using the value unless the system can be safely inferred by the context. Applications should provide a system wherever possible, as information sharing in a wider context is very likely to arise eventually, and values without a system are inherently limited in use.

In addition to the system (which provides a uniqueness scope) and the value, identifiers may also have a type, which may be useful when a system encounters identifiers with unknown system values. Note, however, that the type of an identifier is not a well-controlled vocabulary with wide variations in practice. The type deals only with general categories of identifiers and SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to variations in common usage.

Элемент assigner используется для указания, какой реестр/государство/учреждение/пр. назначили идентификатор. В качестве Reference можно указать просто текстовое описание в элементе display.

Constraints

Terminology Bindings

PathОписаниеТипСсылка
Identifier.use Identifies the purpose for this identifier, if known .RequiredIdentifierUse
Identifier.type A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.ExtensibleIdentifier Type Codes

Identifier используется в следующих местах: Reference, ProductShelfLife, Account, ActivityDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, Basic, BiologicallyDerivedProduct, BodyStructure, Bundle, CarePlan, CareTeam, CatalogEntry, ChargeItem, ChargeItemDefinition, Claim, ClaimResponse, ClinicalImpression, CodeSystem, Communication, CommunicationRequest, Composition, ConceptMap, Condition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceDefinition, DeviceMetric, DeviceRequest, DeviceUseStatement, DiagnosticReport, DocumentManifest, DocumentReference, EffectEvidenceSynthesis, Encounter, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, FamilyMemberHistory, Flag, Goal, Group, GuidanceResponse, HealthcareService, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, InsurancePlan, Invoice, Library, List, Location, Measure, MeasureReport, Media, Medication, MedicationAdministration, MedicationDispense, MedicationRequest, MedicationStatement, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductIngredient, MedicinalProductPackaged, MedicinalProductPharmaceutical, MessageDefinition, MolecularSequence, NutritionOrder, Observation, ObservationDefinition, Organization, OrganizationAffiliation, Patient, PaymentNotice, PaymentReconciliation, Person, PlanDefinition, Practitioner, PractitionerRole, Procedure, Questionnaire, QuestionnaireResponse, RelatedPerson, RequestGroup, ResearchDefinition, ResearchElementDefinition, ResearchStudy, ResearchSubject, RiskAssessment, RiskEvidenceSynthesis, Schedule, ServiceRequest, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureMap, Substance, SubstanceNucleicAcid, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, SupplyDelivery, SupplyRequest, Task, TestReport, TestScript, ValueSet and VisionPrescription

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

Имя человека с указанием текстового представления, частей имени и информации об использовании. A name of a human with text, parts and usage information.

Имя можно изменить или отречься от него. У людей могут быть различные имена в разных обстоятельствах. Имена могут быть разбиты на части разного типа, имеющие переменное значение в зависимости от контекста, хотя деление на части не всегда существенно. В личных именах различные части могут быть пронизаны некоторым неявным смыслом; различные культуры придают различную важность частями имени, и степень, с которой система ДОЛЖНА заботиться о частях имени, по всему миру широко варьируется. Names may be changed or repudiated. People may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts is not always significant. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems SHALL care about name parts around the world varies widely.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. HumanNameΣNElementName of a human - parts and usage
Элементы, определённые в прародителе: id, extension
... use?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
NameUse (Required)
... textΣ0..1stringText representation of the full name
... familyΣ0..1stringFamily name (often called 'Surname')
... givenΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... prefixΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
... suffixΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... periodΣ0..1PeriodTime period when name was/is in use

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <use value="[code]"/><!-- 0..1 usual | official | temp | nickname | anonymous | old | maiden -->
 <text value="[string]"/><!-- 0..1 Text representation of the full name -->
 <family value="[string]"/><!-- 0..1 Family name (often called 'Surname') -->
 <given value="[string]"/><!-- 0..* Given names (not always 'first'). Includes middle names -->
 <prefix value="[string]"/><!-- 0..* Parts that come before the name -->
 <suffix value="[string]"/><!-- 0..* Parts that come after the name -->
 <period><!-- 0..1 Period Time period when name was/is in use --></period>
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:HumanName.use [ code ]; # 0..1 usual | official | temp | nickname | anonymous | old | maiden
  fhir:HumanName.text [ string ]; # 0..1 Text representation of the full name
  fhir:HumanName.family [ string ]; # 0..1 Family name (often called 'Surname')
  fhir:HumanName.given [ string ], ... ; # 0..* Given names (not always 'first'). Includes middle names
  fhir:HumanName.prefix [ string ], ... ; # 0..* Parts that come before the name
  fhir:HumanName.suffix [ string ], ... ; # 0..* Parts that come after the name
  fhir:HumanName.period [ Period ]; # 0..1 Time period when name was/is in use
]

Changes since Release 3

HumanName
  • No Changes

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. HumanNameΣNElementName of a human - parts and usage
Элементы, определённые в прародителе: id, extension
... use?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
NameUse (Required)
... textΣ0..1stringText representation of the full name
... familyΣ0..1stringFamily name (often called 'Surname')
... givenΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... prefixΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
... suffixΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... periodΣ0..1PeriodTime period when name was/is in use

doco Документация по этому формату

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <use value="[code]"/><!-- 0..1 usual | official | temp | nickname | anonymous | old | maiden -->
 <text value="[string]"/><!-- 0..1 Text representation of the full name -->
 <family value="[string]"/><!-- 0..1 Family name (often called 'Surname') -->
 <given value="[string]"/><!-- 0..* Given names (not always 'first'). Includes middle names -->
 <prefix value="[string]"/><!-- 0..* Parts that come before the name -->
 <suffix value="[string]"/><!-- 0..* Parts that come after the name -->
 <period><!-- 0..1 Period Time period when name was/is in use --></period>
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:HumanName.use [ code ]; # 0..1 usual | official | temp | nickname | anonymous | old | maiden
  fhir:HumanName.text [ string ]; # 0..1 Text representation of the full name
  fhir:HumanName.family [ string ]; # 0..1 Family name (often called 'Surname')
  fhir:HumanName.given [ string ], ... ; # 0..* Given names (not always 'first'). Includes middle names
  fhir:HumanName.prefix [ string ], ... ; # 0..* Parts that come before the name
  fhir:HumanName.suffix [ string ], ... ; # 0..* Parts that come after the name
  fhir:HumanName.period [ Period ]; # 0..1 Time period when name was/is in use
]

Changes since Release 3

HumanName
  • No Changes

See the Full Difference for further information

В таблице ниже сведены места, где встречаются общие части имени человека. This table summarizes where common parts of a person's name are found.

ИмяПримерКуда записывается / Комментарии
SurnameSmithFamily Name
First nameJohnGiven Name
TitleMrPrefix
Middle NameSamuelSubsequent Given Names
Patronymicbin OsmanFamily Name
Multiple family namesCarreño QuiñonesFamily Name. See note below about decomposition of family name
InitialsQ.Given Name as initial ("." recommended)
Nick NameJockGiven name, with Use = common
QualificationsPhDSuffix
HonorificsSeniorSuffix
Voorvoegsel / Nobilityvan BeethovenFamily Name. See note below about decomposition of family name

Для получения дополнительной информации, в том числе все W3C Международные примеры , обратитесь к примерам. Note: Implementers should read the name examples for a full understanding of how name works.

The multiple given parts and family name combine to form a single name. Where a person has alternate names that may be used in place of each other (e.g. Nicknames, Aliases), these are different instances of HumanName.

The text element specifies the entire name as it should be displayed e.g. in an application UI. This may be provided instead of or as well as the specific parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. The correct order of assembly of the parts is culture dependent: the order of the parts within a given part type has significance and SHALL be observed. The appropriate order between family name and given names depends on culture and context of use. Note that there is an extension for the few times name assembly order is not fixed by the culture.

The given name parts may contain whitespace, though generally they don't. Initials may be used in place of the full name if that is all that is recorded. Systems that operate across cultures should generally rely on the text form for presentation and use the parts for index/search functionality. For this reason, applications SHOULD populate the text element for future robustness.

In some cultures (e.g. German, Dutch, Spanish, Portuguese), family names are complex and composed of various parts that may need to be managed separately, e.g. they have differing significance for searching. In these cases, the full family name is populated in family, and a decomposition of the name can be provided using the family extensions own-name, own-prefix, partner-name, partner-prefix, fathers-family and mothers-family.

For robust search, servers should search the parts of a family name independently. E.g. Searching either Carreno or Quinones should match a family name of "Carreno Quinones". HL7 affiliates, and others producing implementation guides, may make more specific recommendations about how search should work in specific cultures or environments.

Constraints

Terminology Bindings

PathОписаниеТипСсылка
HumanName.use The use of a human name.RequiredNameUse

HumanName используется в следующих местах: InsurancePlan, Organization, Patient, Person, Practitioner and RelatedPerson

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. AddressΣNElementAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Элементы, определённые в прародителе: id, extension
... use?!Σ0..1codehome | work | temp | old | billing - purpose of this address
AddressUse (Required)
... typeΣ0..1codepostal | physical | both
AddressType (Required)
... textΣ0..1stringТекстовое представление адреса
... lineΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
... cityΣ0..1stringНазвание города, поселка и т. п
... districtΣ0..1stringDistrict name (aka county)
... stateΣ0..1stringSub-unit of country (abbreviations ok)
... postalCodeΣ0..1stringПочтовый индекс области
... countryΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... periodΣ0..1PeriodПериод времени, в течение которого адрес был/находится в использовании

doco Документация по этому формату

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*AddressНазначение этого адреса (this element modifies the meaning of other elements)use : code [0..1] « The use of an address. (Strength=Required)AddressUse! »Различия между физическими адресами (которые можно посетить) и почтовыми адресами (например почтовые ящики и адреса по месту жительства). Большинство адресов являются и теми, и другимиtype : code [0..1] « The type of an address (physical / postal). (Strength=Required)AddressType! »Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific partstext : string [0..1]This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address informationline : string [0..*]The name of the city, town, suburb, village or other community or delivery centercity : string [0..1]The name of the administrative area (county)district : string [0..1]Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes)state : string [0..1]A postal code designating a region defined by the postal servicepostalCode : string [0..1]Страна - нация в общепринятом смыслеcountry : string [0..1]Период времени, в течение которого адрес был/находится в использованииperiod : Period [0..1]

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Address.use [ code ]; # 0..1 home | work | temp | old | billing - purpose of this address
  fhir:Address.type [ code ]; # 0..1 postal | physical | both
  fhir:Address.text [ string ]; # 0..1 Текстовое представление адреса
  fhir:Address.line [ string ], ... ; # 0..* Street name, number, direction & P.O. Box etc.
  fhir:Address.city [ string ]; # 0..1 Название города, поселка и т. п
  fhir:Address.district [ string ]; # 0..1 District name (aka county)
  fhir:Address.state [ string ]; # 0..1 Sub-unit of country (abbreviations ok)
  fhir:Address.postalCode [ string ]; # 0..1 Почтовый индекс области
  fhir:Address.country [ string ]; # 0..1 Country (e.g. can be ISO 3166 2 or 3 letter code)
  fhir:Address.period [ Period ]; # 0..1 Период времени, в течение которого адрес был/находится в использовании
]

Changes since Release 3

Address
Address.use
  • Add Code billing

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. AddressΣNElementAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Элементы, определённые в прародителе: id, extension
... use?!Σ0..1codehome | work | temp | old | billing - purpose of this address
AddressUse (Required)
... typeΣ0..1codepostal | physical | both
AddressType (Required)
... textΣ0..1stringТекстовое представление адреса
... lineΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
... cityΣ0..1stringНазвание города, поселка и т. п
... districtΣ0..1stringDistrict name (aka county)
... stateΣ0..1stringSub-unit of country (abbreviations ok)
... postalCodeΣ0..1stringПочтовый индекс области
... countryΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... periodΣ0..1PeriodПериод времени, в течение которого адрес был/находится в использовании

doco Документация по этому формату

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*AddressНазначение этого адреса (this element modifies the meaning of other elements)use : code [0..1] « The use of an address. (Strength=Required)AddressUse! »Различия между физическими адресами (которые можно посетить) и почтовыми адресами (например почтовые ящики и адреса по месту жительства). Большинство адресов являются и теми, и другимиtype : code [0..1] « The type of an address (physical / postal). (Strength=Required)AddressType! »Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific partstext : string [0..1]This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address informationline : string [0..*]The name of the city, town, suburb, village or other community or delivery centercity : string [0..1]The name of the administrative area (county)district : string [0..1]Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes)state : string [0..1]A postal code designating a region defined by the postal servicepostalCode : string [0..1]Страна - нация в общепринятом смыслеcountry : string [0..1]Период времени, в течение которого адрес был/находится в использованииperiod : Period [0..1]

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Address.use [ code ]; # 0..1 home | work | temp | old | billing - purpose of this address
  fhir:Address.type [ code ]; # 0..1 postal | physical | both
  fhir:Address.text [ string ]; # 0..1 Текстовое представление адреса
  fhir:Address.line [ string ], ... ; # 0..* Street name, number, direction & P.O. Box etc.
  fhir:Address.city [ string ]; # 0..1 Название города, поселка и т. п
  fhir:Address.district [ string ]; # 0..1 District name (aka county)
  fhir:Address.state [ string ]; # 0..1 Sub-unit of country (abbreviations ok)
  fhir:Address.postalCode [ string ]; # 0..1 Почтовый индекс области
  fhir:Address.country [ string ]; # 0..1 Country (e.g. can be ISO 3166 2 or 3 letter code)
  fhir:Address.period [ Period ]; # 0..1 Период времени, в течение которого адрес был/находится в использовании
]

Changes since Release 3

Address
Address.use
  • Add Code billing

See the Full Difference for further information

Элемент text содержит полный адрес в том виде, в котором он должен отображаться, например почтовый адрес. Его можно задать вместо либо в дополнение к отдельным частям. Приложения, обновляющие адрес, ДОЛЖНЫ убедиться, что когда указаны и элемент text, и дискретные элементы адреса, что в элемент text не включены значения, отсутствующие в дискретных полях адреса. The text element specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Ограничения

Terminology Bindings

PathОписаниеТипСсылка
Address.use The use of an address.RequiredAddressUse
Address.type The type of an address (physical / postal).RequiredAddressType

Address используется в следующих местах: Claim, ClaimResponse, ExplanationOfBenefit, InsurancePlan, Location, Organization, Patient, Person, Practitioner and RelatedPerson

См. также Примеры, Подробное описание, Мэппинг, Профили и расширения и R2 Conversions.

Контактные данные человека или организации любого вида технологий опосредованной коммуникации, включая телефон, электронную почту и др.

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. ContactPointΣINElementDetails of a Technology mediated contact point (phone, fax, email, etc.)
+ Rule: Если значение указано, система является обязательной.
Элементы, определённые в прародителе: id, extension
... systemΣI0..1codephone | fax | email | pager | url | sms | other
ContactPointSystem (Required)
... valueΣ0..1stringДетали самой точки контакта
... use?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
ContactPointUse (Required)
... rankΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... periodΣ0..1PeriodПериод времени, когда контактная точка была/находится в употреблении

doco Документация по этому формату

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:ContactPoint.system [ code ]; # 0..1 phone | fax | email | pager | url | sms | other
  fhir:ContactPoint.value [ string ]; # 0..1 Детали самой точки контакта
  fhir:ContactPoint.use [ code ]; # 0..1 home | work | temp | old | mobile - purpose of this contact point
  fhir:ContactPoint.rank [ positiveInt ]; # 0..1 Specify preferred order of use (1 = highest)
  fhir:ContactPoint.period [ Period ]; # 0..1 Период времени, когда контактная точка была/находится в употреблении
]

Changes since Release 3

ContactPoint
  • No Changes

See the Full Difference for further information

Structure

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. ContactPointΣINElementDetails of a Technology mediated contact point (phone, fax, email, etc.)
+ Rule: Если значение указано, система является обязательной.
Элементы, определённые в прародителе: id, extension
... systemΣI0..1codephone | fax | email | pager | url | sms | other
ContactPointSystem (Required)
... valueΣ0..1stringДетали самой точки контакта
... use?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
ContactPointUse (Required)
... rankΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... periodΣ0..1PeriodПериод времени, когда контактная точка была/находится в употреблении

doco Документация по этому формату

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:ContactPoint.system [ code ]; # 0..1 phone | fax | email | pager | url | sms | other
  fhir:ContactPoint.value [ string ]; # 0..1 Детали самой точки контакта
  fhir:ContactPoint.use [ code ]; # 0..1 home | work | temp | old | mobile - purpose of this contact point
  fhir:ContactPoint.rank [ positiveInt ]; # 0..1 Specify preferred order of use (1 = highest)
  fhir:ContactPoint.period [ Period ]; # 0..1 Период времени, к