Smart Bear Implementation Guide
0.3.2 - ci-build

Smart Bear Implementation Guide - Local Development build (v0.3.2). See the Directory of published versions

Resource Profile: ExerciseWalking2WalkAndYaw - Detailed Descriptions

Active as of 2023-08-01

Definitions for the ExerciseWalking2WalkAndYaw resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Observation
2. Observation.extension
Control0..?
3. Observation.extension.extension
Control0..0
4. Observation.extension.url
Control0..?
Pattern Valuehttps://holobalance.eu/fhir/extension-exercise-difficulty
5. Observation.extension.valueCodeableConcept
Control0..1
TypeCodeableConcept
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="https://holobalance.eu/fhir/codesystem-exercise-difficulty"/>
    <code value="&lt;&lt;functionalLevel&gt;&gt;"/>
    <display value="Exercise Progression Level"/>
  </coding>
</valueCodeableConcept>
6. Observation.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control20..*
SlicingThis element introduces a set of slices on Observation.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
7. Observation.identifier:TrainingId
SliceNameTrainingId
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
8. Observation.identifier:TrainingId.system
Control1..?
Pattern Valuehttps://holobalance.eu/fhir/identifiers/exercise-instance
9. Observation.identifier:TrainingId.value
Control0..?
Pattern Value<<traininglogid>>
10. Observation.identifier:SessionId
SliceNameSessionId
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
11. Observation.identifier:SessionId.system
Control1..?
Pattern Valuehttps://holobalance.eu/fhir/identifiers/exercise-session
12. Observation.identifier:SessionId.value
Control0..?
Pattern Value<<sessionid>>
13. Observation.status
Pattern Valuefinal
14. Observation.category
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/observation-category"/>
    <code value="activity"/>
    <display value="Activity"/>
  </coding>
</valueCodeableConcept>
15. Observation.code
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="https://holobalance.eu/fhir/CodeSystem/exercise-type"/>
    <code value="1166"/>
    <display value="Exercise Walking 2 – Walk and Yaw"/>
  </coding>
</valueCodeableConcept>
16. Observation.subject
Control10..1
TypeReference(HolobalancePatient|Patient|Group|Device|Location)
17. Observation.effective[x]
Control10..1
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Observation.effective[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
18. Observation.effectiveDateTime
Control1..1
TypedateTime
19. Observation.component
Control140..*
SlicingThis element introduces a set of slices on Observation.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
20. Observation.component:numberOfExerciseRepetitionsCompleted
SliceNamenumberOfExerciseRepetitionsCompleted
Control1..1
21. Observation.component:numberOfExerciseRepetitionsCompleted.code
Control0..?
22. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding
Control0..?
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://snomed.info/sct"/>
  <code value="1202026006"/>
  <display value="Number of exercise repetitions completed"/>
</valueCoding>
23. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding.version
NoteThis is a business versionId, not a resource version id (see discussion)
Control0..?
Pattern Valuehttp://snomed.info/sct/900000000000207008/version/20220228
24. Observation.component:numberOfExerciseRepetitionsCompleted.code.text
Control0..?
Pattern ValueTotal number of repetitions performed (walk routes)
25. Observation.component:numberOfExerciseRepetitionsCompleted.valueQuantity
Control0..1
TypeQuantity
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="Number"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="{#}"/>
</valueQuantity>
26. Observation.component:frequencyOfExercise
SliceNamefrequencyOfExercise
Control1..1
27. Observation.component:frequencyOfExercise.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="228449008"/>
    <display value="Frequency of exercise"/>
  </coding>
</valueCodeableConcept>
28. Observation.component:frequencyOfExercise.code.text
Control0..?
Pattern ValueTotal number of head turns performed
29. Observation.component:frequencyOfExercise.valueQuantity
Control0..1
TypeQuantity
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="Number"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="{#}"/>
</valueQuantity>
30. Observation.component:sagittalPlaneBodyPosition
SliceNamesagittalPlaneBodyPosition
Control1..1
31. Observation.component:sagittalPlaneBodyPosition.code
Control0..?
32. Observation.component:sagittalPlaneBodyPosition.code.coding
Control0..?
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://loinc.org"/>
  <code value="72282-7"/>
  <display value="Sagittal plane body position"/>
</valueCoding>
33. Observation.component:sagittalPlaneBodyPosition.code.coding.version
NoteThis is a business versionId, not a resource version id (see discussion)
Control0..?
Pattern Value2.69
34. Observation.component:sagittalPlaneBodyPosition.valueSampledData
Control0..1
TypeSampledData
35. Observation.component:sagittalPlaneBodyPosition.valueSampledData.origin
Control0..?
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="degree"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="deg"/>
</valueQuantity>
36. Observation.component:sagittalPlaneBodyPosition.valueSampledData.period
Control0..?
Pattern Value15000
37. Observation.component:sagittalPlaneBodyPosition.valueSampledData.dimensions
Control0..?
Pattern Value1
38. Observation.component:sagittalPlaneBodyPosition.valueSampledData.data
Control0..?
Pattern Value<<posture|FlattenedArrayOddRemoved>>
39. Observation.component:timeSpentExercising
SliceNametimeSpentExercising
Control1..1
40. Observation.component:timeSpentExercising.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="228450008"/>
    <display value="Time spent exercising"/>
  </coding>
</valueCodeableConcept>
41. Observation.component:timeSpentExercising.valueQuantity
Control0..1
TypeQuantity
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="second"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="s"/>
</valueQuantity>
42. Observation.component:performanceBasedMeasureScore
SliceNameperformanceBasedMeasureScore
Control1..1
43. Observation.component:performanceBasedMeasureScore.code
Control0..?
44. Observation.component:performanceBasedMeasureScore.code.coding
Control0..?
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://loinc.org"/>
  <code value="89191-1"/>
  <display value="Performance-based measure score"/>
</valueCoding>
45. Observation.component:performanceBasedMeasureScore.code.coding.version
NoteThis is a business versionId, not a resource version id (see discussion)
Control0..?
Pattern Value2.69
46. Observation.component:performanceBasedMeasureScore.valueQuantity
Control0..1
TypeQuantity
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="score"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="{score}"/>
</valueQuantity>
47. Observation.component:disorientated
SliceNamedisorientated
Control1..1
48. Observation.component:disorientated.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="62476001"/>
    <display value="Disorientated"/>
  </coding>
</valueCodeableConcept>
49. Observation.component:disorientated.valueBoolean
Control0..1
Typeboolean
Pattern Valuetrue
50. Observation.component:disorientated.valueCodeableConcept
Control0..1
TypeCodeableConcept
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;disoriented|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;disoriented|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
51. Observation.component:abnormalVision
SliceNameabnormalVision
Control1..1
52. Observation.component:abnormalVision.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="7973008"/>
    <display value="Abnormal vision"/>
  </coding>
</valueCodeableConcept>
53. Observation.component:abnormalVision.valueBoolean
Control0..1
Typeboolean
Pattern Valuetrue
54. Observation.component:abnormalVision.valueCodeableConcept
Control0..1
TypeCodeableConcept
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;blurryvision|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;blurryvision|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
55. Observation.component:dizziness
SliceNamedizziness
Control1..1
56. Observation.component:dizziness.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="404640003"/>
    <display value="Dizziness"/>
  </coding>
</valueCodeableConcept>
57. Observation.component:dizziness.valueBoolean
Control0..1
Typeboolean
Pattern Valuetrue
58. Observation.component:dizziness.valueCodeableConcept
Control0..1
TypeCodeableConcept
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;dizzy|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;dizzy|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
59. Observation.component:headache
SliceNameheadache
Control1..1
60. Observation.component:headache.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="25064002"/>
    <display value="Headache"/>
  </coding>
</valueCodeableConcept>
61. Observation.component:headache.valueBoolean
Control0..1
Typeboolean
Pattern Valuetrue
62. Observation.component:headache.valueCodeableConcept
Control0..1
TypeCodeableConcept
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;headache|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;headache|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
63. Observation.component:measureOfGait
SliceNamemeasureOfGait
Control1..1
64. Observation.component:measureOfGait.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="363837002"/>
    <display value="Measure of gait"/>
  </coding>
</valueCodeableConcept>
65. Observation.component:measureOfGait.code.text
Control0..?
Pattern ValuePercentage of single support on left foot, single support on right foot and double support per repetition
66. Observation.component:measureOfGait.valueSampledData
Control0..1
TypeSampledData
67. Observation.component:measureOfGait.valueSampledData.extension
Control0..?
68. Observation.component:measureOfGait.valueSampledData.extension.extension
Control0..0
69. Observation.component:measureOfGait.valueSampledData.extension.url
Control0..?
Pattern Valuehttps://holobalance.eu/fhir/offsets
70. Observation.component:measureOfGait.valueSampledData.extension.valueString
Control0..1
Typestring
Pattern Value<<offset|ValOfArrayOfKeyVal>>
71. Observation.component:measureOfGait.valueSampledData.origin
Control0..?
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="percent"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="%"/>
</valueQuantity>
72. Observation.component:measureOfGait.valueSampledData.period
Control0..?
Pattern Value1000
73. Observation.component:measureOfGait.valueSampledData.dimensions
Control0..?
Pattern Value3
74. Observation.component:measureOfGait.valueSampledData.data
Control0..?
Pattern Value<<metrixthree|FlattenedArray>>
75. Observation.component:numberOfStepsInUnspecifiedTimePedometer
SliceNamenumberOfStepsInUnspecifiedTimePedometer
Control1..1
76. Observation.component:numberOfStepsInUnspecifiedTimePedometer.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="55423-8"/>
    <display value="Number of steps in unspecified time Pedometer"/>
  </coding>
</valueCodeableConcept>
77. Observation.component:numberOfStepsInUnspecifiedTimePedometer.code.text
Control0..?
Pattern ValueTotal number of steps performed per walking route
78. Observation.component:numberOfStepsInUnspecifiedTimePedometer.valueSampledData
Control0..1
TypeSampledData
79. Observation.component:numberOfStepsInUnspecifiedTimePedometer.valueSampledData.extension
Control0..?
80. Observation.component:numberOfStepsInUnspecifiedTimePedometer.valueSampledData.extension.extension
Control0..0
81. Observation.component:numberOfStepsInUnspecifiedTimePedometer.valueSampledData.extension.url
Control0..?
Pattern Valuehttps://holobalance.eu/fhir/offsets
82. Observation.component:numberOfStepsInUnspecifiedTimePedometer.valueSampledData.extension.valueString
Control0..1
Typestring
Pattern Value<<offset|ValOfArrayOfKeyVal>>
83. Observation.component:numberOfStepsInUnspecifiedTimePedometer.valueSampledData.origin
Control0..?
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="Number"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="{#}"/>
</valueQuantity>
84. Observation.component:numberOfStepsInUnspecifiedTimePedometer.valueSampledData.period
Control0..?
Pattern Value1000
85. Observation.component:numberOfStepsInUnspecifiedTimePedometer.valueSampledData.dimensions
Control0..?
Pattern Value1
86. Observation.component:numberOfStepsInUnspecifiedTimePedometer.valueSampledData.data
Control0..?
Pattern Value<<numofstep|FlattenedArray>>
87. Observation.component:swayingGait
SliceNameswayingGait
Control1..1
88. Observation.component:swayingGait.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="69021004"/>
    <display value="Swaying gait"/>
  </coding>
</valueCodeableConcept>
89. Observation.component:swayingGait.code.text
Control0..?
Pattern ValueSway index rate
90. Observation.component:swayingGait.valueSampledData
Control0..1
TypeSampledData
91. Observation.component:swayingGait.valueSampledData.extension
Control0..?
92. Observation.component:swayingGait.valueSampledData.extension.extension
Control0..0
93. Observation.component:swayingGait.valueSampledData.extension.url
Control0..?
Pattern Valuehttps://holobalance.eu/fhir/offsets
94. Observation.component:swayingGait.valueSampledData.extension.valueString
Control0..1
Typestring
Pattern Value<<offset|ValOfArrayOfKeyVal>>
95. Observation.component:swayingGait.valueSampledData.origin
Control0..?
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="percent"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="%"/>
</valueQuantity>
96. Observation.component:swayingGait.valueSampledData.period
Control0..?
Pattern Value1000
97. Observation.component:swayingGait.valueSampledData.dimensions
Control0..?
Pattern Value1
98. Observation.component:swayingGait.valueSampledData.data
Control0..?
Pattern Value<<metrixsway|FlattenedArray>>
99. Observation.component:neckJointRangeOfMovement
SliceNameneckJointRangeOfMovement
Control1..1
100. Observation.component:neckJointRangeOfMovement.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="404979006"/>
    <display value="Neck joint - range of movement"/>
  </coding>
</valueCodeableConcept>
101. Observation.component:neckJointRangeOfMovement.code.text
Control0..?
Pattern ValueRange of head turns in yaw plane (Left-Right)
102. Observation.component:neckJointRangeOfMovement.valueSampledData
Control0..1
TypeSampledData
103. Observation.component:neckJointRangeOfMovement.valueSampledData.extension
Control0..?
104. Observation.component:neckJointRangeOfMovement.valueSampledData.extension.extension
Control0..0
105. Observation.component:neckJointRangeOfMovement.valueSampledData.extension.url
Control0..?
Pattern Valuehttps://holobalance.eu/fhir/offsets
106. Observation.component:neckJointRangeOfMovement.valueSampledData.extension.valueString
Control0..1
Typestring
Pattern Value<<offsethead|ValOfArrayOfKeyVal>>
107. Observation.component:neckJointRangeOfMovement.valueSampledData.origin
Control0..?
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="degree"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="deg"/>
</valueQuantity>
108. Observation.component:neckJointRangeOfMovement.valueSampledData.period
Control0..?
Pattern Value1000
109. Observation.component:neckJointRangeOfMovement.valueSampledData.dimensions
Control0..?
Pattern Value1
110. Observation.component:neckJointRangeOfMovement.valueSampledData.data
Control0..?
Pattern Value<<range|FlattenedArray>>
111. Observation.component:countsPerSecond
SliceNamecountsPerSecond
Control1..1
112. Observation.component:countsPerSecond.code
Control0..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="282108002"/>
    <display value="Counts per second"/>
  </coding>
</valueCodeableConcept>
113. Observation.component:countsPerSecond.code.text
Control0..?
Pattern ValueHead turns per second
114. Observation.component:countsPerSecond.valueSampledData
Control0..1
TypeSampledData
115. Observation.component:countsPerSecond.valueSampledData.extension
Control0..?
116. Observation.component:countsPerSecond.valueSampledData.extension.extension
Control0..0
117. Observation.component:countsPerSecond.valueSampledData.extension.url
Control0..?
Pattern Valuehttps://holobalance.eu/fhir/offsets
118. Observation.component:countsPerSecond.valueSampledData.extension.valueString
Control0..1
Typestring
Pattern Value<<offsethead|ValOfArrayOfKeyVal>>
119. Observation.component:countsPerSecond.valueSampledData.origin
Control0..?
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="per second"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="/s"/>
</valueQuantity>
120. Observation.component:countsPerSecond.valueSampledData.period
Control0..?
Pattern Value1000
121. Observation.component:countsPerSecond.valueSampledData.dimensions
Control0..?
Pattern Value1
122. Observation.component:countsPerSecond.valueSampledData.data
Control0..?
Pattern Value<<speed|FlattenedArray>>

Guidance on how to interpret the contents of this table can be found here.

1. Observation
Definition

Measurements and simple assertions made about a patient, device or other subject.

Control0..*
Summaryfalse
Alternate NamesVital Signs, Measurement, Results, Tests
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 laboratory reports, etc.

InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present (: dataAbsentReason.empty() or value.empty())
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present (: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
4. Observation.identifier
Definition

A unique identifier assigned to this observation.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control20..*
TypeIdentifier
Summarytrue
Requirements

Allows observations to be distinguished and referenced.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
5. Observation.identifier:TrainingId
SliceNameTrainingId
Definition

A unique identifier assigned to this observation.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1*
TypeIdentifier
Summarytrue
Requirements

Allows observations to be distinguished and referenced.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Observation.identifier:TrainingId.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Observation.identifier:TrainingId.system
Definition

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

Control10..1
Typeuri
Summarytrue
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.

Comments

Identifier.system is always case sensitive.

Pattern Valuehttps://holobalance.eu/fhir/identifiers/exercise-instance
Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Observation.identifier:TrainingId.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Pattern Value<<traininglogid>>
Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Observation.identifier:SessionId
SliceNameSessionId
Definition

A unique identifier assigned to this observation.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1*
TypeIdentifier
Summarytrue
Requirements

Allows observations to be distinguished and referenced.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Observation.identifier:SessionId.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Observation.identifier:SessionId.system
Definition

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

Control10..1
Typeuri
Summarytrue
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.

Comments

Identifier.system is always case sensitive.

Pattern Valuehttps://holobalance.eu/fhir/identifiers/exercise-session
Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Observation.identifier:SessionId.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Pattern Value<<sessionid>>
Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Observation.status
Definition

The status of the result value.

Control1..1
BindingThe codes SHALL be taken from ObservationStatus

Codes providing the status of an observation.

Typecode
Is Modifiertrue
Summarytrue
Requirements

Need to track the status of individual results. Some results are finalized before the whole report is finalized.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Pattern Valuefinal
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Observation.category
Definition

A code that classifies the general type of observation being made.

Control0..*
BindingThe codes SHOULD be taken from ObservationCategoryCodes

Codes for high level observation categories.

TypeCodeableConcept
Summaryfalse
Requirements

Used for filtering what observations are retrieved and displayed.

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.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/observation-category"/>
    <code value="activity"/>
    <display value="Activity"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Observation.code
Definition

Describes what was observed. Sometimes this is called the observation "name".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Alternate NamesName
Comments

All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="https://holobalance.eu/fhir/CodeSystem/exercise-type"/>
    <code value="1166"/>
    <display value="Exercise Walking 2 – Walk and Yaw"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Observation.subject
Definition

The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

Control10..1
TypeReference(HolobalancePatient|Patient|Group|Device|Location)
Summarytrue
Requirements

Observations have no value if you don't know who or what they're 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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. 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.

Control10..1
TypeChoice of: dateTime, Period, Timing, instant
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

Knowing when an observation was deemed true is important to its relevance as well as determining trends.

Alternate NamesOccurrence
Comments

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.effective[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
18. Observation.effective[x]:effectiveDateTime
SliceNameeffectiveDateTime
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.

Control10..1
TypeChoice of: dateTime, Period, Timing, instant
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

Knowing when an observation was deemed true is important to its relevance as well as determining trends.

Alternate NamesOccurrence
Comments

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. 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.

Control140..*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
20. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
21. Observation.component.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Observation.component:numberOfExerciseRepetitionsCompleted
SliceNamenumberOfExerciseRepetitionsCompleted
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Observation.component:numberOfExerciseRepetitionsCompleted.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
24. Observation.component:numberOfExerciseRepetitionsCompleted.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://snomed.info/sct"/>
  <code value="1202026006"/>
  <display value="Number of exercise repetitions completed"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

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

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Pattern Valuehttp://snomed.info/sct/900000000000207008/version/20220228
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Observation.component:numberOfExerciseRepetitionsCompleted.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueTotal number of repetitions performed (walk routes)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Observation.component:frequencyOfExercise
SliceNamefrequencyOfExercise
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Observation.component:frequencyOfExercise.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
30. Observation.component:frequencyOfExercise.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="228449008"/>
    <display value="Frequency of exercise"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Observation.component:frequencyOfExercise.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueTotal number of head turns performed
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Observation.component:sagittalPlaneBodyPosition
SliceNamesagittalPlaneBodyPosition
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Observation.component:sagittalPlaneBodyPosition.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
34. Observation.component:sagittalPlaneBodyPosition.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Observation.component:sagittalPlaneBodyPosition.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://loinc.org"/>
  <code value="72282-7"/>
  <display value="Sagittal plane body position"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Observation.component:sagittalPlaneBodyPosition.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

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

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Pattern Value2.69
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Observation.component:timeSpentExercising
SliceNametimeSpentExercising
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Observation.component:timeSpentExercising.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. Observation.component:timeSpentExercising.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="228450008"/>
    <display value="Time spent exercising"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Observation.component:performanceBasedMeasureScore
SliceNameperformanceBasedMeasureScore
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Observation.component:performanceBasedMeasureScore.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
42. Observation.component:performanceBasedMeasureScore.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Observation.component:performanceBasedMeasureScore.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://loinc.org"/>
  <code value="89191-1"/>
  <display value="Performance-based measure score"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Observation.component:performanceBasedMeasureScore.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

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

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Pattern Value2.69
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Observation.component:disorientated
SliceNamedisorientated
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Observation.component:disorientated.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
47. Observation.component:disorientated.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="62476001"/>
    <display value="Disorientated"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Observation.component:disorientated.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
49. Observation.component:disorientated.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: boolean, dateTime, string, SampledData, Quantity, Period, Ratio, integer, time, Range, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Observation.component:disorientated.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: CodeableConcept, dateTime, boolean, string, SampledData, Quantity, Period, Ratio, integer, time, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;disoriented|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;disoriented|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Observation.component:abnormalVision
SliceNameabnormalVision
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Observation.component:abnormalVision.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
53. Observation.component:abnormalVision.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="7973008"/>
    <display value="Abnormal vision"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Observation.component:abnormalVision.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
55. Observation.component:abnormalVision.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: boolean, dateTime, string, SampledData, Quantity, Period, Ratio, integer, time, Range, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. Observation.component:abnormalVision.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: CodeableConcept, dateTime, boolean, string, SampledData, Quantity, Period, Ratio, integer, time, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;blurryvision|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;blurryvision|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Observation.component:dizziness
SliceNamedizziness
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Observation.component:dizziness.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
59. Observation.component:dizziness.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="404640003"/>
    <display value="Dizziness"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. Observation.component:dizziness.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
61. Observation.component:dizziness.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: boolean, dateTime, string, SampledData, Quantity, Period, Ratio, integer, time, Range, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Observation.component:dizziness.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: CodeableConcept, dateTime, boolean, string, SampledData, Quantity, Period, Ratio, integer, time, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;dizzy|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;dizzy|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. Observation.component:headache
SliceNameheadache
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. Observation.component:headache.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
65. Observation.component:headache.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="25064002"/>
    <display value="Headache"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. Observation.component:headache.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
67. Observation.component:headache.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: boolean, dateTime, string, SampledData, Quantity, Period, Ratio, integer, time, Range, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. Observation.component:headache.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: CodeableConcept, dateTime, boolean, string, SampledData, Quantity, Period, Ratio, integer, time, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;headache|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;headache|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. Observation.component:measureOfGait
SliceNamemeasureOfGait
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. Observation.component:measureOfGait.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
71. Observation.component:measureOfGait.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="363837002"/>
    <display value="Measure of gait"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. Observation.component:measureOfGait.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValuePercentage of single support on left foot, single support on right foot and double support per repetition
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Observation.component:numberOfStepsInUnspecifiedTimePedometer
SliceNamenumberOfStepsInUnspecifiedTimePedometer
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. Observation.component:numberOfStepsInUnspecifiedTimePedometer.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
75. Observation.component:numberOfStepsInUnspecifiedTimePedometer.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="55423-8"/>
    <display value="Number of steps in unspecified time Pedometer"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. Observation.component:numberOfStepsInUnspecifiedTimePedometer.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueTotal number of steps performed per walking route
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. Observation.component:swayingGait
SliceNameswayingGait
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. Observation.component:swayingGait.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
79. Observation.component:swayingGait.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="69021004"/>
    <display value="Swaying gait"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. Observation.component:swayingGait.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueSway index rate
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
81. Observation.component:neckJointRangeOfMovement
SliceNameneckJointRangeOfMovement
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
82. Observation.component:neckJointRangeOfMovement.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
83. Observation.component:neckJointRangeOfMovement.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="404979006"/>
    <display value="Neck joint - range of movement"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
84. Observation.component:neckJointRangeOfMovement.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueRange of head turns in yaw plane (Left-Right)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. Observation.component:countsPerSecond
SliceNamecountsPerSecond
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.

Control10..1*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. Observation.component:countsPerSecond.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
87. Observation.component:countsPerSecond.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes

Codes identifying names of simple observations.

TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="282108002"/>
    <display value="Counts per second"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. Observation.component:countsPerSecond.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueHead turns per second
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. Observation
Definition

Measurements and simple assertions made about a patient, device or other subject.

Control0..*
Summaryfalse
Alternate NamesVital Signs, Measurement, Results, Tests
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 laboratory reports, etc.

2. Observation.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Summarytrue
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.

3. Observation.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Observation.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Summaryfalse
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Observation.text
Definition

A human-readable narrative that contains a summary of the resource and can 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.

Control0..1
TypeNarrative
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
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 information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. 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.

Control0..*
TypeResource
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. Observation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. Observation.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
10. Observation.extension.extension
Definition

An Extension

Control0..0
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
11. Observation.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Pattern Valuehttps://holobalance.eu/fhir/extension-exercise-difficulty
12. Observation.extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
13. Observation.extension.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="https://holobalance.eu/fhir/codesystem-exercise-difficulty"/>
    <code value="&lt;&lt;functionalLevel&gt;&gt;"/>
    <display value="Exercise Progression Level"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. Observation.identifier
Definition

A unique identifier assigned to this observation.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control2..*
TypeIdentifier
Summarytrue
Requirements

Allows observations to be distinguished and referenced.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
16. Observation.identifier:TrainingId
SliceNameTrainingId
Definition

A unique identifier assigned to this observation.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Summarytrue
Requirements

Allows observations to be distinguished and referenced.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Observation.identifier:TrainingId.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
18. Observation.identifier:TrainingId.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
19. Observation.identifier:TrainingId.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Observation.identifier:TrainingId.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Observation.identifier:TrainingId.system
Definition

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

Control1..1
Typeuri
Summarytrue
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.

Comments

Identifier.system is always case sensitive.

Pattern Valuehttps://holobalance.eu/fhir/identifiers/exercise-instance
Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Observation.identifier:TrainingId.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Pattern Value<<traininglogid>>
Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Observation.identifier:TrainingId.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Observation.identifier:TrainingId.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Summarytrue
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Observation.identifier:SessionId
SliceNameSessionId
Definition

A unique identifier assigned to this observation.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Summarytrue
Requirements

Allows observations to be distinguished and referenced.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Observation.identifier:SessionId.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
27. Observation.identifier:SessionId.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. Observation.identifier:SessionId.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Observation.identifier:SessionId.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Observation.identifier:SessionId.system
Definition

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

Control1..1
Typeuri
Summarytrue
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.

Comments

Identifier.system is always case sensitive.

Pattern Valuehttps://holobalance.eu/fhir/identifiers/exercise-session
Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Observation.identifier:SessionId.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Pattern Value<<sessionid>>
Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Observation.identifier:SessionId.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Observation.identifier:SessionId.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Summarytrue
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Observation.basedOn
Definition

A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

Control0..*
TypeReference(CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder|ServiceRequest)
Summarytrue
Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Alternate NamesFulfills
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Observation.partOf
Definition

A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

Control0..*
TypeReference(MedicationAdministration|MedicationDispense|MedicationStatement|Procedure|Immunization|ImagingStudy)
Summarytrue
Alternate NamesContainer
Comments

To link an Observation to an Encounter use encounter. See the Notes below for guidance on referencing another Observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Observation.status
Definition

The status of the result value.

Control1..1
BindingThe codes SHALL be taken from ObservationStatus Codes providing the status of an observation
Typecode
Is Modifiertrue
Summarytrue
Requirements

Need to track the status of individual results. Some results are finalized before the whole report is finalized.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Pattern Valuefinal
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Observation.category
Definition

A code that classifies the general type of observation being made.

Control0..*
BindingThe codes SHOULD be taken from ObservationCategoryCodes Codes for high level observation categories
TypeCodeableConcept
Summaryfalse
Requirements

Used for filtering what observations are retrieved and displayed.

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.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/observation-category"/>
    <code value="activity"/>
    <display value="Activity"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Observation.code
Definition

Describes what was observed. Sometimes this is called the observation "name".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Alternate NamesName
Comments

All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="https://holobalance.eu/fhir/CodeSystem/exercise-type"/>
    <code value="1166"/>
    <display value="Exercise Walking 2 – Walk and Yaw"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Observation.subject
Definition

The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

Control1..1
TypeReference(HolobalancePatient)
Summarytrue
Requirements

Observations have no value if you don't know who or what they're 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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Observation.focus
Definition

The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

Control0..*
TypeReference(Resource)
Standards StatusTrial Use (from Normative)
Summarytrue
Comments

Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use specimen if a reference to a specimen is required. If a code is required instead of a resource use either bodysite for bodysites or the standard extension focusCode.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Observation.encounter
Definition

The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

Control0..1
TypeReference(Encounter)
Summarytrue
Requirements

For some observations it may be important to know the link between an observation and a particular encounter.

Alternate NamesContext
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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. 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.

Control1..1
TypedateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

Knowing when an observation was deemed true is important to its relevance as well as determining trends.

Alternate NamesOccurrence
Comments

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.effective[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
43. Observation.effective[x]:effectiveDateTime
SliceNameeffectiveDateTime
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.

Control1..1
TypedateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

Knowing when an observation was deemed true is important to its relevance as well as determining trends.

Alternate NamesOccurrence
Comments

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Observation.issued
Definition

The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

Control0..1
Typeinstant
Summarytrue
Comments

For Observations that don’t require review and verification, it may be the same as the lastUpdated time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the lastUpdated time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Observation.performer
Definition

Who was responsible for asserting the observed value as "true".

Control0..*
TypeReference(Practitioner|PractitionerRole|Organization|CareTeam|Patient|RelatedPerson)
Summarytrue
Requirements

May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Observation.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1 This element is affected by the following invariants: obs-7
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Observation.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Observation.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Observation.note
Definition

Comments about the observation or the results.

Control0..*
TypeAnnotation
Summaryfalse
Requirements

Need to be able to provide free text additional information.

Comments

May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Observation.bodySite
Definition

Indicates the site on the subject's body where the observation was made (i.e. the target site).

Control0..1
BindingFor example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality
TypeCodeableConcept
Summaryfalse
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 bodySite.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Observation.method
Definition

Indicates the mechanism used to perform the observation.

Control0..1
BindingFor example codes, see ObservationMethods Methods for simple observations
TypeCodeableConcept
Summaryfalse
Requirements

In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.

Comments

Only used if not implicit in code for Observation.code.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Observation.specimen
Definition

The specimen that was used when this observation was made.

Control0..1
TypeReference(Specimen)
Summaryfalse
Comments

Should only be used if not implicit in code found in Observation.code. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. Observation.device
Definition

The device used to generate the observation data.

Control0..1
TypeReference(Device|DeviceMetric)
Summaryfalse
Comments

Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Observation.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two referenceRange elements would be used.

Control0..*
TypeBackboneElement
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (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())
55. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
56. Observation.referenceRange.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
57. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
58. 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).

Control0..1 This element is affected by the following invariants: obs-3
TypeQuantity(SimpleQuantity)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. 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).

Control0..1 This element is affected by the following invariants: obs-3
TypeQuantity(SimpleQuantity)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. 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.

Control0..1
BindingThe codes SHOULD be taken from ObservationReferenceRangeMeaningCodes Code for the meaning of a reference range
TypeCodeableConcept
Summaryfalse
Requirements

Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. 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. Multiple appliesTo are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

Control0..*
BindingFor example codes, see ObservationReferenceRangeAppliesToCodes Codes identifying the population the reference range applies to
TypeCodeableConcept
Summaryfalse
Requirements

Need to be able to identify the target population for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. 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.

Control0..1
TypeRange
Summaryfalse
Requirements

Some analytes vary greatly over age.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. 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".

Control0..1
Typestring
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. Observation.hasMember
Definition

This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

Control0..*
TypeReference(Observation|QuestionnaireResponse|MolecularSequence)
Summarytrue
Comments

When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. Observation.derivedFrom
Definition

The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

Control0..*
TypeReference(DocumentReference|ImagingStudy|Media|QuestionnaireResponse|Observation|MolecularSequence)
Summarytrue
Comments

All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. 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.

Control14..*
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
67. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
68. Observation.component.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
69. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
70. Observation.component.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. Observation.component.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. Observation.component.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Observation.component.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. Observation.component.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. Observation.component:numberOfExerciseRepetitionsCompleted
SliceNamenumberOfExerciseRepetitionsCompleted
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. Observation.component:numberOfExerciseRepetitionsCompleted.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
77. Observation.component:numberOfExerciseRepetitionsCompleted.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
78. Observation.component:numberOfExerciseRepetitionsCompleted.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
79. Observation.component:numberOfExerciseRepetitionsCompleted.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. Observation.component:numberOfExerciseRepetitionsCompleted.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
81. Observation.component:numberOfExerciseRepetitionsCompleted.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
82. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://snomed.info/sct"/>
  <code value="1202026006"/>
  <display value="Number of exercise repetitions completed"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
83. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
84. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
85. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

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

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Pattern Valuehttp://snomed.info/sct/900000000000207008/version/20220228
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding.display
Definition

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

Control0..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
89. Observation.component:numberOfExerciseRepetitionsCompleted.code.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
90. Observation.component:numberOfExerciseRepetitionsCompleted.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueTotal number of repetitions performed (walk routes)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
91. Observation.component:numberOfExerciseRepetitionsCompleted.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeQuantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="Number"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="{#}"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
92. Observation.component:numberOfExerciseRepetitionsCompleted.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
93. Observation.component:numberOfExerciseRepetitionsCompleted.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
94. Observation.component:numberOfExerciseRepetitionsCompleted.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
95. Observation.component:frequencyOfExercise
SliceNamefrequencyOfExercise
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
96. Observation.component:frequencyOfExercise.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
97. Observation.component:frequencyOfExercise.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
98. Observation.component:frequencyOfExercise.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
99. Observation.component:frequencyOfExercise.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="228449008"/>
    <display value="Frequency of exercise"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
100. Observation.component:frequencyOfExercise.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
101. Observation.component:frequencyOfExercise.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
102. Observation.component:frequencyOfExercise.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
103. Observation.component:frequencyOfExercise.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueTotal number of head turns performed
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
104. Observation.component:frequencyOfExercise.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeQuantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="Number"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="{#}"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
105. Observation.component:frequencyOfExercise.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
106. Observation.component:frequencyOfExercise.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
107. Observation.component:frequencyOfExercise.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
108. Observation.component:sagittalPlaneBodyPosition
SliceNamesagittalPlaneBodyPosition
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
109. Observation.component:sagittalPlaneBodyPosition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
110. Observation.component:sagittalPlaneBodyPosition.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
111. Observation.component:sagittalPlaneBodyPosition.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
112. Observation.component:sagittalPlaneBodyPosition.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
113. Observation.component:sagittalPlaneBodyPosition.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
114. Observation.component:sagittalPlaneBodyPosition.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
115. Observation.component:sagittalPlaneBodyPosition.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://loinc.org"/>
  <code value="72282-7"/>
  <display value="Sagittal plane body position"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
116. Observation.component:sagittalPlaneBodyPosition.code.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
117. Observation.component:sagittalPlaneBodyPosition.code.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
118. Observation.component:sagittalPlaneBodyPosition.code.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
119. Observation.component:sagittalPlaneBodyPosition.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

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

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Pattern Value2.69
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
120. Observation.component:sagittalPlaneBodyPosition.code.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
121. Observation.component:sagittalPlaneBodyPosition.code.coding.display
Definition

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

Control0..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
122. Observation.component:sagittalPlaneBodyPosition.code.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
123. Observation.component:sagittalPlaneBodyPosition.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
124. Observation.component:sagittalPlaneBodyPosition.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeSampledData
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
125. Observation.component:sagittalPlaneBodyPosition.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
126. Observation.component:sagittalPlaneBodyPosition.value[x].extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
127. Observation.component:sagittalPlaneBodyPosition.value[x].origin
Definition

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

Control1..1
TypeQuantity(SimpleQuantity)
Summarytrue
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="degree"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="deg"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
128. Observation.component:sagittalPlaneBodyPosition.value[x].period
Definition

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

Control1..1
Typedecimal
Summarytrue
Comments

This is usually a whole number.

Pattern Value15000
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
129. Observation.component:sagittalPlaneBodyPosition.value[x].factor
Definition

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

Control0..1
Typedecimal
Summarytrue
Meaning if MissingIf no factor is assigned, the data is not adjusted before adding to the origin
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
130. Observation.component:sagittalPlaneBodyPosition.value[x].lowerLimit
Definition

The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
131. Observation.component:sagittalPlaneBodyPosition.value[x].upperLimit
Definition

The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
132. Observation.component:sagittalPlaneBodyPosition.value[x].dimensions
Definition

The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.

Control1..1
TypepositiveInt
Summarytrue
Comments

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

Pattern Value1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
133. Observation.component:sagittalPlaneBodyPosition.value[x].data
Definition

A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value.

Control0..1
Typestring
Summaryfalse
Comments

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

Pattern Value<<posture|FlattenedArrayOddRemoved>>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
134. Observation.component:sagittalPlaneBodyPosition.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
135. Observation.component:sagittalPlaneBodyPosition.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
136. Observation.component:sagittalPlaneBodyPosition.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
137. Observation.component:timeSpentExercising
SliceNametimeSpentExercising
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
138. Observation.component:timeSpentExercising.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
139. Observation.component:timeSpentExercising.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
140. Observation.component:timeSpentExercising.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
141. Observation.component:timeSpentExercising.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="228450008"/>
    <display value="Time spent exercising"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
142. Observation.component:timeSpentExercising.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeQuantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="second"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="s"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
143. Observation.component:timeSpentExercising.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
144. Observation.component:timeSpentExercising.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
145. Observation.component:timeSpentExercising.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
146. Observation.component:performanceBasedMeasureScore
SliceNameperformanceBasedMeasureScore
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
147. Observation.component:performanceBasedMeasureScore.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
148. Observation.component:performanceBasedMeasureScore.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
149. Observation.component:performanceBasedMeasureScore.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
150. Observation.component:performanceBasedMeasureScore.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
151. Observation.component:performanceBasedMeasureScore.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
152. Observation.component:performanceBasedMeasureScore.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
153. Observation.component:performanceBasedMeasureScore.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://loinc.org"/>
  <code value="89191-1"/>
  <display value="Performance-based measure score"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
154. Observation.component:performanceBasedMeasureScore.code.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
155. Observation.component:performanceBasedMeasureScore.code.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
156. Observation.component:performanceBasedMeasureScore.code.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
157. Observation.component:performanceBasedMeasureScore.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

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

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Pattern Value2.69
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
158. Observation.component:performanceBasedMeasureScore.code.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
159. Observation.component:performanceBasedMeasureScore.code.coding.display
Definition

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

Control0..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
160. Observation.component:performanceBasedMeasureScore.code.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
161. Observation.component:performanceBasedMeasureScore.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
162. Observation.component:performanceBasedMeasureScore.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeQuantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="score"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="{score}"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
163. Observation.component:performanceBasedMeasureScore.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
164. Observation.component:performanceBasedMeasureScore.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
165. Observation.component:performanceBasedMeasureScore.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
166. Observation.component:disorientated
SliceNamedisorientated
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
167. Observation.component:disorientated.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
168. Observation.component:disorientated.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
169. Observation.component:disorientated.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
170. Observation.component:disorientated.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="62476001"/>
    <display value="Disorientated"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
171. Observation.component:disorientated.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
172. Observation.component:disorientated.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
173. Observation.component:disorientated.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;disoriented|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;disoriented|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
174. Observation.component:disorientated.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
175. Observation.component:disorientated.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
176. Observation.component:disorientated.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
177. Observation.component:abnormalVision
SliceNameabnormalVision
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
178. Observation.component:abnormalVision.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
179. Observation.component:abnormalVision.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
180. Observation.component:abnormalVision.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
181. Observation.component:abnormalVision.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="7973008"/>
    <display value="Abnormal vision"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
182. Observation.component:abnormalVision.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
183. Observation.component:abnormalVision.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
184. Observation.component:abnormalVision.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;blurryvision|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;blurryvision|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
185. Observation.component:abnormalVision.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
186. Observation.component:abnormalVision.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
187. Observation.component:abnormalVision.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
188. Observation.component:dizziness
SliceNamedizziness
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
189. Observation.component:dizziness.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
190. Observation.component:dizziness.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
191. Observation.component:dizziness.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
192. Observation.component:dizziness.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="404640003"/>
    <display value="Dizziness"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
193. Observation.component:dizziness.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
194. Observation.component:dizziness.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
195. Observation.component:dizziness.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;dizzy|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;dizzy|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
196. Observation.component:dizziness.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
197. Observation.component:dizziness.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
198. Observation.component:dizziness.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
199. Observation.component:headache
SliceNameheadache
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
200. Observation.component:headache.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
201. Observation.component:headache.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
202. Observation.component:headache.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
203. Observation.component:headache.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="25064002"/>
    <display value="Headache"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
204. Observation.component:headache.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeChoice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.component.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
205. Observation.component:headache.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
206. Observation.component:headache.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="&lt;&lt;headache|SeverityCode&gt;&gt;"/>
    <display value="&lt;&lt;headache|SeverityCodeDisplay&gt;&gt;"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
207. Observation.component:headache.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
208. Observation.component:headache.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
209. Observation.component:headache.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
210. Observation.component:measureOfGait
SliceNamemeasureOfGait
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
211. Observation.component:measureOfGait.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
212. Observation.component:measureOfGait.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
213. Observation.component:measureOfGait.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
214. Observation.component:measureOfGait.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="363837002"/>
    <display value="Measure of gait"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
215. Observation.component:measureOfGait.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
216. Observation.component:measureOfGait.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
217. Observation.component:measureOfGait.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
218. Observation.component:measureOfGait.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValuePercentage of single support on left foot, single support on right foot and double support per repetition
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
219. Observation.component:measureOfGait.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeSampledData
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
220. Observation.component:measureOfGait.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
221. Observation.component:measureOfGait.value[x].extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
222. Observation.component:measureOfGait.value[x].origin
Definition

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

Control1..1
TypeQuantity(SimpleQuantity)
Summarytrue
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="percent"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="%"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
223. Observation.component:measureOfGait.value[x].period
Definition

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

Control1..1
Typedecimal
Summarytrue
Comments

This is usually a whole number.

Pattern Value1000
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
224. Observation.component:measureOfGait.value[x].factor
Definition

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

Control0..1
Typedecimal
Summarytrue
Meaning if MissingIf no factor is assigned, the data is not adjusted before adding to the origin
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
225. Observation.component:measureOfGait.value[x].lowerLimit
Definition

The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
226. Observation.component:measureOfGait.value[x].upperLimit
Definition

The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
227. Observation.component:measureOfGait.value[x].dimensions
Definition

The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.

Control1..1
TypepositiveInt
Summarytrue
Comments

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

Pattern Value3
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
228. Observation.component:measureOfGait.value[x].data
Definition

A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value.

Control0..1
Typestring
Summaryfalse
Comments

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

Pattern Value<<metrixthree|FlattenedArray>>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
229. Observation.component:measureOfGait.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
230. Observation.component:measureOfGait.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
231. Observation.component:measureOfGait.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
232. Observation.component:numberOfStepsInUnspecifiedTimePedometer
SliceNamenumberOfStepsInUnspecifiedTimePedometer
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
233. Observation.component:numberOfStepsInUnspecifiedTimePedometer.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
234. Observation.component:numberOfStepsInUnspecifiedTimePedometer.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
235. Observation.component:numberOfStepsInUnspecifiedTimePedometer.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
236. Observation.component:numberOfStepsInUnspecifiedTimePedometer.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="55423-8"/>
    <display value="Number of steps in unspecified time Pedometer"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
237. Observation.component:numberOfStepsInUnspecifiedTimePedometer.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
238. Observation.component:numberOfStepsInUnspecifiedTimePedometer.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
239. Observation.component:numberOfStepsInUnspecifiedTimePedometer.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
240. Observation.component:numberOfStepsInUnspecifiedTimePedometer.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueTotal number of steps performed per walking route
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
241. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeSampledData
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
242. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
243. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x].extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
244. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x].origin
Definition

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

