Current Build

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

FHIR Infrastructure Work GroupMaturity Level: 4Ballot Status: 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

На странице приведено подробное описание типов данных:

Оглавление

Примитивные типы
ElementinstanttimedatedateTimedecimalbooleanintegerstringuribase64BinarycodeidoidunsignedIntpositiveIntmarkdownurlcanonicaluuid
Сложные типы
ElementIdentifierHumanNameAddressContactPointTimingQuantitySimpleQuantityAttachmentRangePeriodRatioCodeableConceptCodingSampledDataAgeDistanceDurationCountMoneyMoneyQuantityAnnotationSignatureBackboneElement

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

todo

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

Attachment
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdAttachment
Definition

For referring to data content defined in other formats.

Control0..*
TypeElement
Requirements

Many models need to include data defined in other specifications that is complex and opaque to the healthcare model. This includes documents, media recordings, structured data, etc.

Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Invariants
Defined on this element
att-1Rule If the Attachment has data, it SHALL have a contentTypedata.empty() or contentType.exists()
Attachment.contentType
Element IdAttachment.contentType
Definition

Identifies 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 appropriate.

Control0..1
Terminology BindingMimeType (Required)
Typecode
Requirements

Processors of the data need to be able to know how to interpret the data.

Summarytrue
Attachment.language
Element IdAttachment.language
Definition

The human language of the content. The value can be any valid value according to BCP 47.

Control0..1
Terminology BindingLanguage (Preferred but limited to Language)
Typecode
Requirements

Users need to be able to choose between the languages in a set of attachments.

Summarytrue
Attachment.data
Element IdAttachment.data
Definition

The actual data of the attachment - a sequence of bytes, base64 encoded.

Control0..1
Typebase64Binary
Requirements

The data needs to able to be transmitted inline.

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Attachment.url
Element IdAttachment.url
Definition

A location where the data can be accessed.

Control0..1
Typeurl
Requirements

The data needs to be transmitted by reference.

Summarytrue
Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Attachment.size
Element IdAttachment.size
Definition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

Control0..1
TypeunsignedInt
Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Summarytrue
Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

Attachment.hash
Element IdAttachment.hash
Definition

The calculated hash of the data using SHA-1. Represented using base64.

Control0..1
Typebase64Binary
Requirements

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Summarytrue
Comments

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. 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.title
Element IdAttachment.title
Definition

A label or set of text to display in place of the data.

Control0..1
Typestring
Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Summarytrue
Attachment.creation
Element IdAttachment.creation
Definition

Дата, когда вложение было впервые создано.

Control0..1
TypedateTime
Requirements

Часто используется по вопросам целостности вложения.

Summarytrue

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

Identifier
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdIdentifier
Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Control0..*
TypeElement
Requirements

Нужна возможность уверенно идентифицировать сущности и давать гарантию, что идентификация не подвержена ошибочному истолкованию.

Summarytrue
Identifier.use
Element IdIdentifier.use
Definition

Назначение этого идентификатора.

Control0..1
Terminology BindingIdentifierUse (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.)
Requirements

Позволяет выбрать подходящий идентификатор для определенного контекста использования среди набора идентификаторов.

Summarytrue
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Identifier.type
Element IdIdentifier.type
Definition

Кодированный тип идентификатора, который можно использовать для определения, какой идентификатор использовать в конкретных целях.

Control0..1
Terminology BindingIdentifierType (Extensible)
TypeCodeableConcept
Requirements

Позволяет пользователям использовать идентификаторы, когда система идентификатора не известна.

Summarytrue
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Identifier.system
Element IdIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1
Typeuri
Requirements

Существует много последовательностей идентификаторов. Чтобы найти соответствие, нам необходимо знать, с какой последовательностью мы имеем дело. Система идентифицирует конкретную последовательность или набор уникальных идентификаторов.

Summarytrue
Comments

Identifier.system is always case sensitive.

Identifier.value
Element IdIdentifier.value
Definition

