This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
-
STU
(v5.0.0-snapshot3:
R5
Snapshot
#3,
to
support
Connectathon
32
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Orders
and
Observations
Work
Group
|
Maturity Level : 0 | Trial Use | Use Context : Any |
The
official
canonical
URL
for
this
profile
is:
http://hl7.org/fhir/StructureDefinition/devicemetricobservation
This profile describes the direct or derived, qualitative or quantitative physiological measurement, setting, or calculation data produced by a medical device or a device component.
This
profile
was
published
on
Mon,
Nov
17,
2014
00:00+1100
Sat,
Aug
11,
2018
00:00+1000
as
a
draft
by
Health
Level
Seven
International
(Health
Care
Devices).
(Orders
and
Observations
Workgroup).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from Observation .
Summary
Mandatory:
5
elements
Must-Support:
12
elements
Prohibited:
4
elements
This
structure
is
derived
from
indicates
the
differences
between
this
profile
and
the
base
Observation
.
structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
0..* | Observation |
Measurements
and
simple
assertions
|
|
|
S | 0..* | Identifier |
Business
Identifier
for
observation
|
|
S | 1..1 | code | registered | preliminary | final | amended + |
|
S | 1..1 | CodeableConcept | Type of observation (code / type) |
|
S | 1..1 | Reference ( Patient | Device ) | Who and/or what the observation is about |
|
0 .. 0 | |||
|
S | 1..1 | dateTime | Clinically relevant time/time-period for observation |
|
0 .. 0 | |||
|
S | 0..1 | Actual result | |
|
Quantity | |||
|
CodeableConcept | |||
|
string | |||
|
Range | |||
|
Ratio | |||
|
SampledData | |||
|
time | |||
|
dateTime | |||
|
Period | |||
|
0 .. 0 | |||
|
0..1 | CodeableConcept | High, low, normal, etc. | |
|
0..* | Annotation |
Comments
about
the
observation
|
|
|
S | 0..1 | CodeableConcept | Observed body part |
|
S | 0..1 | CodeableConcept | How it was done |
|
0 .. 0 | |||
|
S | 1..1 | Reference ( DeviceMetric ) | (Measurement) Device |
|
S | 0..1 | BackboneElement | Provides guide for interpretation |
|
S | 0..* | Reference ( Observation ) |
Related
resource
that
belongs
to
the
Observation
group
|
|
S | 0..* | Reference ( Observation ) |
Related
|
Documentation
for
this
format
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Observation structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
|
0..* | Observation |
Measurements
and
simple
assertions
|
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( preferred ): IETF language tag
|
|||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S Σ | 0..* | Identifier |
Business
Identifier
for
observation
|
||||
| Σ | 0..1 | canonical ( ObservationDefinition ), Reference ( ObservationDefinition ) | Instantiates FHIR ObservationDefinition | ||||
![]() ![]() |
Σ | 0..* | Reference ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) |
Fulfills
plan,
proposal
or
order
|
||||
| 0..* | BackboneElement |
Triggering
observation(s)
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | Σ | 1..1 | Reference ( Observation ) | Triggering observation | ||||
![]() ![]() ![]() | Σ | 1..1 | code |
reflex
|
repeat
|
re-run
Binding: triggeredBytype ( required ): The type of TriggeredBy Observation. | ||||
![]() ![]() ![]() | 0..1 | string | Reason that the observation was triggered | |||||
|
Σ | 0..* |
Reference
(
MedicationAdministration
|
MedicationDispense
|
|
Part
of
referenced
event
|
||||
|
?! S Σ | 1..1 | code |
registered
|
preliminary
|
final
|
amended
+
Binding: ObservationStatus ( required ): Codes providing the status of an observation. |
||||
|
0..* | CodeableConcept |
Classification
of
type
of
observation
Binding: Observation Category Codes ( preferred ): Codes for high level observation categories. |
|||||
|
S Σ | 1..1 | CodeableConcept |
Type
of
observation
(code
/
type)
Binding: LOINC Codes ( example ): Codes identifying names of simple observations. |
||||
|
S Σ | 1..1 | Reference ( Patient | Device ) | Who and/or what the observation is about | ||||
|
Σ TU | 0..* | Reference ( Resource ) |
What
the
observation
is
about,
when
it
is
not
about
the
subject
of
record
|
||||
|
Σ | 1 .. 1 | dateTime |
Clinically
relevant
time/time-period
for
observation
Slice: Unordered, Closed by type:$this |
||||
|
S Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation | ||||
|
Σ | 0..* | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson ) |
Who
is
responsible
for
the
observation
|
||||
|
S
Σ
|
0..1 | Actual result | |||||
|
Quantity | |||||||
|
CodeableConcept | |||||||
|
string | |||||||
|
Range | |||||||
|
Ratio | |||||||
|
SampledData | |||||||
|
time | |||||||
|
dateTime | |||||||
|
Period | |||||||
|
0..1 | CodeableConcept |
High,
low,
normal,
etc.
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations. |
|||||
|
0..* | Annotation |
Comments
about
the
observation
|
|||||
|
S | 0..1 | CodeableConcept |
Observed
body
part
Binding: SNOMED CT Body Structures ( example ): SNOMED CT Body site concepts |
||||
|
C
![]() | 0..1 | Reference ( BodyStructure ) | Observed body structure | ||||
![]() ![]() |
S | 0..1 | CodeableConcept |
How
it
was
done
Binding: Observation Methods ( example ): Methods for simple observations. |
||||
|
S | 1..1 | Reference ( DeviceMetric ) | (Measurement) Device | ||||
|
S
|
0..1 | BackboneElement |
Provides
guide
for
interpretation
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
C
![]() | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
![]() ![]() ![]() |
|
0..1 | SimpleQuantity |
|
||||
|
|
0..1 |
|
Binding: Observation Reference Range Normal Value Codes ( extensible ): Codes identifying the normal value of the observation. |
||||
|
0..1 | CodeableConcept |
Reference
range
qualifier
Binding: Observation Reference Range Meaning Codes ( preferred ): Code for the meaning of a reference range. |
|||||
|
0..* | CodeableConcept |
Reference
range
population
Binding: Observation Reference Range Applies To Codes ( example ): Codes identifying the population the reference range applies to. |
|||||
|
0..1 | Range | Applicable age range, if relevant | |||||
|
0..1 | string | Text based reference range in an observation | |||||
|
S Σ | 0..* | Reference ( Observation ) |
Related
resource
that
belongs
to
the
Observation
group
|
||||
|
S Σ | 0..* | Reference ( Observation ) |
Related
|
||||
|
Σ | 0..* | BackboneElement |
Component
results
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | CodeableConcept |
Type
of
component
observation
(code
/
type)
Binding: LOINC Codes ( example ): Codes identifying names of simple observations. |
||||
|
Σ | 0..1 | Actual component result | |||||
|
Quantity | |||||||
|
CodeableConcept | |||||||
|
string | |||||||
|
boolean | |||||||
|
integer | |||||||
|
Range | |||||||
|
Ratio | |||||||
|
SampledData | |||||||
|
time | |||||||
|
dateTime | |||||||
|
Period | |||||||
| Attachment | |||||||
|
|
0..1 | CodeableConcept |
Why
the
component
result
is
missing
Binding: DataAbsentReason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing. |
||||
|
0..* | CodeableConcept |
High,
low,
normal,
etc.
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations. |
|||||
|
0..* | See referenceRange (Observation) |
Provides
guide
for
interpretation
of
component
result
|
|||||
Documentation
for
this
format
|
||||||||
<!-- Device Metric Observation Profile --><Observation xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
<</meta> < < <<meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text><</contained><contained><!-- 0..* Resource Contained, inline Resources --></contained> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- I 0..* Identifier Business Identifier for observation --></identifier><</basedOn> <</partOf> < <</category> <</code> <<instantiates[x]><!-- I 0..1 canonical|Reference(ObservationDefinition) Instantiates FHIR ObservationDefinition --></instantiates[x]> <basedOn><!-- I 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn> <triggeredBy> I 0..* BackboneElement <!-- I 0..* Triggering observation(s) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <observation><!-- I 1..1 Reference(Observation) Triggering observation --></observation> <type value="[code]"/><!-- I 1..1 reflex | repeat | re-run --> <reason value="[string]"/><!-- I 0..1 Reason that the observation was triggered --> </triggeredBy> <partOf><!-- I 0..* Reference(MedicationAdministration) Part of referenced event --></partOf> <status value="[code]"/><!-- I 1..1 registered | preliminary | final | amended + --> <category><!-- I 0..* CodeableConcept Classification of type of observation --></category> <code><!-- I 1..1 CodeableConcept Type of observation (code / type) --></code> <subject><!-- I 1..1 Reference(Patient) Who and/or what the observation is about --></subject><<focus><!-- I 0..* Reference(Resource) What the observation is about, when it is not about the subject of record --></focus><<encounter><!-- I 0..0 Reference(Encounter) Healthcare event during which this observation is made --></encounter> <-- effectiveDateTime sliced by type:$this in the specified orderClosed-->< < <<effectiveDateTime value="[dateTime]"/><!-- I 1..1 Clinically relevant time/time-period for observation --> <issued value="[instant]"/><!-- I 0..0 Date/Time this version was made available --> <performer><!-- I 0..* Reference(Practitioner) Who is responsible for the observation --></performer><|<value[x]><!-- I 0..1 Quantity|CodeableConcept|string|Range|Ratio| SampledData|time|dateTime|Period Actual result --></value[x]><</dataAbsentReason> <</interpretation> <</note> <</bodySite> <</method> <</specimen> <</device> <<dataAbsentReason><!-- I 0..0 CodeableConcept Why the result is missing --></dataAbsentReason> <interpretation><!-- I 0..1 CodeableConcept High, low, normal, etc. --></interpretation> <note><!-- I 0..* Annotation Comments about the observation --></note> <bodySite><!-- I 0..1 CodeableConcept Observed body part --></bodySite> <bodyStructure><!-- I 0..1 Reference(BodyStructure) Observed body structure --></bodyStructure> <method><!-- I 0..1 CodeableConcept How it was done --></method> <specimen><!-- I 0..0 Reference(Specimen) Specimen used for this observation --></specimen> <device><!-- I 1..1 Reference(DeviceMetric) (Measurement) Device --></device> <referenceRange> I 0..1 BackboneElement <!-- I 0..1 Provides guide for interpretation --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <low><!-- I 0..1 Quantity Low Range, if relevant --></low><<high><!-- I 0..1 Quantity High Range, if relevant --></high><</type> <</appliesTo> <<normalValue><!-- I 0..1 CodeableConcept Normal value, if relevant --></normalValue> <type><!-- I 0..1 CodeableConcept Reference range qualifier --></type> <appliesTo><!-- I 0..* CodeableConcept Reference range population --></appliesTo> <age><!-- I 0..1 Range Applicable age range, if relevant --></age><<text value="[string]"/><!-- I 0..1 Text based reference range in an observation --> </referenceRange><<hasMember><!-- I 0..* Reference(Observation) Related resource that belongs to the Observation group --></hasMember>< Related measurements the observation is made from</derivedFrom> <<derivedFrom><!-- I 0..* Reference(Observation) Related resource from which the observation is made --></derivedFrom> <component> I 0..* BackboneElement <!-- I 0..* Component results --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> <| Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 1..1 CodeableConcept Type of component observation (code / type) --></code> <value[x]><!-- I 0..1 Quantity|CodeableConcept|string| boolean|integer|Range|Ratio|SampledData|time|dateTime|Period|Attachment Actual component result --></value[x]><</dataAbsentReason> <</interpretation><dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc. --></interpretation> <referenceRange><!-- See http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange Provides guide for interpretation of component result --></referenceRange> </component> </Observation>
{ // Device Metric Observation Profile
// from Element: extension
"
"
"
"
"
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"
"
"
"
"
"
"
"
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"identifier" : [{ Identifier }], // IBusiness Identifier for observation
// value[x]: Instantiates FHIR ObservationDefinition. One of these 2:
"instantiatesCanonical" : "<canonical>", // IInstantiates FHIR ObservationDefinition
"instantiatesReference" : { Reference(ObservationDefinition) }, // IInstantiates FHIR ObservationDefinition
"basedOn" : [{ Reference(CarePlan) }], // IFulfills plan, proposal or order
"triggeredBy" : [{ BackboneElement }], // ITriggering observation(s)
"partOf" : [{ Reference(MedicationAdministration) }], // IPart of referenced event
"status" : "<code>", // I R! registered | preliminary | final | amended +
"category" : [{ CodeableConcept }], // IClassification of type of observation
"code" : { CodeableConcept }, // I R! Type of observation (code / type)
"subject" : { Reference(Patient) }, // I R! Who and/or what the observation is about
"focus" : [{ Reference(Resource) }], // IWhat the observation is about, when it is not about the subject of record
"effectiveDateTime" : [ // sliced by type:$this in the specified order, Closed
{ //
{ // Clinically relevant time/time-period for observation // I R!
// from Element: extension
}
],
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"performer" : [{ Reference(Practitioner) }], // IWho is responsible for the observation
// value[x]: Actual result. One of these 9:
"valueQuantity" : { Quantity }, // IActual result
"valueCodeableConcept" : { CodeableConcept }, // IActual result
"valueString" : "<string>", // IActual result
"valueRange" : { Range }, // IActual result
"valueRatio" : { Ratio }, // IActual result
"valueSampledData" : { SampledData }, // IActual result
"valueTime" : "<time>", // IActual result
"valueDateTime" : "<dateTime>", // IActual result
"valuePeriod" : { Period }, // IActual result
"interpretation" : { CodeableConcept }, // IHigh, low, normal, etc.
"note" : [{ Annotation }], // IComments about the observation
"bodySite" : { CodeableConcept }, // IObserved body part
"bodyStructure" : { Reference(BodyStructure) }, // IObserved body structure
"method" : { CodeableConcept }, // IHow it was done
"device" : { Reference(DeviceMetric) }, // I R! (Measurement) Device
"referenceRange" : { BackboneElement }, // IProvides guide for interpretation
"hasMember" : [{ Reference(Observation) }], // IRelated resource that belongs to the Observation group
"derivedFrom" : [{ Reference(Observation) }], // IRelated resource from which the observation is made
"component" : [{ BackboneElement }], // IComponent results
}
This structure is derived from Observation .
Differential View
This
structure
is
derived
from
indicates
the
differences
between
this
profile
and
the
base
Observation
.
structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
0..* | Observation |
Measurements
and
simple
assertions
|
|
|
S | 0..* | Identifier |
Business
Identifier
for
observation
|
|
S | 1..1 | code | registered | preliminary | final | amended + |
|
S | 1..1 | CodeableConcept | Type of observation (code / type) |
|
S | 1..1 | Reference ( Patient | Device ) | Who and/or what the observation is about |
|
0 .. 0 | |||
|
S | 1..1 | dateTime | Clinically relevant time/time-period for observation |
|
0 .. 0 | |||
|
S | 0..1 | Actual result | |
|
Quantity | |||
|
CodeableConcept | |||
|
string | |||
|
Range | |||
|
Ratio | |||
|
SampledData | |||
|
time | |||
|
dateTime | |||
|
Period | |||
|
0 .. 0 | |||
|
0..1 | CodeableConcept | High, low, normal, etc. | |
|
0..* | Annotation |
Comments
about
the
observation
|
|
|
S | 0..1 | CodeableConcept | Observed body part |
|
S | 0..1 | CodeableConcept | How it was done |
|
0 .. 0 | |||
|
S | 1..1 | Reference ( DeviceMetric ) | (Measurement) Device |
|
S | 0..1 | BackboneElement | Provides guide for interpretation |
|
S | 0..* | Reference ( Observation ) |
Related
resource
that
belongs
to
the
Observation
group
|
|
S | 0..* | Reference ( Observation ) |
Related
|
Documentation
for
this
format
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Observation structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
|
0..* | Observation |
Measurements
and
simple
assertions
|
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( preferred ): IETF language tag
|
|||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S Σ | 0..* | Identifier |
Business
Identifier
for
observation
|
||||
| Σ | 0..1 | canonical ( ObservationDefinition ), Reference ( ObservationDefinition ) | Instantiates FHIR ObservationDefinition | ||||
![]() ![]() |
Σ | 0..* | Reference ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) |
Fulfills
plan,
proposal
or
order
|
||||
| 0..* | BackboneElement |
Triggering
observation(s)
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | Σ | 1..1 | Reference ( Observation ) | Triggering observation | ||||
![]() ![]() ![]() | Σ | 1..1 | code |
reflex
|
repeat
|
re-run
Binding: triggeredBytype ( required ): The type of TriggeredBy Observation. | ||||
![]() ![]() ![]() | 0..1 | string | Reason that the observation was triggered | |||||
|
Σ | 0..* |
Reference
(
MedicationAdministration
|
MedicationDispense
|
|
Part
of
referenced
event
|
||||
|
?! S Σ | 1..1 | code |
registered
|
preliminary
|
final
|
amended
+
Binding: ObservationStatus ( required ): Codes providing the status of an observation. |
||||
|
0..* | CodeableConcept |
Classification
of
type
of
observation
Binding: Observation Category Codes ( preferred ): Codes for high level observation categories. |
|||||
|
S Σ | 1..1 | CodeableConcept |
Type
of
observation
(code
/
type)
Binding: LOINC Codes ( example ): Codes identifying names of simple observations. |
||||
|
S Σ | 1..1 | Reference ( Patient | Device ) | Who and/or what the observation is about | ||||
|
Σ TU | 0..* | Reference ( Resource ) |
What
the
observation
is
about,
when
it
is
not
about
the
subject
of
record
|
||||
|
Σ | 1 .. 1 | dateTime |
Clinically
relevant
time/time-period
for
observation
Slice: Unordered, Closed by type:$this |
||||
|
S Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation | ||||
|
Σ | 0..* | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson ) |
Who
is
responsible
for
the
observation
|
||||
|
S
Σ
|
0..1 | Actual result | |||||
|
Quantity | |||||||
|
CodeableConcept | |||||||
|
string | |||||||
|
Range | |||||||
|
Ratio | |||||||
|
SampledData | |||||||
|
time | |||||||
|
dateTime | |||||||
|
Period | |||||||
|
0..1 | CodeableConcept |
High,
low,
normal,
etc.
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations. |
|||||
|
0..* | Annotation |
Comments
about
the
observation
|
|||||
|
S | 0..1 | CodeableConcept |
Observed
body
part
Binding: SNOMED CT Body Structures ( example ): SNOMED CT Body site concepts |
||||
|
C
![]() | 0..1 | Reference ( BodyStructure ) | Observed body structure | ||||
![]() ![]() |
S | 0..1 | CodeableConcept |
How
it
was
done
Binding: Observation Methods ( example ): Methods for simple observations. |
||||
|
S | 1..1 | Reference ( DeviceMetric ) | (Measurement) Device | ||||
|
S
|
0..1 | BackboneElement |
Provides
guide
for
interpretation
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
C
![]() | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
![]() ![]() ![]() |
|
0..1 | SimpleQuantity |
|
||||
|
|
0..1 |
|
Binding: Observation Reference Range Normal Value Codes ( extensible ): Codes identifying the normal value of the observation. |
||||
|
0..1 | CodeableConcept |
Reference
range
qualifier
Binding: Observation Reference Range Meaning Codes ( preferred ): Code for the meaning of a reference range. |
|||||
|
0..* | CodeableConcept |
Reference
range
population
Binding: Observation Reference Range Applies To Codes ( example ): Codes identifying the population the reference range applies to. |
|||||
|
0..1 | Range | Applicable age range, if relevant | |||||
|
0..1 | string | Text based reference range in an observation | |||||
|
S Σ | 0..* | Reference ( Observation ) |
Related
resource
that
belongs
to
the
Observation
group
|
||||
|
S Σ | 0..* | Reference ( Observation ) |
Related
|
||||
|
Σ | 0..* | BackboneElement |
Component
results
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | CodeableConcept |
Type
of
component
observation
(code
/
type)
Binding: LOINC Codes ( example ): Codes identifying names of simple observations. |
||||
|
Σ | 0..1 | Actual component result | |||||
|
Quantity | |||||||
|
CodeableConcept | |||||||
|
string | |||||||
|
boolean | |||||||
|
integer | |||||||
|
Range | |||||||
|
Ratio | |||||||
|
SampledData | |||||||
|
time | |||||||
|
dateTime | |||||||
|
Period | |||||||
|
Attachment | |||||||
|
|
0..1 | CodeableConcept |
Why
the
component
result
is
missing
Binding: DataAbsentReason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing. |
||||
|
0..* | CodeableConcept |
High,
low,
normal,
etc.
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations. |
|||||
|
0..* | See referenceRange (Observation) |
Provides
guide
for
interpretation
of
component
result
|
|||||
Documentation
for
this
format
|
||||||||
XML Template
<!-- Device Metric Observation Profile --><Observation xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
<</meta> < < <<meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text><</contained><contained><!-- 0..* Resource Contained, inline Resources --></contained> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- I 0..* Identifier Business Identifier for observation --></identifier><</basedOn> <</partOf> < <</category> <</code> <<instantiates[x]><!-- I 0..1 canonical|Reference(ObservationDefinition) Instantiates FHIR ObservationDefinition --></instantiates[x]> <basedOn><!-- I 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn> <triggeredBy> I 0..* BackboneElement <!-- I 0..* Triggering observation(s) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <observation><!-- I 1..1 Reference(Observation) Triggering observation --></observation> <type value="[code]"/><!-- I 1..1 reflex | repeat | re-run --> <reason value="[string]"/><!-- I 0..1 Reason that the observation was triggered --> </triggeredBy> <partOf><!-- I 0..* Reference(MedicationAdministration) Part of referenced event --></partOf> <status value="[code]"/><!-- I 1..1 registered | preliminary | final | amended + --> <category><!-- I 0..* CodeableConcept Classification of type of observation --></category> <code><!-- I 1..1 CodeableConcept Type of observation (code / type) --></code> <subject><!-- I 1..1 Reference(Patient) Who and/or what the observation is about --></subject><<focus><!-- I 0..* Reference(Resource) What the observation is about, when it is not about the subject of record --></focus><<encounter><!-- I 0..0 Reference(Encounter) Healthcare event during which this observation is made --></encounter> <-- effectiveDateTime sliced by type:$this in the specified orderClosed-->< < <<effectiveDateTime value="[dateTime]"/><!-- I 1..1 Clinically relevant time/time-period for observation --> <issued value="[instant]"/><!-- I 0..0 Date/Time this version was made available --> <performer><!-- I 0..* Reference(Practitioner) Who is responsible for the observation --></performer><|<value[x]><!-- I 0..1 Quantity|CodeableConcept|string|Range|Ratio| SampledData|time|dateTime|Period Actual result --></value[x]><</dataAbsentReason> <</interpretation> <</note> <</bodySite> <</method> <</specimen> <</device> <<dataAbsentReason><!-- I 0..0 CodeableConcept Why the result is missing --></dataAbsentReason> <interpretation><!-- I 0..1 CodeableConcept High, low, normal, etc. --></interpretation> <note><!-- I 0..* Annotation Comments about the observation --></note> <bodySite><!-- I 0..1 CodeableConcept Observed body part --></bodySite> <bodyStructure><!-- I 0..1 Reference(BodyStructure) Observed body structure --></bodyStructure> <method><!-- I 0..1 CodeableConcept How it was done --></method> <specimen><!-- I 0..0 Reference(Specimen) Specimen used for this observation --></specimen> <device><!-- I 1..1 Reference(DeviceMetric) (Measurement) Device --></device> <referenceRange> I 0..1 BackboneElement <!-- I 0..1 Provides guide for interpretation --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <low><!-- I 0..1 Quantity Low Range, if relevant --></low><<high><!-- I 0..1 Quantity High Range, if relevant --></high><</type> <</appliesTo> <<normalValue><!-- I 0..1 CodeableConcept Normal value, if relevant --></normalValue> <type><!-- I 0..1 CodeableConcept Reference range qualifier --></type> <appliesTo><!-- I 0..* CodeableConcept Reference range population --></appliesTo> <age><!-- I 0..1 Range Applicable age range, if relevant --></age><<text value="[string]"/><!-- I 0..1 Text based reference range in an observation --> </referenceRange><<hasMember><!-- I 0..* Reference(Observation) Related resource that belongs to the Observation group --></hasMember>< Related measurements the observation is made from</derivedFrom> <<derivedFrom><!-- I 0..* Reference(Observation) Related resource from which the observation is made --></derivedFrom> <component> I 0..* BackboneElement <!-- I 0..* Component results --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> <| Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 1..1 CodeableConcept Type of component observation (code / type) --></code> <value[x]><!-- I 0..1 Quantity|CodeableConcept|string| boolean|integer|Range|Ratio|SampledData|time|dateTime|Period|Attachment Actual component result --></value[x]><</dataAbsentReason> <</interpretation><dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc. --></interpretation> <referenceRange><!-- See http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange Provides guide for interpretation of component result --></referenceRange> </component> </Observation>
JSON Template
{ // Device Metric Observation Profile
// from Element: extension
"
"
"
"
"
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"
"
"
"
"
"
"
"
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"identifier" : [{ Identifier }], // IBusiness Identifier for observation
// value[x]: Instantiates FHIR ObservationDefinition. One of these 2:
"instantiatesCanonical" : "<canonical>", // IInstantiates FHIR ObservationDefinition
"instantiatesReference" : { Reference(ObservationDefinition) }, // IInstantiates FHIR ObservationDefinition
"basedOn" : [{ Reference(CarePlan) }], // IFulfills plan, proposal or order
"triggeredBy" : [{ BackboneElement }], // ITriggering observation(s)
"partOf" : [{ Reference(MedicationAdministration) }], // IPart of referenced event
"status" : "<code>", // I R! registered | preliminary | final | amended +
"category" : [{ CodeableConcept }], // IClassification of type of observation
"code" : { CodeableConcept }, // I R! Type of observation (code / type)
"subject" : { Reference(Patient) }, // I R! Who and/or what the observation is about
"focus" : [{ Reference(Resource) }], // IWhat the observation is about, when it is not about the subject of record
"effectiveDateTime" : [ // sliced by type:$this in the specified order, Closed
{ //
{ // Clinically relevant time/time-period for observation // I R!
// from Element: extension
}
],
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"performer" : [{ Reference(Practitioner) }], // IWho is responsible for the observation
// value[x]: Actual result. One of these 9:
"valueQuantity" : { Quantity }, // IActual result
"valueCodeableConcept" : { CodeableConcept }, // IActual result
"valueString" : "<string>", // IActual result
"valueRange" : { Range }, // IActual result
"valueRatio" : { Ratio }, // IActual result
"valueSampledData" : { SampledData }, // IActual result
"valueTime" : "<time>", // IActual result
"valueDateTime" : "<dateTime>", // IActual result
"valuePeriod" : { Period }, // IActual result
"interpretation" : { CodeableConcept }, // IHigh, low, normal, etc.
"note" : [{ Annotation }], // IComments about the observation
"bodySite" : { CodeableConcept }, // IObserved body part
"bodyStructure" : { Reference(BodyStructure) }, // IObserved body structure
"method" : { CodeableConcept }, // IHow it was done
"device" : { Reference(DeviceMetric) }, // I R! (Measurement) Device
"referenceRange" : { BackboneElement }, // IProvides guide for interpretation
"hasMember" : [{ Reference(Observation) }], // IRelated resource that belongs to the Observation group
"derivedFrom" : [{ Reference(Observation) }], // IRelated resource from which the observation is made
"component" : [{ BackboneElement }], // IComponent results
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| Observation.language | Common Languages | preferred | Common Languages |
| Observation.triggeredBy.type | triggeredBytype | required | triggeredBytype |
| Observation.status | ObservationStatus | required | ObservationStatus |
| Observation.category | Observation Category Codes | preferred | Observation Category Codes |
| Observation.code | LOINC Codes | example | LOINC Codes |
| Observation.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
| Observation.bodySite | SNOMED CT Body Structures | example | SNOMED CT Body Structures |
| Observation.method | Observation Methods | example | Observation Methods |
| Observation.referenceRange.normalValue | Observation Reference Range Normal Value Codes | extensible | Observation Reference Range Normal Value Codes |
| Observation.referenceRange.type | Observation Reference Range Meaning Codes | preferred | Observation Reference Range Meaning Codes |
| Observation.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
| Observation.component.code | LOINC Codes | example | LOINC Codes |
| Observation.component.dataAbsentReason | DataAbsentReason | extensible | DataAbsentReason |
| Observation.component.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |