R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.18 Resource DeviceMetric - Content

Health Care Devices icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

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, readings and settings of, or 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 link to the parent Device.

8.18.2 Boundaries and Relationships

These are the 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.

8.18.3 References to this Resource

8.18.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric TUDomainResourceMeasurement, calculation or setting capability of a medical device

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

... type Σ1..1CodeableConceptIdentity of metric, for example Heart Rate or PEEP Setting
Binding: Device Metric and Component Types (Preferred)
... unit Σ0..1CodeableConceptUnit of Measure for the Metric
Binding: UCUM Codes (Preferred)
... operationalStatus Σ0..1codeon | off | standby | entered-in-error
Binding: Device Metric Operational Status (Required)
... color 0..1codeColor name (from CSS4) or #RRGGBB code
Binding: Color Codes (Names or RGB Values) (Required)
... category Σ1..1codemeasurement | setting | calculation | unspecified
Binding: Device Metric Category (Required)
... measurementFrequency 0..1QuantityIndicates how often the metric is taken or recorded
... calibration 0..*BackboneElementDescribes the calibrations that have been performed or that are required to be performed

.... type 0..1codeunspecified | offset | gain | two-point
Binding: Device Metric Calibration Type (Required)
.... state 0..1codenot-calibrated | calibration-required | calibrated | unspecified
Binding: Device Metric Calibration State (Required)
.... time 0..1instantDescribes 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 IDidentifier : Identifier [0..*]Describes the type of the metric. For example: Heart Rate, PEEP Setting, etctype : CodeableConcept [1..1] « Describes the metric type. (Strength=Preferred)DeviceMetricAndComponentTypes? »Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etcunit : CodeableConcept [0..1] « Describes the unit of the metric. (Strength=Preferred)UCUMCodes? »Describes the link to the Device. This is also known as a channel devicedevice : Reference [1..1] « Device »Indicates current operational state of the device. For example: On, Off, Standby, etcoperationalStatus : code [0..1] « null (Strength=Required)DeviceMetricOperationalStatus! »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 magentacolor : 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 calculationcategory : 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. 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 measuredmeasurementFrequency : Quantity [0..1]CalibrationDescribes the type of the calibration methodtype : code [0..1] « null (Strength=Required)DeviceMetricCalibrationType! »Describes the state of the calibrationstate : code [0..1] « null (Strength=Required)DeviceMetricCalibrationState! »Describes the time last calibration has been performedtime : instant [0..1]Describes the calibrations that have been performed or that are required to be performedcalibration[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>
 <type><!-- 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting --></type>
 <unit><!-- 0..1 CodeableConcept Unit of Measure for the Metric --></unit>
 <device><!-- 1..1 Reference(Device) Describes the link to the Device --></device>
 <operationalStatus value="[code]"/><!-- 0..1 on | off | standby | entered-in-error -->
 <color value="[code]"/><!-- 0..1 Color name (from CSS4) or #RRGGBB code -->
 <category value="[code]"/><!-- 1..1 measurement | setting | calculation | unspecified -->
 <measurementFrequency><!-- 0..1 Quantity Indicates how often the metric is taken or recorded --></measurementFrequency>
 <calibration>  <!-- 0..* Describes the calibrations that have been performed or that are required to be performed -->
  <type value="[code]"/><!-- 0..1 unspecified | offset | gain | two-point -->
  <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 Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Instance identifier
  fhir:type [ CodeableConcept ] ; # 1..1 Identity of metric, for example Heart Rate or PEEP Setting
  fhir:unit [ CodeableConcept ] ; # 0..1 Unit of Measure for the Metric
  fhir:device [ Reference(Device) ] ; # 1..1 Describes the link to the Device
  fhir:operationalStatus [ code ] ; # 0..1 on | off | standby | entered-in-error
  fhir:color [ code ] ; # 0..1 Color name (from CSS4) or #RRGGBB code
  fhir:category [ code ] ; # 1..1 measurement | setting | calculation | unspecified
  fhir:measurementFrequency [ Quantity ] ; # 0..1 Indicates how often the metric is taken or recorded
  fhir:calibration ( [ # 0..* Describes the calibrations that have been performed or that are required to be performed
    fhir:type [ code ] ; # 0..1 unspecified | offset | gain | two-point
    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.device
  • Added Mandatory Element
DeviceMetric.color
DeviceMetric.measurementFrequency
  • Added Element
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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric TUDomainResourceMeasurement, calculation or setting capability of a medical device

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

... type Σ1..1CodeableConceptIdentity of metric, for example Heart Rate or PEEP Setting
Binding: Device Metric and Component Types (Preferred)
... unit Σ0..1CodeableConceptUnit of Measure for the Metric
Binding: UCUM Codes (Preferred)
... operationalStatus Σ0..1codeon | off | standby | entered-in-error
Binding: Device Metric Operational Status (Required)
... color 0..1codeColor name (from CSS4) or #RRGGBB code
Binding: Color Codes (Names or RGB Values) (Required)
... category Σ1..1codemeasurement | setting | calculation | unspecified
Binding: Device Metric Category (Required)
... measurementFrequency 0..1QuantityIndicates how often the metric is taken or recorded
... calibration 0..*BackboneElementDescribes the calibrations that have been performed or that are required to be performed

.... type 0..1codeunspecified | offset | gain | two-point
Binding: Device Metric Calibration Type (Required)
.... state 0..1codenot-calibrated | calibration-required | calibrated | unspecified
Binding: Device Metric Calibration State (Required)
.... time 0..1instantDescribes 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 IDidentifier : Identifier [0..*]Describes the type of the metric. For example: Heart Rate, PEEP Setting, etctype : CodeableConcept [1..1] « Describes the metric type. (Strength=Preferred)DeviceMetricAndComponentTypes? »Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etcunit : CodeableConcept [0..1] « Describes the unit of the metric. (Strength=Preferred)UCUMCodes? »Describes the link to the Device. This is also known as a channel devicedevice : Reference [1..1] « Device »Indicates current operational state of the device. For example: On, Off, Standby, etcoperationalStatus : code [0..1] « null (Strength=Required)DeviceMetricOperationalStatus! »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 magentacolor : 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 calculationcategory : 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. 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 measuredmeasurementFrequency : Quantity [0..1]CalibrationDescribes the type of the calibration methodtype : code [0..1] « null (Strength=Required)DeviceMetricCalibrationType! »Describes the state of the calibrationstate : code [0..1] « null (Strength=Required)DeviceMetricCalibrationState! »Describes the time last calibration has been performedtime : instant [0..1]Describes the calibrations that have been performed or that are required to be performedcalibration[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>
 <type><!-- 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting --></type>
 <unit><!-- 0..1 CodeableConcept Unit of Measure for the Metric --></unit>
 <device><!-- 1..1 Reference(Device) Describes the link to the Device --></device>
 <operationalStatus value="[code]"/><!-- 0..1 on | off | standby | entered-in-error -->
 <color value="[code]"/><!-- 0..1 Color name (from CSS4) or #RRGGBB code -->
 <category value="[code]"/><!-- 1..1 measurement | setting | calculation | unspecified -->
 <measurementFrequency><!-- 0..1 Quantity Indicates how often the metric is taken or recorded --></measurementFrequency>
 <calibration>  <!-- 0..* Describes the calibrations that have been performed or that are required to be performed -->
  <type value="[code]"/><!-- 0..1 unspecified | offset | gain | two-point -->
  <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 Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Instance identifier
  fhir:type [ CodeableConcept ] ; # 1..1 Identity of metric, for example Heart Rate or PEEP Setting
  fhir:unit [ CodeableConcept ] ; # 0..1 Unit of Measure for the Metric
  fhir:device [ Reference(Device) ] ; # 1..1 Describes the link to the Device
  fhir:operationalStatus [ code ] ; # 0..1 on | off | standby | entered-in-error
  fhir:color [ code ] ; # 0..1 Color name (from CSS4) or #RRGGBB code
  fhir:category [ code ] ; # 1..1 measurement | setting | calculation | unspecified
  fhir:measurementFrequency [ Quantity ] ; # 0..1 Indicates how often the metric is taken or recorded
  fhir:calibration ( [ # 0..* Describes the calibrations that have been performed or that are required to be performed
    fhir:type [ code ] ; # 0..1 unspecified | offset | gain | two-point
    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.device
  • Added Mandatory Element
DeviceMetric.color
DeviceMetric.measurementFrequency
  • Added Element
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

PathValueSetTypeDocumentation
DeviceMetric.type DeviceMetricAndComponentTypes (a valid code from ISO 11073-10101 Health informatics - Point-of-care 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.operationalStatus DeviceMetricOperationalStatus Required

Describes the operational status of the DeviceMetric.
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.category DeviceMetricCategory Required

Describes the category of the metric.
DeviceMetric.calibration.type DeviceMetricCalibrationType Required

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.

NameTypeDescriptionExpressionIn Common
categorytokenThe category of the metricDeviceMetric.category
devicereferenceThe device resourceDeviceMetric.device
(Device)
identifiertokenThe identifier of the metricDeviceMetric.identifier
typetokenThe type of metricDeviceMetric.type