FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

10.1.13.2 StructureDefinition: DeviceMetricObservationProfile

Orders and Observations icon Work Group  Maturity Level: 0 Trial Use Use Context: Any

The 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 Sat, Aug 11, 2018 00:00+0000 as a draft by HL7 International / Orders and Observations.

10.1.13.2.1 Formal Views of Profile Content

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 indicates the differences between this profile and the base Observation structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Observation 0..* Observation Measurements and simple assertions
... identifier S 0..* Identifier Business Identifier for observation
... status S 1..1 code registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
... code S 1..1 CodeableConcept Type of observation (code / type)
... subject S 1..1 Reference(Patient | Device) Who and/or what the observation is about
... encounter 0..0
... effectiveDateTime S 1..1 dateTime Clinically relevant time/time-period for observation
... issued 0..0
... value[x] S 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason 0..0
... interpretation 0..1 CodeableConcept High, low, normal, etc
... note 0..* Annotation Comments about the observation
... bodySite S 0..1 CodeableConcept Observed body part
... method S 0..1 CodeableConcept How it was done
... specimen 0..0
... device S 1..1 Reference(DeviceMetric) A reference to the device that generates the measurements or the device settings for the device
... referenceRange S 0..1 BackboneElement Provides guide for interpretation
... hasMember S 0..* Reference(Observation) Related resource that belongs to the Observation group
... derivedFrom S 0..* Reference(Observation) Related resource from which the observation is made

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Observation structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Observation C icon 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).
obs-8: bodyStructure SHALL only be present if Observation.bodySite is not present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Business Identifier for observation
... instantiates[x] Σ 0..1 canonical(ObservationDefinition), Reference(ObservationDefinition) Instantiates FHIR ObservationDefinition
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... triggeredBy 0..* BackboneElement Triggering observation(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observation Σ 1..1 Reference(Observation) Triggering observation
.... type Σ 1..1 code reflex | repeat | re-run
Binding: triggered Bytype (required): The type of TriggeredBy Observation.

.... reason 0..1 string Reason that the observation was triggered
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) Part of referenced event
... status ?!SΣ 1..1 code registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Binding: Observation Status (required): Codes providing the status of an observation.

... category 0..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


... code SΣC icon 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.

... subject SΣ 1..1 Reference(Patient | Device) Who and/or what the observation is about
... focus ?!Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... Slices for effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣ 1..1 dateTime Clinically relevant time/time-period for observation
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... value[x] SΣC icon 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... interpretation 0..1 CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.


... note 0..* Annotation Comments about the observation
... bodySite SC icon 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures (example): SNOMED CT Body site concepts

... bodyStructure C icon 0..1 Reference(BodyStructure) Observed body structure
... method S 0..1 CodeableConcept How it was done
Binding: Observation Methods (example): Methods for simple observations.

... device S 1..1 Reference(DeviceMetric) A reference to the device that generates the measurements or the device settings for the device
... referenceRange SC icon 0..1 BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C icon 0..1 SimpleQuantity Low Range, if relevant
.... high C icon 0..1 SimpleQuantity High Range, if relevant
.... normalValue 0..1 CodeableConcept Normal value, if relevant
Binding: Observation Reference Range Normal Value Codes (extensible): Codes identifying the normal value of the observation.

.... type 0..1 CodeableConcept Reference range qualifier
Binding: Observation Reference Range Meaning Codes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: Observation Reference Range Applies To Codes (example): Codes identifying the population the reference range applies to.


.... age 0..1 Range Applicable age range, if relevant
.... text C icon 0..1 markdown Text based reference range in an observation
... hasMember SΣ 0..* Reference(Observation) Related resource that belongs to the Observation group
... derivedFrom SΣ 0..* Reference(Observation) Related resource from which the observation is made
... component ΣC icon 0..* BackboneElement Component results
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code ΣC icon 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... valueAttachment Attachment
..... valueReference Reference(MolecularSequence)
.... dataAbsentReason 0..1 CodeableConcept Why the component result value is missing
Binding: Data Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..* CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result value

doco Documentation for this format icon
<!-- DeviceMetricObservationProfile -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <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><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Business Identifier for observation --></identifier>
 <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 | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained   -->
 <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><!-- I 0..0 CodeableConcept Why the result value 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) 
     A reference to the device that generates the measurements or the device settings for the device --></device>
 <referenceRange> I 0..1 BackboneElement  <!-- I 0..1 Provides guide for interpretation -->
  <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>
  <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="[markdown]"/><!-- 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>
 <derivedFrom><!-- I 0..* Reference(Observation) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->
  <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|
    Reference(MolecularSequence) Actual component result --></value[x]>
  <dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result value 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 value --></referenceRange>
 </component>
</Observation>

