DSTU2

This page is part of the FHIR Specification (v0.0.82: (v1.0.2: DSTU 1). 2). 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

5.12 Resource DeviceMetric - Content

This resource maintained by the
Health Care Devices Work Group Maturity Level : 1 Compartments : Device

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

5.12.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 represents 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.

5.12.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 [Observation] observation

5.12.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . DeviceMetric Σ DomainResource Measurement, calculation or setting capability of a medical device
. . . type Σ 1..1 CodeableConcept Type of metric
MetricType ( Required Preferred )
. . . identifier Σ 1..1 Identifier Unique identifier of this DeviceMetric
. . . unit Σ 0..1 CodeableConcept Unit of metric
MetricUnit ( Required Preferred )
. . . source Σ 0..1 Reference ( Device ) Describes the link to the source Device
. . . parent Σ 0..1 Reference ( DeviceComponent ) Describes the link to the parent DeviceComponent
. . . operationalStatus Σ 0..1 code on | off | standby
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..* Element 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

DeviceMetric ( DomainResource ) Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc type : CodeableConcept 1..1 [1..1] « Describes the metric type type. (Strength=Preferred) MetricType ? » Describes the unique identification of this metric that has been assigned by the device or gateway software. 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 identifier : Identifier 1..1 [1..1] Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc unit : CodeableConcept 0..1 [0..1] « Describes the unit of the metric metric. (Strength=Preferred) MetricUnit ? » Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacture, serial number, etc source : Reference ( [0..1] « Device ) 0..1 » Describes the link to the DeviceComponent 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 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 ) 0..1 » Indicates current operational state of the device. For example: On, Off, Standby, etc operationalStatus : code 0..1 [0..1] « Describes the operational status of the DeviceMetric DeviceMetric. (Strength=Required) DeviceMetricOperationalStatus ! » Describes the typical color of the representation of observations 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 have been generated has ECG/HR and Pleth for this DeviceMetric example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta color : code 0..1 [0..1] « Describes the typical color of representation 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 [1..1] « Describes the category of the metric 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 [0..1] Calibration Describes the type of the calibration method type : code 0..1 [0..1] « Describes the type of a metric calibration calibration. (Strength=Required) DeviceMetricCalibrationType ! » Describes the state of the calibration state : code 0..1 [0..1] « Describes the state of a metric calibration calibration. (Strength=Required) DeviceMetricCalibrationState ! » Describes the time last calibration has been performed time : instant 0..1 [0..1] Describes the calibrations that have been performed or that are required to be performed calibration 0..* [0..*]

XML Template 

<DeviceMetric xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</type>
 <<a title="Describes the unique identification of this metric that has been assigned by the device or gateway software. 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." class="dict" href="devicemetric-definitions.html#DeviceMetric.identifier"></identifier>
 <</unit>
 <</source>
 <<a title="Describes the link to the  DeviceComponent 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 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." class="dict" href="devicemetric-definitions.html#DeviceMetric.parent">
     Describes the link to the parent DeviceComponent</parent>
 <
 <
 <
 <<a title="Describes the measurement repetition time. This is not
necessarily the same as the update
period." class="dict" href="devicemetric-definitions.html#DeviceMetric.measurementPeriod"></measurementPeriod>

 <type><!-- 1..1 CodeableConcept Type of metric  --></type>
 <identifier><!-- 1..1 Identifier Unique identifier of this DeviceMetric --></identifier>
 <unit><!-- 0..1 CodeableConcept Unit of metric  --></unit>
 <source><!-- 0..1 Reference(Device) Describes the link to the source Device --></source>
 <parent><!-- 0..1 Reference(DeviceComponent) Describes the link to the parent DeviceComponent --></parent>
 <operationalStatus value="[code]"/><!-- 0..1 on | off | standby -->
 <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>

JSON Template 

