DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 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

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 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]

5.12.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric DomainResourceMeasurement, calculation or setting capability of a medical device
... type 1..1CodeableConceptType of metric
MetricType (Required)
... identifier 1..1IdentifierUnique identifier of this DeviceMetric
... unit 0..1CodeableConceptUnit of metric
MetricUnit (Required)
... source 0..1DeviceDescribes the link to the source Device
... parent 0..1DeviceComponentDescribes the link to the parent DeviceComponent
... operationalStatus 0..1codeon | off | standby
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..*ElementDescribes 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

UML Diagram

DeviceMetric (DomainResource)Describes the type of the metric. For example: Heart Rate, PEEP Setting, etctype : CodeableConcept 1..1 « Describes the metric typeMetricType »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 deviceidentifier : Identifier 1..1Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etcunit : CodeableConcept 0..1 « Describes the unit of the metricMetricUnit »Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacture, serial number, etcsource : Reference(Device) 0..1Describes 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 locationparent : Reference(DeviceComponent) 0..1Indicates current operational state of the device. For example: On, Off, Standby, etcoperationalStatus : code 0..1 « Describes the operational status of the DeviceMetricDeviceMetricOperationalStatus »Describes the typical color of the representation of observations that have been generated for this DeviceMetriccolor : code 0..1 « Describes the typical color of representationDeviceMetricColor »Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculationcategory : code 1..1 « Describes the category of the metricDeviceMetricCategory »Describes the measurement repetition time. This is not necessarily the same as the update periodmeasurementPeriod : Timing 0..1CalibrationDescribes the type of the calibration methodtype : code 0..1 « Describes the type of a metric calibrationDeviceMetricCalibrationType »Describes the state of the calibrationstate : code 0..1 « Describes the state of a metric calibrationDeviceMetricCalibrationState »Describes the time last calibration has been performedtime : instant 0..1Describes the calibrations that have been performed or that are required to be performedcalibration0..*

XML Template

<DeviceMetric xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <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
  "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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric DomainResourceMeasurement, calculation or setting capability of a medical device
... type 1..1CodeableConceptType of metric
MetricType (Required)
... identifier 1..1IdentifierUnique identifier of this DeviceMetric
... unit 0..1CodeableConceptUnit of metric
MetricUnit (Required)
... source 0..1DeviceDescribes the link to the source Device
... parent 0..1DeviceComponentDescribes the link to the parent DeviceComponent
... operationalStatus 0..1codeon | off | standby
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..*ElementDescribes 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

UML Diagram

DeviceMetric (DomainResource)Describes the type of the metric. For example: Heart Rate, PEEP Setting, etctype : CodeableConcept 1..1 « Describes the metric typeMetricType »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 deviceidentifier : Identifier 1..1Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etcunit : CodeableConcept 0..1 « Describes the unit of the metricMetricUnit »Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacture, serial number, etcsource : Reference(Device) 0..1Describes 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 locationparent : Reference(DeviceComponent) 0..1Indicates current operational state of the device. For example: On, Off, Standby, etcoperationalStatus : code 0..1 « Describes the operational status of the DeviceMetricDeviceMetricOperationalStatus »Describes the typical color of the representation of observations that have been generated for this DeviceMetriccolor : code 0..1 « Describes the typical color of representationDeviceMetricColor »Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculationcategory : code 1..1 « Describes the category of the metricDeviceMetricCategory »Describes the measurement repetition time. This is not necessarily the same as the update periodmeasurementPeriod : Timing 0..1CalibrationDescribes the type of the calibration methodtype : code 0..1 « Describes the type of a metric calibrationDeviceMetricCalibrationType »Describes the state of the calibrationstate : code 0..1 « Describes the state of a metric calibrationDeviceMetricCalibrationState »Describes the time last calibration has been performedtime : instant 0..1Describes the calibrations that have been performed or that are required to be performedcalibration0..*

XML Template

<DeviceMetric xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <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
  "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)

5.12.3.1 Terminology Bindings

PathDefinitionTypeReference
DeviceMetric.type Describes the metric typeRequiredRTM Management Service
DeviceMetric.unit Describes the unit of the metricRequiredRTM Management Service
DeviceMetric.operationalStatus Describes the operational status of the DeviceMetricRequiredhttp://hl7.org/fhir/metric-operational-status
DeviceMetric.color Describes the typical color of representationRequiredhttp://hl7.org/fhir/metric-color
DeviceMetric.category Describes the category of the metricRequiredhttp://hl7.org/fhir/metric-category
DeviceMetric.calibration.type Describes the type of a metric calibrationRequiredhttp://hl7.org/fhir/metric-calibration-type
DeviceMetric.calibration.state Describes the state of a metric calibrationRequiredhttp://hl7.org/fhir/metric-calibration-state

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.

NameTypeDescriptionPaths
categorytokenThe category of the metricDeviceMetric.category
identifiertokenThe identifier of the metricDeviceMetric.identifier
parentreferenceThe parent DeviceMetric resourceDeviceMetric.parent
(DeviceComponent)
sourcereferenceThe device resourceDeviceMetric.source
(Device)
typetokenThe component typeDeviceMetric.type