FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.19 Resource DeviceMetric - Content

Health Care Devices icon

Work Group

Maturity Level: 1

Trial Use

Security Category: Anonymous

Compartments: No defined compartments

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

8.19.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.19.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.19.3 References to this Resource

Resource References: DeviceAlert, Group and Observation

8.19.4 Resource Content

Structure

Name	Flags	Card.	Type	Description & Constraints
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 Binding: UCUM Codes (Preferred)
device	Σ	1..1	Reference(Device)	Describes the link to the Device
operationalStatus	Σ	0..1	code	on \| off \| standby \| entered-in-error Binding: Device Metric Operational Status (Required)
color		0..1	code	Color name (from CSS4) or #RRGGBB code Binding: Color Codes (Names or RGB Values) (Required)
category	Σ	1..1	CodeableConcept	The kind of metric represented Binding: Device Metric Category (Extensible)
measurementFrequency		0..1	Quantity	Indicates how often the 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	CodeableConcept	The method of calibration Binding: Device Metric Calibration Type (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
Documentation for this format

See the Extensions for this resource

XML Template

<DeviceMetric xmlns="http://hl7.org/fhir"> 
 <!-- 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><!-- 1..1 CodeableConcept The kind of metric represented --></category>
 <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><!-- 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>

JSON Template

{
  "resourceType" : "DeviceMetric",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Instance identifier
  "type" : { CodeableConcept }, // R!  Identity of metric, for example Heart Rate or PEEP Setting
  "unit" : { CodeableConcept }, // Unit of Measure for the Metric
  "device" : { Reference(Device) }, // R!  Describes the link to the Device
  "operationalStatus" : "<code>", // on | off | standby | entered-in-error
  "color" : "<code>", // Color name (from CSS4) or #RRGGBB code
  "category" : { CodeableConcept }, // R!  The kind of metric represented
  "measurementFrequency" : { Quantity }, // Indicates how often the metric is taken or recorded
  "calibration" : [{ // Describes the calibrations that have been performed or that are required to be performed
    "type" : { CodeableConcept }, // The method of calibration
    "state" : "<code>", // not-calibrated | calibration-required | calibrated | unspecified
    "time" : "<instant>" // Describes the time last calibration has been performed
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/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: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 [ CodeableConcept ] ; # 1..1 The kind of metric represented
  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 [ 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.device

Added Mandatory Element

DeviceMetric.color

Change value set from http://hl7.org/fhir/ValueSet/metric-color|4.0.0 to Color Codes (Names or RGB Values)

DeviceMetric.category

Type changed from code to CodeableConcept
Change binding strength from required to extensible

DeviceMetric.measurementFrequency

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.

Structure

Name	Flags	Card.	Type	Description & Constraints
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 Binding: UCUM Codes (Preferred)
device	Σ	1..1	Reference(Device)	Describes the link to the Device
operationalStatus	Σ	0..1	code	on \| off \| standby \| entered-in-error Binding: Device Metric Operational Status (Required)
color		0..1	code	Color name (from CSS4) or #RRGGBB code Binding: Color Codes (Names or RGB Values) (Required)
category	Σ	1..1	CodeableConcept	The kind of metric represented Binding: Device Metric Category (Extensible)
measurementFrequency		0..1	Quantity	Indicates how often the 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	CodeableConcept	The method of calibration Binding: Device Metric Calibration Type (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
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<DeviceMetric xmlns="http://hl7.org/fhir"> 
 <!-- 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><!-- 1..1 CodeableConcept The kind of metric represented --></category>
 <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><!-- 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>

JSON Template

{
  "resourceType" : "DeviceMetric",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Instance identifier
  "type" : { CodeableConcept }, // R!  Identity of metric, for example Heart Rate or PEEP Setting
  "unit" : { CodeableConcept }, // Unit of Measure for the Metric
  "device" : { Reference(Device) }, // R!  Describes the link to the Device
  "operationalStatus" : "<code>", // on | off | standby | entered-in-error
  "color" : "<code>", // Color name (from CSS4) or #RRGGBB code
  "category" : { CodeableConcept }, // R!  The kind of metric represented
  "measurementFrequency" : { Quantity }, // Indicates how often the metric is taken or recorded
  "calibration" : [{ // Describes the calibrations that have been performed or that are required to be performed
    "type" : { CodeableConcept }, // The method of calibration
    "state" : "<code>", // not-calibrated | calibration-required | calibrated | unspecified
    "time" : "<instant>" // Describes the time last calibration has been performed
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/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: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 [ CodeableConcept ] ; # 1..1 The kind of metric represented
  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 [ 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.device

Added Mandatory Element

DeviceMetric.color

Change value set from http://hl7.org/fhir/ValueSet/metric-color|4.0.0 to Color Codes (Names or RGB Values)

DeviceMetric.category

Type changed from code to CodeableConcept
Change binding strength from required to extensible

DeviceMetric.measurementFrequency

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.

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

8.19.4.1 Terminology Bindings

Path ValueSet Type Documentation

DeviceMetric.type

Path	ValueSet	Type	Documentation
DeviceMetric.type	DeviceMetricAndComponentTypes (a valid code from ISO 11073-10101 Health informatics - Point-of-care )	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 )	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 , or any valid RGB code (`#RRGGBB` in Hex).
DeviceMetric.category	DeviceMetricCategory	Extensible	Describes the category of the metric.
DeviceMetric.calibration.type	DeviceMetricCalibrationType	Extensible	Describes the type of a metric calibration.
DeviceMetric.calibration.state	DeviceMetricCalibrationState	Required	Describes the state of a metric calibration.

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

Extensible

Describes the category of the metric.

DeviceMetric.calibration.type

DeviceMetricCalibrationType

Extensible

Describes the type of a metric calibration.

DeviceMetric.calibration.state

DeviceMetricCalibrationState

Required

Describes the state of a metric calibration.

8.19.5 Notes:

The codes for the metric types are registered in the RTM Management service , but this is not required. See Terminology Systems for the representation of these codes in a Coding data type.

8.19.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
type	token	The type of metric	DeviceMetric.type