Observation
Observation I Observation There are no (further) constraints on this elementElement idObservation
Short description Measurements and simple assertions
Alternate names Vital Signs, Measurement, Results, Tests
Definition Measurements and simple assertions made about a patient, device or other subject.
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.
Data type Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
- dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
- dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-6: A resource should have narrative for robust management
text.`div`.exists()
- dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.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()
- obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
Mappings- rim: Entity. Role, or Act
- workflow: Event
- sct-concept: < 363787002 |Observable entity|
- v2: OBX
- rim: Observation[classCode=OBS, moodCode=EVN]
id Σ 0..1 string There are no (further) constraints on this elementElement idObservation.id
Short description Logical id of this artifact
Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
Data type meta Σ 0..1 Meta There are no (further) constraints on this elementElement idObservation.meta
Short description Metadata about the resource
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
implicitRules Σ ?! 0..1 uri There are no (further) constraints on this elementElement idObservation.implicitRules
Short description A set of rules under which this content was created
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.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
language 0..1 codeBinding There are no (further) constraints on this elementElement idObservation.language
Short description Language of the resource content
Definition The base language in which the resource is written.
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).
Data type Binding A human language.
CommonLanguages (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
text 0..1 Narrative There are no (further) constraints on this elementElement idObservation.text
Short description Text summary of the resource, for human interpretation
Alternate names narrative, html, xhtml, display
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.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
contained 0..* Resource There are no (further) constraints on this elementElement idObservation.contained
Short description Contained, inline Resources
Alternate names inline resources, anonymous resources, contained resources
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.
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.
Data type Mappings- rim: Entity. Role, or Act
- rim: N/A
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.modifierExtension
Short description Extensions that cannot be ignored
Alternate names extensions, user content
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).
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
identifier Σ 0..* Identifier There are no (further) constraints on this elementElement idObservation.identifier
Short description Business Identifier for observation
Definition A unique identifier assigned to this observation.
Requirements Allows observations to be distinguished and referenced.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- workflow: Event.identifier
- w5: FiveWs.identifier
- v2: OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4.
- rim: id
basedOn Σ I 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) There are no (further) constraints on this elementElement idObservation.basedOn
Short description Fulfills plan, proposal or order
Alternate names Fulfills
Definition A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
Requirements Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data type Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: Event.basedOn
- v2: ORC
- rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]
partOf Σ I 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) There are no (further) constraints on this elementElement idObservation.partOf
Short description Part of referenced event
Alternate names Container
Definition A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
Comments To link an Observation to an Encounter use encounter
. See the Notes below for guidance on referencing another Observation.
Data type Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: Event.partOf
- v2: Varies by domain
- rim: .outboundRelationship[typeCode=FLFS].target
status Σ ?! 1..1 codeBinding There are no (further) constraints on this elementElement idObservation.status
Short description registered | preliminary | final | amended +
Definition The status of the result value.
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.
Data type Binding Codes providing the status of an observation.
ObservationStatus (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- workflow: Event.status
- w5: FiveWs.status
- sct-concept: < 445584004 |Report by finality status|
- v2: OBX-11
- rim: status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise"
category 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.category
Short description Classification of type of observation
Definition A code that classifies the general type of observation being made.
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.
Data type Binding Codes for high level observation categories.
ObservationCategoryCodes (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.class
- rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
code Σ 1..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.code
Short description Type of observation (code / type)
Alternate names Name
Definition Describes what was observed. Sometimes this is called the observation "name".
Requirements Knowing what kind of observation is being made is essential to understanding the observation.
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: Event.code
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
- sct-attr: 116680003 |Is a|
subject Σ I 0..1 Reference(Patient | Group | Device | Location) There are no (further) constraints on this elementElement idObservation.subject
Short description Who and/or what the observation is about
Definition The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus
element or the code
itself specifies the actual focus of the observation.
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.
Data type Reference(Patient | Group | Device | Location)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: Event.subject
- w5: FiveWs.subject[x]
- v2: PID-3
- rim: participation[typeCode=RTGT]
- w5: FiveWs.subject
focus Σ I 0..* Reference(Resource) There are no (further) constraints on this elementElement idObservation.focus
Short description What the observation is about, when it is not about the subject of record
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.
Comments Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use specimen
if a reference to a specimen is required. If a code is required instead of a resource use either bodysite
for bodysites or the standard extension focusCode.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5: FiveWs.subject[x]
- v2: OBX-3
- rim: participation[typeCode=SBJ]
- w5: FiveWs.subject
encounter Σ I 0..1 Reference(Encounter) There are no (further) constraints on this elementElement idObservation.encounter
Short description Healthcare event during which this observation is made
Alternate names Context
Definition The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
Requirements For some observations it may be important to know the link between an observation and a particular encounter.
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).
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: Event.context
- w5: FiveWs.context
- v2: PV1
- rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
effective[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.effective[x]
Short description Clinically relevant time/time-period for observation
Alternate names Occurrence
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.
Requirements Knowing when an observation was deemed true is important to its relevance as well as determining trends.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- workflow: Event.occurrence[x]
- w5: FiveWs.done[x]
- v2: OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
- rim: effectiveTime
effectiveDateTime dateTime There are no (further) constraints on this elementData type effectivePeriod Period There are no (further) constraints on this elementData type effectiveTiming Timing There are no (further) constraints on this elementData type effectiveInstant instant There are no (further) constraints on this elementData type issued Σ 0..1 instant There are no (further) constraints on this elementElement idObservation.issued
Short description Date/Time this version was made available
Definition The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
Comments For Observations that don’t require review and verification, it may be the same as the lastUpdated
time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the lastUpdated
time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- w5: FiveWs.recorded
- v2: OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)
- rim: participation[typeCode=AUT].time
performer Σ I 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) There are no (further) constraints on this elementElement idObservation.performer
Short description Who is responsible for the observation
Definition Who was responsible for asserting the observed value as "true".
Requirements May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data type Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: Event.performer.actor
- w5: FiveWs.actor
- v2: OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'
- rim: participation[typeCode=PRF]
value[x] Σ I 0..1 There are no (further) constraints on this elementElement idObservation.value[x]
Short description Actual result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Quantity There are no (further) constraints on this elementData type valueCodeableConcept CodeableConcept There are no (further) constraints on this elementData type valueString string There are no (further) constraints on this elementData type valueBoolean boolean There are no (further) constraints on this elementData type valueInteger integer There are no (further) constraints on this elementData type valueRange Range There are no (further) constraints on this elementData type valueRatio Ratio There are no (further) constraints on this elementData type valueSampledData SampledData There are no (further) constraints on this elementData type valueTime time There are no (further) constraints on this elementData type valueDateTime dateTime There are no (further) constraints on this elementData type valuePeriod Period There are no (further) constraints on this elementData type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.dataAbsentReason
Short description Why the result is missing
Definition Provides a reason why the expected value in the element Observation.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
note 0..* Annotation There are no (further) constraints on this elementElement idObservation.note
Short description Comments about the observation
Definition Comments about the observation or the results.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: N/A
- rim: Act
- v2: NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
- rim: subjectOf.observationEvent[code="annotation"].value
bodySite 0..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.bodySite
Short description Observed body part
Definition Indicates the site on the subject's body where the observation was made (i.e. the target site).
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.
Data type Binding Codes describing anatomical locations. May include laterality.
SNOMEDCTBodyStructures (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 123037004 |Body structure|
- v2: OBX-20
- rim: targetSiteCode
- sct-attr: 718497002 |Inherent location|
method 0..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.method
Short description How it was done
Definition Indicates the mechanism used to perform the observation.
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.
Data type Binding Methods for simple observations.
ObservationMethods (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: OBX-17
- rim: methodCode
specimen I 0..1 Reference(Specimen) There are no (further) constraints on this elementElement idObservation.specimen
Short description Specimen used for this observation
Definition The specimen that was used when this observation was made.
Comments Should only be used if not implicit in code found in Observation.code
. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- sct-concept: < 123038009 |Specimen|
- v2: SPM segment
- rim: participation[typeCode=SPC].specimen
- sct-attr: 704319004 |Inherent in|
device I 0..1 Reference(Device | DeviceMetric) There are no (further) constraints on this elementElement idObservation.device
Short description (Measurement) Device
Definition The device used to generate the observation data.
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.
Data type Reference(Device | DeviceMetric)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- sct-concept: < 49062001 |Device|
- v2: OBX-17 / PRT -10
- rim: participation[typeCode=DEV]
- sct-attr: 424226004 |Using device|
referenceRange I 0..* BackboneElement There are no (further) constraints on this elementElement idObservation.referenceRange
Short description Provides guide for interpretation
Definition Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two referenceRange
elements would be used.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
id 0..1 string There are no (further) constraints on this elementElement idObservation.referenceRange.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.referenceRange.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.referenceRange.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
low I 0..1 SimpleQuantity There are no (further) constraints on this elementElement idObservation.referenceRange.low
Short description Low Range, if relevant
Definition The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
Comments The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
- sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()
Mappings- rim: n/a
- v2: SN (see also Range) or CQ
- rim: PQ, IVL<PQ>, MO, CO, depending on the values
- v2: OBX-7
- rim: value:IVL_PQ.low
high I 0..1 SimpleQuantity There are no (further) constraints on this elementElement idObservation.referenceRange.high
Short description High Range, if relevant
Definition The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
Comments The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
- sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()
Mappings- rim: n/a
- v2: SN (see also Range) or CQ
- rim: PQ, IVL<PQ>, MO, CO, depending on the values
- v2: OBX-7
- rim: value:IVL_PQ.high
type 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.referenceRange.type
Short description Reference range qualifier
Definition Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
Requirements Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.
Comments This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.
Data type Binding Code for the meaning of a reference range.
ObservationReferenceRangeMeaningCodes (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values| OR
< 365860008 |General clinical state finding|
OR
< 250171008 |Clinical history or observation findings| OR
< 415229000 |Racial group| OR
< 365400002 |Finding of puberty stage| OR
< 443938003 |Procedure carried out on subject|
- v2: OBX-10
- rim: interpretationCode
appliesTo 0..* CodeableConcept There are no (further) constraints on this elementElement idObservation.referenceRange.appliesTo
Short description Reference range population
Definition Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo
are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.
Requirements Need to be able to identify the target population for proper interpretation.
Comments This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.
Data type Binding Codes identifying the population the reference range applies to.
ObservationReferenceRangeAppliesToCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values| OR
< 365860008 |General clinical state finding|
OR
< 250171008 |Clinical history or observation findings| OR
< 415229000 |Racial group| OR
< 365400002 |Finding of puberty stage| OR
< 443938003 |Procedure carried out on subject|
- v2: OBX-10
- rim: interpretationCode
age I 0..1 Range There are no (further) constraints on this elementElement idObservation.referenceRange.age
Short description Applicable age range, if relevant
Definition The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.
Requirements Some analytes vary greatly over age.
Comments The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)
Mappings- rim: n/a
- v2: NR and also possibly SN (but see also quantity)
- rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>
- rim: outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value
text 0..1 string There are no (further) constraints on this elementElement idObservation.referenceRange.text
Short description Text based reference range in an observation
Definition Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: OBX-7
- rim: value:ST
hasMember Σ I 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) There are no (further) constraints on this elementElement idObservation.hasMember
Short description Related resource that belongs to the Observation group
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.
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.
Data type Reference(Observation | QuestionnaireResponse | MolecularSequence)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: Relationships established by OBX-4 usage
- rim: outBoundRelationship
derivedFrom Σ I 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) There are no (further) constraints on this elementElement idObservation.derivedFrom
Short description Related measurements the observation is made from
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.
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.
Data type Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: Relationships established by OBX-4 usage
- rim: .targetObservation
component Σ 2..* BackboneElement Element idObservation.component
Short description Component results
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.
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.
Data type Sliced: Unordered, Open, by code(Pattern)
Slice pattern for component.codeConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
(All Slices) There are no (further) constraints on this element id 0..1 string There are no (further) constraints on this elementElement idObservation.component.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.component.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.component.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Quantity There are no (further) constraints on this elementData type valueCodeableConcept CodeableConcept There are no (further) constraints on this elementData type valueString string There are no (further) constraints on this elementData type valueBoolean boolean There are no (further) constraints on this elementData type valueInteger integer There are no (further) constraints on this elementData type valueRange Range There are no (further) constraints on this elementData type valueRatio Ratio There are no (further) constraints on this elementData type valueSampledData SampledData There are no (further) constraints on this elementData type valueTime time There are no (further) constraints on this elementData type valueDateTime dateTime There are no (further) constraints on this elementData type valuePeriod Period There are no (further) constraints on this elementData type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
systolic Σ 0..* BackboneElement Element idObservation.component:systolic
Short description Registrierung des Blutdrucks
Definition Mithilfe der DiGA soll ein Patient seinen Blutdruck verfolgen und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement gibt den gemessenen Blutdruck an
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:systolic.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:systolic.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:systolic.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConceptPattern Element idObservation.component:systolic.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"coding": [
{
"system": "http://loinc.org",
"code": "8480-6"
}
]
}
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 Element idObservation.component:systolic.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Sliced: Unordered, Open, by $this(Type)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Σ 0..1 QuantityPattern Element idObservation.component:systolic.value[x]:valueQuantity
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"system": "http://unitsofmeasure.org",
"code": "mm[Hg]"
}
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:systolic.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:systolic.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:systolic.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
diastolic Σ 0..* BackboneElement Element idObservation.component:diastolic
Short description Registrierung des Blutdrucks
Definition Mithilfe der DiGA soll ein Patient seinen Blutdruck verfolgen und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement gibt den gemessenen Blutdruck an
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:diastolic.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:diastolic.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:diastolic.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConceptPattern Element idObservation.component:diastolic.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"coding": [
{
"system": "http://loinc.org",
"code": "8462-4"
}
]
}
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 Element idObservation.component:diastolic.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Sliced: Unordered, Open, by $this(Type)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Σ 0..1 QuantityPattern Element idObservation.component:diastolic.value[x]:valueQuantity
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"system": "http://unitsofmeasure.org",
"code": "mm[Hg]"
}
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:diastolic.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:diastolic.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:diastolic.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
bodyWeight Σ 1..* BackboneElement Element idObservation.component:bodyWeight
Short description Abbildung des Körpergewichts zur Gewichtskontrolle
Definition Menschen mit Adipositas haben Probleme mit dem Halten des Gewichts. Daher sind in der DiGA regelmäßige Gewichtsmessungen vorgesehen.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:bodyWeight.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:bodyWeight.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:bodyWeight.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConceptPattern Element idObservation.component:bodyWeight.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"coding": [
{
"system": "http://loinc.org",
"code": "29463-7"
}
]
}
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 Element idObservation.component:bodyWeight.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Sliced: Unordered, Open, by $this(Type)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Σ 0..1 QuantityPattern Element idObservation.component:bodyWeight.value[x]:valueQuantity
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"system": "http://unitsofmeasure.org",
"code": "kg"
}
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:bodyWeight.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:bodyWeight.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:bodyWeight.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
alchohol Σ 0..* BackboneElement Element idObservation.component:alchohol
Short description Angabe des konsumierten Alkohols
Definition Mithilfe der DiGA soll ein Patient seinen Alkoholkonsum nachverfolgen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement gibt die Alkoholeinheiten an
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:alchohol.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:alchohol.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:alchohol.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConceptPattern Element idObservation.component:alchohol.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"coding": [
{
"system": "http://acme-rehab.org",
"code": "alcohol-type"
}
]
}
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.component:alchohol.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Quantity Data type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:alchohol.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:alchohol.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:alchohol.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
glucose Σ 0..* BackboneElement Element idObservation.component:glucose
Short description Registrierung des Glukosespiegels
Definition Mithilfe der DiGA soll ein Patient seinen Blutzuckerspiegel verfolgen und sich einen Überblick über seine Registrierungen verschaffen können. Dieses Datenelement gibt den Glukosespiegel an
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:glucose.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:glucose.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:glucose.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConceptPattern Element idObservation.component:glucose.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"coding": [
{
"system": "http://loinc.org",
"code": "2339-0"
}
]
}
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 Element idObservation.component:glucose.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Sliced: Unordered, Open, by $this(Type)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Σ 0..1 QuantityPattern Element idObservation.component:glucose.value[x]:valueQuantity
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"system": "http://unitsofmeasure.org",
"code": "mg/dL"
}
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:glucose.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:glucose.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:glucose.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
diet_goal Σ 0..* BackboneElement Element idObservation.component:diet_goal
Short description Angabe von Diätzielen
Definition Anhand der DiGA soll ein Patient seine Ernährungsziele nachverfolgen und einstellen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement spezifiziert die Diätziele und Registrierungen
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:diet_goal.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:diet_goal.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:diet_goal.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConceptPattern Element idObservation.component:diet_goal.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/goal-category",
"code": "dietary"
}
]
}
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.component:diet_goal.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueRange Range Data type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:diet_goal.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:diet_goal.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:diet_goal.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
life_goal Σ 0..* BackboneElement Element idObservation.component:life_goal
Short description Spezifizierung von Lebensstilzielen
Definition Mithilfe der DiGA soll ein Patient seine Lebensziele nachverfolgen und einstellen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement spezifiziert die Lebensziele und Anmeldungen
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:life_goal.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:life_goal.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:life_goal.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConceptPattern Element idObservation.component:life_goal.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/goal-category",
"code": "lifestyle"
}
]
}
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.component:life_goal.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueRange Range Data type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:life_goal.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:life_goal.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:life_goal.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
bodyHeight Σ 1..1 BackboneElement Element idObservation.component:bodyHeight
Short description Körpergröße, die zusammen mit dem Körpergewicht zur Berechnung des BMI verwendet wird
Definition Übergewichtige Menschen haben Probleme, ihr Gewicht zu halten. Daher sind regelmäßige Gewichtsmessungen in der DiGA geplant. In Kombination mit der Körpergröße ist ein Maß für den BMI möglich
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:bodyHeight.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:bodyHeight.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:bodyHeight.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConceptPattern Element idObservation.component:bodyHeight.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"coding": [
{
"system": "http://loinc.org",
"code": "8302-2"
}
]
}
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 Element idObservation.component:bodyHeight.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Sliced: Unordered, Open, by $this(Type)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Σ 0..1 QuantityPattern Element idObservation.component:bodyHeight.value[x]:valueQuantity
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"system": "http://unitsofmeasure.org",
"code": "cm"
}
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:bodyHeight.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:bodyHeight.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:bodyHeight.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
medication Σ 0..* BackboneElement Element idObservation.component:medication
Short description Eigene Spezifikation der Verwendung von Medikamenten
Definition Mithilfe der DiGA soll ein Patient seine eingenommenen Medikamente nachverfolgen und einstellen sowie einen Überblick über seine Registrierungen erhalten können. Dieses Datenelement spezifiziert die Arzneimittelregistrierungen
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:medication.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:medication.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:medication.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.component:medication.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.component:medication.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueString string Data type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:medication.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:medication.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:medication.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
cigarettes Σ 0..* BackboneElement Element idObservation.component:cigarettes
Short description Spezifikation des Zigarettenverbrauchs
Definition Mithilfe der DiGA soll ein Patient seinen Zigarettenkonsum nachverfolgen können und einen Überblick über seine Registrierungen erhalten. Dieses Datenelement gibt die Zigaretten pro Tag an
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:cigarettes.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:cigarettes.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:cigarettes.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.component:cigarettes.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.component:cigarettes.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueInteger integer Data type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:cigarettes.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:cigarettes.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:cigarettes.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
sport Σ 0..* BackboneElement Element idObservation.component:sport
Short description Angabe einer durchgeführten sportlichen Betätigung
Definition Mittels der DiGA soll ein Patient seine sportlichen Aktivitäten tracken können und eine Übersicht über sein Aktivitäts- bzw. Bewegungverhalten erhalten. Mit diesem Datenelement wird die Sportart angegeben
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:sport.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:sport.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:sport.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.component:sport.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 Element idObservation.component:sport.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Sliced: Unordered, Open, by $this(Type)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Σ 0..1 QuantityPattern Element idObservation.component:sport.value[x]:valueQuantity
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"system": "http://unitsofmeasure.org",
"code": "min"
}
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:sport.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:sport.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:sport.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
mood Σ 0..* BackboneElement Element idObservation.component:mood
Short description Angabe des Stimmungsniveaus
Definition Mithilfe der DiGA soll ein Patient seine Stimmungslage nachverfolgen und einstellen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement spezifiziert die Stimmungsniveaus
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:mood.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:mood.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:mood.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.component:mood.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.component:mood.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueInteger integer Data type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:mood.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:mood.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:mood.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
pain Σ 0..* BackboneElement Element idObservation.component:pain
Short description Angabe des Schmerzniveaus
Definition Mithilfe der DiGA soll ein Patient seine Schmerzwerte nachverfolgen und einstellen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement gibt die Schmerzpegel an
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:pain.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:pain.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:pain.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.component:pain.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.component:pain.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueInteger integer Data type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:pain.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:pain.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:pain.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
sleep Σ 0..* BackboneElement Element idObservation.component:sleep
Short description Indication of sleep duration
Definition Mithilfe der DiGA soll ein Patient seine Schlafzeit nachverfolgen und einstellen können und einen Überblick über seine Anmeldungen erhalten. Dieses Datenelement gibt den Schlaf pro Tag an
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:sleep.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:sleep.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:sleep.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.component:sleep.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 Element idObservation.component:sleep.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Sliced: Unordered, Open, by $this(Type)
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueQuantity Σ 0..1 QuantityPattern Element idObservation.component:sleep.value[x]:valueQuantity
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern {
"system": "http://unitsofmeasure.org",
"code": "min"
}
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:sleep.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:sleep.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:sleep.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
nr_steps Σ 0..* BackboneElement Element idObservation.component:nr_steps
Short description Angabe einer Anzahl von Schritten
Definition Mithilfe der DiGA soll ein Patient seine Schrittzahl verfolgen können und sich einen Überblick über Schrittzahl und Bewegungsverhalten verschaffen. Dieses Datenelement gibt die Anzahl der Schritte an
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: containment by OBX-4?
- rim: outBoundRelationship[typeCode=COMP]
id 0..1 string There are no (further) constraints on this elementElement idObservation.component:nr_steps.id
Short description Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:nr_steps.extension
Short description Additional content defined by implementations
Alternate names extensions, user content
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.
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.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- 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()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idObservation.component:nr_steps.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized
Alternate names extensions, user content, modifiers
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).
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.
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.
Data type Constraints- 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()
Mappings- rim: n/a
- rim: N/A
code Σ 1..1 CodeableConcept There are no (further) constraints on this elementElement idObservation.component:nr_steps.code
Short description Type of component observation (code / type)
Definition Describes what was observed. Sometimes this is called the observation "code".
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.
Data type Binding Codes identifying names of simple observations.
LOINCCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- sct-concept: < 363787002 |Observable entity| OR
< 386053000 |Evaluation procedure|
- v2: OBX-3
- rim: code
value[x] Σ 0..1 There are no (further) constraints on this elementElement idObservation.component:nr_steps.value[x]
Short description Actual component result
Definition The information determined as a result of making the observation, if the information has a simple value.
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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
- v2: OBX.2, OBX.5, OBX.6
- rim: value
- sct-attr: 363714003 |Interprets|
valueInteger integer Data type dataAbsentReason I 0..1 CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:nr_steps.dataAbsentReason
Short description Why the component result is missing
Definition Provides a reason why the expected value in the element Observation.component.value[x] is missing.
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.
Data type Binding Codes specifying why the result (Observation.value[x]
) is missing.
DataAbsentReason (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: N/A
- rim: value.nullFlavor
interpretation 0..* CodeableConceptBinding There are no (further) constraints on this elementElement idObservation.component:nr_steps.interpretation
Short description High, low, normal, etc.
Alternate names Abnormal Flag
Definition A categorical assessment of an observation value. For example, high, low, normal.
Requirements For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
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.
Data type Binding Codes identifying interpretations of observations.
ObservationInterpretationCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 260245000 |Findings values|
- v2: OBX-8
- rim: interpretationCode
- sct-attr: 363713009 |Has interpretation|
referenceRange 0..* see (referenceRange) There are no (further) constraints on this elementElement idObservation.component:nr_steps.referenceRange
Short description Provides guide for interpretation of component result
Definition Guidance on how to interpret the value by comparison to a normal or recommended range.
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.
Mappings- v2: OBX.7
- rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
Observation | I | Observation | There are no (further) constraints on this element Element idObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. 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.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idObservation.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idObservation.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservation.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idObservation.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idObservation.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element idObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA 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. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element idObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation.
|
category | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. 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. Codes for high level observation categories.
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations.
|
subject | Σ I | 0..1 | Reference(Patient | Group | Device | Location) | There are no (further) constraints on this element Element idObservation.subject Who and/or what the observation is about DefinitionThe 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 Observations have no value if you don't know who or what they're about. 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. Reference(Patient | Group | Device | Location) Constraints
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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).
|
effective[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
| |
effectiveDateTime | dateTime | There are no (further) constraints on this element Data type | ||
effectivePeriod | Period | There are no (further) constraints on this element Data type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data type | ||
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element idObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element idObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element idObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valuePeriod | Period | There are no (further) constraints on this element Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element idObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. 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.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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. Codes describing anatomical locations. May include laterality.
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations.
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element idObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element idObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. 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. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idObservation.referenceRange Provides guide for interpretation DefinitionGuidance 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 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.referenceRange.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.referenceRange.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.referenceRange.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idObservation.referenceRange.low Low Range, if relevant DefinitionThe value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idObservation.referenceRange.high High Range, if relevant DefinitionThe value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range.
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element idObservation.referenceRange.appliesTo Reference range population DefinitionCodes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to.
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element idObservation.referenceRange.age Applicable age range, if relevant DefinitionThe age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element idObservation.referenceRange.text Text based reference range in an observation DefinitionText based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element idObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element idObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ | 2..* | BackboneElement | Element idObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below. Unordered, Open, by code(Pattern) Slice pattern for component.code Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valuePeriod | Period | There are no (further) constraints on this element Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
systolic | Σ | 0..* | BackboneElement | Element idObservation.component:systolic Registrierung des Blutdrucks DefinitionMithilfe der DiGA soll ein Patient seinen Blutdruck verfolgen und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement gibt den gemessenen Blutdruck an 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:systolic.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:systolic.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:systolic.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConceptPattern | Element idObservation.component:systolic.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
{ "coding": [ { "system": "http://loinc.org", "code": "8480-6" } ] }
|
value[x] | Σ | 0..1 | Element idObservation.component:systolic.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityPattern | Element idObservation.component:systolic.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
{ "system": "http://unitsofmeasure.org", "code": "mm[Hg]" }
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:systolic.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:systolic.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:systolic.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
diastolic | Σ | 0..* | BackboneElement | Element idObservation.component:diastolic Registrierung des Blutdrucks DefinitionMithilfe der DiGA soll ein Patient seinen Blutdruck verfolgen und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement gibt den gemessenen Blutdruck an 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:diastolic.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:diastolic.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:diastolic.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConceptPattern | Element idObservation.component:diastolic.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
{ "coding": [ { "system": "http://loinc.org", "code": "8462-4" } ] }
|
value[x] | Σ | 0..1 | Element idObservation.component:diastolic.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityPattern | Element idObservation.component:diastolic.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
{ "system": "http://unitsofmeasure.org", "code": "mm[Hg]" }
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:diastolic.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:diastolic.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:diastolic.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
bodyWeight | Σ | 1..* | BackboneElement | Element idObservation.component:bodyWeight Abbildung des Körpergewichts zur Gewichtskontrolle DefinitionMenschen mit Adipositas haben Probleme mit dem Halten des Gewichts. Daher sind in der DiGA regelmäßige Gewichtsmessungen vorgesehen. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:bodyWeight.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:bodyWeight.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:bodyWeight.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConceptPattern | Element idObservation.component:bodyWeight.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
{ "coding": [ { "system": "http://loinc.org", "code": "29463-7" } ] }
|
value[x] | Σ | 0..1 | Element idObservation.component:bodyWeight.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityPattern | Element idObservation.component:bodyWeight.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
{ "system": "http://unitsofmeasure.org", "code": "kg" }
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:bodyWeight.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:bodyWeight.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:bodyWeight.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
alchohol | Σ | 0..* | BackboneElement | Element idObservation.component:alchohol Angabe des konsumierten Alkohols DefinitionMithilfe der DiGA soll ein Patient seinen Alkoholkonsum nachverfolgen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement gibt die Alkoholeinheiten an 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:alchohol.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:alchohol.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:alchohol.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConceptPattern | Element idObservation.component:alchohol.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
{ "coding": [ { "system": "http://acme-rehab.org", "code": "alcohol-type" } ] }
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component:alchohol.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueQuantity | Quantity | Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:alchohol.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:alchohol.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:alchohol.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
glucose | Σ | 0..* | BackboneElement | Element idObservation.component:glucose Registrierung des Glukosespiegels DefinitionMithilfe der DiGA soll ein Patient seinen Blutzuckerspiegel verfolgen und sich einen Überblick über seine Registrierungen verschaffen können. Dieses Datenelement gibt den Glukosespiegel an 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:glucose.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:glucose.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:glucose.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConceptPattern | Element idObservation.component:glucose.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
{ "coding": [ { "system": "http://loinc.org", "code": "2339-0" } ] }
|
value[x] | Σ | 0..1 | Element idObservation.component:glucose.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityPattern | Element idObservation.component:glucose.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
{ "system": "http://unitsofmeasure.org", "code": "mg/dL" }
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:glucose.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:glucose.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:glucose.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
diet_goal | Σ | 0..* | BackboneElement | Element idObservation.component:diet_goal Angabe von Diätzielen DefinitionAnhand der DiGA soll ein Patient seine Ernährungsziele nachverfolgen und einstellen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement spezifiziert die Diätziele und Registrierungen 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:diet_goal.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:diet_goal.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:diet_goal.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConceptPattern | Element idObservation.component:diet_goal.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/goal-category", "code": "dietary" } ] }
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component:diet_goal.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueRange | Range | Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:diet_goal.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:diet_goal.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:diet_goal.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
life_goal | Σ | 0..* | BackboneElement | Element idObservation.component:life_goal Spezifizierung von Lebensstilzielen DefinitionMithilfe der DiGA soll ein Patient seine Lebensziele nachverfolgen und einstellen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement spezifiziert die Lebensziele und Anmeldungen 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:life_goal.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:life_goal.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:life_goal.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConceptPattern | Element idObservation.component:life_goal.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/goal-category", "code": "lifestyle" } ] }
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component:life_goal.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueRange | Range | Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:life_goal.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:life_goal.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:life_goal.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
bodyHeight | Σ | 1..1 | BackboneElement | Element idObservation.component:bodyHeight Körpergröße, die zusammen mit dem Körpergewicht zur Berechnung des BMI verwendet wird DefinitionÜbergewichtige Menschen haben Probleme, ihr Gewicht zu halten. Daher sind regelmäßige Gewichtsmessungen in der DiGA geplant. In Kombination mit der Körpergröße ist ein Maß für den BMI möglich 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:bodyHeight.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:bodyHeight.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:bodyHeight.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConceptPattern | Element idObservation.component:bodyHeight.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
{ "coding": [ { "system": "http://loinc.org", "code": "8302-2" } ] }
|
value[x] | Σ | 0..1 | Element idObservation.component:bodyHeight.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityPattern | Element idObservation.component:bodyHeight.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
{ "system": "http://unitsofmeasure.org", "code": "cm" }
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:bodyHeight.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:bodyHeight.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:bodyHeight.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
medication | Σ | 0..* | BackboneElement | Element idObservation.component:medication Eigene Spezifikation der Verwendung von Medikamenten DefinitionMithilfe der DiGA soll ein Patient seine eingenommenen Medikamente nachverfolgen und einstellen sowie einen Überblick über seine Registrierungen erhalten können. Dieses Datenelement spezifiziert die Arzneimittelregistrierungen 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:medication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:medication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:medication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:medication.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component:medication.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueString | string | Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:medication.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:medication.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:medication.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
cigarettes | Σ | 0..* | BackboneElement | Element idObservation.component:cigarettes Spezifikation des Zigarettenverbrauchs DefinitionMithilfe der DiGA soll ein Patient seinen Zigarettenkonsum nachverfolgen können und einen Überblick über seine Registrierungen erhalten. Dieses Datenelement gibt die Zigaretten pro Tag an 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:cigarettes.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:cigarettes.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:cigarettes.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:cigarettes.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component:cigarettes.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueInteger | integer | Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:cigarettes.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:cigarettes.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:cigarettes.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
sport | Σ | 0..* | BackboneElement | Element idObservation.component:sport Angabe einer durchgeführten sportlichen Betätigung DefinitionMittels der DiGA soll ein Patient seine sportlichen Aktivitäten tracken können und eine Übersicht über sein Aktivitäts- bzw. Bewegungverhalten erhalten. Mit diesem Datenelement wird die Sportart angegeben 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:sport.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:sport.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:sport.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:sport.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
|
value[x] | Σ | 0..1 | Element idObservation.component:sport.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityPattern | Element idObservation.component:sport.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
{ "system": "http://unitsofmeasure.org", "code": "min" }
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:sport.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:sport.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:sport.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
mood | Σ | 0..* | BackboneElement | Element idObservation.component:mood Angabe des Stimmungsniveaus DefinitionMithilfe der DiGA soll ein Patient seine Stimmungslage nachverfolgen und einstellen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement spezifiziert die Stimmungsniveaus 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:mood.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:mood.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:mood.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:mood.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component:mood.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueInteger | integer | Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:mood.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:mood.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:mood.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
pain | Σ | 0..* | BackboneElement | Element idObservation.component:pain Angabe des Schmerzniveaus DefinitionMithilfe der DiGA soll ein Patient seine Schmerzwerte nachverfolgen und einstellen können und sich einen Überblick über seine Anmeldungen verschaffen können. Dieses Datenelement gibt die Schmerzpegel an 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:pain.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:pain.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:pain.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:pain.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component:pain.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueInteger | integer | Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:pain.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:pain.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:pain.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
sleep | Σ | 0..* | BackboneElement | Element idObservation.component:sleep Indication of sleep duration DefinitionMithilfe der DiGA soll ein Patient seine Schlafzeit nachverfolgen und einstellen können und einen Überblick über seine Anmeldungen erhalten. Dieses Datenelement gibt den Schlaf pro Tag an 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:sleep.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:sleep.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:sleep.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:sleep.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
|
value[x] | Σ | 0..1 | Element idObservation.component:sleep.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityPattern | Element idObservation.component:sleep.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
{ "system": "http://unitsofmeasure.org", "code": "min" }
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:sleep.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:sleep.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:sleep.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
nr_steps | Σ | 0..* | BackboneElement | Element idObservation.component:nr_steps Angabe einer Anzahl von Schritten DefinitionMithilfe der DiGA soll ein Patient seine Schrittzahl verfolgen können und sich einen Überblick über Schrittzahl und Bewegungsverhalten verschaffen. Dieses Datenelement gibt die Anzahl der Schritte an 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:nr_steps.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:nr_steps.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:nr_steps.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:nr_steps.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations.
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component:nr_steps.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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.
| |
valueInteger | integer | Data type | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:nr_steps.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:nr_steps.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. Codes identifying interpretations of observations.
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:nr_steps.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
|