Control1..1
TypeQuantity(SimpleQuantity)
Summarytrue
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="Number"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="{#}"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
245. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x].period
Definition

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

Control1..1
Typedecimal
Summarytrue
Comments

This is usually a whole number.

Pattern Value1000
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
246. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x].factor
Definition

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

Control0..1
Typedecimal
Summarytrue
Meaning if MissingIf no factor is assigned, the data is not adjusted before adding to the origin
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
247. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x].lowerLimit
Definition

The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
248. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x].upperLimit
Definition

The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
249. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x].dimensions
Definition

The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.

Control1..1
TypepositiveInt
Summarytrue
Comments

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

Pattern Value1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
250. Observation.component:numberOfStepsInUnspecifiedTimePedometer.value[x].data
Definition

A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value.

Control0..1
Typestring
Summaryfalse
Comments

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

Pattern Value<<numofstep|FlattenedArray>>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
251. Observation.component:numberOfStepsInUnspecifiedTimePedometer.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
252. Observation.component:numberOfStepsInUnspecifiedTimePedometer.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
253. Observation.component:numberOfStepsInUnspecifiedTimePedometer.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
254. Observation.component:swayingGait
SliceNameswayingGait
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
255. Observation.component:swayingGait.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
256. Observation.component:swayingGait.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
257. Observation.component:swayingGait.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
258. Observation.component:swayingGait.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="69021004"/>
    <display value="Swaying gait"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
