Release 5 FHIR CI-Build

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

8.18 Resource DeviceMetric - Content

Responsible Owner: Health Care Devices icon Work Group Maturity Level : 1   Trial Use Security Category : Anonymous Compartments : No defined compartments Device

Describes a measurement, calculation or setting capability of a device.

8.18.1 Scope and Usage

The DeviceMetric resource describes dynamic properties that characterize a direct or derived, quantitative or qualitative setting, or calculation produced by a medical device i.e, device, i.e., readings and settings of, or from from, the device. The DeviceMetric resource can also be used to describe the properties relevant to the metric such as status, last calibration time and type, measurement mode, color, and to link to the parent Device.

8.18.2 Boundaries and Relationships

These are the DeviceMetric related DeviceMetric-related resources:

  • Device: The physical, virtual, or software device that this DeviceMetric is for. Note that the Device.property element is used to record static characteristics or properties of the Device. DeviceDefinition: Describes a "kind" of device - not a specific instance of the device. Note alternatively to Device the DeviceDefinition.property element may be used to record static characteristics or properties of the DeviceDefinition. .
  • Observation: Used to record the particular value of the DeviceMetric at a point in time.
  • DeviceAlert: Can refer to a DeviceMetric to identify the detector of the alert condition via the device data element.

8.18.3 References to this Resource

8.18.4 Resource Content

Structure

Identity 0..1 Unit Describes the link on | off | standby | entered-in-error Σ 1..1 measurement | setting | calculation | unspecified Binding: Device Metric Category ( Required ) Indicates how often unspecified | offset | gain | two-point
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . DeviceMetric TU DomainResource Measurement, calculation or setting capability of a medical device

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Instance identifier

. . type . status ?! Σ 1..1 code active | inactive | entered-in-error | unknown
Binding: Device Metric Status ( Required )
... operationalStatus Σ 0..1 code on | off | standby | unknown
Binding: Device Metric Operational Status ( Required )
. . . unit type Σ 1..1 CodeableConcept Identity of Measure metric, for the Metric example Heart Rate or PEEP Setting
Binding: UCUM Codes Device Metric and Component Types ( Preferred )
. . . device Σ 1..1 Reference ( Device ) The device to the Device which this DeviceMetric applies
. . operationalStatus . unit Σ 0..1 code CodeableConcept Unit of Measure for the Metric
Binding: Device Metric Operational Status UCUM Codes ( Required Preferred )
. . . color 0..1 code Color name (from CSS4) or #RRGGBB code
Binding: Color Codes (Names or RGB Values) ( Required )
. . category . measurementFrequency 0..1 code Quantity Indicates how often the metric is taken or recorded
. . . measurementFrequency availability Σ 0..1 Quantity CodeableConcept The continuity of the metric is taken or recorded (e.g., measurement)
Binding: Device Metric Availability ( Required )
. . . calibration 0..* BackboneElement Describes the calibrations that have been performed or that are required to be performed

. . . . type 0..1 code CodeableConcept The method of calibration
Binding: Device Metric Calibration Type ( Required Extensible )
. . . . state 0..1 code not-calibrated | calibration-required | calibrated | unspecified
Binding: Device Metric Calibration State ( Required )
. . . . time 0..1 instant Describes the time last calibration has been performed

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