Часть идентификатора, обычно отображаемая пользователю, которая является уникальной в контексте системы.

Control0..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. 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.

Identifier.period
Element IdIdentifier.period
Definition

Временной период, в течение которого идентификатор является/являлся допустимым к использованию.

Control0..1
TypePeriod
Summarytrue
Identifier.assigner
Element IdIdentifier.assigner
Definition

Организация, присваивающая/управляющая идентификатором.

Control0..1
TypeReference(Organization)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

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

Coding
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdCoding
Definition

Ссылка на код, определенный терминологической системой.

Control0..*
TypeElement
Requirements

Ссылки на коды очень распространены в моделях здравоохранения.

Summarytrue
Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Coding.system
Element IdCoding.system
Definition

Идентификация кодовой системы, которая определяет смысл обозначения в коде.

Control0..1
Typeuri
Requirements

Нужна однозначная информация об источнике определения обозначения.

Summarytrue
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Coding.version
Element IdCoding.version
Definition

Версия кодовой системы, которая была использована при выборе этого кода. Обратите внимание, что поддерживаемая в хорошем состоянии кодовая система не нуждается в указании версии из-за непротиворечивости смысла кодов в разных версиях. Однако в этом нельзя быть постоянно уверенным, и когда непротиворечивость значений не гарантируется, НЕОБХОДИМО указывать версию.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

Где справочник не четко определяет, какую строку следует использовать для идентификации версий кодовой системы, рекомендуется использовать дату (выраженную в FHIR-формате даты) официальной публикации этой версии в качестве даты версии.

Coding.code
Element IdCoding.code
Definition

Обозначение в синтаксисе, определенном системой. Обозначение может быть стандартным кодом или выражением в синтаксисе, определенном кодовой системой (например посткоординация).

Control0..1
Typecode
Requirements

Необходимо ссылаться на конкретный код в системе.

Summarytrue
Coding.display
Element IdCoding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Нужна возможность передавать человекочитаемое значение кода для читателей, которые не знакомы с системой.

Summarytrue
Coding.userSelected
Element IdCoding.userSelected
Definition

Указывает, что этот кодинг был выбран непосредственно пользователем - то есть из списка выбора доступных элементов (кодов или значений для отображения).

Control0..1
Typeboolean
Requirements

Определено в качестве критерия клинической безопасности - что именно эта пара system/code была выбрана явным образом, а не подразумевается системой на основе каких-то правил или языковой обработки.

Summarytrue
Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

CodeableConcept
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdCodeableConcept
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control0..*
TypeElement
Requirements

This is a common pattern in healthcare - a concept that may be defined by one or more codes from formal definitions including LOINC and SNOMED CT, and/or defined by the provision of text that captures a human sense of the concept.

Summarytrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

CodeableConcept.coding
Element IdCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Summarytrue
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

CodeableConcept.text
Element IdCodeableConcept.text
Definition

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 user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Summarytrue
Comments

Very often the text is the same as a displayName of one of the codings.

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

Quantity
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdQuantity
Definition

Измеренная величина (или величина, которая потенциально может быть измерена). Обратите внимание, что измеренные величины включают величины, которые не определены количественно точно, включая величины, связанные с произвольными единицами измерения и плавающей валютой.

Control0..*
TypeElement
Requirements

Нужно возможность передавать все виды измеренных значений, даже если измеренное значение точно не определяется количественно. Значения включают в себя точные меры, такие как 3.51g, привычные единицы, таких как 3 таблетки, и валюты, такие как $100.32USD.

Summarytrue
Comments

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

Invariants
Defined on this element
qty-3Rule If a code for the unit is present, the system SHALL also be presentcode.empty() or system.exists()
Quantity.value
Element IdQuantity.value
Definition

Значение измеренной величины. Значение включает в себя неявное указание точности в представлении значения.

Control0..1
Typedecimal
Requirements

Точность обрабатывается неявно почти во всех случаях измерения.

Summarytrue
Comments