259. Observation.component:swayingGait.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
260. Observation.component:swayingGait.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
261. Observation.component:swayingGait.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
262. Observation.component:swayingGait.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueSway index rate
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
263. Observation.component:swayingGait.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeSampledData
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
264. Observation.component:swayingGait.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
265. Observation.component:swayingGait.value[x].extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
266. Observation.component:swayingGait.value[x].origin
Definition

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

Control1..1
TypeQuantity(SimpleQuantity)
Summarytrue
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="percent"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="%"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
267. Observation.component:swayingGait.value[x].period
Definition

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

Control1..1
Typedecimal
Summarytrue
Comments

This is usually a whole number.

Pattern Value1000
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
268. Observation.component:swayingGait.value[x].factor
Definition

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

Control0..1
Typedecimal
Summarytrue
Meaning if MissingIf no factor is assigned, the data is not adjusted before adding to the origin
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
269. Observation.component:swayingGait.value[x].lowerLimit
Definition

The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
270. Observation.component:swayingGait.value[x].upperLimit
Definition

The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
271. Observation.component:swayingGait.value[x].dimensions
Definition

The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.

Control1..1
TypepositiveInt
Summarytrue
Comments

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

Pattern Value1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
272. Observation.component:swayingGait.value[x].data
Definition