DeviceMetric ( DomainResource ) Instance identifiers assigned to a device, by the device or gateway software, manufacturers, other organizations or owners. For example, handle ID identifier : Identifier [0..*] Describes Indicates current state of the type record (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) DeviceMetricStatus ! » Indicates current operational state of the metric. device. For example: Heart Rate, PEEP Setting, On, Off, Standby, etc type operationalStatus : CodeableConcept code [1..1] [0..1] « null (Strength=Required) DeviceMetricOperationalStatus ! » Describes Indicates the metric type. (Strength=Preferred) category of the observation generation process. A DeviceMetric can be, for example, a setting, measurement, or calculation DeviceMetricAndComponentTypes category ? : CodeableConcept [1..1] « null (Strength=Extensible) DeviceMetricCategory + » Describes the unit that an observed value determined for this metric will have. type of the metric. For example: Percent, Seconds, Heart Rate, PEEP Setting, etc unit type : CodeableConcept [0..1] [1..1] « Describes the unit of the metric. metric type. (Strength=Preferred) UCUMCodes DeviceMetricAndComponentTypes ? » Describes the link The device to the Device. This is also known as which this DeviceMetric applies. The referenced device may be a top-level device or a component of a channel device device : Reference [1..1] « Device » Indicates current operational state of Describes the device. unit that an observed value determined for this metric will have. For example: On, Off, Standby, Percent, Seconds, etc operationalStatus unit : code CodeableConcept [0..1] « null (Strength=Required) Describes the unit of the metric. (Strength=Preferred) DeviceMetricOperationalStatus ! UCUMCodes ? » The preferred color associated with the metric (e.g., display color). This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta color : code [0..1] « null (Strength=Required) ColorCodesOrRGB ! » Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation category : code [1..1] « null (Strength=Required) DeviceMetricCategory ! » The frequency at which the metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the millisecond range, while an NIBP might trigger only once an hour. Less often, the measurementFrequency may be based on a unit other than time, such as distance (e.g. (e.g., for a measuring wheel). The update period may be different than the measurement frequency, if the device does not update the published observed value with the same frequency as it was measured measurementFrequency : Quantity [0..1] Indicates whether the metric is derived (measured) by a continuous means or by an intermittent means availability : CodeableConcept [0..1] « null (Strength=Required) DeviceMetricAvailability ! » Calibration Describes the type of the calibration method type : code CodeableConcept [0..1] « null (Strength=Required) (Strength=Extensible) DeviceMetricCalibrationType ! + » Describes the state of the calibration state : code [0..1] « null (Strength=Required) DeviceMetricCalibrationState ! » Describes the time last calibration has been performed time : instant [0..1] Describes the calibrations that have been performed or that are required to be performed calibration [0..*]

XML Template 

<DeviceMetric xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Instance identifier --></identifier>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown -->
 <operationalStatus value="[code]"/><!-- 0..1 on | off | standby | unknown -->
 <category><!-- 1..1 CodeableConcept The kind of metric represented --></category>

 <type><!-- 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting --></type>
 <device><!-- 1..1 Reference(Device) The device to which this DeviceMetric applies --></device>

 <unit><!-- 0..1 CodeableConcept Unit of Measure for the Metric --></unit>
 <</device>
 <

 <color value="[code]"/><!-- 0..1 Color name (from CSS4) or #RRGGBB code -->
 <
 <</measurementFrequency>

 <measurementFrequency><!-- 0..1 Quantity Indicates how often the metric is taken or recorded --></measurementFrequency>
 <availability><!-- 0..1 CodeableConcept The continuity of the metric (e.g., measurement) --></availability>

 <calibration>  <!-- 0..* Describes the calibrations that have been performed or that are required to be performed -->
  <

  <type><!-- 0..1 CodeableConcept The method of calibration --></type>

  <state value="[code]"/><!-- 0..1 not-calibrated | calibration-required | calibrated | unspecified -->
  <time value="[instant]"/><!-- 0..1 Describes the time last calibration has been performed -->
 </calibration>
</DeviceMetric>

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DeviceMetric;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension

  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Instance identifier
  fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown
  fhir:operationalStatus [ code ] ; # 0..1 on | off | standby | unknown
  fhir:category [ CodeableConcept ] ; # 1..1 The kind of metric represented

  fhir:type [ CodeableConcept ] ; # 1..1 Identity of metric, for example Heart Rate or PEEP Setting
  fhir:device [ Reference(Device) ] ; # 1..1 The device to which this DeviceMetric applies

  fhir:unit [ CodeableConcept ] ; # 0..1 Unit of Measure for the Metric
  fhir:
  fhir:

  fhir:color [ code ] ; # 0..1 Color name (from CSS4) or #RRGGBB code
  fhir:
  fhir:

  fhir:measurementFrequency [ Quantity ] ; # 0..1 Indicates how often the metric is taken or recorded
  fhir:availability [ CodeableConcept ] ; # 0..1 The continuity of the metric (e.g., measurement)

  fhir:calibration ( [ # 0..* Describes the calibrations that have been performed or that are required to be performed
    fhir:

    fhir:type [ CodeableConcept ] ; # 0..1 The method of calibration

    fhir:state [ code ] ; # 0..1 not-calibrated | calibration-required | calibrated | unspecified
    fhir:time [ instant ] ; # 0..1 Describes the time last calibration has been performed
  ] ... ) ;
]

