Release 4 5

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

8.16 8.18 Resource DeviceMetric - Content

Health Care Devices icon Work Group Maturity Level : 1   Trial Use Security Category : Anonymous Compartments : Not linked to any No defined compartments

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

8.16.1 8.18.1 Scope and Usage

The DeviceMetric resource describes mandatory static dynamic properties that characterize a direct or derived, quantitative or qualitative biosignal measurement, 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 non-static but highly relevant properties relevant to the metric such as metric status, metric last calibration time and type, measurement mode, color, reference and link to the parent DeviceComponent to where it belongs, and any capabilities that the metric offers (for example: setting the metric label). Note: For the initial scope, this DeviceMetric resource is only applicable to describe a single metric node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard. Device.

8.16.2 8.18.2 Boundaries and Relationships

There These are two the DeviceMetric related resources resources:

  • Device Device: - The physical physical, virtual, or software device that this DeviceMetric belongs to. 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.
This resource is referenced by Media

8.18.3 References to this Resource

8.16.3 8.18.4 Resource Content

Structure

Σ black | red | green | yellow | blue | magenta | cyan | white Σ Describes Σ Σ Σ Σ
Name Flags Card. Type Description & Constraints 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 Σ 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting
Binding: Device Metric and Component Types ( Preferred )
. . . unit Σ 0..1 CodeableConcept Unit of Measure for the Metric
Device Metric and Component Types Binding: UCUM Codes ( Preferred )
. . parent . operationalStatus Σ 0..1 Reference ( Device ) Describes the link to the parent Device operationalStatus Σ 0..1 code on | off | standby | entered-in-error
DeviceMetricOperationalStatus Binding: Device Metric Operational Status ( Required )
. . . color 0..1 code Color name (from CSS4) or #RRGGBB code
DeviceMetricColor Binding: Color Codes (Names or RGB Values) ( Required )
. . . category Σ 1..1 code measurement | setting | calculation | unspecified
DeviceMetricCategory Binding: Device Metric Category ( Required )
. . measurementPeriod . measurementFrequency 0..1 Timing Quantity Indicates how often the measurement repetition time metric is taken or recorded
. . . calibration 0..* BackboneElement Describes the calibrations that have been performed or that are required to be performed

. . . . type 0..1 code unspecified | offset | gain | two-point
DeviceMetricCalibrationType Binding: Device Metric Calibration Type ( Required )
. . . . state 0..1 code not-calibrated | calibration-required | calibrated | unspecified
DeviceMetricCalibrationState 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 ) Unique instance Instance identifiers assigned to a device device, by the device or gateway software, manufacturers, other organizations or owners. For example: example, handle ID identifier : Identifier [0..*] Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc type : 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, etc unit : CodeableConcept [0..1] « Describes the unit of the metric. (Strength=Preferred) DeviceMetricAndComponentTypes UCUMCodes ? » Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc source : Reference [0..1] « Device » Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by is also known as a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location channel device parent device : Reference [0..1] [1..1] « Device » Indicates current operational state of the device. For example: On, Off, Standby, etc operationalStatus : code [0..1] « Describes the operational status of the DeviceMetric. null (Strength=Required) DeviceMetricOperationalStatus ! » Describes the The preferred color representation for associated with the metric. 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 for example; Pleth; the parameters metrics are displayed in different characteristic colors, such as HR-blue, BP-green, HR in blue, BP in green, and PR and SpO2- SpO2 in magenta color : code [0..1] « Describes the typical color of representation. null (Strength=Required) DeviceMetricColor ColorCodesOrRGB ! » Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation category : code [1..1] « Describes the category of the metric. null (Strength=Required) DeviceMetricCategory ! » Describes The frequency at which the measurement repetition time. This metric is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for taken or recorded. Devices measure metrics at a measurement repetition time in the wide range of milliseconds is the sampling rate of an ECG. An example frequencies; for a measurement repetition time example, an ECG might sample measurements in the range of hours is a millisecond range, while an NIBP that is triggered automatically every 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 repetition time, frequency, if the device does not update the published observed value with the same frequency as it was measured measurementPeriod measurementFrequency : Timing Quantity [0..1] Calibration Describes the type of the calibration method type : code [0..1] « Describes the type of a metric calibration. null (Strength=Required) DeviceMetricCalibrationType ! » Describes the state of the calibration state : code [0..1] « Describes the state of a metric calibration. 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>

 <identifier><!-- 0..* Identifier Instance identifier --></identifier>

 <type><!-- 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting --></type>
 <</unit>
 <</source>
 <</parent>

 <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 -->
 <</measurementPeriod>

 <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:;