A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value.

Control0..1
Typestring
Summaryfalse
Comments

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

Pattern Value<<metrixsway|FlattenedArray>>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
273. Observation.component:swayingGait.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
274. Observation.component:swayingGait.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
275. Observation.component:swayingGait.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
276. Observation.component:neckJointRangeOfMovement
SliceNameneckJointRangeOfMovement
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
277. Observation.component:neckJointRangeOfMovement.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
278. Observation.component:neckJointRangeOfMovement.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
279. Observation.component:neckJointRangeOfMovement.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
280. Observation.component:neckJointRangeOfMovement.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="404979006"/>
    <display value="Neck joint - range of movement"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
281. Observation.component:neckJointRangeOfMovement.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
282. Observation.component:neckJointRangeOfMovement.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
283. Observation.component:neckJointRangeOfMovement.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
284. Observation.component:neckJointRangeOfMovement.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueRange of head turns in yaw plane (Left-Right)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
285. Observation.component:neckJointRangeOfMovement.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeSampledData
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
286. Observation.component:neckJointRangeOfMovement.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
287. Observation.component:neckJointRangeOfMovement.value[x].extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
288. Observation.component:neckJointRangeOfMovement.value[x].origin
Definition

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

Control1..1
TypeQuantity(SimpleQuantity)
Summarytrue
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="degree"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="deg"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
289. Observation.component:neckJointRangeOfMovement.value[x].period
Definition

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

