This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
Health
Care
Devices
Work
Group
|
|
Security Category : Anonymous |
Compartments
:
|
Describes
a
measurement,
calculation
or
setting
capability
of
a
medical
device.
The
DeviceMetric
resource
describes
mandatory
static
dynamic
properties
that
characterize
a
direct
or
derived,
quantitative
or
qualitative
biosignal
measurement,
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
non-static
but
highly
relevant
properties
relevant
to
the
metric
such
as
metric
status,
metric
last
calibration
time
and
type,
measurement
mode,
color,
reference
and
to
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.
Device.
There
These
are
two
related
resources
the
DeviceMetric-related
resources:
Device.property
element
is
used
to
record
static
characteristics
or
properties
of
the
Device
.
device
data
element.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Measurement,
calculation
or
setting
capability
of
a
medical
device
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Instance
identifier
|
|
?! Σ | 1..1 |
|
active
|
inactive
|
entered-in-error
|
unknown
Binding: Device Metric |
|
Σ | 0..1 | code |
on
|
off
|
standby
|
unknown
Binding: Device Metric Operational Status ( Required ) |
![]() ![]() | Σ | 1..1 | CodeableConcept |
The
kind
of
Binding: Device Metric |
|
Σ | 1..1 |
CodeableConcept
|
Identity
of
metric,
for
example
Heart
Rate
or
PEEP
Setting
Binding: Device Metric and Component Types ( |
|
Σ | 1..1 | Reference ( Device ) |
The
device
to
|
|
Σ | 0..1 |
|
Unit
of
Measure
for
the
Metric
|
|
0..1 | code |
Color
name
(from
CSS4)
or
#RRGGBB
code
|
|
|
0..1 |
|
Indicates
how
often
the
metric
is
taken
or
recorded
|
|
|
Σ | 0..1 |
|
The
continuity
of
the
Binding: Device Metric Availability ( Required ) |
|
0..* | BackboneElement |
Describes
the
calibrations
that
have
been
performed
or
that
are
required
to
be
performed
|
|
|
0..1 |
|
The
method
of
calibration
|
|
|
0..1 | code |
not-calibrated
|
calibration-required
|
calibrated
|
unspecified
|
|
|
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><identifier><!-- 0..* Identifier Instance identifier --></identifier> <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown --> <operationalStatus value="[code]"/><!-- 0..1 on | off | standby | unknown --> <category><!-- 1..1 CodeableConcept The kind of metric represented --></category> <type><!-- 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting --></type><</unit> <</source> <</parent> < < < <</measurementPeriod><device><!-- 1..1 Reference(Device) The device to which this DeviceMetric applies --></device> <unit><!-- 0..1 CodeableConcept Unit of Measure for the Metric --></unit> <color value="[code]"/><!-- 0..1 Color name (from CSS4) or #RRGGBB code --> <measurementFrequency><!-- 0..1 Quantity Indicates how often the metric is taken or recorded --></measurementFrequency> <availability><!-- 0..1 CodeableConcept The continuity of the metric (e.g., measurement) --></availability> <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" : "",
"resourceType" : "DeviceMetric",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"identifier" : [{ Identifier }], // Instance identifier
"status" : "<code>", // R! active | inactive | entered-in-error | unknown
"operationalStatus" : "<code>", // on | off | standby | unknown
"category" : { CodeableConcept }, // R! The kind of metric represented
"type" : { CodeableConcept }, // R! Identity of metric, for example Heart Rate or PEEP Setting
"
"
"
"
"
"
"
"device" : { Reference(Device) }, // R! The device to which this DeviceMetric applies
"unit" : { CodeableConcept }, // Unit of Measure for the Metric
"color" : "<code>", // Color name (from CSS4) or #RRGGBB code
"measurementFrequency" : { Quantity }, // Indicates how often the metric is taken or recorded
"availability" : { CodeableConcept }, // The continuity of the metric (e.g., measurement)
"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:;[ a fhir:DeviceMetric; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...;# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* Instance identifier fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown fhir:operationalStatus [ code ] ; # 0..1 on | off | standby | unknown fhir:category [ CodeableConcept ] ; # 1..1 The kind of metric represented fhir:type [ CodeableConcept ] ; # 1..1 Identity of metric, for example Heart Rate or PEEP Setting fhir:device [ Reference(Device) ] ; # 1..1 The device to which this DeviceMetric applies fhir:unit [ CodeableConcept ] ; # 0..1 Unit of Measure for the Metric fhir:color [ code ] ; # 0..1 Color name (from CSS4) or #RRGGBB code fhir:measurementFrequency [ Quantity ] ; # 0..1 Indicates how often the metric is taken or recorded fhir:availability [ CodeableConcept ] ; # 0..1 The continuity of the metric (e.g., measurement) 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
since
R3
from
both
R4
and
R4B
| DeviceMetric | |
| DeviceMetric.status |
|
|
|
|
| DeviceMetric.category |
|
|
|
|
|
|
|
|
|
|
|
|
|
| DeviceMetric.calibration.type |
|
|
|
|
| DeviceMetric.parent |
|
| DeviceMetric.measurementPeriod |
|
See the Full Difference for further information
This
analysis
is
available
for
R4
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.)
for
R4B
as
XML
or
JSON
.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Measurement,
calculation
or
setting
capability
of
a
medical
device
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Instance
identifier
|
|
?! Σ | 1..1 |
|
active
|
inactive
|
entered-in-error
|
unknown
Binding: Device Metric |
|
Σ | 0..1 | code |
on
|
off
|
standby
|
unknown
Binding: Device Metric Operational Status ( Required ) |
![]() ![]() | Σ | 1..1 | CodeableConcept |
The
kind
of
Binding: Device Metric |
|
Σ | 1..1 |
CodeableConcept
|
Identity
of
metric,
for
example
Heart
Rate
or
PEEP
Setting
Binding: Device Metric and Component Types ( |
|
Σ | 1..1 | Reference ( Device ) |
The
device
to
|
|
Σ | 0..1 |
|
Unit
of
Measure
for
the
Metric
|
|
0..1 | code |
Color
name
(from
CSS4)
or
#RRGGBB
code
|
|
|
0..1 |
|
Indicates
how
often
the
metric
is
taken
or
recorded
|
|
|
Σ | 0..1 |
|
The
continuity
of
the
Binding: Device Metric Availability ( Required ) |
|
0..* | BackboneElement |
Describes
the
calibrations
that
have
been
performed
or
that
are
required
to
be
performed
|
|
|
0..1 |
|
The
method
of
calibration
|
|
|
0..1 | code |
not-calibrated
|
calibration-required
|
calibrated
|
unspecified
|
|
|
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><identifier><!-- 0..* Identifier Instance identifier --></identifier> <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown --> <operationalStatus value="[code]"/><!-- 0..1 on | off | standby | unknown --> <category><!-- 1..1 CodeableConcept The kind of metric represented --></category> <type><!-- 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting --></type><</unit> <</source> <</parent> < < < <</measurementPeriod><device><!-- 1..1 Reference(Device) The device to which this DeviceMetric applies --></device> <unit><!-- 0..1 CodeableConcept Unit of Measure for the Metric --></unit> <color value="[code]"/><!-- 0..1 Color name (from CSS4) or #RRGGBB code --> <measurementFrequency><!-- 0..1 Quantity Indicates how often the metric is taken or recorded --></measurementFrequency> <availability><!-- 0..1 CodeableConcept The continuity of the metric (e.g., measurement) --></availability> <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" : "",
"resourceType" : "DeviceMetric",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"identifier" : [{ Identifier }], // Instance identifier
"status" : "<code>", // R! active | inactive | entered-in-error | unknown
"operationalStatus" : "<code>", // on | off | standby | unknown
"category" : { CodeableConcept }, // R! The kind of metric represented
"type" : { CodeableConcept }, // R! Identity of metric, for example Heart Rate or PEEP Setting
"
"
"
"
"
"
"
"device" : { Reference(Device) }, // R! The device to which this DeviceMetric applies
"unit" : { CodeableConcept }, // Unit of Measure for the Metric
"color" : "<code>", // Color name (from CSS4) or #RRGGBB code
"measurementFrequency" : { Quantity }, // Indicates how often the metric is taken or recorded
"availability" : { CodeableConcept }, // The continuity of the metric (e.g., measurement)
"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:;[ a fhir:DeviceMetric; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...;# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* Instance identifier fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown fhir:operationalStatus [ code ] ; # 0..1 on | off | standby | unknown fhir:category [ CodeableConcept ] ; # 1..1 The kind of metric represented fhir:type [ CodeableConcept ] ; # 1..1 Identity of metric, for example Heart Rate or PEEP Setting fhir:device [ Reference(Device) ] ; # 1..1 The device to which this DeviceMetric applies fhir:unit [ CodeableConcept ] ; # 0..1 Unit of Measure for the Metric fhir:color [ code ] ; # 0..1 Color name (from CSS4) or #RRGGBB code fhir:measurementFrequency [ Quantity ] ; # 0..1 Indicates how often the metric is taken or recorded fhir:availability [ CodeableConcept ] ; # 0..1 The continuity of the metric (e.g., measurement) 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
since
Release
3
from
both
R4
and
R4B
| DeviceMetric | |
| DeviceMetric.status |
|
| DeviceMetric.operationalStatus |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| DeviceMetric.calibration.type |
|
|
|
|
| DeviceMetric.parent |
|
| DeviceMetric.measurementPeriod |
|
See the Full Difference for further information
This
analysis
is
available
for
R4
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.)
for
R4B
as
XML
or
JSON
.
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| DeviceMetric.status | DeviceMetricStatus | Required |
Describes
the
|
| DeviceMetric.operationalStatus | DeviceMetricOperationalStatus |
|
Describes the operational status of the DeviceMetric. |
| DeviceMetric.category | DeviceMetricCategory | Extensible |
Describes
the
|
| DeviceMetric.type |
DeviceMetricAndComponentTypes
(a
valid
code
from
ISO/IEEE
11073
Medical
Device
Communication
Nomenclature
)
|
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 |
)
|
|
Unified Code for Units of Measure (UCUM). This value set includes all UCUM codes |
| DeviceMetric.color |
|
Required |
This
value
set
includes
color
codes
-
either
the
color
names
as
defined
in
CSS4
|
| DeviceMetric.availability |
|
Required |
The availability of the means from which a device metric state/value is derived. |
| DeviceMetric.calibration.type | DeviceMetricCalibrationType | Extensible |
Describes the type of a metric calibration. |
| DeviceMetric.calibration.state | DeviceMetricCalibrationState | Required |
Describes
the
state
of
a
metric
calibration.
|
,
but
this
is
not
required.
See
Terminology
Systems
for
the
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 | |
|
|
|
The
|
( Device ) |
|
|
|
|
The
|
|
|
|
status
|
|
The
|
|
|
| type | token |
The
|
DeviceMetric.type |