Неявная точность значения всегда должна учитываться. Денежные значения имеют свои собственные правила для обработки точности (см. стандартные учебники по бухгалтерскому учету).

Quantity.comparator
Element IdQuantity.comparator
Definition

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.

Control0..1
Terminology BindingQuantityComparator (Required)
Typecode
Is Modifiertrue (Reason: Помечено как "Is Modifier", поскольку компаратор существенно модифицирует интерпретацию значения. Если компаратор не указан, значит модификации значения нет)
Meaning if MissingIf there is no comparator, then there is no modification of the value
Requirements

Нужна система обработки измерений, где значением будет <5ug/L или >400mg/L из-за ограничений методологии измерения.

Summarytrue
Quantity.unit
Element IdQuantity.unit
Definition

A human-readable form of the unit.

Control0..1
Typestring
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Summarytrue
Quantity.system
Element IdQuantity.system
Definition

Идентификация системы, которая обеспечивает кодированную форму единиц измерения.

Control0..1
Typeuri
Requirements

Нужно знать систему, которая определяет кодированную форму единиц измерения.

Summarytrue
Invariants
Affect this element
qty-3Rule If a code for the unit is present, the system SHALL also be presentcode.empty() or system.exists()
Quantity.code
Element IdQuantity.code
Definition

A computer processable form of the unit in some unit representation system.

Control0..1
Typecode
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Summarytrue
Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.

Money
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdMoney
Definition

An amount of economic utility in some recognized currency.

Control0..*
TypeElement
Summarytrue
Money.value
Element IdMoney.value
Definition

Numerical value (with implicit precision).

Control0..1
Typedecimal
Requirements

The amount of the currency. The value includes an implicit precision in the presentation of the value.

Summarytrue
Comments

Monetary values have their own rules for handling precision (refer to standard accounting text books).

Money.currency
Element IdMoney.currency
Definition

ISO 4217 Currency Code.

Control0..1
Terminology BindingCurrencyCode (Required)
Typecode
Requirements

A code indicating the currency, taken from ISO 4217.

Summarytrue

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

Range
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdRange
Definition

Ряд упорядоченных величин, заданных через верхний и нижний пределы.

Control0..*
TypeElement
Requirements

Нужна возможность указывать диапазоны значений.

Summarytrue
Comments

Считается, что приводимые нижнее и верхнее значения имеют сколь угодно высокую точность при определении, какие значения входят в диапазон. Т. е. 1.99 не входит в диапазон 2 -> 3.

Invariants
Defined on this element
rng-2Rule If present, low SHALL have a lower value than highlow.empty() or high.empty() or (low <= high)
Range.low
Element IdRange.low
Definition

Нижний предел. Границы включительно.

Control0..1
TypeSimpleQuantity
Summarytrue
Comments

Если элемент low отсутствует, нижняя граница не известна.

Range.high
Element IdRange.high
Definition

The high limit. The boundary is inclusive.

Control0..1
TypeSimpleQuantity
Summarytrue
Comments

Если элемент high отсутствует, верхняя граница не известна.

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

Ratio
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdRatio
Definition

A relationship of two Quantity values - expressed as a numerator and a denominator.

Control0..*
TypeElement
Requirements

Нужна возможность записывать пропорции для некоторых измерений (титры) и некоторых показателей (стоимость).

Summarytrue
Comments

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.

Invariants
Defined on this element
rat-1Rule 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())
Ratio.numerator
Element IdRatio.numerator
Definition

Значение числителя.

Control0..1
TypeQuantity
Summarytrue
Ratio.denominator
Element IdRatio.denominator
Definition

Значение знаменателя.

Control0..1
TypeQuantity
Summarytrue

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

Period
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdPeriod
Definition

Период времени, заданный датой начала и окончания и, необязательно, временем.

Control0..*
TypeElement
Summarytrue
Comments

A Period specifies a range of time; 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 range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
Defined on this element
per-1Rule Если указана, начальная дата ДОЛЖНА быть меньше, чем дата окончанияstart.hasValue().not() or end.hasValue().not() or (start <= end)
Period.start
Element IdPeriod.start
Definition

