Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-Observation resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Observation | |
| Definition | Measurements and simple assertions made about a patient, device or other subject. |
| Short | Measurements and simple assertions |
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as lab reports, etc. |
| Control | 0..* |
| Alternate Names | Vital Signs, Measurement, Results, Tests |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present ( value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty())obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present ( dataAbsentReason.empty() or value.empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present (value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()) obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present (dataAbsentReason.empty() or value.empty()) |
| 2. Observation.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. Observation.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Observation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Observation.extension:effective | |
| Slice Name | effective |
| Definition | R4B: |
| Short | R4B: effective additional types |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4B: effective additional types) (Extension Type: Choice of: Period, Timing, instant) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. Observation.extension:value | |
| Slice Name | value |
| Definition | R4B: |
| Short | R4B: value additional types |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4B: value additional types) (Extension Type: Choice of: integer, Range, Ratio, SampledData, Period) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. Observation.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 12. Observation.status | |
| Definition | The status of the result value. |
| Short | registered | preliminary | final | amended + |
| Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/observation-status|3.0.2)Codes providing the status of an observation. |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to track the status of individual results. Some results are finalized before the whole report is finalized. |
| 14. Observation.code | |
| Definition | Describes what was observed. Sometimes this is called the observation "name". |
| Short | Type of observation (code / type) |
| Control | 1..1 |
| Binding | For example codes, see LOINC Codeshttp://hl7.org/fhir/ValueSet/observation-codes|3.0.2 (example to http://hl7.org/fhir/ValueSet/observation-codes|3.0.2)Codes identifying names of simple observations. |
| Type | CodeableConcept |
| Summary | true |
| Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
| Alternate Names | Name |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Observation | |
| 2. Observation.meta | |
| 4. Observation.meta.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Observation.meta.extension:meta | |
| Slice Name | meta |
| Definition | R4B: |
| Short | R4B: meta additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: meta additional types) (Extension Type: Meta) |
| 8. Observation.text | |
| 10. Observation.text.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Observation.text.extension:text | |
| Slice Name | text |
| Definition | R4B: |
| Short | R4B: text additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: text additional types) (Complex Extension) |
| 14. Observation.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Observation.extension:effective | |
| Slice Name | effective |
| Definition | R4B: |
| Short | R4B: effective additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: effective additional types) (Extension Type: Choice of: Period, Timing, instant) |
| 18. Observation.extension:value | |
| Slice Name | value |
| Definition | R4B: |
| Short | R4B: value additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: value additional types) (Extension Type: Choice of: integer, Range, Ratio, SampledData, Period) |
| 20. Observation.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| 22. Observation.identifier.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. Observation.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | R4B: |
| Short | R4B: identifier additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: identifier additional types) (Extension Type: Identifier) |
| 26. Observation.basedOn | |
| 28. Observation.basedOn.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. Observation.basedOn.extension:basedOn | |
| Slice Name | basedOn |
| Definition | R4B: |
| Short | R4B: basedOn |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 32. Observation.subject | |
| 34. Observation.subject.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 36. Observation.subject.extension:subject | |
| Slice Name | subject |
| Definition | R4B: |
| Short | R4B: Who and/or what the observation is about |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 38. Observation.context | |
| 40. Observation.context.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.context.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. Observation.context.extension:encounter | |
| Slice Name | encounter |
| Definition | R4B: |
| Short | R4B: encounter additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 44. Observation.performer | |
| 46. Observation.performer.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.performer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. Observation.performer.extension:performer | |
| Slice Name | performer |
| Definition | R4B: |
| Short | R4B: performer |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 50. Observation.comment | |
| 52. Observation.comment.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.comment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 54. Observation.comment.extension:note | |
| Slice Name | note |
| Definition | R4B: |
| Short | R4B: Comments about the observation additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: Comments about the observation additional types) (Extension Type: Annotation) |
| 56. Observation.specimen | |
| 58. Observation.specimen.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.specimen.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 60. Observation.specimen.extension:specimen | |
| Slice Name | specimen |
| Definition | R4B: |
| Short | R4B: specimen additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 62. Observation.device | |
| 64. Observation.device.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.device.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 66. Observation.device.extension:device | |
| Slice Name | device |
| Definition | R4B: |
| Short | R4B: device additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 68. Observation.referenceRange | |
| 70. Observation.referenceRange.age | |
| 72. Observation.referenceRange.age.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.referenceRange.age.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 74. Observation.referenceRange.age.extension:age | |
| Slice Name | age |
| Definition | R4B: |
| Short | R4B: age additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: age additional types) (Extension Type: Range) |
| 76. Observation.related | |
| 78. Observation.related.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.related.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 80. Observation.related.extension:partOf | |
| Slice Name | partOf |
| Definition | R4B: |
| Short | R4B: Part of referenced event (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: Part of referenced event (new)) (Extension Type: Reference(Cross-version Profile for R4B.MedicationAdministration for use in FHIR STU3, MedicationAdministration, Cross-version Profile for R4B.MedicationDispense for use in FHIR STU3, MedicationDispense, Cross-version Profile for R4B.MedicationStatement for use in FHIR STU3, MedicationStatement, Cross-version Profile for R4B.Procedure for use in FHIR STU3, Procedure, Cross-version Profile for R4B.Immunization for use in FHIR STU3, Immunization, Cross-version Profile for R4B.ImagingStudy for use in FHIR STU3, ImagingStudy)) |
| 82. Observation.related.extension:focus | |
| Slice Name | focus |
| Definition | R4B: |
| Short | R4B: What the observation is about, when it is not about the subject of record (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: What the observation is about, when it is not about the subject of record (new)) (Extension Type: Reference(Cross-version Profile for R4B.Resource for use in FHIR STU3, Resource)) |
| 84. Observation.related.target | |
| 86. Observation.related.target.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.related.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 88. Observation.related.target.extension:hasMember | |
| Slice Name | hasMember |
| Definition | R4B: |
| Short | R4B: Related resource that belongs to the Observation group |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 90. Observation.related.target.extension:derivedFrom | |
| Slice Name | derivedFrom |
| Definition | R4B: |
| Short | R4B: Related measurements the observation is made from |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 92. Observation.component | |
| 94. Observation.component.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Observation.component.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 96. Observation.component.extension:value | |
| Slice Name | value |
| Definition | R4B: |
| Short | R4B: value additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: value additional types) (Extension Type: Choice of: boolean, integer, Range, Ratio, SampledData, Period) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Observation | |||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. | ||||
| Short | Measurements and simple assertions | ||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as lab reports, etc. | ||||
| Control | 0..* | ||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present ( value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty())obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present ( dataAbsentReason.empty() or value.empty()) | ||||
| 2. Observation.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. Observation.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. Observation.meta.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 8. Observation.meta.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. Observation.meta.extension:meta | |||||
| Slice Name | meta | ||||
| Definition | R4B: | ||||
| Short | R4B: meta additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: meta additional types) (Extension Type: Meta) | ||||
| 12. Observation.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. | ||||
| Short | Version specific identifier | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 14. Observation.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 16. Observation.meta.profile | |||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 0..* | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 18. Observation.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 20. Observation.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see Common Tags (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 22. Observation.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 24. Observation.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 26. Observation.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 28. Observation.text.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 30. Observation.text.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. Observation.text.extension:text | |||||
| Slice Name | text | ||||
| Definition | R4B: | ||||
| Short | R4B: text additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: text additional types) (Complex Extension) | ||||
| 34. Observation.text.status | |||||
| Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. | ||||
| Short | generated | extensions | additional | empty | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from NarrativeStatus (required to http://hl7.org/fhir/ValueSet/narrative-status|3.0.2)The status of a resource narrative | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 36. Observation.text.div | |||||
| Definition | The actual narrative content, a stripped down version of XHTML. | ||||
| Short | Limited xhtml content | ||||
| Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. | ||||
| Control | 1..1 | ||||
| Type | xhtml | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlchecks())txt-2: The narrative SHALL have some non-whitespace content ( htmlchecks()) | ||||
| 38. Observation.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 40. Observation.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 42. Observation.extension:effective | |||||
| Slice Name | effective | ||||
| Definition | R4B: | ||||
| Short | R4B: effective additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: effective additional types) (Extension Type: Choice of: Period, Timing, instant) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 44. Observation.extension:value | |||||
| Slice Name | value | ||||
| Definition | R4B: | ||||
| Short | R4B: value additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: value additional types) (Extension Type: Choice of: integer, Range, Ratio, SampledData, Period) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 46. Observation.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 48. Observation.identifier | |||||
| Definition | A unique identifier assigned to this observation. | ||||
| Short | Business Identifier for observation | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| Requirements | Allows observations to be distinguished and referenced. | ||||
| 50. Observation.identifier.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 52. Observation.identifier.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 54. Observation.identifier.extension:identifier | |||||
| Slice Name | identifier | ||||
| Definition | R4B: | ||||
| Short | R4B: identifier additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R4B: identifier additional types) (Extension Type: Identifier) | ||||
| 56. Observation.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary (If known) | ||||
| Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|3.0.2)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| 58. Observation.identifier.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|3.0.2)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| 60. Observation.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Example | General: http://www.acme.com/identifiers/patient | ||||
| 62. Observation.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | The value that is unique | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | General: 123456 | ||||
| 64. Observation.identifier.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| 66. Observation.identifier.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Summary | true | ||||
| 68. Observation.basedOn | |||||
| Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. | ||||
| Short | Fulfills plan, proposal or order | ||||
| Control | 0..* | ||||
| Type | Reference(CarePlan, DeviceRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ProcedureRequest, ReferralRequest) | ||||
| Summary | true | ||||
| Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. | ||||
| Alternate Names | Fulfills | ||||
| 70. Observation.basedOn.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 72. Observation.basedOn.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 74. Observation.basedOn.extension:basedOn | |||||
| Slice Name | basedOn | ||||
| Definition | R4B: | ||||
| Short | R4B: basedOn | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 76. Observation.basedOn.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 78. Observation.basedOn.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 80. Observation.basedOn.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 82. Observation.status | |||||
| Definition | The status of the result value. | ||||
| Short | registered | preliminary | final | amended + | ||||
| Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ObservationStatus (required to http://hl7.org/fhir/ValueSet/observation-status|3.0.2)Codes providing the status of an observation. | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to track the status of individual results. Some results are finalized before the whole report is finalized. | ||||
| 84. Observation.category | |||||
| Definition | A code that classifies the general type of observation being made. | ||||
| Short | Classification of type of observation | ||||
| Comments | In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. | ||||
| Control | 0..* | ||||
| Binding | The codes SHOULD be taken from Observation Category Codes (preferred to http://hl7.org/fhir/ValueSet/observation-category|3.0.2)Codes for high level observation categories. | ||||
| Type | CodeableConcept | ||||
| Requirements | Used for filtering what observations are retrieved and displayed. | ||||
| 86. Observation.code | |||||
| Definition | Describes what was observed. Sometimes this is called the observation "name". | ||||
| Short | Type of observation (code / type) | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see LOINC Codes (example to http://hl7.org/fhir/ValueSet/observation-codes|3.0.2)Codes identifying names of simple observations. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
| Alternate Names | Name | ||||
| 88. Observation.subject | |||||
| Definition | The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject. | ||||
| Short | Who and/or what this is about | ||||
| Comments | One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. If the target of the observation is different than the subject, the general extension observation-focal-subject. may be used. However, the distinction between the patient's own value for an observation versus that of the fetus, or the donor or blood product unit, etc., are often specified in the observation code. | ||||
| Control | 0..1 | ||||
| Type | Reference(Patient, Group, Device, Location) | ||||
| Summary | true | ||||
| Requirements | Observations have no value if you don't know who or what they're about. | ||||
| 90. Observation.subject.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 92. Observation.subject.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 94. Observation.subject.extension:subject | |||||
| Slice Name | subject | ||||
| Definition | R4B: | ||||
| Short | R4B: Who and/or what the observation is about | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 96. Observation.subject.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 98. Observation.subject.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 100. Observation.subject.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 102. Observation.context | |||||
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. | ||||
| Short | Healthcare event during which this observation is made | ||||
| Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests). | ||||
| Control | 0..1 | ||||
| Type | Reference(Encounter, EpisodeOfCare) | ||||
| Requirements | For some observations it may be important to know the link between an observation and a particular encounter. | ||||
| Alternate Names | Encounter | ||||
| 104. Observation.context.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 106. Observation.context.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.context.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 108. Observation.context.extension:encounter | |||||
| Slice Name | encounter | ||||
| Definition | R4B: | ||||
| Short | R4B: encounter additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 110. Observation.context.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 112. Observation.context.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 114. Observation.context.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 116. Observation.effective[x] | |||||
| Definition | The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. | ||||
| Short | Clinically relevant time/time-period for observation | ||||
| Comments | At least a date should be present unless this observation is a historical report. | ||||
| Control | 0..1 | ||||
| Type | Choice of: dateTime, Period | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. | ||||
| Alternate Names | Occurrence | ||||
| 118. Observation.issued | |||||
| Definition | The date and time this observation was made available to providers, typically after the results have been reviewed and verified. | ||||
| Short | Date/Time this was made available | ||||
| Comments | Updated when the result is updated. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 120. Observation.performer | |||||
| Definition | Who was responsible for asserting the observed value as "true". | ||||
| Short | Who is responsible for the observation | ||||
| Control | 0..* | ||||
| Type | Reference(Practitioner, Organization, Patient, RelatedPerson) | ||||
| Summary | true | ||||
| Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. | ||||
| 122. Observation.performer.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 124. Observation.performer.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.performer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 126. Observation.performer.extension:performer | |||||
| Slice Name | performer | ||||
| Definition | R4B: | ||||
| Short | R4B: performer | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 128. Observation.performer.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 130. Observation.performer.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 132. Observation.performer.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 134. Observation.value[x] | |||||
| Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
| Short | Actual result | ||||
| Comments | Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is "'value' + the type name" with a capital on the first letter of the type). If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For further discussion and examples see the notes section below. | ||||
| Control | 0..1 This element is affected by the following invariants: obs-7 | ||||
| Type | Choice of: Quantity, CodeableConcept, string, boolean, Range, Ratio, SampledData, Attachment, time, dateTime, Period | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations. | ||||
| 136. Observation.dataAbsentReason | |||||
| Definition | Provides a reason why the expected value in the element Observation.value[x] is missing. | ||||
| Short | Why the result is missing | ||||
| Comments | Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. | ||||
| Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Observation Value Absent Reason (extensible to http://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2)Codes specifying why the result (Observation.value[x]) is missing. | ||||
| Type | CodeableConcept | ||||
| Requirements | For many results it is necessary to handle exceptional values in measurements. | ||||
| 138. Observation.interpretation | |||||
| Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. | ||||
| Short | High, low, normal, etc. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Observation Interpretation Codes ![]() (extensible to http://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2)Codes identifying interpretations of observations. | ||||
| Type | CodeableConcept | ||||
| Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
| Alternate Names | Abnormal Flag | ||||
| 140. Observation.comment | |||||
| Definition | May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result. | ||||
| Short | Comments about result | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Need to be able to provide free text additional information. | ||||
| 142. Observation.comment.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 144. Observation.comment.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.comment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 146. Observation.comment.extension:note | |||||
| Slice Name | note | ||||
| Definition | R4B: | ||||
| Short | R4B: Comments about the observation additional types | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: Comments about the observation additional types) (Extension Type: Annotation) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 148. Observation.comment.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Max Length: | 1048576 | ||||
| 150. Observation.bodySite | |||||
| Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). | ||||
| Short | Observed body part | ||||
| Comments | Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension body-site-instance. | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see SNOMED CT Body Structures (example to http://hl7.org/fhir/ValueSet/body-site|3.0.2)Codes describing anatomical locations. May include laterality. | ||||
| Type | CodeableConcept | ||||
| 152. Observation.method | |||||
| Definition | Indicates the mechanism used to perform the observation. | ||||
| Short | How it was done | ||||
| Comments | Only used if not implicit in code for Observation.code. | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Observation Methods (example to http://hl7.org/fhir/ValueSet/observation-methods|3.0.2)Methods for simple observations. | ||||
| Type | CodeableConcept | ||||
| Requirements | In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. | ||||
| 154. Observation.specimen | |||||
| Definition | The specimen that was used when this observation was made. | ||||
| Short | Specimen used for this observation | ||||
| Comments | Should only be used if not implicit in code found in | ||||
| Control | 0..1 | ||||
| Type | Reference(Specimen) | ||||
| 156. Observation.specimen.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 158. Observation.specimen.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.specimen.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 160. Observation.specimen.extension:specimen | |||||
| Slice Name | specimen | ||||
| Definition | R4B: | ||||
| Short | R4B: specimen additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 162. Observation.specimen.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 164. Observation.specimen.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 166. Observation.specimen.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 168. Observation.device | |||||
| Definition | The device used to generate the observation data. | ||||
| Short | (Measurement) Device | ||||
| Comments | An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either an extension or through the Observation.related element. | ||||
| Control | 0..1 | ||||
| Type | Reference(Device, DeviceMetric) | ||||
| 170. Observation.device.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 172. Observation.device.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.device.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 174. Observation.device.extension:device | |||||
| Slice Name | device | ||||
| Definition | R4B: | ||||
| Short | R4B: device additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 176. Observation.device.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 178. Observation.device.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 180. Observation.device.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 182. Observation.referenceRange | |||||
| Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
| Short | Provides guide for interpretation | ||||
| Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))obs-3: Must have at least a low or a high or text ( low.exists() or high.exists() or text.exists()) | ||||
| 184. Observation.referenceRange.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 186. Observation.referenceRange.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional Content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 188. Observation.referenceRange.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 190. Observation.referenceRange.low | |||||
| Definition | The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). | ||||
| Short | Low Range, if relevant | ||||
| Control | 0..1 This element is affected by the following invariants: obs-3 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| 192. Observation.referenceRange.high | |||||
| Definition | The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). | ||||
| Short | High Range, if relevant | ||||
| Control | 0..1 This element is affected by the following invariants: obs-3 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| 194. Observation.referenceRange.type | |||||
| Definition | Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. | ||||
| Short | Reference range qualifier | ||||
| Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Observation Reference Range Meaning Codes (extensible to http://hl7.org/fhir/ValueSet/referencerange-meaning|3.0.2)Code for the meaning of a reference range. | ||||
| Type | CodeableConcept | ||||
| Requirements | Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc, - for proper interpretation. | ||||
| 196. Observation.referenceRange.appliesTo | |||||
| Definition | Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. | ||||
| Short | Reference range population | ||||
| Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see Observation Reference Range Applies To Codes (example to http://hl7.org/fhir/ValueSet/referencerange-appliesto|3.0.2)Codes identifying the population the reference range applies to. | ||||
| Type | CodeableConcept | ||||
| Requirements | Need to be able to identify the target population for proper interpretation. | ||||
| 198. Observation.referenceRange.age | |||||
| Definition | The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. | ||||
| Short | Applicable age range, if relevant | ||||
| Control | 0..1 | ||||
| Type | Range | ||||
| Requirements | Some analytes vary greatly over age. | ||||
| 200. Observation.referenceRange.age.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 202. Observation.referenceRange.age.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.referenceRange.age.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 204. Observation.referenceRange.age.extension:age | |||||
| Slice Name | age | ||||
| Definition | R4B: | ||||
| Short | R4B: age additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: age additional types) (Extension Type: Range) | ||||
| 206. Observation.referenceRange.age.low | |||||
| Definition | The low limit. The boundary is inclusive. | ||||
| Short | Low limit | ||||
| Comments | If the low element is missing, the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: rng-2 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Summary | true | ||||
| 208. Observation.referenceRange.age.high | |||||
| Definition | The high limit. The boundary is inclusive. | ||||
| Short | High limit | ||||
| Comments | If the high element is missing, the high boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: rng-2 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Summary | true | ||||
| 210. Observation.referenceRange.text | |||||
| Definition | Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'. | ||||
| Short | Text based reference range in an observation | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 212. Observation.related | |||||
| Definition | A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code. | ||||
| Short | Resource related to this observation | ||||
| Comments | For a discussion on the ways Observations can assembled in groups together see Notes below. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Requirements | Normally, an observation will have either a value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and a set of related observations or sometimes a QuestionnaireResponse from which the measure is derived. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 214. Observation.related.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 216. Observation.related.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.related.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 218. Observation.related.extension:partOf | |||||
| Slice Name | partOf | ||||
| Definition | R4B: | ||||
| Short | R4B: Part of referenced event (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: Part of referenced event (new)) (Extension Type: Reference(Cross-version Profile for R4B.MedicationAdministration for use in FHIR STU3, MedicationAdministration, Cross-version Profile for R4B.MedicationDispense for use in FHIR STU3, MedicationDispense, Cross-version Profile for R4B.MedicationStatement for use in FHIR STU3, MedicationStatement, Cross-version Profile for R4B.Procedure for use in FHIR STU3, Procedure, Cross-version Profile for R4B.Immunization for use in FHIR STU3, Immunization, Cross-version Profile for R4B.ImagingStudy for use in FHIR STU3, ImagingStudy)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 220. Observation.related.extension:focus | |||||
| Slice Name | focus | ||||
| Definition | R4B: | ||||
| Short | R4B: What the observation is about, when it is not about the subject of record (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: What the observation is about, when it is not about the subject of record (new)) (Extension Type: Reference(Cross-version Profile for R4B.Resource for use in FHIR STU3, Resource)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 222. Observation.related.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 224. Observation.related.type | |||||
| Definition | A code specifying the kind of relationship that exists with the target resource. | ||||
| Short | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by | ||||
| Comments | The "derived-from" type is the only logical choice when referencing the QuestionnaireAnswer resource. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ObservationRelationshipType (required to http://hl7.org/fhir/ValueSet/observation-relationshiptypes|3.0.2)Codes specifying how two observations are related. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | A relationship type SHOULD be provided. | ||||
| 226. Observation.related.target | |||||
| Definition | A reference to the observation or QuestionnaireResponse resource that is related to this observation. | ||||
| Short | Resource that is related to this one | ||||
| Control | 1..1 | ||||
| Type | Reference(Observation, QuestionnaireResponse, Sequence) | ||||
| 228. Observation.related.target.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 230. Observation.related.target.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.related.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 232. Observation.related.target.extension:hasMember | |||||
| Slice Name | hasMember | ||||
| Definition | R4B: | ||||
| Short | R4B: Related resource that belongs to the Observation group | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 234. Observation.related.target.extension:derivedFrom | |||||
| Slice Name | derivedFrom | ||||
| Definition | R4B: | ||||
| Short | R4B: Related measurements the observation is made from | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 236. Observation.related.target.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 238. Observation.related.target.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 240. Observation.related.target.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 242. Observation.component | |||||
| Definition | Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. | ||||
| Short | Component results | ||||
| Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 244. Observation.component.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 246. Observation.component.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Observation.component.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 248. Observation.component.extension:value | |||||
| Slice Name | value | ||||
| Definition | R4B: | ||||
| Short | R4B: value additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: value additional types) (Extension Type: Choice of: boolean, integer, Range, Ratio, SampledData, Period) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 250. Observation.component.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 252. Observation.component.code | |||||
| Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
| Short | Type of component observation (code / type) | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see LOINC Codes (example to http://hl7.org/fhir/ValueSet/observation-codes|3.0.2)Codes identifying names of simple observations. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
| 254. Observation.component.value[x] | |||||
| Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
| Short | Actual component result | ||||
| Comments | Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from <http://hl7.org/fhir/ValueSet/v2-0136> (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type). | ||||
| Control | 0..1 | ||||
| Type | Choice of: Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations. | ||||
| 256. Observation.component.dataAbsentReason | |||||
| Definition | Provides a reason why the expected value in the element Observation.value[x] is missing. | ||||
| Short | Why the component result is missing | ||||
| Comments | "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. | ||||
| Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Observation Value Absent Reason (extensible to http://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2)Codes specifying why the result (Observation.value[x]) is missing. | ||||
| Type | CodeableConcept | ||||
| Requirements | For many results it is necessary to handle exceptional values in measurements. | ||||
| 258. Observation.component.interpretation | |||||
| Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. | ||||
| Short | High, low, normal, etc. | ||||
| Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Observation Interpretation Codes ![]() (extensible to http://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2)Codes identifying interpretations of observations. | ||||
| Type | CodeableConcept | ||||
| Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
| Alternate Names | Abnormal Flag | ||||
| 260. Observation.component.referenceRange | |||||
| Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
| Short | Provides guide for interpretation of component result | ||||
| Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange | ||||
| Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. | ||||