[ 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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
  ], ...;

  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 since R3 from both R4 and R4B

DeviceMetric.identifier Min Cardinality changed from 1 to 0 Max Cardinality changed from 1 to *
DeviceMetric
DeviceMetric.parent DeviceMetric.device
  • Type Reference: Added Target Type Device Type Reference: Removed Target Type DeviceComponent Mandatory Element
DeviceMetric.operationalStatus DeviceMetric.color
  • Change value set from http://hl7.org/fhir/ValueSet/metric-operational-status http://hl7.org/fhir/ValueSet/metric-color|4.0.0 to http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1 Color Codes (Names or RGB Values)
DeviceMetric.color DeviceMetric.measurementFrequency
  • Change value set from http://hl7.org/fhir/ValueSet/metric-color to http://hl7.org/fhir/ValueSet/metric-color|4.0.1 Added Element
DeviceMetric.category DeviceMetric.source
  • Change value set from http://hl7.org/fhir/ValueSet/metric-category to http://hl7.org/fhir/ValueSet/metric-category|4.0.1 Deleted
DeviceMetric.calibration.type DeviceMetric.parent
  • Change value set from http://hl7.org/fhir/ValueSet/metric-calibration-type to http://hl7.org/fhir/ValueSet/metric-calibration-type|4.0.1 Deleted
DeviceMetric.calibration.state DeviceMetric.measurementPeriod
  • Change value set from http://hl7.org/fhir/ValueSet/metric-calibration-state to http://hl7.org/fhir/ValueSet/metric-calibration-state|4.0.1 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 R3 <--> R4 <--> R5 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.) See Conversions Summary .)

Structure

Σ black | red | green | yellow | blue | magenta | cyan | white Σ Describes Σ Σ Σ Σ
Name Flags Card. Type Description & Constraints 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 Σ 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting
Binding: Device Metric and Component Types ( Preferred )
. . . unit Σ 0..1 CodeableConcept Unit of Measure for the Metric
Device Metric and Component Types Binding: UCUM Codes ( Preferred )
. . parent . operationalStatus Σ 0..1 Reference ( Device ) Describes the link to the parent Device operationalStatus Σ 0..1 code on | off | standby | entered-in-error
DeviceMetricOperationalStatus Binding: Device Metric Operational Status ( Required )
. . . color 0..1 code Color name (from CSS4) or #RRGGBB code
DeviceMetricColor Binding: Color Codes (Names or RGB Values) ( Required )
. . . category Σ 1..1 code measurement | setting | calculation | unspecified
DeviceMetricCategory Binding: Device Metric Category ( Required )
. . measurementPeriod . measurementFrequency 0..1 Timing Quantity Indicates how often the measurement repetition time metric is taken or recorded
. . . calibration 0..* BackboneElement Describes the calibrations that have been performed or that are required to be performed

. . . . type 0..1 code unspecified | offset | gain | two-point
DeviceMetricCalibrationType Binding: Device Metric Calibration Type ( Required )
. . . . state 0..1 code not-calibrated | calibration-required | calibrated | unspecified
DeviceMetricCalibrationState 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 ) Unique instance Instance identifiers assigned to a device device, by the device or gateway software, manufacturers, other organizations or owners. For example: example, handle ID identifier : Identifier [0..*] Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc type : 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, etc unit : CodeableConcept [0..1] « Describes the unit of the metric. (Strength=Preferred) DeviceMetricAndComponentTypes UCUMCodes ? » Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc source : Reference [0..1] « Device » Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by is also known as a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location channel device parent device : Reference [0..1] [1..1] « Device » Indicates current operational state of the device. For example: On, Off, Standby, etc operationalStatus : code [0..1] « Describes the operational status of the DeviceMetric. null (Strength=Required) DeviceMetricOperationalStatus ! » Describes the The preferred color representation for associated with the metric. 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 for example; Pleth; the parameters metrics are displayed in different characteristic colors, such as HR-blue, BP-green, HR in blue, BP in green, and PR and SpO2- SpO2 in magenta color : code [0..1] « Describes the typical color of representation. null (Strength=Required) DeviceMetricColor ColorCodesOrRGB ! » Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation category : code [1..1] « Describes the category of the metric. null (Strength=Required) DeviceMetricCategory ! » Describes The frequency at which the measurement repetition time. This metric is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for taken or recorded. Devices measure metrics at a measurement repetition time in the wide range of milliseconds is the sampling rate of an ECG. An example frequencies; for a measurement repetition time example, an ECG might sample measurements in the range of hours is a millisecond range, while an NIBP that is triggered automatically every 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 repetition time, frequency, if the device does not update the published observed value with the same frequency as it was measured measurementPeriod measurementFrequency : Timing Quantity [0..1] Calibration Describes the type of the calibration method type : code [0..1] « Describes the type of a metric calibration. null (Strength=Required) DeviceMetricCalibrationType ! » Describes the state of the calibration state : code [0..1] « Describes the state of a metric calibration. 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>

 <identifier><!-- 0..* Identifier Instance identifier --></identifier>

 <type><!-- 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting --></type>
 <</unit>
 <</source>
 <</parent>

 <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 -->
 <</measurementPeriod>

 <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:;

