FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) 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 R4 R3 R2

8.16 Resource DeviceMetric - Content

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

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

8.16.1 Scope and Usage

The DeviceMetric resource describes mandatory static properties that characterize a direct or derived, quantitative or qualitative biosignal measurement, setting, or calculation produced by a medical device. The DeviceMetric resource can also be used to describe the non-static but highly relevant properties to the metric such as metric status, metric last calibration time and type, measurement mode, color, reference 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.

8.16.2 Boundaries and Relationships

There are two related resources

  • Device - The physical device that this DeviceMetric belongs to.
    • DeviceComponent - The DeviceComponent that this DeviceMetric is part of. This can be a DeviceComponent of any kind like a VirtualMedicalDevice, a MedicalDeviceSystem, or a Channel.

This resource is referenced by Media and Observation

8.16.3 Resource Content

Structure

1..1 Unique
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 of this DeviceMetric
. . . type Σ 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting
Device Metric and Component Types ( Preferred )
. . . unit Σ 0..1 CodeableConcept Unit of Measure for the Metric
Device Metric and Component Types ( Preferred )
. . . source Σ 0..1 Reference ( Device ) Describes the link to the source Device
. . . parent Σ 0..1 Reference ( DeviceComponent Device ) Describes the link to the parent DeviceComponent Device
. . . operationalStatus Σ 0..1 code on | off | standby | entered-in-error
DeviceMetricOperationalStatus ( Required )
. . . color Σ 0..1 code black | red | green | yellow | blue | magenta | cyan | white
DeviceMetricColor ( Required )
. . . category Σ 1..1 code measurement | setting | calculation | unspecified
DeviceMetricCategory ( Required )
. . . measurementPeriod Σ 0..1 Timing Describes the measurement repetition time
. . . 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 ( Required )
. . . . state Σ 0..1 code not-calibrated | calibration-required | calibrated | unspecified
DeviceMetricCalibrationState ( Required )
. . . . time Σ 0..1 instant Describes the time last calibration has been performed

doco Documentation for this format

UML Diagram ( Legend )

DeviceMetric ( DomainResource ) Describes the unique identification of this metric that has been Unique instance identifiers assigned to a device by the device or gateway software. software, manufacturers, other organizations or owners. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device ID identifier : Identifier [1..1] [0..*] Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc type : CodeableConcept [1..1] « Describes the metric type. (Strength=Preferred) Device Metric and Component T... 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) Device Metric and Component T... DeviceMetricAndComponentTypes ? » 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 DeviceComponent 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 DeviceComponent Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location parent : Reference [0..1] DeviceComponent « 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. (Strength=Required) DeviceMetricOperationalStatus ! » Describes the color representation for the metric. 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; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta color : code [0..1] « Describes the typical color of representation. (Strength=Required) DeviceMetricColor ! » 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. (Strength=Required) DeviceMetricCategory ! » Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured measurementPeriod : Timing [0..1] Calibration Describes the type of the calibration method type : code [0..1] « Describes the type of a metric calibration. (Strength=Required) DeviceMetricCalibrationType ! » Describes the state of the calibration state : code [0..1] « Describes the state of a metric calibration. (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><!-- 0..1 CodeableConcept Unit of Measure for the Metric --></unit>
 <source><!-- 0..1 Reference(Device) Describes the link to the source Device --></source>
 <</parent>
 <
 <
 <

 <parent><!-- 0..1 Reference(Device) Describes the link to the parent Device --></parent>
 <operationalStatus value="[code]"/><!-- 0..1 on | off | standby | entered-in-error -->
 <color value="[code]"/><!-- 0..1 black | red | green | yellow | blue | magenta | cyan | white -->
 <category value="[code]"/><!-- 1..1 measurement | setting | calculation | unspecified -->

 <measurementPeriod><!-- 0..1 Timing Describes the measurement repetition time --></measurementPeriod>
 <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:

  fhir:DeviceMetric.identifier [ Identifier ], ... ; # 0..* Instance identifier

  fhir:DeviceMetric.type [ CodeableConcept ]; # 1..1 Identity of metric, for example Heart Rate or PEEP Setting
  fhir:DeviceMetric.unit [ CodeableConcept ]; # 0..1 Unit of Measure for the Metric
  fhir:DeviceMetric.source [ Reference(Device) ]; # 0..1 Describes the link to the source Device
  fhir:

  fhir:DeviceMetric.parent [ Reference(Device) ]; # 0..1 Describes the link to the parent Device

  fhir:DeviceMetric.operationalStatus [ code ]; # 0..1 on | off | standby | entered-in-error
  fhir:DeviceMetric.color [ code ]; # 0..1 black | red | green | yellow | blue | magenta | cyan | white
  fhir:DeviceMetric.category [ code ]; # 1..1 measurement | setting | calculation | unspecified
  fhir:DeviceMetric.measurementPeriod [ Timing ]; # 0..1 Describes the measurement repetition time
  fhir:DeviceMetric.calibration [ # 0..* Describes the calibrations that have been performed or that are required to be performed
    fhir:DeviceMetric.calibration.type [ code ]; # 0..1 unspecified | offset | gain | two-point
    fhir:DeviceMetric.calibration.state [ code ]; # 0..1 not-calibrated | calibration-required | calibrated | unspecified
    fhir:DeviceMetric.calibration.time [ instant ]; # 0..1 Describes the time last calibration has been performed
  ], ...;
]