Changes from both R4 and R4B

DeviceMetric
DeviceMetric.status
  • Added Mandatory Element
DeviceMetric.operationalStatus
  • Remove code entered-in-error
  • Add code unknown
DeviceMetric.category
  • Type changed from code to CodeableConcept
  • Change binding strength from required to extensible
DeviceMetric.device
  • Added Mandatory Element
DeviceMetric.color
DeviceMetric.measurementFrequency
  • Added Element
DeviceMetric.availability
  • Added Element
DeviceMetric.calibration.type
  • Type changed from code to CodeableConcept
  • Change binding strength from required to extensible
DeviceMetric.source
  • Deleted
DeviceMetric.parent
  • Deleted
DeviceMetric.measurementPeriod
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

See R4 <--> R5 Conversion Maps (status = See Conversions Summary .)

Structure

Identity 0..1 Unit Describes the link on | off | standby | entered-in-error Σ 1..1 measurement | setting | calculation | unspecified Binding: Device Metric Category ( Required ) Indicates how often unspecified | offset | gain | two-point
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . DeviceMetric TU DomainResource Measurement, calculation or setting capability of a medical device

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Instance identifier

. . type . status ?! Σ 1..1 code active | inactive | entered-in-error | unknown
Binding: Device Metric Status ( Required )
... operationalStatus Σ 0..1 code on | off | standby | unknown
Binding: Device Metric Operational Status ( Required )
. . . unit type Σ 1..1 CodeableConcept Identity of Measure metric, for the Metric example Heart Rate or PEEP Setting
Binding: UCUM Codes Device Metric and Component Types ( Preferred )
. . . device Σ 1..1 Reference ( Device ) The device to the Device which this DeviceMetric applies
. . operationalStatus . unit Σ 0..1 code CodeableConcept Unit of Measure for the Metric
Binding: Device Metric Operational Status UCUM Codes ( Required Preferred )
. . . color 0..1 code Color name (from CSS4) or #RRGGBB code
Binding: Color Codes (Names or RGB Values) ( Required )
. . category . measurementFrequency 0..1 code Quantity Indicates how often the metric is taken or recorded
. . . measurementFrequency availability Σ 0..1 Quantity CodeableConcept The continuity of the metric is taken or recorded (e.g., measurement)
Binding: Device Metric Availability ( Required )
. . . calibration 0..* BackboneElement Describes the calibrations that have been performed or that are required to be performed

. . . . type 0..1 code CodeableConcept The method of calibration
Binding: Device Metric Calibration Type ( Required Extensible )
. . . . state 0..1 code not-calibrated | calibration-required | calibrated | unspecified
Binding: Device Metric Calibration State ( Required )
. . . . time 0..1 instant Describes the time last calibration has been performed

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