[ 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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
  ], ...;

  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 since Release 3 from both R4 and R4B

DeviceMetric.identifier Min Cardinality changed from 1 to 0 Max Cardinality changed from 1 to *
DeviceMetric
DeviceMetric.parent DeviceMetric.device
  • Type Reference: Added Target Type Device Type Reference: Removed Target Type DeviceComponent Mandatory Element
DeviceMetric.operationalStatus DeviceMetric.color
  • Change value set from http://hl7.org/fhir/ValueSet/metric-operational-status http://hl7.org/fhir/ValueSet/metric-color|4.0.0 to http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1 Color Codes (Names or RGB Values)
DeviceMetric.color DeviceMetric.measurementFrequency
  • Change value set from http://hl7.org/fhir/ValueSet/metric-color to http://hl7.org/fhir/ValueSet/metric-color|4.0.1 Added Element
DeviceMetric.category DeviceMetric.source
  • Change value set from http://hl7.org/fhir/ValueSet/metric-category to http://hl7.org/fhir/ValueSet/metric-category|4.0.1 Deleted
DeviceMetric.calibration.type DeviceMetric.parent
  • Change value set from http://hl7.org/fhir/ValueSet/metric-calibration-type to http://hl7.org/fhir/ValueSet/metric-calibration-type|4.0.1 Deleted
DeviceMetric.calibration.state DeviceMetric.measurementPeriod
  • Change value set from http://hl7.org/fhir/ValueSet/metric-calibration-state to http://hl7.org/fhir/ValueSet/metric-calibration-state|4.0.1 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 R3 <--> R4 <--> R5 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.) See Conversions Summary .)

 

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

8.16.3.1 8.18.4.1 Terminology Bindings

Path Definition ValueSet Type Reference Documentation
DeviceMetric.type Describes the metric type. DeviceMetricAndComponentTypes (a valid code from ISO 11073-10101 Health informatics - Point-of-care icon ) Preferred DeviceMetricAndComponentTypes

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 Describes the unit of the metric. UCUMCodes (a valid code from UCUM icon ) Preferred DeviceMetricAndComponentTypes

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

DeviceMetric.operationalStatus Describes the operational status of the DeviceMetric. DeviceMetricOperationalStatus Required DeviceMetricOperationalStatus

Describes the operational status of the DeviceMetric.

DeviceMetric.color Describes the typical color of representation. ColorCodesOrRGB Required DeviceMetricColor

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 Describes the category of the metric. DeviceMetricCategory Required DeviceMetricCategory

Describes the category of the metric.

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

Describes the type of a metric calibration.

DeviceMetric.calibration.state Describes the state of a metric calibration. DeviceMetricCalibrationState Required DeviceMetricCalibrationState

Describes the state of a metric calibration.

8.16.4 8.18.5 Notes:

8.16.5 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
identifier token device The identifier of the metric DeviceMetric.identifier parent reference The parent DeviceMetric device resource DeviceMetric.parent DeviceMetric.device
( Device )
source identifier reference token The device resource identifier of the metric DeviceMetric.source ( Device ) DeviceMetric.identifier
type token The component type of metric DeviceMetric.type