Changes since DSTU2 R3

DeviceMetric
DeviceMetric.identifier
  • No Changes Min Cardinality changed from 1 to 0
  • Max Cardinality changed from 1 to *
DeviceMetric.parent
  • Type Reference: Added Target Type Device
  • Type Reference: Removed Target Type DeviceComponent
DeviceMetric.operationalStatus
  • Change value set from http://hl7.org/fhir/ValueSet/metric-operational-status to http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1
DeviceMetric.color
  • Change value set from http://hl7.org/fhir/ValueSet/metric-color to http://hl7.org/fhir/ValueSet/metric-color|4.0.1
DeviceMetric.category
  • Change value set from http://hl7.org/fhir/ValueSet/metric-category to http://hl7.org/fhir/ValueSet/metric-category|4.0.1
DeviceMetric.calibration.type
  • Change value set from http://hl7.org/fhir/ValueSet/metric-calibration-type to http://hl7.org/fhir/ValueSet/metric-calibration-type|4.0.1
DeviceMetric.calibration.state
  • Change value set from http://hl7.org/fhir/ValueSet/metric-calibration-state to http://hl7.org/fhir/ValueSet/metric-calibration-state|4.0.1

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). valid.)

Structure

1..1 Unique
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 of this DeviceMetric
. . . type Σ 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting
Device Metric and Component Types ( Preferred )
. . . unit Σ 0..1 CodeableConcept Unit of Measure for the Metric
Device Metric and Component Types ( Preferred )
. . . source Σ 0..1 Reference ( Device ) Describes the link to the source Device
. . . parent Σ 0..1 Reference ( DeviceComponent Device ) Describes the link to the parent DeviceComponent Device
. . . operationalStatus Σ 0..1 code on | off | standby | entered-in-error
DeviceMetricOperationalStatus ( Required )
. . . color Σ 0..1 code black | red | green | yellow | blue | magenta | cyan | white
DeviceMetricColor ( Required )
. . . category Σ 1..1 code measurement | setting | calculation | unspecified
DeviceMetricCategory ( Required )
. . . measurementPeriod Σ 0..1 Timing Describes the measurement repetition time
. . . 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 ( Required )
. . . . state Σ 0..1 code not-calibrated | calibration-required | calibrated | unspecified
DeviceMetricCalibrationState ( Required )
. . . . time Σ 0..1 instant Describes the time last calibration has been performed

doco Documentation for this format

UML Diagram ( Legend )

