工作组: FHIR Infrastructure ![]() | 成熟度: Normative | 标准状态: Normative |
This page provides the detailed descriptions for the data types
Table of Contents
| Primitive Types |
Complex Types |
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
todo
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Attachment | |||||||||
| Standards Status | This element has a standards status of "Normative" | ||||||||
| Element Id | Attachment | ||||||||
| Definition | For referring to data content defined in other formats. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Element | ||||||||
| 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 |
| ||||||||
| Attachment.contentType | |||||||||
| Element Id | Attachment.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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | MimeType (Required) | ||||||||
| Type | code | ||||||||
| Requirements | Processors of the data need to be able to know how to interpret the data. | ||||||||
| Summary | true | ||||||||
| Attachment.language | |||||||||
| Element Id | Attachment.language | ||||||||
| Definition | The human language of the content. The value can be any valid value according to BCP 47. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | Common Languages (Preferred but limited to All Languages) | ||||||||
| Type | code | ||||||||
| Requirements | Users need to be able to choose between the languages in a set of attachments. | ||||||||
| Summary | true | ||||||||
| Attachment.data | |||||||||
| Element Id | Attachment.data | ||||||||
| Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | base64Binary | ||||||||
| 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 Id | Attachment.url | ||||||||
| Definition | A location where the data can be accessed. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | url | ||||||||
| Requirements | The data needs to be transmitted by reference. | ||||||||
| Summary | true | ||||||||
| 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 Id | Attachment.size | ||||||||
| Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | unsignedInt | ||||||||
| Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. | ||||||||
| Summary | true | ||||||||
| 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 Id | Attachment.hash | ||||||||
| Definition | The calculated hash of the data using SHA-1. Represented using base64. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | base64Binary | ||||||||
| 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). | ||||||||
| Summary | true | ||||||||
| 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 Id | Attachment.title | ||||||||
| Definition | A label or set of text to display in place of the data. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| 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. | ||||||||
| Summary | true | ||||||||
| Attachment.creation | |||||||||
| Element Id | Attachment.creation | ||||||||
| Definition | The date that the attachment was first created. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Requirements | This is often tracked as an integrity issue for use of the attachment. | ||||||||
| Summary | true | ||||||||
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Identifier | |
| Standards Status | This element has a standards status of "Normative" |
| Element Id | Identifier |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 0..* |
| Type | Element |
| Requirements | Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation. |
| Summary | true |
| Identifier.use | |
| Element Id | Identifier.use |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Terminology Binding | IdentifierUse (Required) |
| Type | code |
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.) |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Summary | true |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Identifier.type | |
| Element Id | Identifier.type |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Terminology Binding | IdentifierType (Extensible) |
| Type | CodeableConcept |
| Requirements | 当不知道标识符系统时使用 |
| Summary | true |
| 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 Id | Identifier.system |
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
| Cardinality | 0..1 |
| Type | uri |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Summary | true |
| Comments | Identifier.system is always case sensitive. |
| Identifier.value | |
| Element Id | Identifier.value |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 0..1 |
| Type | string |
| Summary | true |
| 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 Id | Identifier.period |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | true |
| Identifier.assigner | |
| Element Id | Identifier.assigner |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | true |
| 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. |
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Coding | |
| Standards Status | This element has a standards status of "Normative" |
| Element Id | Coding |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 0..* |
| Type | Element |
| Requirements | References to codes are very common in healthcare models. |
| Summary | true |
| 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 Id | Coding.system |
| Definition | 编码符号所属编码系统的URI。 |
| Cardinality | 0..1 |
| Type | uri |
| Requirements | 需要明确编码符号定义的来源。 |
| Summary | true |
| Comments | URI可以是OID(urn:OID:…)或UUID(urn:UUID:…)。OID和UUIDs必须引用自HL7 OID注册表。否则,该URI应该选自HL7为FHIR定义的特殊URI列表。如果要引用其它系统的定义的URI,所引用的系统应该有清晰、明确的定义。 |
| Coding.version | |
| Element Id | Coding.version |
| Definition | 选择此编码时使用的编码系统的版本。注意,维护良好的编码系统不需要使用版本,因为编码的含义在不同版本之间是一致的。然而,这却一定能得到保证,当同一编码的不同版本含义不能保证一致时,应提供版本信息。 |
| Note | This is a business versionId, not a resource version id (see discussion) |
| Cardinality | 0..1 |
| Type | string |
| Summary | true |
| Comments | 如果术语没有明确定义用于标识编码系统版本的字符串,建议使用该版本正式发布的日期(以FHIR日期格式表示)作为版本日期。 |
| Coding.code | |
| Element Id | Coding.code |
| Definition | 由系统定义的语法符号。符号可以是预定义的编码或由编码系统定义的语法中的表达式,例如:后协调(post-coordination)。 |
| Cardinality | 0..1 |
| Type | code |
| Requirements | 需要指向系统中的特定编码。 |
| Summary | true |
| Coding.display | |
| Element Id | Coding.display |
| Definition | 用于说明编码在系统中的意义,它遵循系统的规则。 |
| Cardinality | 0..1 |
| Type | string |
| Requirements | 需要能够为不了解系统的使用者提供可读性强的编码含义。 |
| Summary | true |
| Coding.userSelected | |
| Element Id | Coding.userSelected |
| Definition | 此编码是否是由用户直接选择的。例如,从下拉列表框中的选取的编码或含义。 |
| Cardinality | 0..1 |
| Type | boolean |
| Requirements | 这已经被确定为一个临床安全性标准-这明确了“系统/编码”对是由用户显式选择的,而不是由系统根据一些规则或语言处理自动生成的。 |
| Summary | true |
| Comments | 当同一个CodeableConcept里的存在多个的Coding时,将用户直接选择的编码作为编码转换的起点是最合适的。关于“直接选择”究竟意味着什么,存在一些模糊性,可能需要数据交互的多方进一步约定以更全面地澄清这一要素的使用及其后果。 |
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| CodeableConcept | |
| Standards Status | This element has a standards status of "Normative" |
| Element Id | CodeableConcept |
| Definition | 一种概念,它可以通过对术语或本体的正式引用来定义,也可以通过文本来表示。 |
| Cardinality | 0..* |
| Type | Element |
| 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. |
| Summary | true |
| Comments | 这是表示术语的常用模型,但并不适用于所有的术语。在某些情况下,会直接使用编码,并使用自己的结构来管理描述文本、编码、转换、元素之间的关系、前协调(预置映射规则)和后协调(映射后置处理)。 |
| CodeableConcept.coding | |
| Element Id | CodeableConcept.coding |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 0..* |
| Type | Coding |
| Requirements | 允许在编码系统中使用备用编码,并支持转换为其他编码系统。 |
| Summary | true |
| Comments | 编码可以使用枚举值或编码列表非常随意地定义。也可以非常正式的定义,如SNOMED CT。请参阅HL7 v3核心原则。 此类型并未定义编码的顺序,并不得用于推断含义。通常,最多只有一个Coding的UserSelected属性被标记为true。 |
| CodeableConcept.text | |
| Element Id | CodeableConcept.text |
| Definition | 自然语言表示的概念,它是由输入数据的用户看到、选择、说出,并代表着用户意图。 |
| Cardinality | 0..1 |
| Type | string |
| Requirements | 术语中的编码并不总能精确的表达其所有细微差别的含义,或者有时根本没有合适的编码。在这些情况下,文本可用于表达编码的全部含义。 |
| Summary | true |
| Comments | 通常此元素的文本与此资源中某一个coding元素的display属性值相同。 |
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Quantity | |||||||||
| Standards Status | This element has a standards status of "Normative" | ||||||||
| Element Id | Quantity | ||||||||
| Definition | A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Element | ||||||||
| Requirements | Need to able to capture all sorts of measured values, even if the measured value are not precisely quantified. Values include exact measures such as 3.51g, customary units such as 3 tablets, and currencies such as $100.32USD. | ||||||||
| Summary | true | ||||||||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||||||||
| Invariants |
| ||||||||
| Quantity.value | |||||||||
| Element Id | Quantity.value | ||||||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | decimal | ||||||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||||||
| Summary | true | ||||||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||||||
| Quantity.comparator | |||||||||
| Element Id | Quantity.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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | QuantityComparator (Required) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value) | ||||||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||||||
| Summary | true | ||||||||
| Quantity.unit | |||||||||
| Element Id | Quantity.unit | ||||||||
| Definition | A human-readable form of the unit. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||||||
| Summary | true | ||||||||
| Quantity.system | |||||||||
| Element Id | Quantity.system | ||||||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | uri | ||||||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||||||
| Summary | true | ||||||||
| Invariants |
| ||||||||
| Quantity.code | |||||||||
| Element Id | Quantity.code | ||||||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | code | ||||||||
| 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. | ||||||||
| Summary | true | ||||||||
| 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 Status | This element has a standards status of "Normative" |
| Element Id | Money |
| Definition | An amount of economic utility in some recognized currency. |
| Cardinality | 0..* |
| Type | Element |
| Summary | true |
| Money.value | |
| Element Id | Money.value |
| Definition | Numerical value (with implicit precision). |
| Cardinality | 0..1 |
| Type | decimal |
| Requirements | The amount of the currency. The value includes an implicit precision in the presentation of the value. |
| Summary | true |
| Comments | Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Money.currency | |
| Element Id | Money.currency |
| Definition | ISO 4217 Currency Code. |
| Cardinality | 0..1 |
| Terminology Binding | CurrencyCode (Required) |
| Type | code |
| Requirements | A code indicating the currency, taken from ISO 4217. |
| Summary | true |
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Range | |||||||||
| Standards Status | This element has a standards status of "Normative" | ||||||||
| Element Id | Range | ||||||||
| Definition | A set of ordered Quantities defined by a low and high limit. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Element | ||||||||
| Requirements | Need to be able to specify ranges of values. | ||||||||
| Summary | true | ||||||||
| Comments | The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3. | ||||||||
| Invariants |
| ||||||||
| Range.low | |||||||||
| Element Id | Range.low | ||||||||
| Definition | The low limit. The boundary is inclusive. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | SimpleQuantity | ||||||||
| Summary | true | ||||||||
| Comments | If the low element is missing, the low boundary is not known. | ||||||||
| Range.high | |||||||||
| Element Id | Range.high | ||||||||
| Definition | The high limit. The boundary is inclusive. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | SimpleQuantity | ||||||||
| Summary | true | ||||||||
| Comments | If the high element is missing, the high boundary is not known. | ||||||||
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Ratio | |||||||||
| Standards Status | This element has a standards status of "Normative" | ||||||||
| Element Id | Ratio | ||||||||
| Definition | A relationship of two Quantity values - expressed as a numerator and a denominator. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Element | ||||||||
| Requirements | Need to able to capture ratios for some measurements (titers) and some rates (costs). | ||||||||
| Summary | true | ||||||||
| 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 |
| ||||||||
| Ratio.numerator | |||||||||
| Element Id | Ratio.numerator | ||||||||
| Definition | The value of the numerator. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Quantity | ||||||||
| Summary | true | ||||||||
| Ratio.denominator | |||||||||
| Element Id | Ratio.denominator | ||||||||
| Definition | The value of the denominator. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Quantity | ||||||||
| Summary | true | ||||||||
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Period | |||||||||
| Standards Status | This element has a standards status of "Normative" | ||||||||
| Element Id | Period | ||||||||
| Definition | A time period defined by a start and end date and optionally time. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Element | ||||||||
| Summary | true | ||||||||
| 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 |
| ||||||||
| Period.start | |||||||||
| Element Id | Period.start | ||||||||
| Definition | The start of the period. The boundary is inclusive. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Summary | true | ||||||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||||||
| Invariants |
| ||||||||
| Period.end | |||||||||
| Element Id | Period.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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||||||
| Summary | true | ||||||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||||||
| Invariants |
| ||||||||
Normative Candidate Note: This DataType is not normative - it is still undergoing Trial Use while more experience is gathered.
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| SampledData | |
| Standards Status | This element has a standards status of "Trial Use" |
| Element Id | SampledData |
| Definition | A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data. |
| Cardinality | 0..* |
| Type | Element |
| 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 Id | SampledData.origin |
| Definition | The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series. |
| Cardinality | 1..1 |
| Type | SimpleQuantity |
| Summary | true |
| SampledData.period | |
| Element Id | SampledData.period |
| Definition | The length of time between sampling times, measured in milliseconds. |
| Cardinality | 1..1 |
| Type | decimal |
| Summary | true |
| Comments | This is usually a whole number. |
| SampledData.factor | |
| Element Id | SampledData.factor |
| Definition | A correction factor that is applied to the sampled data points before they are added to the origin. |
| Cardinality | 0..1 |
| Type | decimal |
| Meaning if Missing | If no factor is assigned, the data is not adjusted before adding to the origin |
| Summary | true |
| SampledData.lowerLimit | |
| Element Id | SampledData.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). |
| Cardinality | 0..1 |
| Type | decimal |
| Summary | true |
| SampledData.upperLimit | |
| Element Id | SampledData.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). |
| Cardinality | 0..1 |
| Type | decimal |
| Summary | true |
| SampledData.dimensions | |
| Element Id | SampledData.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. |
| Cardinality | 1..1 |
| Type | positiveInt |
| Summary | true |
| 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 Id | SampledData.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. |
| Cardinality | 0..1 |
| Type | string |
| Comments | Data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData. |
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| HumanName | |
| Standards Status | This element has a standards status of "Normative" |
| Element Id | HumanName |
| Definition | A human's name with the ability to identify parts and usage. |
| Cardinality | 0..* |
| Type | Element |
| Requirements | Need to be able to record names, along with notes about their use. |
| Summary | true |
| 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 Id | HumanName.use |
| Definition | Identifies the purpose for this name. |
| Cardinality | 0..1 |
| Terminology Binding | NameUse (Required) |
| Type | code |
| Is Modifier | true (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. |
| Summary | true |
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| HumanName.text | |
| Element Id | HumanName.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. |
| Cardinality | 0..1 |
| Type | string |
| Requirements | A renderable, unencoded form. |
| Summary | true |
| 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 Id | HumanName.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. |
| Cardinality | 0..1 |
| Type | string |
| Alternate Names | surname |
| Summary | true |
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
| HumanName.given | |
| Element Id | HumanName.given |
| Definition | Given name. |
| Cardinality | 0..* |
| Type | string |
| Element Order Meaning | Given Names appear in the correct order for presenting the name |
| Alternate Names | first name; middle name |
| Summary | true |
| 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 Id | HumanName.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. |
| Cardinality | 0..* |
| Type | string |
| Element Order Meaning | Prefixes appear in the correct order for presenting the name |
| Summary | true |
| HumanName.suffix | |
| Element Id | HumanName.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. |
| Cardinality | 0..* |
| Type | string |
| Element Order Meaning | Suffixes appear in the correct order for presenting the name |
| Summary | true |
| HumanName.period | |
| Element Id | HumanName.period |
| Definition | Indicates the period of time when this name was valid for the named person. |
| Cardinality | 0..1 |
| Type | Period |
| Requirements | Allows names to be placed in historical context. |
| Summary | true |
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Address | |
| Standards Status | This element has a standards status of "Normative" |
| Element Id | Address |
| 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. |
| Cardinality | 0..* |
| Type | Element |
| Requirements | Need to be able to record postal addresses, along with notes about their use. |
| Summary | true |
| 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 Id | Address.use |
| Definition | The purpose of this address. |
| Cardinality | 0..1 |
| Terminology Binding | AddressUse (Required) |
| Type | code |
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one) |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Summary | true |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Address.type | |
| Element Id | Address.type |
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
| Cardinality | 0..1 |
| Terminology Binding | AddressType (Required) |
| Type | code |
| Summary | true |
| 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 Id | Address.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. |
| Cardinality | 0..1 |
| Type | string |
| Requirements | A renderable, unencoded form. |
| Summary | true |
| Comments | Can provide both a text representation and 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. |
| Address.line | |
| Element Id | Address.line |
| Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
| Cardinality | 0..* |
| Type | string |
| Element Order Meaning | The order in which lines should appear in an address label |
| Summary | true |
| Address.city | |
| Element Id | Address.city |
| Definition | The name of the city, town, suburb, village or other community or delivery center. |
| Cardinality | 0..1 |
| Type | string |
| Alternate Names | Municpality |
| Summary | true |
| Address.district | |
| Element Id | Address.district |
| Definition | The name of the administrative area (county). |
| Cardinality | 0..1 |
| Type | string |
| Alternate Names | County |
| Summary | true |
| 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 Id | Address.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). |
| Cardinality | 0..1 |
| Type | string |
| Alternate Names | Province; Territory |
| Summary | true |
| Address.postalCode | |
| Element Id | Address.postalCode |
| Definition | A postal code designating a region defined by the postal service. |
| Cardinality | 0..1 |
| Type | string |
| Alternate Names | Zip |
| Summary | true |
| Address.country | |
| Element Id | Address.country |
| Definition | Country - a nation as commonly understood or generally accepted. |
| Cardinality | 0..1 |
| Type | string |
| Summary | true |
| Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
| Address.period | |
| Element Id | Address.period |
| Definition | Time period when address was/is in use. |
| Cardinality | 0..1 |
| Type | Period |
| Requirements | Allows addresses to be placed in historical context. |
| Summary | true |
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| ContactPoint | |||||||||
| Standards Status | This element has a standards status of "Normative" | ||||||||
| Element Id | ContactPoint | ||||||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Element | ||||||||
| Requirements | Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc. | ||||||||
| Summary | true | ||||||||
| Invariants |
| ||||||||
| ContactPoint.system | |||||||||
| Element Id | ContactPoint.system | ||||||||
| Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ContactPointSystem (Required) | ||||||||
| Type | code | ||||||||
| Summary | true | ||||||||
| Invariants |
| ||||||||
| ContactPoint.value | |||||||||
| Element Id | ContactPoint.value | ||||||||
| Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||||||
| Summary | true | ||||||||
| 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 Id | ContactPoint.use | ||||||||
| Definition | Identifies the purpose for the contact point. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ContactPointUse (Required) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one) | ||||||||
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||||||
| Summary | true | ||||||||
| Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||||||
| ContactPoint.rank | |||||||||
| Element Id | ContactPoint.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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | positiveInt | ||||||||
| Summary | true | ||||||||
| Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||||||
| ContactPoint.period | |||||||||
| Element Id | ContactPoint.period | ||||||||
| Definition | Time period when the contact point was/is in use. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Period | ||||||||
| Summary | true | ||||||||
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Timing | |||||||||||||||||||||||||||||||||||||||||
| Standards Status | This element has a standards status of "Normative" | ||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing | ||||||||||||||||||||||||||||||||||||||||
| Definition |
为可能多次发生的事件设置定时计划。定时数据类型用来记录那些计划、预期或申请发生的事件。常用于药物剂量类型(Dosage)的用法时间元素、照护计划资源(CarePlan)的日程元素。也可用于报告过去定期活动的时间表。 | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
| Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||
| Requirements | Need to able to track proposed timing schedules. There are several different ways to do this: one or more specified times, a simple rules like three times a day, or before/after meals. | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Comments |
定时数据类型用于指定事件预期或申请发生的时间和允许发生的规则条件,其中“事件”元素(Timing.event)定义为“未来”事件,但也可用于描述历史或正在发生的事件。
也可用于表示过去或正在进行的事件的摘要。为简单起见,计时组件的。
定时数据类型支持以列表形式指定多个事件发生的时间,也支持指定的事件发生的条件。 其表现方式可以用结构化元素,也可以用编码表示。 当同时指定“事件”元素(Timing.event)和“重复”元素(Timing.repeat),应将“事件”元素理解为对“重复”元素中的信息的解释。 | ||||||||||||||||||||||||||||||||||||||||
| Timing.event | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.event | ||||||||||||||||||||||||||||||||||||||||
| Definition | Identifies specific times when the event occurs. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
| Type | dateTime | ||||||||||||||||||||||||||||||||||||||||
| Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.repeat | ||||||||||||||||||||||||||||||||||||||||
| Definition |
用于描述事件定时计划何时生效的一组规则。
A set of rules that describe when the event is scheduled. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Requirements | Many timing schedules are determined by regular repetitions. | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.bounds[x] | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.repeat.bounds[x] | ||||||||||||||||||||||||||||||||||||||||
| Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | Duration|Range|Period | ||||||||||||||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.count | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.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. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | positiveInt | ||||||||||||||||||||||||||||||||||||||||
| Requirements | Repetitions may be limited by end time or total occurrences. | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| 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 Id | Timing.repeat.countMax | ||||||||||||||||||||||||||||||||||||||||
| Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | positiveInt | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.duration | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.repeat.duration | ||||||||||||||||||||||||||||||||||||||||
| Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | decimal | ||||||||||||||||||||||||||||||||||||||||
| Requirements | Some activities are not instantaneous and need to be maintained for a period of time. | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| 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 Id | Timing.repeat.durationMax | ||||||||||||||||||||||||||||||||||||||||
| Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | decimal | ||||||||||||||||||||||||||||||||||||||||
| Requirements | Some activities are not instantaneous and need to be maintained for a period of time. | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| 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 Id | Timing.repeat.durationUnit | ||||||||||||||||||||||||||||||||||||||||
| Definition | The units of time for the duration, in UCUM units. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | UnitsOfTime (Required) | ||||||||||||||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.frequency | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.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. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | positiveInt | ||||||||||||||||||||||||||||||||||||||||
| Meaning if Missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.frequencyMax | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.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. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | positiveInt | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.period | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.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. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | decimal | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.periodMax | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.repeat.periodMax | ||||||||||||||||||||||||||||||||||||||||
| Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | decimal | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.periodUnit | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.repeat.periodUnit | ||||||||||||||||||||||||||||||||||||||||
| Definition | The units of time for the period in UCUM units. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | UnitsOfTime (Required) | ||||||||||||||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.dayOfWeek | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.repeat.dayOfWeek | ||||||||||||||||||||||||||||||||||||||||
| Definition | If one or more days of week is provided, then the action happens only on the specified day(s). | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | DaysOfWeek (Required) | ||||||||||||||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| 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 Id | Timing.repeat.timeOfDay | ||||||||||||||||||||||||||||||||||||||||
| Definition | Specified time of day for action to take place. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
| Type | time | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| 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 Id | Timing.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. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | EventTiming (Required) | ||||||||||||||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||||||||||||||
| Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Comments | When more than one event is listed, the event is tied to the union of the specified events. | ||||||||||||||||||||||||||||||||||||||||
| Timing.repeat.offset | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.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. | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Type | unsignedInt | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Timing.code | |||||||||||||||||||||||||||||||||||||||||
| Element Id | Timing.code | ||||||||||||||||||||||||||||||||||||||||
| Definition | 用编码来表示定时计划。可以使用像BID这样的通用编码,也可以使用机构自己定义的额外编码。 如果提供了编码,只编码所表示的才是完整的描述(无论定时类型中其它元素的值是什么)。 另外,无论是使用编码还是使用元素数据来定义定时计划,Timing.repeat.bounds元素定义的内容都适用于编码(编码并不包含bounds)。 | ||||||||||||||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | TimingAbbreviation (Preferred) | ||||||||||||||||||||||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||
| Comments |
常用编码有:
BID:每日两次 ;TID:一日三次 ;QID :一日四次; AM:上午 ;PM:下午 ; QD:一日一次;QOD:隔日一次;QW:一周一次;BIW:两周两次;Q2H:每两小时一次;QN:每晚一次;HS:临睡前,等等。 而更具体的时间点则通常由机构自行规定并形成惯例。例如,某医院的BID指的就是“在早上7点和下午6点”。如果没有这样的约定,则不应使用编码BID来表示。 为了解决此问题另外有两种方式,一是使用机构的自定义编码;二是使用两个Timing.event元素来分别指定两个具体的时间。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.
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Signature | |
| Standards Status | This element has a standards status of "Trial Use" |
| Element Id | Signature |
| 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. |
| Cardinality | 0..* |
| Type | Element |
| Requirements | There are a number of places where content must be signed in healthcare. |
| 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 Id | Signature.type |
| Definition | An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. |
| Cardinality | 1..* |
| Terminology Binding | Signature Type Codes (Preferred) |
| Type | Coding |
| Summary | true |
| Comments | Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication". |
| Signature.when | |
| Element Id | Signature.when |
| Definition | When the digital signature was signed. |
| Cardinality | 1..1 |
| Type | instant |
| Summary | true |
| Comments | This should agree with the information in the signature. |
| Signature.who | |
| Element Id | Signature.who |
| Definition | A reference to an application-usable description of the identity that signed (e.g. the signature used their private key). |
| Cardinality | 1..1 |
| Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
| Summary | true |
| Comments | This should agree with the information in the signature. |
| Signature.onBehalfOf | |
| Element Id | Signature.onBehalfOf |
| Definition | A reference to an application-usable description of the identity that is represented by the signature. |
| Cardinality | 0..1 |
| Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
| Requirements | used when the signature is on behalf of a non-signer. |
| Summary | true |
| Comments | The party that can't sign. For example a child. |
| Signature.targetFormat | |
| Element Id | Signature.targetFormat |
| Definition | A mime type that indicates the technical format of the target resources signed by the signature. |
| Cardinality | 0..1 |
| Terminology Binding | MimeType (Required) |
| Type | code |
| 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 Id | Signature.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. |
| Cardinality | 0..1 |
| Terminology Binding | MimeType (Required) |
| Type | code |
| Signature.data | |
| Element Id | Signature.data |
| Definition | The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty. |
| Cardinality | 0..1 |
| Type | base64Binary |
| 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. |
See also Base Definition, Examples, Profiles & Extensions, Mappings and R2 Conversions.
| Annotation | |
| Standards Status | This element has a standards status of "Normative" |
| Element Id | Annotation |
| Definition | A text note which also contains information about who made the statement and when. |
| Cardinality | 0..* |
| Type | Element |
| 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 Id | Annotation.author[x] |
| Definition | The individual responsible for making the annotation. |
| Cardinality | 0..1 |
| Type | Reference(Practitioner | Patient | RelatedPerson | Organization)|string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Summary | true |
| Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
| Annotation.time | |
| Element Id | Annotation.time |
| Definition | Indicates when this particular annotation was made. |
| Cardinality | 0..1 |
| Type | dateTime |
| Summary | true |
| Annotation.text | |
| Element Id | Annotation.text |
| Definition | The text of the annotation in markdown format. |
| Cardinality | 1..1 |
| Type | markdown |
| Summary | true |