Начало периода. Граничное значение входит в период.

Control0..1
TypedateTime
Summarytrue
Comments

Если элемент low отсутствует, это означает, что нижняя граница не известна.

Invariants
Affect this element
per-1Rule Если указана, начальная дата ДОЛЖНА быть меньше, чем дата окончанияstart.hasValue().not() or end.hasValue().not() or (start <= end)
Period.end
Element IdPeriod.end
Definition

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 time.

Control0..1
TypedateTime
Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
Summarytrue
Comments

Верхнее значение включает соответствующую дату/время, т. е. 2012-02-03T10:00:00 входит в период, который имеет дату окончания 2012-02-03.

Invariants
Affect this element
per-1Rule Если указана, начальная дата ДОЛЖНА быть меньше, чем дата окончанияstart.hasValue().not() or end.hasValue().not() or (start <= end)

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

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

SampledData
Standards StatusThis element has a standards status of "Trial Use" which is different from the status of the whole resource
Element IdSampledData
Definition

A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

Control0..*
TypeElement
Requirements

There is a need for a concise way to handle the data produced by devices that sample a physical state at a high frequency.

Comments

The data is not interpretable without at least origin, period, and dimensions, but these are optional to allow a separation between the template of measurement and the actual measurement, such as between DeviceCapabilities and DeviceLog. When providing a summary view (for example with Observation.value[x]) SampledData should be represented with a brief display text such as "Sampled Data".

SampledData.origin
Element IdSampledData.origin
Definition

The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.

Control1..1
TypeSimpleQuantity
Summarytrue
SampledData.period
Element IdSampledData.period
Definition

The length of time between sampling times, measured in milliseconds.

Control1..1
Typedecimal
Summarytrue
Comments

This is usually a whole number.

SampledData.factor
Element IdSampledData.factor
Definition

A correction factor that is applied to the sampled data points before they are added to the origin.

Control0..1
Typedecimal
Meaning if MissingIf no factor is assigned, the data is not adjusted before adding to the origin
Summarytrue
SampledData.lowerLimit
Element IdSampledData.lowerLimit
Definition

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).

Control0..1
Typedecimal
Summarytrue
SampledData.upperLimit
Element IdSampledData.upperLimit
Definition

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).

Control0..1
Typedecimal
Summarytrue
SampledData.dimensions
Element IdSampledData.dimensions
Definition

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 once.

Control1..1
TypepositiveInt
Summarytrue
Comments

If there is more than one dimension, the code for the type of data will define the meaning of the dimensions (typically ECG data).

SampledData.data
Element IdSampledData.data
Definition

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 value.

Control0..1
Typestring
Comments

Data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData.

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

HumanName
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdHumanName
Definition

A human's name with the ability to identify parts and usage.

Control0..*
TypeElement
Requirements

Need to be able to record names, along with notes about their use.

Summarytrue
Comments

Names may be changed, or repudiated, or 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 does not always matter. 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 must care about name parts around the world varies widely.

HumanName.use
Element IdHumanName.use
Definition

Identifies the purpose for this name.

Control0..1
Terminology BindingNameUse (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one)
Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Summarytrue
Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

HumanName.text
Element IdHumanName.text
Definition

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 parts.

Control0..1
Typestring
Requirements

A renderable, unencoded form.

Summarytrue
Comments

Can provide both a text representation and 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.

HumanName.family
Element IdHumanName.family
Definition

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 father.

Control0..1
Typestring
Alternate Namessurname
Summarytrue
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

HumanName.given
Element IdHumanName.given
Definition

Given name.

Control0..*
Typestring
Element Order MeaningGiven Names appear in the correct order for presenting the name
Alternate Namesfirst name; middle name
Summarytrue
Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

HumanName.prefix
Element IdHumanName.prefix
Definition

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 name.

Control0..*
Typestring
Element Order MeaningPrefixes appear in the correct order for presenting the name
Summarytrue
HumanName.suffix
Element IdHumanName.suffix
Definition

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 name.

Control0..*
Typestring
Element Order MeaningSuffixes appear in the correct order for presenting the name
Summarytrue
HumanName.period
Element IdHumanName.period
Definition

Indicates the period of time when this name was valid for the named person.

Control0..1
TypePeriod
Requirements

Allows names to be placed in historical context.

Summarytrue

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

Address
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdAddress
Definition

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.

Control0..*
TypeElement
Requirements

Нужна возможность записывать почтовые адреса наряду с примечаниями об их применении.

Summarytrue
Comments

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Address.use
Element IdAddress.use
Definition

Назначение этого адреса.

Control0..1
Terminology BindingAddressUse (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one)
Requirements

Позволяет выбрать подходящий из списка адресов.

Summarytrue
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Address.type
Element IdAddress.type
Definition

Различия между физическими адресами (которые можно посетить) и почтовыми адресами (например почтовые ящики и адреса по месту жительства). Большинство адресов являются и теми, и другими.

Control0..1
Terminology BindingAddressType (Required)
Typecode
Summarytrue
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Address.text
Element IdAddress.text
Definition

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.

Control0..1
Typestring
Requirements

Визуализируемая, не закодированная форма.

Summarytrue
Comments

Может содержать и текстовое представление, и структурированные части. 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.

Address.line
Element IdAddress.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Control0..*
Typestring
Element Order MeaningThe order in which lines should appear in an address label
Summarytrue
Address.city
Element IdAddress.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

Control0..1
Typestring
Alternate NamesMunicpality
Summarytrue
Address.district
Element IdAddress.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Alternate NamesCounty
Summarytrue
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Address.state
Element IdAddress.state
Definition

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).

Control0..1
Typestring
Alternate NamesПровинция; административная территория
Summarytrue
Address.postalCode
Element IdAddress.postalCode
Definition

A postal code designating a region defined by the postal service.

Control0..1
Typestring
Alternate NamesZip
Summarytrue
Address.country
Element IdAddress.country
Definition

Страна - нация в общепринятом смысле.

Control0..1
Typestring
Summarytrue
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Address.period
Element IdAddress.period
Definition

Период времени, в течение которого адрес был/находится в использовании.

Control0..1
TypePeriod
Requirements

Позволяет размещать адреса в историческом контексте.

Summarytrue

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

ContactPoint
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdContactPoint
Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Control0..*
TypeElement
Requirements

Необходимо отслеживать телефон, факс, мобильный, SMS-номера, адреса электронной почты, теги Twitter-а и т. д.

Summarytrue
Invariants
Defined on this element
cpt-2Rule Если значение указано, система является обязательной.value.empty() or system.exists()
ContactPoint.system
Element IdContactPoint.system
Definition

Вид телекоммуникации для этой точки контакта - какая система связи требуется для использования этого контакта.

Control0..1
Terminology BindingContactPointSystem (Required)
Typecode
Summarytrue
Invariants
Affect this element
cpt-2Rule Если значение указано, система является обязательной.value.empty() or system.exists()
ContactPoint.value
Element IdContactPoint.value
Definition

Фактические детали точки контакта в той форме, которая имеет смысл для указанной системы связи (т. е. номер телефона или адрес электронной почты).

Control0..1
Typestring
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Summarytrue
Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

ContactPoint.use
Element IdContactPoint.use
Definition

Определяет назначение точки контакта.

Control0..1
Terminology BindingContactPointUse (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one)
Requirements

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

Summarytrue
Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

ContactPoint.rank
Element IdContactPoint.rank
Definition

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 values.

Control0..1
TypepositiveInt
Summarytrue
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

ContactPoint.period
Element IdContactPoint.period
Definition

Период времени, когда контактная точка была/находится в употреблении.

Control0..1
TypePeriod
Summarytrue

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

Timing
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdTiming
Definition

Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

Control0..*
TypeBackboneElement
Requirements