Control1..1
Typedecimal
Summarytrue
Comments

This is usually a whole number.

Pattern Value1000
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
290. Observation.component:neckJointRangeOfMovement.value[x].factor
Definition

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

Control0..1
Typedecimal
Summarytrue
Meaning if MissingIf no factor is assigned, the data is not adjusted before adding to the origin
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
291. Observation.component:neckJointRangeOfMovement.value[x].lowerLimit
Definition

The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
292. Observation.component:neckJointRangeOfMovement.value[x].upperLimit
Definition

The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
293. Observation.component:neckJointRangeOfMovement.value[x].dimensions
Definition

The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.

Control1..1
TypepositiveInt
Summarytrue
Comments

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

Pattern Value1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
294. Observation.component:neckJointRangeOfMovement.value[x].data
Definition

A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value.

Control0..1
Typestring
Summaryfalse
Comments

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

Pattern Value<<range|FlattenedArray>>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
295. Observation.component:neckJointRangeOfMovement.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
296. Observation.component:neckJointRangeOfMovement.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
297. Observation.component:neckJointRangeOfMovement.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
298. Observation.component:countsPerSecond
SliceNamecountsPerSecond
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.

Control1..1
TypeBackboneElement
Summarytrue
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.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
299. Observation.component:countsPerSecond.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
300. Observation.component:countsPerSecond.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
301. Observation.component:countsPerSecond.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
302. Observation.component:countsPerSecond.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingFor example codes, see LOINCCodes Codes identifying names of simple observations
TypeCodeableConcept
Summarytrue
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="282108002"/>
    <display value="Counts per second"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