{doco
  "resourceType" : "DeviceMetric",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "<a title="Describes the unique identification of this metric that has been assigned by the device or gateway software. 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." class="dict" href="devicemetric-definitions.html#DeviceMetric.identifier">identifier
  "
  "
  "<a title="Describes the link to the  DeviceComponent 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 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." class="dict" href="devicemetric-definitions.html#DeviceMetric.parent">parent
     Describes the link to the parent DeviceComponent
  "
  "
  "
  "<a title="Describes the measurement repetition time. This is not
necessarily the same as the update
period." class="dict" href="devicemetric-definitions.html#DeviceMetric.measurementPeriod">measurementPeriod
  "
     Describes the calibrations that have been performed or that are required to be performed
    "
    "
    "

  "type" : { CodeableConcept }, // R!  Type of metric 
  "identifier" : { Identifier }, // R!  Unique identifier of this DeviceMetric
  "unit" : { CodeableConcept }, // Unit of metric 
  "source" : { Reference(Device) }, // Describes the link to the source Device
  "parent" : { Reference(DeviceComponent) }, // Describes the link to the parent DeviceComponent
  "operationalStatus" : "<code>", // on | off | standby
  "color" : "<code>", // black | red | green | yellow | blue | magenta | cyan | white
  "category" : "<code>", // R!  measurement | setting | calculation | unspecified
  "measurementPeriod" : { Timing }, // Describes the measurement repetition time
  "calibration" : [{ // Describes the calibrations that have been performed or that are required to be performed
    "type" : "<code>", // unspecified | offset | gain | two-point
    "state" : "<code>", // not-calibrated | calibration-required | calibrated | unspecified
    "time" : "<instant>" // Describes the time last calibration has been performed

  }]
}

Structure

Name Flags Card. Type Description & Constraints doco
. . DeviceMetric Σ DomainResource Measurement, calculation or setting capability of a medical device
. . . type Σ 1..1 CodeableConcept Type of metric
MetricType ( Required Preferred )
. . . identifier Σ 1..1 Identifier Unique identifier of this DeviceMetric
. . . unit Σ 0..1 CodeableConcept Unit of metric
MetricUnit ( Required Preferred )
. . . source Σ 0..1 Reference ( Device ) Describes the link to the source Device
. . . parent Σ 0..1 Reference ( DeviceComponent ) Describes the link to the parent DeviceComponent
. . . operationalStatus Σ 0..1 code on | off | standby
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..* Element 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

DeviceMetric ( DomainResource ) Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc type : CodeableConcept 1..1 [1..1] « Describes the metric type type. (Strength=Preferred) MetricType ? » Describes the unique identification of this metric that has been assigned by the device or gateway software. 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 identifier : Identifier 1..1 [1..1] Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc unit : CodeableConcept 0..1 [0..1] « Describes the unit of the metric metric. (Strength=Preferred) MetricUnit ? » Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacture, serial number, etc source : Reference ( [0..1] « Device ) 0..1 » Describes the link to the DeviceComponent 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 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 ) 0..1 » Indicates current operational state of the device. For example: On, Off, Standby, etc operationalStatus : code 0..1 [0..1] « Describes the operational status of the DeviceMetric DeviceMetric. (Strength=Required) DeviceMetricOperationalStatus ! » Describes the typical color of the representation of observations 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 have been generated has ECG/HR and Pleth for this DeviceMetric example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta color : code 0..1 [0..1] « Describes the typical color of representation 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 [1..1] « Describes the category of the metric 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 [0..1] Calibration Describes the type of the calibration method type : code 0..1 [0..1] « Describes the type of a metric calibration calibration. (Strength=Required) DeviceMetricCalibrationType ! » Describes the state of the calibration state : code 0..1 [0..1] « Describes the state of a metric calibration calibration. (Strength=Required) DeviceMetricCalibrationState ! » Describes the time last calibration has been performed time : instant 0..1 [0..1] Describes the calibrations that have been performed or that are required to be performed calibration 0..* [0..*]

XML Template 

<DeviceMetric xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</type>
 <<a title="Describes the unique identification of this metric that has been assigned by the device or gateway software. 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." class="dict" href="devicemetric-definitions.html#DeviceMetric.identifier"></identifier>
 <</unit>
 <</source>
 <<a title="Describes the link to the  DeviceComponent 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 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." class="dict" href="devicemetric-definitions.html#DeviceMetric.parent">
     Describes the link to the parent DeviceComponent</parent>
 <
 <
 <
 <<a title="Describes the measurement repetition time. This is not