{ // DeviceMetricObservationProfile
  // 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
    "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 | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
    "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! A reference to the device that generates the measurements or the device settings for the 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.

Summary

Mandatory: 5 elements
Must-Support: 12 elements
Prohibited: 4 elements

Differential View

This indicates the differences between this profile and the base Observation structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Observation 0..* Observation Measurements and simple assertions
... identifier S 0..* Identifier Business Identifier for observation
... status S 1..1 code registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
... code S 1..1 CodeableConcept Type of observation (code / type)
... subject S 1..1 Reference(Patient | Device) Who and/or what the observation is about
... encounter 0..0
... effectiveDateTime S 1..1 dateTime Clinically relevant time/time-period for observation
... issued 0..0
... value[x] S 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason 0..0
... interpretation 0..1 CodeableConcept High, low, normal, etc
... note 0..* Annotation Comments about the observation
... bodySite S 0..1 CodeableConcept Observed body part
... method S 0..1 CodeableConcept How it was done
... specimen 0..0
... device S 1..1 Reference(DeviceMetric) A reference to the device that generates the measurements or the device settings for the device
... referenceRange S 0..1 BackboneElement Provides guide for interpretation
... hasMember S 0..* Reference(Observation) Related resource that belongs to the Observation group
... derivedFrom S 0..* Reference(Observation) Related resource from which the observation is made

doco Documentation for this format icon

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 iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Observation C icon 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).
obs-8: bodyStructure SHALL only be present if Observation.bodySite is not present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Business Identifier for observation
... instantiates[x] Σ 0..1 canonical(ObservationDefinition), Reference(ObservationDefinition) Instantiates FHIR ObservationDefinition
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... triggeredBy 0..* BackboneElement Triggering observation(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observation Σ 1..1 Reference(Observation) Triggering observation
.... type Σ 1..1 code reflex | repeat | re-run
Binding: triggered Bytype (required): The type of TriggeredBy Observation.

.... reason 0..1 string Reason that the observation was triggered
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) Part of referenced event
... status ?!SΣ 1..1 code registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Binding: Observation Status (required): Codes providing the status of an observation.

... category 0..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


... code SΣC icon 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.

... subject SΣ 1..1 Reference(Patient | Device) Who and/or what the observation is about
... focus ?!Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... Slices for effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣ 1..1 dateTime Clinically relevant time/time-period for observation
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... value[x] SΣC icon 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... interpretation 0..1 CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.


... note 0..* Annotation Comments about the observation
... bodySite SC icon 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures (example): SNOMED CT Body site concepts

... bodyStructure C icon 0..1 Reference(BodyStructure) Observed body structure
... method S 0..1 CodeableConcept How it was done
Binding: Observation Methods (example): Methods for simple observations.

... device S 1..1 Reference(DeviceMetric) A reference to the device that generates the measurements or the device settings for the device
... referenceRange SC icon 0..1 BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C icon 0..1 SimpleQuantity Low Range, if relevant
.... high C icon 0..1 SimpleQuantity High Range, if relevant
.... normalValue 0..1 CodeableConcept Normal value, if relevant
Binding: Observation Reference Range Normal Value Codes (extensible): Codes identifying the normal value of the observation.

.... type 0..1 CodeableConcept Reference range qualifier
Binding: Observation Reference Range Meaning Codes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: Observation Reference Range Applies To Codes (example): Codes identifying the population the reference range applies to.


.... age 0..1 Range Applicable age range, if relevant
.... text C icon 0..1 markdown Text based reference range in an observation
... hasMember SΣ 0..* Reference(Observation) Related resource that belongs to the Observation group
... derivedFrom SΣ 0..* Reference(Observation) Related resource from which the observation is made
... component ΣC icon 0..* BackboneElement Component results
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code ΣC icon 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... valueAttachment Attachment
..... valueReference Reference(MolecularSequence)
.... dataAbsentReason 0..1 CodeableConcept Why the component result value is missing
Binding: Data Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..* CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result value

doco Documentation for this format icon

XML Template

<!-- DeviceMetricObservationProfile -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <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><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Business Identifier for observation --></identifier>
 <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 | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained   -->
 <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><!-- I 0..0 CodeableConcept Why the result value 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) 
     A reference to the device that generates the measurements or the device settings for the device --></device>
 <referenceRange> I 0..1 BackboneElement  <!-- I 0..1 Provides guide for interpretation -->
  <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>
  <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="[markdown]"/><!-- 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>
 <derivedFrom><!-- I 0..* Reference(Observation) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->
  <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|
    Reference(MolecularSequence) Actual component result --></value[x]>
  <dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result value 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 value --></referenceRange>
 </component>
</Observation>

JSON Template

{ // DeviceMetricObservationProfile
  // 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
    "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 | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
    "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! A reference to the device that generates the measurements or the device settings for the 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

10.1.13.2.2 Terminology Bindings

Path Name Conformance ValueSet
Observation.language All Languages required All Languages
Observation.triggeredBy.type triggered Bytype required triggered Bytype
Observation.status Observation Status required Observation Status
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 Data Absent Reason extensible Data Absent Reason
Observation.component.interpretation Observation Interpretation Codes extensible Observation Interpretation Codes
. .