Нужно иметь возможность отслеживать предложенные календарные графики. Есть несколько различных способов сделать это: указать один или несколько моментов времени, простые правила наподобие "три раза в день" или "до/после еды".

Summarytrue
Comments

Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events.

A Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.

Timing.event
Element IdTiming.event
Definition

Определяет конкретное время, когда происходит событие.

Control0..*
TypedateTime
Requirements

In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.

Summarytrue
Timing.repeat
Element IdTiming.repeat
Definition

A set of rules that describe when the event is scheduled.

Control0..1
Requirements

Многие расписания задаются регулярными повторами.

Summarytrue
Invariants
Defined on this element
tim-1Rule если duration указан, необходимо указать и единицы измерения продолжительностиduration.empty() or durationUnit.exists()
tim-2Rule if there's a period, there needs to be period unitsperiod.empty() or periodUnit.exists()
tim-4Rule duration SHALL be a non-negative valueduration.exists() implies duration >= 0
tim-5Rule period SHALL be a non-negative valueperiod.exists() implies period >= 0
tim-6Rule Если указан periodMax, то должен быть указан и periodperiodMax.empty() or period.exists()
tim-7Rule Если указан durationMax, то должен быть указан и durationdurationMax.empty() or duration.exists()
tim-8Rule If there's a countMax, there must be a countcountMax.empty() or count.exists()
tim-9Rule If there's an offset, there must be a when (and not C, CM, CD, CV)offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10Rule If there's a timeOfDay, there cannot be a when, or vice versatimeOfDay.empty() or when.empty()
Timing.repeat.bounds[x]
Element IdTiming.repeat.bounds[x]
Definition

Либо продолжительность для задания длительности в расписании, диапазон возможной длительности, либо внешние границы начального и/или конечного пределов в расписании.

Control0..1
TypeDuration|Range|Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Timing.repeat.count
Element IdTiming.repeat.count
Definition

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 values.

Control0..1
TypepositiveInt
Requirements

Повторы могут быть ограничены конечным временем или общим количеством событий.

Summarytrue
Comments

If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.

Timing.repeat.countMax
Element IdTiming.repeat.countMax
Definition

If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.

Control0..1
TypepositiveInt
Summarytrue
Timing.repeat.duration
Element IdTiming.repeat.duration
Definition

Сколько это событие будет длиться, когда оно наступит. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.

Control0..1
Typedecimal
Requirements

Некоторые активности не являются моментальными и должны продолжаться в течение некоторого периода времени.

Summarytrue
Comments

For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

Timing.repeat.durationMax
Element IdTiming.repeat.durationMax
Definition

If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.

Control0..1
Typedecimal
Requirements

Некоторые активности не являются моментальными и должны продолжаться в течение некоторого периода времени.

Summarytrue
Comments

For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

Timing.repeat.durationUnit
Element IdTiming.repeat.durationUnit
Definition

Единицы времени для продолжительности, в UCUM единицах.

Control0..1
Terminology BindingUnitsOfTime (Required)
Typecode
Summarytrue
Timing.repeat.frequency
Element IdTiming.repeat.frequency
Definition

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 frequency.

Control0..1
TypepositiveInt
Meaning if MissingIf no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
Summarytrue
Timing.repeat.frequencyMax
Element IdTiming.repeat.frequencyMax
Definition

If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

Control0..1
TypepositiveInt
Summarytrue
Timing.repeat.period
Element IdTiming.repeat.period
Definition

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 length.

Control0..1
Typedecimal
Summarytrue
Timing.repeat.periodMax
Element IdTiming.repeat.periodMax
Definition

Если присутствует, указывает, что период является диапазоном от [period] до [periodMax], что позволяет выражать такие понятия, как "do this once every 3-5 days".

Control0..1
Typedecimal
Summarytrue
Timing.repeat.periodUnit
Element IdTiming.repeat.periodUnit
Definition

Единицы измерения времени для этого периода в UCUM-единицах.

