Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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 Resource DeviceMetric - Content

Health Care Devices Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: 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.

8.16.3 References to this Resource

8.16.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
Device Metric and Component Types (Preferred)
... unit Σ0..1CodeableConceptUnit of Measure for the Metric
Device Metric and Component Types (Preferred)
... parent Σ0..1Reference(Device)Describes the link to the parent Device
... operationalStatus Σ0..1codeon | off | standby | entered-in-error
DeviceMetricOperationalStatus (Required)
... color Σ0..1codeblack | red | green | yellow | blue | magenta | cyan | white
DeviceMetricColor (Required)
... category Σ1..1codemeasurement | setting | calculation | unspecified
DeviceMetricCategory (Required)
... measurementPeriod Σ0..1TimingDescribes the measurement repetition time
... calibration Σ0..*BackboneElementDescribes the calibrations that have been performed or that are required to be performed

.... type Σ0..1codeunspecified | offset | gain | two-point
DeviceMetricCalibrationType (Required)
.... state Σ0..1codenot-calibrated | calibration-required | calibrated | unspecified
DeviceMetricCalibrationState (Required)
.... time Σ0..1instantDescribes the time last calibration has been performed

doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

DeviceMetric (DomainResource)Unique 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] « null (Strength=Preferred)DeviceMetricAndComponentTypes? »Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etcunit : CodeableConcept [0..1] « null (Strength=Preferred)DeviceMetricAndComponentTypes? »Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etcsource : 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 a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment locationparent : Reference [0..1] « Device »Indicates current operational state of the device. For example: On, Off, Standby, etcoperationalStatus : code [0..1] « null (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- magentacolor : code [0..1] « null (Strength=Required)DeviceMetricColor! »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! »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 measuredmeasurementPeriod : Timing [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>
 <source><!-- 0..1 Reference(Device) Describes the link to the source Device --></source>
 <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: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: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 R4

DeviceMetric
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

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

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
Device Metric and Component Types (Preferred)
... unit Σ0..1CodeableConceptUnit of Measure for the Metric
Device Metric and Component Types (Preferred)
... parent Σ0..1Reference(Device)Describes the link to the parent Device
... operationalStatus Σ0..1codeon | off | standby | entered-in-error
DeviceMetricOperationalStatus (Required)
... color Σ0..1codeblack | red | green | yellow | blue | magenta | cyan | white
DeviceMetricColor (Required)
... category Σ1..1codemeasurement | setting | calculation | unspecified
DeviceMetricCategory (Required)
... measurementPeriod Σ0..1TimingDescribes the measurement repetition time
... calibration Σ0..*BackboneElementDescribes the calibrations that have been performed or that are required to be performed

.... type Σ0..1codeunspecified | offset | gain | two-point
DeviceMetricCalibrationType (Required)
.... state Σ0..1codenot-calibrated | calibration-required | calibrated | unspecified
DeviceMetricCalibrationState (Required)
.... time Σ0..1instantDescribes the time last calibration has been performed

doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

DeviceMetric (DomainResource)Unique 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] « null (Strength=Preferred)DeviceMetricAndComponentTypes? »Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etcunit : CodeableConcept [0..1] « null (Strength=Preferred)DeviceMetricAndComponentTypes? »Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etcsource : 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 a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment locationparent : Reference [0..1] « Device »Indicates current operational state of the device. For example: On, Off, Standby, etcoperationalStatus : code [0..1] « null (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- magentacolor : code [0..1] « null (Strength=Required)DeviceMetricColor! »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! »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 measuredmeasurementPeriod : Timing [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>
 <source><!-- 0..1 Reference(Device) Describes the link to the source Device --></source>
 <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: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: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 Release 4

DeviceMetric
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

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

 

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.4.1 Terminology Bindings

PathDefinitionTypeReference
DeviceMetric.type

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.

PreferredDeviceMetricAndComponentTypes
DeviceMetric.unit

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.

PreferredDeviceMetricAndComponentTypes
DeviceMetric.operationalStatus

Describes the operational status of the DeviceMetric.

RequiredDeviceMetricOperationalStatus
DeviceMetric.color

Describes the typical color of representation.

RequiredDeviceMetricColor
DeviceMetric.category

Describes the category of the metric.

RequiredDeviceMetricCategory
DeviceMetric.calibration.type

Describes the type of a metric calibration.

RequiredDeviceMetricCalibrationType
DeviceMetric.calibration.state

Describes the state of a metric calibration.

RequiredDeviceMetricCalibrationState

8.16.5 Notes:

8.16.6 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
category NtokenThe category of the metricDeviceMetric.category
identifiertokenThe identifier of the metricDeviceMetric.identifier
parentreferenceThe parent DeviceMetric resourceDeviceMetric.parent
(Device)
sourcereferenceThe device resourceDeviceMetric.source
(Device)
typetokenThe component typeDeviceMetric.type