Observation |
S I |
|
Observation |
There are no (further) constraints on this element Element Id
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 lab reports, etc.
Data Type
Observation Constraints
- dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
- dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty()
- dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
- dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
- obs-7:If code is the same as a component code then the value element associated with the code SHALL NOT be present
value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
- obs-6:dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
Mappings
- rim:Entity. Role, or Act
- workflow:Event
- sct-concept:< 363787002 |Observable entity|
- v2:OBX
- rim:Observation[classCode=OBS, moodCode=EVN]
- w5:clinical.diagnostics
|
identifier |
Σ |
0..* |
Identifier |
There are no (further) constraints on this element Element Id
Short description
Business Identifier for observation Definition
A unique identifier assigned to this observation.
Requirements
Allows observations to be distinguished and referenced.
Data Type
Identifier Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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
- 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
- w5:id
|
basedOn |
Σ I |
0..* |
Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) |
There are no (further) constraints on this element Element Id
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.
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 | ProcedureRequest | ReferralRequest) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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:.outboundRelationship[typeCode=FLFS].target
|
status |
Σ ?! |
1..1 |
codeBinding |
There are no (further) constraints on this element Element Id
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
code Binding
Codes providing the status of an observation. ObservationStatus (required)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:Event.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"
- w5:status
|
category |
|
0..* |
CodeableConceptBinding |
There are no (further) constraints on this element Element Id
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
CodeableConcept Binding
Codes for high level observation categories. Observation Category Codes (preferred)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
- w5:class
|
code |
S Σ |
1..1 |
CodeableConcept |
There are no (further) constraints on this element Element Id
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
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type
CodeableConcept Binding
Codes identifying names of simple observations. LOINC Codes (example)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.code
- sct-concept:< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
- v2:OBX-3
- rim:code
- sct-attr:116680003 |Is a|
- w5:what
|
coding |
S Σ |
1..1 |
Coding |
Element Id
Short description
Observation code defined by a terminology system Definition
A reference to a code defined by a terminology system.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Comments
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data Type
Coding Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- v2:C*E.1-8, C*E.10-22
- rim:union(., ./translation)
- orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
system |
Σ |
1..1 |
uri |
There are no (further) constraints on this element Element Id
Observation.code.coding.system
Short description
Identity of the terminology system Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comments
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Data Type
uri Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:C*E.3
- rim:./codeSystem
- orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
version |
Σ |
0..1 |
string |
There are no (further) constraints on this element Element Id
Observation.code.coding.version
Short description
Version of the system - if relevant Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comments
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:C*E.7
- rim:./codeSystemVersion
- orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
code |
Σ |
0..1 |
code |
There are no (further) constraints on this element Element Id
Observation.code.coding.code
Short description
Symbol in syntax defined by the system Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Requirements
Need to refer to a particular code in the system.
Comments
Note that FHIR strings may not exceed 1MB in size
Data Type
code Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:C*E.1
- rim:./code
- orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
display |
Σ |
0..1 |
string |
There are no (further) constraints on this element Element Id
Observation.code.coding.display
Short description
Representation defined by the system Definition
A representation of the meaning of the code in the system, following the rules of the system.
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Comments
Note that FHIR strings may not exceed 1MB in size
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:C*E.2 - but note this is not well followed
- rim:CV.displayName
- orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
userSelected |
Σ |
0..1 |
boolean |
There are no (further) constraints on this element Element Id
Observation.code.coding.userSelected
Short description
If this coding was chosen directly by the user Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Data Type
boolean Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:Sometimes implied by being first
- rim:CD.codingRationale
- orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
text |
S Σ |
1..1 |
string |
Element Id
Short description
Plain text representation of the observation code Definition
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Requirements
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments
Very often the text is the same as a displayName of one of the codings.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:C*E.9. But note many systems use C*E.2 for this
- rim:./originalText[mediaType/code="text/plain"]/data
- orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
subject |
S Σ I |
0..1 |
Reference(ZD Patient) |
Element Id
Short description
Who and/or what this is about Definition
The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
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.
If the target of the observation is different than the subject, the general extension observation-focal-subject. may be used. However, the distinction between the patient's own value for an observation versus that of the fetus, or the donor or blood product unit, etc., are often specified in the observation code.
Data Type
Reference(ZD Patient) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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
- v2:PID-3
- rim:participation[typeCode=SBJ]
- w5:who.focus
|
context |
S I |
0..1 |
Reference(ZD Encounter) |
Element Id
Short description
Healthcare event during which this observation is made Alternate names
Encounter 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 or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests).
Data Type
Reference(ZD Encounter) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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
- v2:PV1
- rim:inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
- w5:context
|
effective[x] |
S Σ |
0..1 |
|
There are no (further) constraints on this element Element Id
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.
Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:Event.occurrence[x]
- v2:OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
- rim:effectiveTime
- w5:when.done
|
effectiveDateTime |
|
|
dateTime |
There are no (further) constraints on this element Data Type
dateTime
|
effectivePeriod |
|
|
Period |
There are no (further) constraints on this element Data Type
Period
|
issued |
S Σ |
0..1 |
instant |
There are no (further) constraints on this element Element Id
Short description
Date/Time this was made available Definition
The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
Comments
Updated when the result is updated.
Data Type
instant Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)
- rim:participation[typeCode=AUT].time
- w5:when.recorded
|
performer |
Σ I |
0..* |
Reference(ZD Practitioner | ZD Organization) |
Element Id
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(ZD Practitioner | ZD Organization) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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
- 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]
- w5:who.actor
|
value[x] |
S Σ I |
0..1 |
|
Element Id
Short description
Actual result. Either Observation.value[x] or Observation.component.value[x] must be provided. 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 may not if it is in error, or if it represents a group of observations.
Comments
Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is "'value' + the type name" with a capital on the first letter of the type).
If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For further discussion and examples see the notes section below.
Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:Event.notDone, Event.notDoneReason (maps to valeu[x] or dataAbsentReason)
- 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 element Data Type
Quantity
|
valueCodeableConcept |
|
|
CodeableConcept |
There are no (further) constraints on this element Data Type
CodeableConcept
|
valueString |
|
|
string |
There are no (further) constraints on this element Data Type
string
|
valueBoolean |
|
|
boolean |
There are no (further) constraints on this element Data Type
boolean
|
valueRange |
|
|
Range |
There are no (further) constraints on this element Data Type
Range
|
valueRatio |
|
|
Ratio |
There are no (further) constraints on this element Data Type
Ratio
|
valueSampledData |
|
|
SampledData |
There are no (further) constraints on this element Data Type
SampledData
|
valueAttachment |
|
|
Attachment |
There are no (further) constraints on this element Data Type
Attachment
|
valueTime |
|
|
time |
There are no (further) constraints on this element Data Type
time
|
valueDateTime |
|
|
dateTime |
There are no (further) constraints on this element Data Type
dateTime
|
valuePeriod |
|
|
Period |
There are no (further) constraints on this element Data Type
Period
|
dataAbsentReason |
I |
0..1 |
CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Observation.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
CodeableConcept Binding
Codes specifying why the result (Observation.value[x]) is missing. Observation Value Absent Reason (extensible)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.notDone, Event.notDoneReason (maps to valeu[x] or dataAbsentReason)
- v2:N/A
- rim:value.nullFlavor
|
interpretation |
|
0..1 |
CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Observation.interpretation
Short description
High, low, normal, etc. Alternate names
Abnormal Flag Definition
The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
Requirements
For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
Comments
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type
CodeableConcept Binding
Codes identifying interpretations of observations. Observation Interpretation Codes (extensible)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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|
|
bodySite |
|
0..1 |
CodeableConcept |
There are no (further) constraints on this element Element Id
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 body-site-instance.
Data Type
CodeableConcept Binding
Codes describing anatomical locations. May include laterality. SNOMED CT Body Structures (example)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 element Element Id
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
CodeableConcept Binding
Methods for simple observations. Observation Methods (example)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 element Element Id
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
Reference(Specimen) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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 element Element Id
Short description
(Measurement) Device Definition
The device used to generate the observation data.
Comments
An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either an extension or through the Observation.related element.
Data Type
Reference(Device | DeviceMetric) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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 element Element Id
Observation.referenceRange
Short description
Provides guide for interpretation 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 may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
Data Type
BackboneElement Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- obs-3:Must have at least a low or a high or text
low.exists() or high.exists() or text.exists()
Mappings
- rim:n/a
- v2:OBX.7
- rim:outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
|
low |
I |
0..1 |
SimpleQuantity |
There are no (further) constraints on this element Element Id
Observation.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
SimpleQuantity Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 element Element Id
Observation.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
SimpleQuantity Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 element Element Id
Observation.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
CodeableConcept Binding
Code for the meaning of a reference range. Observation Reference Range Meaning Codes (extensible)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 element Element Id
Observation.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.
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
CodeableConcept Binding
Codes identifying the population the reference range applies to. Observation Reference Range Applies To Codes (example)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 element Element Id
Observation.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
Range Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 element Element Id
Observation.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 may not exceed 1MB in size
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:OBX-7
- rim:value:ST
|
related |
Σ |
0..* |
BackboneElement |
There are no (further) constraints on this element Element Id
Short description
Resource related to this observation Definition
A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
Requirements
Normally, an observation will have either a value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and a set of related observations or sometimes a QuestionnaireResponse from which the measure is derived.
Comments
For a discussion on the ways Observations can assembled in groups together see Notes below.
Data Type
BackboneElement Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:Relationships established by OBX-4 usage
- rim:outBoundRelationship
|
type |
|
0..1 |
codeBinding |
There are no (further) constraints on this element Element Id
Short description
has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Definition
A code specifying the kind of relationship that exists with the target resource.
Requirements
A relationship type SHOULD be provided.
Comments
The "derived-from" type is the only logical choice when referencing the QuestionnaireAnswer resource.
Data Type
code Binding
Codes specifying how two observations are related. ObservationRelationshipType (required)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:N/A
- rim:.typeCode
|
target |
I |
1..1 |
Reference(Observation | QuestionnaireResponse | Sequence) |
There are no (further) constraints on this element Element Id
Observation.related.target
Short description
Resource that is related to this one Definition
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(Observation | QuestionnaireResponse | Sequence) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.contained.id.trace('ids'))
Mappings
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim:.targetObservation
|
component |
Σ |
0..* |
BackboneElement |
Element Id
Short description
Component results. Either Observation.value[x] or Observation.component.value[x] must be provided. 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
BackboneElement Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:containment by OBX-4?
- rim:outBoundRelationship[typeCode=COMP]
|
code |
Σ |
1..1 |
CodeableConcept |
There are no (further) constraints on this element Element Id
Observation.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
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type
CodeableConcept Binding
Codes identifying names of simple observations. LOINC Codes (example)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept:< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
- v2:OBX-3
- rim:code
- w5:what
|
value[x] |
Σ |
0..1 |
|
There are no (further) constraints on this element Element Id
Observation.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 may not if it is in error, or if it represents a group of observations.
Comments
Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from http://hl7.org/fhir/ValueSet/v2-0136 (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type).
Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 element Data Type
Quantity
|
valueCodeableConcept |
|
|
CodeableConcept |
There are no (further) constraints on this element Data Type
CodeableConcept
|
valueString |
|
|
string |
There are no (further) constraints on this element Data Type
string
|
valueRange |
|
|
Range |
There are no (further) constraints on this element Data Type
Range
|
valueRatio |
|
|
Ratio |
There are no (further) constraints on this element Data Type
Ratio
|
valueSampledData |
|
|
SampledData |
There are no (further) constraints on this element Data Type
SampledData
|
valueAttachment |
|
|
Attachment |
There are no (further) constraints on this element Data Type
Attachment
|
valueTime |
|
|
time |
There are no (further) constraints on this element Data Type
time
|
valueDateTime |
|
|
dateTime |
There are no (further) constraints on this element Data Type
dateTime
|
valuePeriod |
|
|
Period |
There are no (further) constraints on this element Data Type
Period
|
dataAbsentReason |
I |
0..1 |
CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Observation.component.dataAbsentReason
Short description
Why the component 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 "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
CodeableConcept Binding
Codes specifying why the result (Observation.value[x]) is missing. Observation Value Absent Reason (extensible)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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..1 |
CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Observation.component.interpretation
Short description
High, low, normal, etc. Alternate names
Abnormal Flag Definition
The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
Requirements
For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
Comments
The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element.
Data Type
CodeableConcept Binding
Codes identifying interpretations of observations. Observation Interpretation Codes (extensible)Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 element Element Id
Observation.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 may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
Mappings
- v2:OBX.7
- rim:outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
|