DeviceMetric ( DomainResource ) Instance identifiers assigned to a device, by the device or gateway software, manufacturers, other organizations or owners. For example, handle ID identifier : Identifier [0..*] Describes Indicates current state of the type record (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) DeviceMetricStatus ! » Indicates current operational state of the metric. device. For example: Heart Rate, PEEP Setting, On, Off, Standby, etc type operationalStatus : CodeableConcept code [1..1] [0..1] « null (Strength=Required) DeviceMetricOperationalStatus ! » Describes Indicates the metric type. (Strength=Preferred) category of the observation generation process. A DeviceMetric can be, for example, a setting, measurement, or calculation DeviceMetricAndComponentTypes category ? : CodeableConcept [1..1] « null (Strength=Extensible) DeviceMetricCategory + » Describes the unit that an observed value determined for this metric will have. type of the metric. For example: Percent, Seconds, Heart Rate, PEEP Setting, etc unit type : CodeableConcept [0..1] [1..1] « Describes the unit of the metric. metric type. (Strength=Preferred) UCUMCodes DeviceMetricAndComponentTypes ? » Describes the link The device to the Device. This is also known as which this DeviceMetric applies. The referenced device may be a top-level device or a component of a channel device device : Reference [1..1] « Device » Indicates current operational state of Describes the device. unit that an observed value determined for this metric will have. For example: On, Off, Standby, Percent, Seconds, etc operationalStatus unit : code CodeableConcept [0..1] « null (Strength=Required) Describes the unit of the metric. (Strength=Preferred) DeviceMetricOperationalStatus ! UCUMCodes ? » The preferred color associated with the metric (e.g., display color). This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta color : code [0..1] « null (Strength=Required) ColorCodesOrRGB ! » Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation category : code [1..1] « null (Strength=Required) DeviceMetricCategory ! » The frequency at which the metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the millisecond range, while an NIBP might trigger only once an hour. Less often, the measurementFrequency may be based on a unit other than time, such as distance (e.g. (e.g., for a measuring wheel). The update period may be different than the measurement frequency, if the device does not update the published observed value with the same frequency as it was measured measurementFrequency : Quantity [0..1] Indicates whether the metric is derived (measured) by a continuous means or by an intermittent means availability : CodeableConcept [0..1] « null (Strength=Required) DeviceMetricAvailability ! » Calibration Describes the type of the calibration method type : code CodeableConcept [0..1] « null (Strength=Required) (Strength=Extensible) DeviceMetricCalibrationType ! + » Describes the state of the calibration state : code [0..1] « null (Strength=Required) DeviceMetricCalibrationState ! » Describes the time last calibration has been performed time : instant [0..1] Describes the calibrations that have been performed or that are required to be performed calibration [0..*]

XML Template 

<DeviceMetric xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Instance identifier --></identifier>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown -->
 <operationalStatus value="[code]"/><!-- 0..1 on | off | standby | unknown -->
 <category><!-- 1..1 CodeableConcept The kind of metric represented --></category>

 <type><!-- 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting --></type>
 <device><!-- 1..1 Reference(Device) The device to which this DeviceMetric applies --></device>

 <unit><!-- 0..1 CodeableConcept Unit of Measure for the Metric --></unit>
 <</device>
 <

 <color value="[code]"/><!-- 0..1 Color name (from CSS4) or #RRGGBB code -->
 <
 <</measurementFrequency>

 <measurementFrequency><!-- 0..1 Quantity Indicates how often the metric is taken or recorded --></measurementFrequency>
 <availability><!-- 0..1 CodeableConcept The continuity of the metric (e.g., measurement) --></availability>

 <calibration>  <!-- 0..* Describes the calibrations that have been performed or that are required to be performed -->
  <

  <type><!-- 0..1 CodeableConcept The method of calibration --></type>

  <state value="[code]"/><!-- 0..1 not-calibrated | calibration-required | calibrated | unspecified -->
  <time value="[instant]"/><!-- 0..1 Describes the time last calibration has been performed -->
 </calibration>
</DeviceMetric>

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DeviceMetric;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension

  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Instance identifier
  fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown
  fhir:operationalStatus [ code ] ; # 0..1 on | off | standby | unknown
  fhir:category [ CodeableConcept ] ; # 1..1 The kind of metric represented

  fhir:type [ CodeableConcept ] ; # 1..1 Identity of metric, for example Heart Rate or PEEP Setting
  fhir:device [ Reference(Device) ] ; # 1..1 The device to which this DeviceMetric applies

  fhir:unit [ CodeableConcept ] ; # 0..1 Unit of Measure for the Metric
  fhir:
  fhir:

  fhir:color [ code ] ; # 0..1 Color name (from CSS4) or #RRGGBB code
  fhir:
  fhir:

  fhir:measurementFrequency [ Quantity ] ; # 0..1 Indicates how often the metric is taken or recorded
  fhir:availability [ CodeableConcept ] ; # 0..1 The continuity of the metric (e.g., measurement)

  fhir:calibration ( [ # 0..* Describes the calibrations that have been performed or that are required to be performed
    fhir:

    fhir:type [ CodeableConcept ] ; # 0..1 The method of calibration

    fhir:state [ code ] ; # 0..1 not-calibrated | calibration-required | calibrated | unspecified
    fhir:time [ instant ] ; # 0..1 Describes the time last calibration has been performed
  ] ... ) ;
]