DeviceMetric ( DomainResource ) Describes the unique identification of this metric that has been Unique instance identifiers assigned to a device by the device or gateway software. software, manufacturers, other organizations or owners. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device ID identifier : Identifier [1..1] [0..*] Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc type : CodeableConcept [1..1] « Describes the metric type. (Strength=Preferred) Device Metric and Component T... 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) Device Metric and Component T... DeviceMetricAndComponentTypes ? » 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 DeviceComponent 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 DeviceComponent Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location parent : Reference [0..1] DeviceComponent « 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. (Strength=Required) DeviceMetricOperationalStatus ! » Describes the color representation for the metric. 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; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta color : code [0..1] « Describes the typical color of representation. (Strength=Required) DeviceMetricColor ! » 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. (Strength=Required) DeviceMetricCategory ! » Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured measurementPeriod : Timing [0..1] Calibration Describes the type of the calibration method type : code [0..1] « Describes the type of a metric calibration. (Strength=Required) DeviceMetricCalibrationType ! » Describes the state of the calibration state : code [0..1] « Describes the state of a metric calibration. (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><!-- 0..1 CodeableConcept Unit of Measure for the Metric --></unit>
 <source><!-- 0..1 Reference(Device) Describes the link to the source Device --></source>
 <</parent>
 <
 <
 <

 <parent><!-- 0..1 Reference(Device) Describes the link to the parent Device --></parent>
 <operationalStatus value="[code]"/><!-- 0..1 on | off | standby | entered-in-error -->
 <color value="[code]"/><!-- 0..1 black | red | green | yellow | blue | magenta | cyan | white -->
 <category value="[code]"/><!-- 1..1 measurement | setting | calculation | unspecified -->

 <measurementPeriod><!-- 0..1 Timing Describes the measurement repetition time --></measurementPeriod>
 <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:

  fhir:DeviceMetric.identifier [ Identifier ], ... ; # 0..* Instance identifier

  fhir:DeviceMetric.type [ CodeableConcept ]; # 1..1 Identity of metric, for example Heart Rate or PEEP Setting
  fhir:DeviceMetric.unit [ CodeableConcept ]; # 0..1 Unit of Measure for the Metric
  fhir:DeviceMetric.source [ Reference(Device) ]; # 0..1 Describes the link to the source Device
  fhir:

  fhir:DeviceMetric.parent [ Reference(Device) ]; # 0..1 Describes the link to the parent Device

  fhir:DeviceMetric.operationalStatus [ code ]; # 0..1 on | off | standby | entered-in-error
  fhir:DeviceMetric.color [ code ]; # 0..1 black | red | green | yellow | blue | magenta | cyan | white
  fhir:DeviceMetric.category [ code ]; # 1..1 measurement | setting | calculation | unspecified
  fhir:DeviceMetric.measurementPeriod [ Timing ]; # 0..1 Describes the measurement repetition time
  fhir:DeviceMetric.calibration [ # 0..* Describes the calibrations that have been performed or that are required to be performed
    fhir:DeviceMetric.calibration.type [ code ]; # 0..1 unspecified | offset | gain | two-point
    fhir:DeviceMetric.calibration.state [ code ]; # 0..1 not-calibrated | calibration-required | calibrated | unspecified
    fhir:DeviceMetric.calibration.time [ instant ]; # 0..1 Describes the time last calibration has been performed
  ], ...;
]

Changes since DSTU2 Release 3

DeviceMetric
DeviceMetric.identifier
  • No Changes Min Cardinality changed from 1 to 0
  • Max Cardinality changed from 1 to *
DeviceMetric.parent
  • Type Reference: Added Target Type Device
  • Type Reference: Removed Target Type DeviceComponent
DeviceMetric.operationalStatus
  • Change value set from http://hl7.org/fhir/ValueSet/metric-operational-status to http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1
DeviceMetric.color
  • Change value set from http://hl7.org/fhir/ValueSet/metric-color to http://hl7.org/fhir/ValueSet/metric-color|4.0.1
DeviceMetric.category
  • Change value set from http://hl7.org/fhir/ValueSet/metric-category to http://hl7.org/fhir/ValueSet/metric-category|4.0.1
DeviceMetric.calibration.type
  • Change value set from http://hl7.org/fhir/ValueSet/metric-calibration-type to http://hl7.org/fhir/ValueSet/metric-calibration-type|4.0.1
DeviceMetric.calibration.state
  • Change value set from http://hl7.org/fhir/ValueSet/metric-calibration-state to http://hl7.org/fhir/ValueSet/metric-calibration-state|4.0.1

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). valid.)

 

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

8.16.3.1 Terminology Bindings

Path Definition Type Reference
DeviceMetric.type Describes the metric type. Preferred Device Metric and Component Types DeviceMetricAndComponentTypes
DeviceMetric.unit Describes the unit of the metric. Preferred Device Metric and Component Types DeviceMetricAndComponentTypes
DeviceMetric.operationalStatus Describes the operational status of the DeviceMetric. Required DeviceMetricOperationalStatus
DeviceMetric.color Describes the typical color of representation. Required DeviceMetricColor
DeviceMetric.category Describes the category of the metric. Required DeviceMetricCategory
DeviceMetric.calibration.type Describes the type of a metric calibration. Required DeviceMetricCalibrationType
DeviceMetric.calibration.state Describes the state of a metric calibration. Required DeviceMetricCalibrationState

8.16.4 Notes:

8.16.5 Search Parameters

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