necessarily the same as the update
period." class="dict" href="devicemetric-definitions.html#DeviceMetric.measurementPeriod"></measurementPeriod>

 <type><!-- 1..1 CodeableConcept Type of metric  --></type>
 <identifier><!-- 1..1 Identifier Unique identifier of this DeviceMetric --></identifier>
 <unit><!-- 0..1 CodeableConcept Unit of metric  --></unit>
 <source><!-- 0..1 Reference(Device) Describes the link to the source Device --></source>
 <parent><!-- 0..1 Reference(DeviceComponent) Describes the link to the parent DeviceComponent --></parent>
 <operationalStatus value="[code]"/><!-- 0..1 on | off | standby -->
 <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>

JSON Template 

{doco
  "resourceType" : "DeviceMetric",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "<a title="Describes the unique identification of this metric that has been assigned by the device or gateway software. 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." class="dict" href="devicemetric-definitions.html#DeviceMetric.identifier">identifier
  "
  "
  "<a title="Describes the link to the  DeviceComponent 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 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." class="dict" href="devicemetric-definitions.html#DeviceMetric.parent">parent
     Describes the link to the parent DeviceComponent
  "
  "
  "
  "<a title="Describes the measurement repetition time. This is not
necessarily the same as the update
period." class="dict" href="devicemetric-definitions.html#DeviceMetric.measurementPeriod">measurementPeriod
  "
     Describes the calibrations that have been performed or that are required to be performed
    "
    "
    "

  "type" : { CodeableConcept }, // R!  Type of metric 
  "identifier" : { Identifier }, // R!  Unique identifier of this DeviceMetric
  "unit" : { CodeableConcept }, // Unit of metric 
  "source" : { Reference(Device) }, // Describes the link to the source Device
  "parent" : { Reference(DeviceComponent) }, // Describes the link to the parent DeviceComponent
  "operationalStatus" : "<code>", // on | off | standby
  "color" : "<code>", // black | red | green | yellow | blue | magenta | cyan | white
  "category" : "<code>", // R!  measurement | setting | calculation | unspecified
  "measurementPeriod" : { Timing }, // Describes the measurement repetition time
  "calibration" : [{ // Describes the calibrations that have been performed or that are required to be performed
    "type" : "<code>", // unspecified | offset | gain | two-point
    "state" : "<code>", // not-calibrated | calibration-required | calibrated | unspecified
    "time" : "<instant>" // Describes the time last calibration has been performed

  }]
}

 

Alternate definitions: Schema / Schematron , Resource Profile ( XML , JSON ), Questionnaire

5.12.3.1 Terminology Bindings

Path Definition Type Reference
DeviceMetric.type Describes the metric type type. Required Preferred RTM Management Service IEEE 11073-10101
DeviceMetric.unit Describes the unit of the metric metric. Required Preferred RTM Management Service IEEE 11073-10101
DeviceMetric.operationalStatus Describes the operational status of the DeviceMetric DeviceMetric. Required http://hl7.org/fhir/metric-operational-status DeviceMetricOperationalStatus
DeviceMetric.color Describes the typical color of representation representation. Required http://hl7.org/fhir/metric-color DeviceMetricColor
DeviceMetric.category Describes the category of the metric metric. Required http://hl7.org/fhir/metric-category DeviceMetricCategory
DeviceMetric.calibration.type Describes the type of a metric calibration calibration. Required http://hl7.org/fhir/metric-calibration-type DeviceMetricCalibrationType
DeviceMetric.calibration.state Describes the state of a metric calibration calibration. Required http://hl7.org/fhir/metric-calibration-state DeviceMetricCalibrationState

5.12.4 Notes:

5.12.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 Paths
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 )
source reference The device resource DeviceMetric.source
( Device )
type token The component type DeviceMetric.type