Changes from both R4 and R4B

DeviceMetric
DeviceMetric.status
  • Added Mandatory Element
DeviceMetric.operationalStatus
  • Remove code entered-in-error
  • Add code unknown
DeviceMetric.category
  • Type changed from code to CodeableConcept
  • Change binding strength from required to extensible
DeviceMetric.device
  • Added Mandatory Element
DeviceMetric.color
DeviceMetric.measurementFrequency
  • Added Element
DeviceMetric.availability
  • Added Element
DeviceMetric.calibration.type
  • Type changed from code to CodeableConcept
  • Change binding strength from required to extensible
DeviceMetric.source
  • Deleted
DeviceMetric.parent
  • Deleted
DeviceMetric.measurementPeriod
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

See R4 <--> R5 Conversion Maps (status = See Conversions Summary .)

 

Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

8.18.4.1 Terminology Bindings

DeviceMetric.operationalStatus DeviceMetricOperationalStatus Required Describes the operational status of the DeviceMetric. DeviceMetric.category
Path ValueSet Type Documentation
DeviceMetric.status DeviceMetricStatus Required

Describes the status of the DeviceMetric record.

DeviceMetric.operationalStatus DeviceMetricOperationalStatus Required

Describes the operational status of the DeviceMetric.

DeviceMetric.category DeviceMetricCategory Extensible

Describes the category of the metric.

DeviceMetric.type DeviceMetricAndComponentTypes (a valid code from ISO 11073-10101 Health informatics - Point-of-care ISO/IEEE 11073 Medical Device Communication Nomenclature icon ) Preferred

Codes used to identify health care device metric types and units and component types as part of the ISO/IEEE 11073-10101 Medical Device Communication Nomenclature.

DeviceMetric.unit UCUMCodes (a valid code from UCUM icon ) Preferred

Unified Code for Units of Measure (UCUM). This value set includes all UCUM codes

DeviceMetric.color ColorCodesOrRGB Required

This value set includes color codes - either the color names as defined in CSS4 icon , or any valid RGB code ( #RRGGBB in Hex).

DeviceMetric.availability DeviceMetricCategory DeviceMetricAvailability Required

Describes the category The availability of the metric. means from which a device metric state/value is derived.

DeviceMetric.calibration.type DeviceMetricCalibrationType Required Extensible

Describes the type of a metric calibration.

DeviceMetric.calibration.state DeviceMetricCalibrationState Required

Describes the state of a metric calibration.

8.18.5 Notes:

8.18.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
category token The category of the metric DeviceMetric.category
device reference The device resource DeviceMetric.device
( Device )
identifier token The identifier of the metric DeviceMetric.identifier
status token The status of the metric record DeviceMetric.status
type token The type of metric DeviceMetric.type