This page is part of the FHIR Specification (v1.6.0:
STU
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
Compartments
|
Describes a measurement, calculation or setting capability of a medical device.
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.
There are two related resources
This resource is referenced by observation
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 1..1 | CodeableConcept |
|
|
Σ | 1..1 | Identifier |
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..1 | Reference ( Device ) |
|
|
Σ | 0..1 | Reference ( DeviceComponent ) |
|
|
Σ | 0..1 | code |
DeviceMetricOperationalStatus |
|
Σ | 0..1 | code |
DeviceMetricColor |
|
Σ | 1..1 | code |
DeviceMetricCategory |
|
Σ | 0..1 | Timing |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 0..1 | code |
DeviceMetricCalibrationType |
|
Σ | 0..1 | code |
DeviceMetricCalibrationState |
|
Σ | 0..1 | instant |
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
(
Legend
)
XML
Template
XML Template
<
<DeviceMetric xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</type> <</identifier> <</unit> <</source> <</parent> < < < <</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
JSON Template
{
"resourceType" : "",
{
"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
}]
}
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:DeviceMetric.type [ CodeableConcept ]; # 1..1 Type of metric fhir:DeviceMetric.identifier [ Identifier ]; # 1..1 Unique identifier of this DeviceMetric fhir:DeviceMetric.unit [ CodeableConcept ]; # 0..1 Unit of metric fhir:DeviceMetric.source [ Reference(Device) ]; # 0..1 Describes the link to the source Device fhir:DeviceMetric.parent [ Reference(DeviceComponent) ]; # 0..1 Describes the link to the parent DeviceComponent fhir:DeviceMetric.operationalStatus [ code ]; # 0..1 on | off | standby 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
| DeviceMetric | No Changes |
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 1..1 | CodeableConcept |
|
|
Σ | 1..1 | Identifier |
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..1 | Reference ( Device ) |
|
|
Σ | 0..1 | Reference ( DeviceComponent ) |
|
|
Σ | 0..1 | code |
DeviceMetricOperationalStatus |
|
Σ | 0..1 | code |
DeviceMetricColor |
|
Σ | 1..1 | code |
DeviceMetricCategory |
|
Σ | 0..1 | Timing |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 0..1 | code |
DeviceMetricCalibrationType |
|
Σ | 0..1 | code |
DeviceMetricCalibrationState |
|
Σ | 0..1 | instant |
|
Documentation for this format
|
||||
XML
Template
XML Template
<
<DeviceMetric xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</type> <</identifier> <</unit> <</source> <</parent> < < < <</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
JSON Template
{
"resourceType" : "",
{
"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:
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:DeviceMetric.type [ CodeableConcept ]; # 1..1 Type of metric fhir:DeviceMetric.identifier [ Identifier ]; # 1..1 Unique identifier of this DeviceMetric fhir:DeviceMetric.unit [ CodeableConcept ]; # 0..1 Unit of metric fhir:DeviceMetric.source [ Reference(Device) ]; # 0..1 Describes the link to the source Device fhir:DeviceMetric.parent [ Reference(DeviceComponent) ]; # 0..1 Describes the link to the parent DeviceComponent fhir:DeviceMetric.operationalStatus [ code ]; # 0..1 on | off | standby 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
| DeviceMetric | No Changes |
See the Full Difference for further information
Alternate definitions: Master Definition (
XML
,
JSON
),
XML
Schema
/
Schematron
,
Resource
Profile
(
XML
,
(for ) +
JSON
Schema
,
ShEx
(for
Turtle
),
Questionnaire
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| DeviceMetric.type |
|
Preferred |
|
| DeviceMetric.unit |
|
Preferred |
|
| DeviceMetric.operationalStatus |
|
Required | DeviceMetricOperationalStatus |
| DeviceMetric.color |
|
Required | DeviceMetricColor |
| DeviceMetric.category |
|
Required | DeviceMetricCategory |
| DeviceMetric.calibration.type |
|
Required | DeviceMetricCalibrationType |
| DeviceMetric.calibration.state |
|
Required | DeviceMetricCalibrationState |
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| category | token |
|
DeviceMetric.category |
| identifier | token |
|
DeviceMetric.identifier |
| parent | reference |
|
DeviceMetric.parent
( DeviceComponent ) |
| source | reference |
|
DeviceMetric.source
( Device ) |
| type | token |
|
DeviceMetric.type |