Control0..1
Terminology BindingUnitsOfTime (Required)
Typecode
Summarytrue
Timing.repeat.dayOfWeek
Element IdTiming.repeat.dayOfWeek
Definition

If one or more days of week is provided, then the action happens only on the specified day(s).

Control0..*
Terminology BindingDaysOfWeek (Required)
Typecode
Summarytrue
Comments

If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.

Timing.repeat.timeOfDay
Element IdTiming.repeat.timeOfDay
Definition

Specified time of day for action to take place.

Control0..*
Typetime
Summarytrue
Comments

When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.

Timing.repeat.when
Element IdTiming.repeat.when
Definition

An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

Control0..*
Terminology BindingEventTiming (Required)
Typecode
Requirements

Распределение по времени часто определяется такими явлениями, как бодрствование, прием пищи и сон.

Summarytrue
Comments

When more than one event is listed, the event is tied to the union of the specified events.

Timing.repeat.offset
Element IdTiming.repeat.offset
Definition

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 event.

Control0..1
TypeunsignedInt
Summarytrue
Timing.code
Element IdTiming.code
Definition

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).

Control0..1
Terminology BindingTimingAbbreviation (Preferred)
TypeCodeableConcept
Summarytrue
Comments

BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).

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

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

Signature
Standards StatusThis element has a standards status of "Trial Use" which is different from the status of the whole resource
Element IdSignature
Definition

A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

Control0..*
TypeElement
Requirements

В здравоохранении есть ряд мест, где содержимое должно быть подписано.

Comments

The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.

Signature.type
Element IdSignature.type
Definition

Указание причины, по которой данное лицо подписало этот документ. Это может быть явно включено в качестве части информации о подписи и может быть использовано при определении ответственности за различные действия в отношении документа.

Control1..*
Terminology BindingSignature Type Codes (Preferred)
TypeCoding
Summarytrue
Comments

Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a &quot;Commitment Type Indication&quot;.

Signature.when
Element IdSignature.when
Definition

Дата подписания цифровой подписью.

Control1..1
Typeinstant
Summarytrue
Comments

Должно соответствовать информации в подписи.

Signature.who
Element IdSignature.who
Definition

Ссылка на пригодное для приложения описание человека, который подписал сертификат (например цифровая подпись использовала их закрытый ключ).

Control1..1
TypeReference(Practitioner | RelatedPerson | Patient | Device | Organization)
Summarytrue
Comments

Должно соответствовать информации в подписи.

Signature.onBehalfOf
Element IdSignature.onBehalfOf
Definition

A reference to an application-usable description of the identity that is represented by the signature.

Control0..1
TypeReference(Practitioner | RelatedPerson | Patient | Device | Organization)
Requirements

used when the signature is on behalf of a non-signer.

Summarytrue
Comments

The party that can't sign. For example a child.

Signature.targetFormat
Element IdSignature.targetFormat
Definition

A mime type that indicates the technical format of the target resources signed by the signature.

Control0..1
Terminology BindingMimeType (Required)
Typecode
Comments

"xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.

Signature.sigFormat
Element IdSignature.sigFormat
Definition

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, etc.

Control0..1
Terminology BindingMimeType (Required)
Typecode
Signature.data
Element IdSignature.data
Definition

The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.

Control0..1
Typebase64Binary
Comments

Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form.

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

Annotation
Standards StatusThis element has a standards status of "Normative" which is different from the status of the whole resource
Element IdAnnotation
Definition

A text note which also contains information about who made the statement and when.

Control0..*
TypeElement
Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Annotation.author[x]
Element IdAnnotation.author[x]
Definition

The individual responsible for making the annotation.

Control0..1
TypeReference(Practitioner | Patient | RelatedPerson | Organization)|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Annotation.time
Element IdAnnotation.time
Definition

Indicates when this particular annotation was made.

Control0..1
TypedateTime
Summarytrue
Annotation.text
Element IdAnnotation.text
Definition

The text of the annotation in markdown format.

Control1..1
Typemarkdown
Summarytrue