303. Observation.component:countsPerSecond.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
304. Observation.component:countsPerSecond.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
305. Observation.component:countsPerSecond.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
306. Observation.component:countsPerSecond.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

Pattern ValueHead turns per second
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
307. Observation.component:countsPerSecond.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
TypeSampledData
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
308. Observation.component:countsPerSecond.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
309. Observation.component:countsPerSecond.value[x].extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.component.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
310. Observation.component:countsPerSecond.value[x].origin
Definition

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

Control1..1
TypeQuantity(SimpleQuantity)
Summarytrue
Pattern Value<valueQuantity xmlns="http://hl7.org/fhir">
  <unit value="per second"/>
  <system value="http://unitsofmeasure.org"/>
  <code value="/s"/>
</valueQuantity>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
311. Observation.component:countsPerSecond.value[x].period
Definition

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

Control1..1
Typedecimal
Summarytrue
Comments

This is usually a whole number.

Pattern Value1000
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
312. Observation.component:countsPerSecond.value[x].factor
Definition

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

Control0..1
Typedecimal
Summarytrue
Meaning if MissingIf no factor is assigned, the data is not adjusted before adding to the origin
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
313. Observation.component:countsPerSecond.value[x].lowerLimit
Definition

The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
314. Observation.component:countsPerSecond.value[x].upperLimit
Definition

The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

Control0..1
Typedecimal
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
315. Observation.component:countsPerSecond.value[x].dimensions
Definition

The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.

Control1..1
TypepositiveInt
Summarytrue
Comments

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

Pattern Value1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
316. Observation.component:countsPerSecond.value[x].data
Definition

A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value.

Control0..1
Typestring
Summaryfalse
Comments

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

Pattern Value<<speed|FlattenedArray>>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
317. Observation.component:countsPerSecond.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Summaryfalse
Requirements

For many results it is necessary to handle exceptional values in measurements.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
318. Observation.component:countsPerSecond.interpretation
Definition

A categorical assessment of an observation value. For example, high, low, normal.

Control0..*
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations
TypeCodeableConcept
Summaryfalse
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Alternate NamesAbnormal Flag
Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
319. Observation.component:countsPerSecond.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Summaryfalse
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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))