Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Orders and Observations icon Work Group Maturity Level: 0Trial 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+1000 as a draft by Health Level Seven International (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 indicates the differences between this profile and the base Observation structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements and simple assertions
... identifier S0..*IdentifierBusiness Identifier for observation
... status S1..1coderegistered | preliminary | final | amended +
... code S1..1CodeableConceptType of observation (code / type)
... encounter 0..0
... effectiveDateTime S1..1dateTimeClinically relevant time/time-period for observation
... issued 0..0
... value[x] S0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason 0..0
... interpretation 0..1CodeableConceptHigh, low, normal, etc
... note 0..*AnnotationComments about the observation
... bodySite S0..1CodeableConceptObserved body part
... method S0..1CodeableConceptHow it was done
... specimen 0..0
... device S1..1Reference(DeviceMetric)A reference to the device that generates the measurements or the device settings for the device
... referenceRange S0..1BackboneElementProvides guide for interpretation
... hasMember S0..*Reference(Observation)Related resource that belongs to the Observation group
... derivedFrom S0..*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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C icon0..*ObservationMeasurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: All Languages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... instantiates[x] ΣTU0..1canonical(ObservationDefinition), Reference(ObservationDefinition)Instantiates FHIR ObservationDefinition
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... triggeredBy TU0..*BackboneElementTriggering observation(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... observation Σ1..1Reference(Observation)Triggering observation
.... type Σ1..1codereflex | repeat | re-run
Binding: triggered Bytype (required): The type of TriggeredBy Observation.

.... reason 0..1stringReason that the observation was triggered
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy)Part of referenced event
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: Observation Status (required): Codes providing the status of an observation.

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


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

... subject SΣ1..1Reference(Patient | Device)Who and/or what the observation is about
... focus ΣTU0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... Slices for effective[x] Σ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣ1..1dateTimeClinically 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 icon0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... interpretation 0..1CodeableConceptHigh, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite SC icon0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example): SNOMED CT Body site concepts

... bodyStructure C iconTU0..1Reference(BodyStructure)Observed body structure
... method S0..1CodeableConceptHow it was done
Binding: Observation Methods (example): Methods for simple observations.

... device S1..1Reference(DeviceMetric)A reference to the device that generates the measurements or the device settings for the device
... referenceRange SC icon0..1BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C icon0..1SimpleQuantityLow Range, if relevant
.... high C icon0..1SimpleQuantityHigh Range, if relevant
.... normalValue TU0..1CodeableConceptNormal value, if relevant
Binding: Observation Reference Range Normal Value Codes (extensible): Codes identifying the normal value of the observation.

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

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


.... age 0..1RangeApplicable age range, if relevant
.... text C icon0..1markdownText 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 icon0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣC icon1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.

.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... valueAttachmentAttachment
..... valueReferenceReference(MolecularSequence)
.... dataAbsentReason 0..1CodeableConceptWhy the component result is missing
Binding: Data Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, 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

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 | 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><!-- 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) 
     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 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>
{ // 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 | 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! 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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements and simple assertions
... identifier S0..*IdentifierBusiness Identifier for observation
... status S1..1coderegistered | preliminary | final | amended +
... code S1..1CodeableConceptType of observation (code / type)
... encounter 0..0
... effectiveDateTime S1..1dateTimeClinically relevant time/time-period for observation
... issued 0..0
... value[x] S0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason 0..0
... interpretation 0..1CodeableConceptHigh, low, normal, etc
... note 0..*AnnotationComments about the observation
... bodySite S0..1CodeableConceptObserved body part
... method S0..1CodeableConceptHow it was done
... specimen 0..0
... device S1..1Reference(DeviceMetric)A reference to the device that generates the measurements or the device settings for the device
... referenceRange S0..1BackboneElementProvides guide for interpretation
... hasMember S0..*Reference(Observation)Related resource that belongs to the Observation group
... derivedFrom S0..*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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C icon0..*ObservationMeasurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: All Languages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... instantiates[x] ΣTU0..1canonical(ObservationDefinition), Reference(ObservationDefinition)Instantiates FHIR ObservationDefinition
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... triggeredBy TU0..*BackboneElementTriggering observation(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... observation Σ1..1Reference(Observation)Triggering observation
.... type Σ1..1codereflex | repeat | re-run
Binding: triggered Bytype (required): The type of TriggeredBy Observation.

.... reason 0..1stringReason that the observation was triggered
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy)Part of referenced event
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: Observation Status (required): Codes providing the status of an observation.

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


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

... subject SΣ1..1Reference(Patient | Device)Who and/or what the observation is about
... focus ΣTU0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... Slices for effective[x] Σ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣ1..1dateTimeClinically 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 icon0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... interpretation 0..1CodeableConceptHigh, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite SC icon0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example): SNOMED CT Body site concepts

... bodyStructure C iconTU0..1Reference(BodyStructure)Observed body structure
... method S0..1CodeableConceptHow it was done
Binding: Observation Methods (example): Methods for simple observations.

... device S1..1Reference(DeviceMetric)A reference to the device that generates the measurements or the device settings for the device
... referenceRange SC icon0..1BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C icon0..1SimpleQuantityLow Range, if relevant
.... high C icon0..1SimpleQuantityHigh Range, if relevant
.... normalValue TU0..1CodeableConceptNormal value, if relevant
Binding: Observation Reference Range Normal Value Codes (extensible): Codes identifying the normal value of the observation.

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

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


.... age 0..1RangeApplicable age range, if relevant
.... text C icon0..1markdownText 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 icon0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣC icon1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.

.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... valueAttachmentAttachment
..... valueReferenceReference(MolecularSequence)
.... dataAbsentReason 0..1CodeableConceptWhy the component result is missing
Binding: Data Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, 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

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 | 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><!-- 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) 
     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 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

{ // 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 | 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! 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

PathNameConformanceValueSet
Observation.languageAll LanguagesrequiredAll Languages
Observation.triggeredBy.typetriggered Bytyperequiredtriggered Bytype
Observation.statusObservation StatusrequiredObservation Status
Observation.categoryObservation Category CodespreferredObservation Category Codes
Observation.codeLOINC CodesexampleLOINC Codes
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
Observation.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Observation.methodObservation MethodsexampleObservation Methods
Observation.referenceRange.normalValueObservation Reference Range Normal Value CodesextensibleObservation Reference Range Normal Value Codes
Observation.referenceRange.typeObservation Reference Range Meaning CodespreferredObservation Reference Range Meaning Codes
Observation.referenceRange.appliesToObservation Reference Range Applies To CodesexampleObservation Reference Range Applies To Codes
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonData Absent ReasonextensibleData Absent Reason
Observation.component.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
. .