HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1, STU 1.3 (Standard for Trial Use), published by HL7 International Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.3.0). This version is based on the current content of https://github.com/HL7/us-odh/ and changes regularly. See the Directory of published versions
Active as of 2020-01-04 |
Definitions for the odh-PastOrPresentJob resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Observation | |
Definition | Related data elements for a current or previous job, as reported by the person, i.e., a work situation or position held for a specified time period. A person can have more than one job at the same time and multiple jobs over time, so the data related to each job must remain in the record in perpetuity. Each job should be recorded in a separate instance of PastOrPresentJob. A person’s job can be a social determinant of their health and information about a person’s job can support patient care, population health, and public health. In patient care, knowledge of a person’s past or present job(s) can impact recognition, diagnosis, management, and treatment of injuries and illnesses. These data also can be used for clinical decision support and to prompt discussion of preventive care measures. For example, a record of jobs that require prolonged time in the sun might prompt a health care provider to inquire if the person wears protective clothing or sunscreen while working. At a minimum, it is important to have a record of a person’s current job(s); i.e., the job(s) in which a person is engaged at the time that he or she presents to a health care provider, regardless of duration, and to retain that information over time. In the event a person recently stopped working (e.g. retired without another job, became unemployed or disabled and unable to work), the most recent job(s) is used instead of the current job(s). Measurements and simple assertions made about a patient, device or other subject. |
2. Observation.extension | |
Slicing | This element introduces a set of slices on Observation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
3. Observation.extension:employer | |
SliceName | employer |
Control | 0..1 |
Type | Extension(Employer) (Extension Type: Reference(RelatedPerson|Organization)) |
4. Observation.extension:ODHIsCurrentJobExtension | |
SliceName | ODHIsCurrentJobExtension |
Control | 0..1 |
Type | Extension(ODHIsCurrentJobExtension) (Extension Type: boolean) |
5. Observation.basedOn | |
Definition | The plan, proposal or order that is fulfilled in whole or in part by this observation. 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. |
Type | Reference(ServiceRequest|CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder) |
6. Observation.partOf | |
Definition | The larger procedure that this particular observation is a component or step. A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
Type | Reference(Procedure|MedicationAdministration|MedicationDispense|MedicationStatement|Immunization|ImagingStudy) |
7. Observation.category | |
Control | 0..1* |
8. Observation.category.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
9. Observation.category.coding:Fixed_social-history | |
SliceName | Fixed_social-history |
Definition | Social History |
Control | 1..1 |
Type | Coding |
10. Observation.category.coding:Fixed_social-history.system | |
Control | 1..1 |
Fixed Value | http://terminology.hl7.org/CodeSystem/observation-category |
11. Observation.category.coding:Fixed_social-history.code | |
Control | 1..1 |
Fixed Value | social-history |
12. Observation.code | |
13. Observation.code.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
14. Observation.code.coding:Fixed_11341-5 | |
SliceName | Fixed_11341-5 |
Definition | History of Occupation |
Control | 1..1 |
Type | Coding |
15. Observation.code.coding:Fixed_11341-5.system | |
Control | 1..1 |
Fixed Value | http://loinc.org |
16. Observation.code.coding:Fixed_11341-5.code | |
Control | 1..1 |
Fixed Value | 11341-5 |
17. Observation.subject | |
Definition | The subject of an observation. 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 |
Control | 10..1 |
Type | Reference(USCorePatientProfile|Patient|Group|Device|Location) |
18. Observation.focus | |
Type | Reference(RelatedPerson|Resource) |
Comments | This is used only when conveying job information of person(s) who share a home with a patient who is a child. It represents the relationship of the person holding this Job Occupation to the patient. 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 |
19. Observation.effectivePeriod | |
Control | 1..1 |
Type | Period |
Comments | The Period.start asserts when the Job Occupation began, as reported by the person and when the Job Occupation ended, as reported by the person. If Job Occupation is current, Period.end should be omitted |
20. Observation.performer | |
Type | Reference(Practitioner|Organization|USCorePatientProfile|RelatedPerson|PractitionerRole|CareTeam|Patient) |
21. Observation.valueCodeableConcept | |
Definition | Express the Occupation using a coded value. If no coded value is available, use text. If the Occupation is not available, explain using dataAbsentReason. |
Control | 0..? |
Type | CodeableConcept |
22. Observation.valueCodeableConcept.coding | |
Control | 0..* |
Slicing | This element introduces a set of slices on Observation.valueCodeableConcept.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
23. Observation.valueCodeableConcept.coding:occupationCDCCensus2010 | |
SliceName | occupationCDCCensus2010 |
Definition | Occupation CDC Census 2010 |
Control | 0..1 |
Binding | The codes SHALL be taken from Occupation CDC Census 2010 Occupation CDC Census 201 |
24. Observation.valueCodeableConcept.coding:occupationONETSOCDetailODH | |
SliceName | occupationONETSOCDetailODH |
Definition | Occupation ONETSOC Detail (ODH) |
Control | 0..1 |
Binding | The codes SHALL be taken from Occupation ONETSOC Detail (ODH) Occupation ONETSOC Detail (ODH |
25. Observation.valueCodeableConcept.coding:occupationCDCCensus2018 | |
SliceName | occupationCDCCensus2018 |
Definition | Occupation CDC Census 2018 |
Control | 0..1 |
Binding | The codes SHALL be taken from Occupation CDC Census 2018 Occupation CDC Census 201 |
26. Observation.valueCodeableConcept.text | |
Definition | Use the narrative description if there is no coded value available for the Occupation. |
Control | 0..1 |
27. Observation.dataAbsentReason | |
Definition | The reason that there is no value available for the Occupation. Provides a reason why the expected value in the element Observation.value[x] is missing. |
28. Observation.interpretation | |
Control | 0..0* |
29. Observation.bodySite | |
Control | 0..01 |
Binding | The codes SHOULD be taken from SNOMEDCTBodyStructuresFor example codes, see SNOMEDCTBodyStructures |
30. Observation.method | |
Control | 0..01 |
31. Observation.specimen | |
Control | 0..01 |
32. Observation.device | |
Control | 0..01 |
Type | Reference(Device|DeviceMetric) |
33. Observation.referenceRange | |
Control | 0..0* |
34. Observation.hasMember | |
Control | 0..0* |
35. Observation.derivedFrom | |
Type | Reference(DocumentReference|Media|QuestionnaireResponse|Observation|ImagingStudy|MolecularSequence) |
36. Observation.component | |
Slicing | This element introduces a set of slices on Observation.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
37. Observation.component.value[x] | |
Type | Choice of: , , , , , , , , , boolean, integer |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | If there is no coded value available for the Industry, the narrative description SHALL be expressed using originalText. The CDC_Census system has been used by public health programs to classify industry and occupation when only a text description has been collected. The PHIN VADS Hot Topics for ODH includes crosswalk tables from Industry_NAICS_Detail_(ODH) values to Industry_CDC_Census_2010 values. 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. |
38. Observation.component.referenceRange | |
Control | 0..0* |
39. Observation.component:odh-PastOrPresentIndustry | |
SliceName | odh-PastOrPresentIndustry |
Definition | The type(s) of business (industry) associated with the patient's past and present occupation(s). Express the Industry using a coded value. If no coded value is available, use text. If the Industry is not available, explain using dataAbsentReason. |
Control | 0..1 |
40. Observation.component:odh-PastOrPresentIndustry.code | |
Control | 0..? |
41. Observation.component:odh-PastOrPresentIndustry.code.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
42. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0 | |
SliceName | Fixed_86188-0 |
Definition | History of Occupation industry |
Control | 1..1 |
Type | Coding |
43. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.system | |
Control | 1..1 |
Fixed Value | http://loinc.org |
44. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.code | |
Control | 1..1 |
Fixed Value | 86188-0 |
45. Observation.component:odh-PastOrPresentIndustry.valueCodeableConcept | |
Definition | Express the Industry using a coded value. If no coded value is available, use text. If the Industry is not available, explain using dataAbsentReason. |
Control | 0..1 |
Type | CodeableConcept |
46. Observation.component:odh-PastOrPresentIndustry.valueCodeableConcept.coding | |
Control | 0..* |
Slicing | This element introduces a set of slices on Observation.component.valueCodeableConcept.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
47. Observation.component:odh-PastOrPresentIndustry.valueCodeableConcept.coding:industryCDCCensus2010 | |
SliceName | industryCDCCensus2010 |
Definition | Industry CDC Census 2010 |
Control | 0..1 |
Binding | The codes SHALL be taken from Industry CDC Census 2010 Industry CDC Census 201 |
48. Observation.component:odh-PastOrPresentIndustry.valueCodeableConcept.coding:industryONETSOCDetailODH | |
SliceName | industryONETSOCDetailODH |
Definition | Industry NAICS Detail (ODH) |
Control | 0..1 |
Binding | The codes SHALL be taken from Industry NAICS Detail (ODH) Industry NAICS Detail (ODH |
49. Observation.component:odh-PastOrPresentIndustry.valueCodeableConcept.coding:industryCDCCensus2018 | |
SliceName | industryCDCCensus2018 |
Definition | Industry CDC Census 2018 |
Control | 0..1 |
Binding | The codes SHALL be taken from Industry CDC Census 2018 Industry CDC Census 201 |
50. Observation.component:odh-PastOrPresentIndustry.valueCodeableConcept.text | |
Definition | Use the narrative description if there is no coded value available for the Industry. |
Control | 0..1 |
51. Observation.component:odh-PastOrPresentIndustry.dataAbsentReason | |
Definition | The reason that there is no value available for the Industry. |
Control | 0..1 |
52. Observation.component:odh-PastOrPresentIndustry.interpretation | |
Control | 0..0 |
53. Observation.component:odh-PastOrPresentIndustry.referenceRange | |
Control | 0..0 |
54. Observation.component:odh-WorkClassification | |
SliceName | odh-WorkClassification |
Definition | Type of compensation and sector for a person's job, such as 'paid work, self-employed' or 'voluntary work', as reported by the person. |
Control | 0..1 |
55. Observation.component:odh-WorkClassification.code | |
Control | 0..? |
56. Observation.component:odh-WorkClassification.code.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
57. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8 | |
SliceName | Fixed_85104-8 |
Definition | Compensation and sector employment type |
Control | 1..1 |
Type | Coding |
58. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.system | |
Control | 1..1 |
Fixed Value | http://loinc.org |
59. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.code | |
Control | 1..1 |
Fixed Value | 85104-8 |
60. Observation.component:odh-WorkClassification.valueCodeableConcept | |
Control | 0..? |
Binding | The codes SHALL be taken from WorkClassificationODH |
Type | CodeableConcept |
61. Observation.component:odh-WorkClassification.interpretation | |
Control | 0..0 |
62. Observation.component:odh-WorkClassification.referenceRange | |
Control | 0..0 |
63. Observation.component:odh-SupervisoryLevel | |
SliceName | odh-SupervisoryLevel |
Definition | A coded indicator of responsibilities for directing work and personnel management responsibilities for a person's job, as reported by the person. For US military jobs, this is pay grade. |
Control | 0..1 |
64. Observation.component:odh-SupervisoryLevel.code | |
Control | 0..? |
65. Observation.component:odh-SupervisoryLevel.code.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
66. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6 | |
SliceName | Fixed_87707-6 |
Definition | Job supervisory level or pay grade |
Control | 1..1 |
Type | Coding |
67. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.system | |
Control | 1..1 |
Fixed Value | http://loinc.org |
68. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.code | |
Control | 1..1 |
Fixed Value | 87707-6 |
69. Observation.component:odh-SupervisoryLevel.valueCodeableConcept | |
Control | 0..? |
Binding | The codes SHALL be taken from Job Supervisory Level or Pay Grade (ODH) |
Type | CodeableConcept |
70. Observation.component:odh-SupervisoryLevel.interpretation | |
Control | 0..0 |
71. Observation.component:odh-SupervisoryLevel.referenceRange | |
Control | 0..0 |
72. Observation.component:odh-JobDuty | |
SliceName | odh-JobDuty |
Definition | A regular action performed by a person at a job, as reported by the person. For example, a Job Duty could be 'carry construction supplies' for a job with the Occupation 'construction laborer.' |
Control | 0..* |
73. Observation.component:odh-JobDuty.code | |
Control | 0..? |
74. Observation.component:odh-JobDuty.code.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
75. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1 | |
SliceName | Fixed_63761-1 |
Definition | What were your main activities or duties for this job [NHANES] |
Control | 1..1 |
Type | Coding |
76. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.system | |
Control | 1..1 |
Fixed Value | http://loinc.org |
77. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.code | |
Control | 1..1 |
Fixed Value | 63761-1 |
78. Observation.component:odh-JobDuty.valueString | |
Control | 0..? |
Type | string |
79. Observation.component:odh-JobDuty.interpretation | |
Control | 0..0 |
80. Observation.component:odh-JobDuty.referenceRange | |
Control | 0..0 |
81. Observation.component:odh-OccupationalHazard | |
SliceName | odh-OccupationalHazard |
Definition | A hazard that is specific to a person's work or work environment at one job and with which the person might come in contact, as reported by the person. A hazard is a source of potential harm to a person’s physical or mental health. Hazards can be biological, physical, psychological, chemical, or radiological in nature. |
Control | 0..* |
82. Observation.component:odh-OccupationalHazard.code | |
Control | 0..? |
83. Observation.component:odh-OccupationalHazard.code.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
84. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0 | |
SliceName | Fixed_87729-0 |
Definition | History of Occupational hazard |
Control | 1..1 |
Type | Coding |
85. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.system | |
Control | 1..1 |
Fixed Value | http://loinc.org |
86. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.code | |
Control | 1..1 |
Fixed Value | 87729-0 |
87. Observation.component:odh-OccupationalHazard.valueString | |
Control | 0..? |
Type | string |
88. Observation.component:odh-OccupationalHazard.interpretation | |
Control | 0..0 |
89. Observation.component:odh-OccupationalHazard.referenceRange | |
Control | 0..0 |
90. Observation.component:odh-WorkSchedule | |
SliceName | odh-WorkSchedule |
Definition | Typical arrangement of working hours for a person's job, as reported by the person. |
Control | 0..1 |
91. Observation.component:odh-WorkSchedule.code | |
Control | 0..? |
92. Observation.component:odh-WorkSchedule.code.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
93. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5 | |
SliceName | Fixed_74159-5 |
Definition | Work schedule NIOSH |
Control | 1..1 |
Type | Coding |
94. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.system | |
Control | 1..1 |
Fixed Value | http://loinc.org |
95. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.code | |
Control | 1..1 |
Fixed Value | 74159-5 |
96. Observation.component:odh-WorkSchedule.valueCodeableConcept | |
Control | 0..? |
Binding | The codes SHALL be taken from WorkScheduleODH |
Type | CodeableConcept |
97. Observation.component:odh-WorkSchedule.interpretation | |
Control | 0..0 |
98. Observation.component:odh-WorkSchedule.referenceRange | |
Control | 0..0 |
99. Observation.component:odh-WeeklyWorkDays | |
SliceName | odh-WeeklyWorkDays |
Definition | The average number of days per week that a person spends performing their duties for work. |
Control | 0..1 |
100. Observation.component:odh-WeeklyWorkDays.code | |
Control | 0..? |
101. Observation.component:odh-WeeklyWorkDays.code.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
102. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3 | |
SliceName | Fixed_74160-3 |
Definition | Work days per week |
Control | 1..1 |
Type | Coding |
103. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.system | |
Control | 1..1 |
Fixed Value | http://loinc.org |
104. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.code | |
Control | 1..1 |
Fixed Value | 74160-3 |
105. Observation.component:odh-WeeklyWorkDays.valueQuantity | |
Control | 0..? |
Type | Quantity |
106. Observation.component:odh-WeeklyWorkDays.valueQuantity.system | |
Control | 0..? |
Fixed Value | http://unitsofmeasure.org |
107. Observation.component:odh-WeeklyWorkDays.valueQuantity.code | |
Control | 0..? |
Fixed Value | d |
108. Observation.component:odh-WeeklyWorkDays.interpretation | |
Control | 0..0 |
109. Observation.component:odh-WeeklyWorkDays.referenceRange | |
Control | 0..0 |
110. Observation.component:odh-DailyWorkHours | |
SliceName | odh-DailyWorkHours |
Definition | The average number of hours in a day that a person spends performing their duties for work. |
Control | 0..1 |
111. Observation.component:odh-DailyWorkHours.code | |
Control | 0..? |
112. Observation.component:odh-DailyWorkHours.code.coding | |
Control | 1..* |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
113. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0 | |
SliceName | Fixed_87512-0 |
Definition | Work hours per day |
Control | 1..1 |
Type | Coding |
114. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.system | |
Control | 1..1 |
Fixed Value | http://loinc.org |
115. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.code | |
Control | 1..1 |
Fixed Value | 87512-0 |
116. Observation.component:odh-DailyWorkHours.valueQuantity | |
Control | 0..? |
Type | Quantity |
117. Observation.component:odh-DailyWorkHours.valueQuantity.system | |
Control | 0..? |
Fixed Value | http://unitsofmeasure.org |
118. Observation.component:odh-DailyWorkHours.valueQuantity.code | |
Control | 0..? |
Fixed Value | h |
119. Observation.component:odh-DailyWorkHours.interpretation | |
Control | 0..0 |
120. Observation.component:odh-DailyWorkHours.referenceRange | |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here.
1. Observation | |
Definition | Related data elements for a current or previous job, as reported by the person, i.e., a work situation or position held for a specified time period. A person can have more than one job at the same time and multiple jobs over time, so the data related to each job must remain in the record in perpetuity. Each job should be recorded in a separate instance of PastOrPresentJob. A person’s job can be a social determinant of their health and information about a person’s job can support patient care, population health, and public health. In patient care, knowledge of a person’s past or present job(s) can impact recognition, diagnosis, management, and treatment of injuries and illnesses. These data also can be used for clinical decision support and to prompt discussion of preventive care measures. For example, a record of jobs that require prolonged time in the sun might prompt a health care provider to inquire if the person wears protective clothing or sunscreen while working. At a minimum, it is important to have a record of a person’s current job(s); i.e., the job(s) in which a person is engaged at the time that he or she presents to a health care provider, regardless of duration, and to retain that information over time. In the event a person recently stopped working (e.g. retired without another job, became unemployed or disabled and unable to work), the most recent job(s) is used instead of the current job(s). Measurements and simple assertions made about a patient, device or other subject. |
Control | 0..* |
Summary | false |
Alternate Names | Vital 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. |
Invariants | Defined 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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
3. Observation.extension | |
Definition | An Extension 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. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, 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. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. Observation.extension:employer | |
SliceName | employer |
Definition | A person or organization that hires the services of another. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Employer) (Extension Type: Reference(RelatedPerson|Organization)) |
Invariants | Defined 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()) |
5. Observation.extension:ODHIsCurrentJobExtension | |
SliceName | ODHIsCurrentJobExtension |
Definition | An Extension |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ODHIsCurrentJobExtension) (Extension Type: boolean) |
Invariants | Defined 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()) |
6. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | false |
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 Names | extensions, 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. |
Invariants | Defined 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()) |
7. Observation.basedOn | |
Definition | The plan, proposal or order that is fulfilled in whole or in part by this observation. 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. |
Control | 0..* |
Type | Reference(ServiceRequest|CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder) |
Summary | true |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
Alternate Names | Fulfills |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
8. Observation.partOf | |
Definition | The larger procedure that this particular observation is a component or step. A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
Control | 0..* |
Type | Reference(Procedure|MedicationAdministration|MedicationDispense|MedicationStatement|Immunization|ImagingStudy) |
Summary | true |
Alternate Names | Container |
Comments | To link an Observation to an Encounter use |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. Observation.status | |
Definition | The status of the result value. |
Control | 1..1 |
Binding | The codes SHALL be taken from ObservationStatus Codes providing the status of an observation. |
Type | code |
Is Modifier | true |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. Observation.category | |
Definition | A code that classifies the general type of observation being made. |
Control | 0..1* |
Binding | The codes SHOULD be taken from ObservationCategoryCodes Codes for high level observation categories. |
Type | CodeableConcept |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. Observation.category.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
12. Observation.category.coding:Fixed_social-history | |
SliceName | Fixed_social-history |
Definition | Social History A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. Observation.category.coding:Fixed_social-history.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://terminology.hl7.org/CodeSystem/observation-category |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. Observation.category.coding:Fixed_social-history.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | social-history |
Invariants | Defined 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". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Alternate Names | Name |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
16. Observation.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
17. Observation.code.coding:Fixed_11341-5 | |
SliceName | Fixed_11341-5 |
Definition | History of Occupation A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. Observation.code.coding:Fixed_11341-5.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. Observation.code.coding:Fixed_11341-5.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 11341-5 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. Observation.subject | |
Definition | The subject of an observation. 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 |
Control | 10..1 |
Type | Reference(USCorePatientProfile|Patient|Group|Device|Location) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. 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. |
Control | 0..* |
Type | Reference(RelatedPerson|Resource) |
Summary | true |
Comments | This is used only when conveying job information of person(s) who share a home with a patient who is a child. It represents the relationship of the person holding this Job Occupation to the patient. 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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. 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. |
Control | 10..1 |
Type | Choice of: Period, dateTime, Timing, instant |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Alternate Names | Occurrence |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.effective[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
23. Observation.effective[x]:effectivePeriod | |
SliceName | effectivePeriod |
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. |
Control | 10..1 |
Type | Choice of: Period, dateTime, Timing, instant |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Alternate Names | Occurrence |
Comments | The Period.start asserts when the Job Occupation began, as reported by the person and when the Job Occupation ended, as reported by the person. If Job Occupation is current, Period.end should be omitted 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. Observation.performer | |
Definition | Who was responsible for asserting the observed value as "true". |
Control | 0..* |
Type | Reference(Practitioner|Organization|USCorePatientProfile|RelatedPerson|PractitionerRole|CareTeam|Patient) |
Summary | true |
Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Observation.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 0..1 This element is affected by the following invariants: obs-7 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
26. Observation.value[x]:valueCodeableConcept | |
SliceName | valueCodeableConcept |
Definition | Express the Occupation using a coded value. If no coded value is available, use text. If the Occupation is not available, explain using dataAbsentReason. The information determined as a result of making the observation, if the information has a simple value. |
Control | 0..1 This element is affected by the following invariants: obs-7 |
Type | Choice of: CodeableConcept, dateTime, boolean, string, SampledData, Quantity, Period, Ratio, integer, time, Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. Observation.value[x]:valueCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.value[x].coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
28. Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | |
SliceName | occupationCDCCensus2010 |
Definition | Occupation CDC Census 2010 A reference to a code defined by a terminology system. |
Control | 0..1* |
Binding | The codes SHALL be taken from Occupation CDC Census 2010For codes, see (unbound) Occupation CDC Census 201 |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | |
SliceName | occupationONETSOCDetailODH |
Definition | Occupation ONETSOC Detail (ODH) A reference to a code defined by a terminology system. |
Control | 0..1* |
Binding | The codes SHALL be taken from Occupation ONETSOC Detail (ODH)For codes, see (unbound) Occupation ONETSOC Detail (ODH |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | |
SliceName | occupationCDCCensus2018 |
Definition | Occupation CDC Census 2018 A reference to a code defined by a terminology system. |
Control | 0..1* |
Binding | The codes SHALL be taken from Occupation CDC Census 2018For codes, see (unbound) Occupation CDC Census 201 |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. Observation.dataAbsentReason | |
Definition | The reason that there is no value available for the Occupation. Provides a reason why the expected value in the element Observation.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result ( |
Type | CodeableConcept |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. Observation.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..0* |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Summary | false |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. Observation.bodySite | |
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). |
Control | 0..01 |
Binding | The codes SHOULD be taken from SNOMEDCTBodyStructuresFor example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality. |
Type | CodeableConcept |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. Observation.method | |
Definition | Indicates the mechanism used to perform the observation. |
Control | 0..01 |
Binding | For example codes, see ObservationMethods Methods for simple observations. |
Type | CodeableConcept |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. Observation.specimen | |
Definition | The specimen that was used when this observation was made. |
Control | 0..01 |
Type | Reference(Specimen) |
Summary | false |
Comments | Should only be used if not implicit in code found in |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
36. Observation.device | |
Definition | The device used to generate the observation data. |
Control | 0..01 |
Type | Reference(Device|DeviceMetric) |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
37. 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 |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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. |
Invariants | Defined 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()) |
38. 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. |
Control | 0..0* |
Type | Reference(Observation|QuestionnaireResponse|MolecularSequence) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
39. 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. |
Control | 0..* |
Type | Reference(DocumentReference|Media|QuestionnaireResponse|Observation|ImagingStudy|MolecularSequence) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
40. 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. |
Control | 0..* |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
41. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, 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. |
Invariants | Defined 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.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
43. Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 0..1 |
Type | Choice of: Quantity, CodeableConcept, string, Range, Ratio, SampledData, time, dateTime, Period, boolean, integer |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
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 | If there is no coded value available for the Industry, the narrative description SHALL be expressed using originalText. The CDC_Census system has been used by public health programs to classify industry and occupation when only a text description has been collected. The PHIN VADS Hot Topics for ODH includes crosswalk tables from Industry_NAICS_Detail_(ODH) values to Industry_CDC_Census_2010 values. 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
44. Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..0* |
Type | See ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
45. Observation.component:odh-PastOrPresentIndustry | |
SliceName | odh-PastOrPresentIndustry |
Definition | The type(s) of business (industry) associated with the patient's past and present occupation(s). Express the Industry using a coded value. If no coded value is available, use text. If the Industry is not available, explain using dataAbsentReason. 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. |
Control | 0..1* |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
46. Observation.component:odh-PastOrPresentIndustry.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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, 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. |
Invariants | Defined 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:odh-PastOrPresentIndustry.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
48. Observation.component:odh-PastOrPresentIndustry.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
49. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0 | |
SliceName | Fixed_86188-0 |
Definition | History of Occupation industry A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
50. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
51. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 86188-0 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
52. Observation.component:odh-PastOrPresentIndustry.dataAbsentReason | |
Definition | The reason that there is no value available for the Industry. Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result ( |
Type | CodeableConcept |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
53. Observation.component:odh-PastOrPresentIndustry.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..0* |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Summary | false |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
54. Observation.component:odh-PastOrPresentIndustry.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
55. Observation.component:odh-WorkClassification | |
SliceName | odh-WorkClassification |
Definition | Type of compensation and sector for a person's job, such as 'paid work, self-employed' or 'voluntary work', as reported by the person. 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. |
Control | 0..1* |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
56. Observation.component:odh-WorkClassification.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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, 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. |
Invariants | Defined 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.component:odh-WorkClassification.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
58. Observation.component:odh-WorkClassification.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
59. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8 | |
SliceName | Fixed_85104-8 |
Definition | Compensation and sector employment type A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
60. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
61. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 85104-8 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
62. Observation.component:odh-WorkClassification.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..0* |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Summary | false |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
63. Observation.component:odh-WorkClassification.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
64. Observation.component:odh-SupervisoryLevel | |
SliceName | odh-SupervisoryLevel |
Definition | A coded indicator of responsibilities for directing work and personnel management responsibilities for a person's job, as reported by the person. For US military jobs, this is pay grade. 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. |
Control | 0..1* |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
65. Observation.component:odh-SupervisoryLevel.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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, 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. |
Invariants | Defined 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()) |
66. Observation.component:odh-SupervisoryLevel.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
67. Observation.component:odh-SupervisoryLevel.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
68. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6 | |
SliceName | Fixed_87707-6 |
Definition | Job supervisory level or pay grade A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
69. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
70. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 87707-6 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
71. Observation.component:odh-SupervisoryLevel.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..0* |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Summary | false |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
72. Observation.component:odh-SupervisoryLevel.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
73. Observation.component:odh-JobDuty | |
SliceName | odh-JobDuty |
Definition | A regular action performed by a person at a job, as reported by the person. For example, a Job Duty could be 'carry construction supplies' for a job with the Occupation 'construction laborer.' 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. |
Control | 0..* |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
74. Observation.component:odh-JobDuty.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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, 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. |
Invariants | Defined 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:odh-JobDuty.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
76. Observation.component:odh-JobDuty.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
77. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1 | |
SliceName | Fixed_63761-1 |
Definition | What were your main activities or duties for this job [NHANES] A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
78. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
79. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 63761-1 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
80. Observation.component:odh-JobDuty.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..0* |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Summary | false |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
81. Observation.component:odh-JobDuty.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
82. Observation.component:odh-OccupationalHazard | |
SliceName | odh-OccupationalHazard |
Definition | A hazard that is specific to a person's work or work environment at one job and with which the person might come in contact, as reported by the person. A hazard is a source of potential harm to a person’s physical or mental health. Hazards can be biological, physical, psychological, chemical, or radiological in nature. 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. |
Control | 0..* |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
83. Observation.component:odh-OccupationalHazard.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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, 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. |
Invariants | Defined 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()) |
84. Observation.component:odh-OccupationalHazard.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
85. Observation.component:odh-OccupationalHazard.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
86. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0 | |
SliceName | Fixed_87729-0 |
Definition | History of Occupational hazard A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
87. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
88. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 87729-0 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
89. Observation.component:odh-OccupationalHazard.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..0* |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Summary | false |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
90. Observation.component:odh-OccupationalHazard.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
91. Observation.component:odh-WorkSchedule | |
SliceName | odh-WorkSchedule |
Definition | Typical arrangement of working hours for a person's job, as reported by the person. 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. |
Control | 0..1* |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
92. Observation.component:odh-WorkSchedule.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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, 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. |
Invariants | Defined 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()) |
93. Observation.component:odh-WorkSchedule.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
94. Observation.component:odh-WorkSchedule.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
95. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5 | |
SliceName | Fixed_74159-5 |
Definition | Work schedule NIOSH A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
96. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
97. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 74159-5 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
98. Observation.component:odh-WorkSchedule.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..0* |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Summary | false |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
99. Observation.component:odh-WorkSchedule.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
100. Observation.component:odh-WeeklyWorkDays | |
SliceName | odh-WeeklyWorkDays |
Definition | The average number of days per week that a person spends performing their duties for work. 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. |
Control | 0..1* |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
101. Observation.component:odh-WeeklyWorkDays.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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, 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. |
Invariants | Defined 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()) |
102. Observation.component:odh-WeeklyWorkDays.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
103. Observation.component:odh-WeeklyWorkDays.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
104. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3 | |
SliceName | Fixed_74160-3 |
Definition | Work days per week A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
105. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
106. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 74160-3 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
107. Observation.component:odh-WeeklyWorkDays.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..0* |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Summary | false |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
108. Observation.component:odh-WeeklyWorkDays.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
109. Observation.component:odh-DailyWorkHours | |
SliceName | odh-DailyWorkHours |
Definition | The average number of hours in a day that a person spends performing their duties for work. 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. |
Control | 0..1* |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
110. Observation.component:odh-DailyWorkHours.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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, 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. |
Invariants | Defined 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:odh-DailyWorkHours.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
112. Observation.component:odh-DailyWorkHours.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
113. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0 | |
SliceName | Fixed_87512-0 |
Definition | Work hours per day A reference to a code defined by a terminology system. |
Control | 10..1* |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
114. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
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. |
Fixed Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
115. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.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). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 87512-0 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
116. Observation.component:odh-DailyWorkHours.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..0* |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Summary | false |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
117. Observation.component:odh-DailyWorkHours.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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. |
Invariants | Defined 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 | Related data elements for a current or previous job, as reported by the person, i.e., a work situation or position held for a specified time period. A person can have more than one job at the same time and multiple jobs over time, so the data related to each job must remain in the record in perpetuity. Each job should be recorded in a separate instance of PastOrPresentJob. A person’s job can be a social determinant of their health and information about a person’s job can support patient care, population health, and public health. In patient care, knowledge of a person’s past or present job(s) can impact recognition, diagnosis, management, and treatment of injuries and illnesses. These data also can be used for clinical decision support and to prompt discussion of preventive care measures. For example, a record of jobs that require prolonged time in the sun might prompt a health care provider to inquire if the person wears protective clothing or sunscreen while working. At a minimum, it is important to have a record of a person’s current job(s); i.e., the job(s) in which a person is engaged at the time that he or she presents to a health care provider, regardless of duration, and to retain that information over time. In the event a person recently stopped working (e.g. retired without another job, became unemployed or disabled and unable to work), the most recent job(s) is used instead of the current job(s). | ||||
Control | 0..* | ||||
Summary | false | ||||
Alternate Names | Vital 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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
Invariants | Defined 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined 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. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
Summary | false | ||||
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). | ||||
Invariants | Defined 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. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Summary | false | ||||
Alternate Names | narrative, 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. | ||||
Invariants | Defined 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Summary | false | ||||
Alternate Names | inline 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 | An Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Invariants | Defined 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()) | ||||
Slicing | This element introduces a set of slices on Observation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
9. Observation.extension:employer | |||||
SliceName | employer | ||||
Definition | A person or organization that hires the services of another. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Employer) (Extension Type: Reference(RelatedPerson|Organization)) | ||||
Invariants | Defined 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()) | ||||
10. Observation.extension:ODHIsCurrentJobExtension | |||||
SliceName | ODHIsCurrentJobExtension | ||||
Definition | An Extension | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ODHIsCurrentJobExtension) (Extension Type: boolean) | ||||
Invariants | Defined 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()) | ||||
11. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | false | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
12. Observation.identifier | |||||
Definition | A unique identifier assigned to this observation. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Allows observations to be distinguished and referenced. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
13. Observation.basedOn | |||||
Definition | The plan, proposal or order that is fulfilled in whole or in part by this observation. | ||||
Control | 0..* | ||||
Type | Reference(ServiceRequest) | ||||
Summary | true | ||||
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. | ||||
Alternate Names | Fulfills | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
14. Observation.partOf | |||||
Definition | The larger procedure that this particular observation is a component or step. | ||||
Control | 0..* | ||||
Type | Reference(Procedure) | ||||
Summary | true | ||||
Alternate Names | Container | ||||
Comments | To link an Observation to an Encounter use | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
15. Observation.status | |||||
Definition | The status of the result value. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ObservationStatus Codes providing the status of an observation | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
16. Observation.category | |||||
Definition | A code that classifies the general type of observation being made. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from ObservationCategoryCodes Codes for high level observation categories | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
17. Observation.category.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
18. Observation.category.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This element introduces a set of slices on Observation.category.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
19. Observation.category.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
20. Observation.category.coding:Fixed_social-history | |||||
SliceName | Fixed_social-history | ||||
Definition | Social History | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
21. Observation.category.coding:Fixed_social-history.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
22. Observation.category.coding:Fixed_social-history.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This element introduces a set of slices on Observation.category.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
23. Observation.category.coding:Fixed_social-history.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://terminology.hl7.org/CodeSystem/observation-category | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
24. Observation.category.coding:Fixed_social-history.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
25. Observation.category.coding:Fixed_social-history.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | social-history | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. Observation.category.coding:Fixed_social-history.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. Observation.category.coding:Fixed_social-history.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. Observation.category.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
29. Observation.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "name". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Alternate Names | Name | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. Observation.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
31. Observation.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This element introduces a set of slices on Observation.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
32. Observation.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
33. Observation.code.coding:Fixed_11341-5 | |||||
SliceName | Fixed_11341-5 | ||||
Definition | History of Occupation | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. Observation.code.coding:Fixed_11341-5.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
35. Observation.code.coding:Fixed_11341-5.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This element introduces a set of slices on Observation.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
36. Observation.code.coding:Fixed_11341-5.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://loinc.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. Observation.code.coding:Fixed_11341-5.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. Observation.code.coding:Fixed_11341-5.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 11341-5 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. Observation.code.coding:Fixed_11341-5.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
40. Observation.code.coding:Fixed_11341-5.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
41. Observation.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
42. Observation.subject | |||||
Definition | The subject of an observation. | ||||
Control | 1..1 | ||||
Type | Reference(USCorePatientProfile) | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
43. 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. | ||||
Control | 0..* | ||||
Type | Reference(RelatedPerson) | ||||
Summary | true | ||||
Comments | This is used only when conveying job information of person(s) who share a home with a patient who is a child. It represents the relationship of the person holding this Job Occupation to the patient. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. Observation.encounter | |||||
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. | ||||
Control | 0..1 | ||||
Type | Reference(Encounter) | ||||
Summary | true | ||||
Requirements | For some observations it may be important to know the link between an observation and a particular encounter. | ||||
Alternate Names | Context | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
45. 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. | ||||
Control | 1..1 | ||||
Type | Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. | ||||
Alternate Names | Occurrence | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.effective[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
46. Observation.effective[x]:effectivePeriod | |||||
SliceName | effectivePeriod | ||||
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. | ||||
Control | 1..1 | ||||
Type | Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. | ||||
Alternate Names | Occurrence | ||||
Comments | The Period.start asserts when the Job Occupation began, as reported by the person and when the Job Occupation ended, as reported by the person. If Job Occupation is current, Period.end should be omitted | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
47. 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. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Summary | true | ||||
Comments | For Observations that don’t require review and verification, it may be the same as the | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
48. Observation.performer | |||||
Definition | Who was responsible for asserting the observed value as "true". | ||||
Control | 0..* | ||||
Type | Reference(Practitioner|Organization|USCorePatientProfile|RelatedPerson) | ||||
Summary | true | ||||
Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
49. Observation.value[x] | |||||
Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
Control | 0..1 This element is affected by the following invariants: obs-7 | ||||
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
50. Observation.value[x]:valueCodeableConcept | |||||
SliceName | valueCodeableConcept | ||||
Definition | Express the Occupation using a coded value. If no coded value is available, use text. If the Occupation is not available, explain using dataAbsentReason. | ||||
Control | 0..1 This element is affected by the following invariants: obs-7 | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. Observation.value[x]:valueCodeableConcept.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
52. Observation.value[x]:valueCodeableConcept.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This element introduces a set of slices on Observation.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
53. Observation.value[x]:valueCodeableConcept.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.value[x].coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
54. Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2010 | |||||
SliceName | occupationCDCCensus2010 | ||||
Definition | Occupation CDC Census 2010 | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Occupation CDC Census 2010 Occupation CDC Census 201 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
55. Observation.value[x]:valueCodeableConcept.coding:occupationONETSOCDetailODH | |||||
SliceName | occupationONETSOCDetailODH | ||||
Definition | Occupation ONETSOC Detail (ODH) | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Occupation ONETSOC Detail (ODH) Occupation ONETSOC Detail (ODH | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
56. Observation.value[x]:valueCodeableConcept.coding:occupationCDCCensus2018 | |||||
SliceName | occupationCDCCensus2018 | ||||
Definition | Occupation CDC Census 2018 | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Occupation CDC Census 2018 Occupation CDC Census 201 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
57. Observation.value[x]:valueCodeableConcept.text | |||||
Definition | Use the narrative description if there is no coded value available for the Occupation. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
58. Observation.dataAbsentReason | |||||
Definition | The reason that there is no value available for the Occupation. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
59. Observation.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
60. Observation.note | |||||
Definition | Comments about the observation or the results. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
61. Observation.bodySite | |||||
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). | ||||
Control | 0..0 | ||||
Binding | The codes SHOULD be taken from SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
62. Observation.method | |||||
Definition | Indicates the mechanism used to perform the observation. | ||||
Control | 0..0 | ||||
Binding | For example codes, see ObservationMethods Methods for simple observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
63. Observation.specimen | |||||
Definition | The specimen that was used when this observation was made. | ||||
Control | 0..0 | ||||
Type | Reference(Specimen) | ||||
Summary | false | ||||
Comments | Should only be used if not implicit in code found in | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
64. Observation.device | |||||
Definition | The device used to generate the observation data. | ||||
Control | 0..0 | ||||
Type | Reference(Device) | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
65. 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 | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined 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()) | ||||
66. 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. | ||||
Control | 0..0 | ||||
Type | Reference(Observation|QuestionnaireResponse|MolecularSequence) | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
67. 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. | ||||
Control | 0..* | ||||
Type | Reference(DocumentReference|Media|QuestionnaireResponse|Observation) | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
68. 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. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
69. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
70. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
72. Observation.component.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
73. Observation.component.value[x] | |||||
Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
Control | 0..1 | ||||
Type | Choice of: Quantity, CodeableConcept, string, Range, Ratio, SampledData, time, dateTime, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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 | If there is no coded value available for the Industry, the narrative description SHALL be expressed using originalText. The CDC_Census system has been used by public health programs to classify industry and occupation when only a text description has been collected. The PHIN VADS Hot Topics for ODH includes crosswalk tables from Industry_NAICS_Detail_(ODH) values to Industry_CDC_Census_2010 values. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
74. Observation.component.dataAbsentReason | |||||
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
75. Observation.component.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
76. Observation.component.referenceRange | |||||
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
Control | 0..0 | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
77. Observation.component:odh-PastOrPresentIndustry | |||||
SliceName | odh-PastOrPresentIndustry | ||||
Definition | The type(s) of business (industry) associated with the patient's past and present occupation(s). Express the Industry using a coded value. If no coded value is available, use text. If the Industry is not available, explain using dataAbsentReason. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
78. Observation.component:odh-PastOrPresentIndustry.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
79. Observation.component:odh-PastOrPresentIndustry.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
80. Observation.component:odh-PastOrPresentIndustry.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
81. Observation.component:odh-PastOrPresentIndustry.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
82. Observation.component:odh-PastOrPresentIndustry.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
83. Observation.component:odh-PastOrPresentIndustry.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
84. Observation.component:odh-PastOrPresentIndustry.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
85. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0 | |||||
SliceName | Fixed_86188-0 | ||||
Definition | History of Occupation industry | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
86. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
87. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
88. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://loinc.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
89. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
90. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 86188-0 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
91. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
92. Observation.component:odh-PastOrPresentIndustry.code.coding:Fixed_86188-0.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
93. Observation.component:odh-PastOrPresentIndustry.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
94. Observation.component:odh-PastOrPresentIndustry.value[x] | |||||
Definition | Express the Industry using a coded value. If no coded value is available, use text. If the Industry is not available, explain using dataAbsentReason. | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
95. Observation.component:odh-PastOrPresentIndustry.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
96. Observation.component:odh-PastOrPresentIndustry.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
97. Observation.component:odh-PastOrPresentIndustry.value[x].coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component.value[x].coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
98. Observation.component:odh-PastOrPresentIndustry.value[x].coding:industryCDCCensus2010 | |||||
SliceName | industryCDCCensus2010 | ||||
Definition | Industry CDC Census 2010 | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Industry CDC Census 2010 Industry CDC Census 201 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
99. Observation.component:odh-PastOrPresentIndustry.value[x].coding:industryONETSOCDetailODH | |||||
SliceName | industryONETSOCDetailODH | ||||
Definition | Industry NAICS Detail (ODH) | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Industry NAICS Detail (ODH) Industry NAICS Detail (ODH | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
100. Observation.component:odh-PastOrPresentIndustry.value[x].coding:industryCDCCensus2018 | |||||
SliceName | industryCDCCensus2018 | ||||
Definition | Industry CDC Census 2018 | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Industry CDC Census 2018 Industry CDC Census 201 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
101. Observation.component:odh-PastOrPresentIndustry.value[x].text | |||||
Definition | Use the narrative description if there is no coded value available for the Industry. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
102. Observation.component:odh-PastOrPresentIndustry.dataAbsentReason | |||||
Definition | The reason that there is no value available for the Industry. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
103. Observation.component:odh-PastOrPresentIndustry.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
104. Observation.component:odh-PastOrPresentIndustry.referenceRange | |||||
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
105. Observation.component:odh-WorkClassification | |||||
SliceName | odh-WorkClassification | ||||
Definition | Type of compensation and sector for a person's job, such as 'paid work, self-employed' or 'voluntary work', as reported by the person. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
106. Observation.component:odh-WorkClassification.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
107. Observation.component:odh-WorkClassification.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
108. Observation.component:odh-WorkClassification.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
109. Observation.component:odh-WorkClassification.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
110. Observation.component:odh-WorkClassification.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
111. Observation.component:odh-WorkClassification.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
112. Observation.component:odh-WorkClassification.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
113. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8 | |||||
SliceName | Fixed_85104-8 | ||||
Definition | Compensation and sector employment type | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
114. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
115. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
116. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://loinc.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
117. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
118. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 85104-8 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
119. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
120. Observation.component:odh-WorkClassification.code.coding:Fixed_85104-8.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
121. Observation.component:odh-WorkClassification.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
122. Observation.component:odh-WorkClassification.value[x] | |||||
Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from WorkClassificationODH | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
123. Observation.component:odh-WorkClassification.dataAbsentReason | |||||
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
124. Observation.component:odh-WorkClassification.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
125. Observation.component:odh-WorkClassification.referenceRange | |||||
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
126. Observation.component:odh-SupervisoryLevel | |||||
SliceName | odh-SupervisoryLevel | ||||
Definition | A coded indicator of responsibilities for directing work and personnel management responsibilities for a person's job, as reported by the person. For US military jobs, this is pay grade. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
127. Observation.component:odh-SupervisoryLevel.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
128. Observation.component:odh-SupervisoryLevel.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
129. Observation.component:odh-SupervisoryLevel.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
130. Observation.component:odh-SupervisoryLevel.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
131. Observation.component:odh-SupervisoryLevel.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
132. Observation.component:odh-SupervisoryLevel.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
133. Observation.component:odh-SupervisoryLevel.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
134. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6 | |||||
SliceName | Fixed_87707-6 | ||||
Definition | Job supervisory level or pay grade | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
135. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
136. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
137. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://loinc.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
138. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
139. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 87707-6 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
140. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
141. Observation.component:odh-SupervisoryLevel.code.coding:Fixed_87707-6.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
142. Observation.component:odh-SupervisoryLevel.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
143. Observation.component:odh-SupervisoryLevel.value[x] | |||||
Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Job Supervisory Level or Pay Grade (ODH) | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
144. Observation.component:odh-SupervisoryLevel.dataAbsentReason | |||||
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
145. Observation.component:odh-SupervisoryLevel.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
146. Observation.component:odh-SupervisoryLevel.referenceRange | |||||
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
147. Observation.component:odh-JobDuty | |||||
SliceName | odh-JobDuty | ||||
Definition | A regular action performed by a person at a job, as reported by the person. For example, a Job Duty could be 'carry construction supplies' for a job with the Occupation 'construction laborer.' | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
148. Observation.component:odh-JobDuty.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
149. Observation.component:odh-JobDuty.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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:odh-JobDuty.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
151. Observation.component:odh-JobDuty.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
152. Observation.component:odh-JobDuty.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
153. Observation.component:odh-JobDuty.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
154. Observation.component:odh-JobDuty.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
155. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1 | |||||
SliceName | Fixed_63761-1 | ||||
Definition | What were your main activities or duties for this job [NHANES] | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
156. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
157. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
158. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://loinc.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
159. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
160. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 63761-1 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
161. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
162. Observation.component:odh-JobDuty.code.coding:Fixed_63761-1.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
163. Observation.component:odh-JobDuty.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
164. Observation.component:odh-JobDuty.value[x] | |||||
Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
165. Observation.component:odh-JobDuty.dataAbsentReason | |||||
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
166. Observation.component:odh-JobDuty.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
167. Observation.component:odh-JobDuty.referenceRange | |||||
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
168. Observation.component:odh-OccupationalHazard | |||||
SliceName | odh-OccupationalHazard | ||||
Definition | A hazard that is specific to a person's work or work environment at one job and with which the person might come in contact, as reported by the person. A hazard is a source of potential harm to a person’s physical or mental health. Hazards can be biological, physical, psychological, chemical, or radiological in nature. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
169. Observation.component:odh-OccupationalHazard.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
170. Observation.component:odh-OccupationalHazard.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
171. Observation.component:odh-OccupationalHazard.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
172. Observation.component:odh-OccupationalHazard.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
173. Observation.component:odh-OccupationalHazard.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
174. Observation.component:odh-OccupationalHazard.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
175. Observation.component:odh-OccupationalHazard.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
176. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0 | |||||
SliceName | Fixed_87729-0 | ||||
Definition | History of Occupational hazard | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
177. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
178. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
179. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://loinc.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
180. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
181. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 87729-0 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
182. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
183. Observation.component:odh-OccupationalHazard.code.coding:Fixed_87729-0.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
184. Observation.component:odh-OccupationalHazard.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
185. Observation.component:odh-OccupationalHazard.value[x] | |||||
Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
186. Observation.component:odh-OccupationalHazard.dataAbsentReason | |||||
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
187. Observation.component:odh-OccupationalHazard.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
188. Observation.component:odh-OccupationalHazard.referenceRange | |||||
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
189. Observation.component:odh-WorkSchedule | |||||
SliceName | odh-WorkSchedule | ||||
Definition | Typical arrangement of working hours for a person's job, as reported by the person. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
190. Observation.component:odh-WorkSchedule.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
191. Observation.component:odh-WorkSchedule.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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:odh-WorkSchedule.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
193. Observation.component:odh-WorkSchedule.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
194. Observation.component:odh-WorkSchedule.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
195. Observation.component:odh-WorkSchedule.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
196. Observation.component:odh-WorkSchedule.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
197. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5 | |||||
SliceName | Fixed_74159-5 | ||||
Definition | Work schedule NIOSH | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
198. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
199. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
200. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://loinc.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
201. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
202. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 74159-5 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
203. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
204. Observation.component:odh-WorkSchedule.code.coding:Fixed_74159-5.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
205. Observation.component:odh-WorkSchedule.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
206. Observation.component:odh-WorkSchedule.value[x] | |||||
Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from WorkScheduleODH | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
207. Observation.component:odh-WorkSchedule.dataAbsentReason | |||||
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
208. Observation.component:odh-WorkSchedule.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
209. Observation.component:odh-WorkSchedule.referenceRange | |||||
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
210. Observation.component:odh-WeeklyWorkDays | |||||
SliceName | odh-WeeklyWorkDays | ||||
Definition | The average number of days per week that a person spends performing their duties for work. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
211. Observation.component:odh-WeeklyWorkDays.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
212. Observation.component:odh-WeeklyWorkDays.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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:odh-WeeklyWorkDays.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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:odh-WeeklyWorkDays.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
215. Observation.component:odh-WeeklyWorkDays.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
216. Observation.component:odh-WeeklyWorkDays.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
217. Observation.component:odh-WeeklyWorkDays.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
218. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3 | |||||
SliceName | Fixed_74160-3 | ||||
Definition | Work days per week | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
219. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
220. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
221. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://loinc.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
222. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
223. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 74160-3 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
224. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
225. Observation.component:odh-WeeklyWorkDays.code.coding:Fixed_74160-3.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
226. Observation.component:odh-WeeklyWorkDays.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
227. Observation.component:odh-WeeklyWorkDays.value[x] | |||||
Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
Control | 0..1 | ||||
Type | Quantity | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
228. Observation.component:odh-WeeklyWorkDays.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
229. Observation.component:odh-WeeklyWorkDays.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
230. Observation.component:odh-WeeklyWorkDays.value[x].value | |||||
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Summary | true | ||||
Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
231. Observation.component:odh-WeeklyWorkDays.value[x].comparator | |||||
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
232. Observation.component:odh-WeeklyWorkDays.value[x].unit | |||||
Definition | A human-readable form of the unit. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
233. Observation.component:odh-WeeklyWorkDays.value[x].system | |||||
Definition | The identification of the system that provides the coded form of the unit. | ||||
Control | 0..1 This element is affected by the following invariants: qty-3 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to know the system that defines the coded form of the unit. | ||||
Fixed Value | http://unitsofmeasure.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
234. Observation.component:odh-WeeklyWorkDays.value[x].code | |||||
Definition | A computer processable form of the unit in some unit representation system. | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
Fixed Value | d | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
235. Observation.component:odh-WeeklyWorkDays.dataAbsentReason | |||||
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
236. Observation.component:odh-WeeklyWorkDays.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
237. Observation.component:odh-WeeklyWorkDays.referenceRange | |||||
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
238. Observation.component:odh-DailyWorkHours | |||||
SliceName | odh-DailyWorkHours | ||||
Definition | The average number of hours in a day that a person spends performing their duties for work. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. | ||||
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
239. Observation.component:odh-DailyWorkHours.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
240. Observation.component:odh-DailyWorkHours.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
241. Observation.component:odh-DailyWorkHours.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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 Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
242. Observation.component:odh-DailyWorkHours.code | |||||
Definition | Describes what was observed. Sometimes this is called the observation "code". | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
243. Observation.component:odh-DailyWorkHours.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
244. Observation.component:odh-DailyWorkHours.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
245. Observation.component:odh-DailyWorkHours.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Observation.component.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
246. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0 | |||||
SliceName | Fixed_87512-0 | ||||
Definition | Work hours per day | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
247. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
248. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
249. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
Fixed Value | http://loinc.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
250. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
251. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 87512-0 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
252. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
253. Observation.component:odh-DailyWorkHours.code.coding:Fixed_87512-0.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
254. Observation.component:odh-DailyWorkHours.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
255. Observation.component:odh-DailyWorkHours.value[x] | |||||
Definition | The information determined as a result of making the observation, if the information has a simple value. | ||||
Control | 0..1 | ||||
Type | Quantity | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
256. Observation.component:odh-DailyWorkHours.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
257. Observation.component:odh-DailyWorkHours.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, 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. | ||||
Invariants | Defined 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()) | ||||
Slicing | This 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:
| ||||
258. Observation.component:odh-DailyWorkHours.value[x].value | |||||
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Summary | true | ||||
Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
259. Observation.component:odh-DailyWorkHours.value[x].comparator | |||||
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
260. Observation.component:odh-DailyWorkHours.value[x].unit | |||||
Definition | A human-readable form of the unit. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
261. Observation.component:odh-DailyWorkHours.value[x].system | |||||
Definition | The identification of the system that provides the coded form of the unit. | ||||
Control | 0..1 This element is affected by the following invariants: qty-3 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to know the system that defines the coded form of the unit. | ||||
Fixed Value | http://unitsofmeasure.org | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
262. Observation.component:odh-DailyWorkHours.value[x].code | |||||
Definition | A computer processable form of the unit in some unit representation system. | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
Fixed Value | h | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
263. Observation.component:odh-DailyWorkHours.dataAbsentReason | |||||
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. | ||||
Control | 0..1 This element is affected by the following invariants: obs-6 | ||||
Binding | The 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
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
264. Observation.component:odh-DailyWorkHours.interpretation | |||||
Definition | A categorical assessment of an observation value. For example, high, low, normal. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. | ||||
Alternate Names | Abnormal 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
265. Observation.component:odh-DailyWorkHours.referenceRange | |||||
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |