Introduction

This resource describes qualities and other properties related to a Device. In addition it can describe a measurement, calculation or setting capability of the device.

Scope and Usage

In scope of the eHealth Infrastructure, the DeviceMetric resource is used for:

• additional properties pertaining to the referenced Device, for instance, properties specifying simplicity of use, language, size and so on. These properties are captured through a generic structure based on a property type and value in the extension properties.

• setting of device quality

DeviceMetric resources are created and updated automatically based on actions and information provided in the Service, Support & Logistics (SSL) domain of the eHealth Infrastructure. The use of DeviceMetric therefore concerns reading and searching only.

Device quality settings

The quality of the device can be expressed in a number of ways:

• through calibration information (which may or may not apply to a particular kind of device) - specifying the last time of calibration and possibly when the calibration expires. Expiration of calibration, specified through the extension calibration.expires, is when the device quality cannot be determined by its calibration information.
• an initial device quality
• a degraded device quality value
• an overridden device quality

The current quality of the Device is DeviceMetric.quality.

The default values for initial, degraded, and overridden quality are kept in DeviceMetric.templateQualities.

Historic values and periods of DeviceMetric.quality are kept in DeviceMetric.qualityHistory. This history is maintained by the eHealth Infrastructure.

If the device is of a kind where calibration influences the device quality, and once the calibration has expired, the device quality will be based on the degraded quality value. Once the device has been calibrated (and a new calibration expiry has been set), the device quality is based on the initial device quality.

At any time, a Practitioner can set which of the initial, degraded and overridden device quality shall be used as current.

Life cycle

In most cases DeviceMetric resources are created by the SSL subsystem when a Device is signalled to be in use by a Patient.

The initial values of device quality is set from values in the SSL catalogue.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from DeviceMetric

Name	Flags	Card.	Type	Description & Constraints
DeviceMetric			DeviceMetric
Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url
properties		0..*	(Complex)	Properties of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties
qualities		1..1	(Complex)	Qualities of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities
qualitiyHistory		0..*	(Complex)	History of device quality URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory
templateQualities		3..3	(Complex)	Device quality default settings URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities
type		1..1	CodeableConcept	Identity of metric, for example Heart Rate or PEEP Setting Binding: Device Measurement Unit (required)
unit		0..1	CodeableConcept	Unit of Measure for the Metric Binding: Device Measurement Unit (required)
source		1..1	Reference(ehealth-device) {r}	Describes the link to the source Device
parent		0..0
calibration
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
calibrationExpires		0..1	dateTime	Date when the current calibration expires. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-calibrationExpires
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DeviceMetric.type	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.unit	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG

Name	Flags	Card.	Type	Description & Constraints
DeviceMetric		0..*	DeviceMetric	Measurement, calculation or setting capability of a medical device dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
properties		0..*	(Complex)	Properties of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
qualities		1..1	(Complex)	Qualities of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
qualitiyHistory		0..*	(Complex)	History of device quality URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
templateQualities		3..3	(Complex)	Device quality default settings URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	Σ	1..1	CodeableConcept	Identity of metric, for example Heart Rate or PEEP Setting Binding: Device Measurement Unit (required) ele-1: All FHIR elements must have a @value or children
unit	Σ	0..1	CodeableConcept	Unit of Measure for the Metric Binding: Device Measurement Unit (required) ele-1: All FHIR elements must have a @value or children
source	Σ	1..1	Reference(ehealth-device) {r}	Describes the link to the source Device ele-1: All FHIR elements must have a @value or children
category	Σ	1..1	code	measurement | setting | calculation | unspecified Binding: DeviceMetricCategory (required): Describes the category of the metric. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DeviceMetric.type	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.unit	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.category	required	DeviceMetricCategory http://hl7.org/fhir/ValueSet/metric-category|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
DeviceMetric		0..*	DeviceMetric	Measurement, calculation or setting capability of a medical device
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url
properties		0..*	(Complex)	Properties of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties
qualities		1..1	(Complex)	Qualities of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities
qualitiyHistory		0..*	(Complex)	History of device quality URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory
templateQualities		3..3	(Complex)	Device quality default settings URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Instance identifier
type	Σ	1..1	CodeableConcept	Identity of metric, for example Heart Rate or PEEP Setting Binding: Device Measurement Unit (required)
unit	Σ	0..1	CodeableConcept	Unit of Measure for the Metric Binding: Device Measurement Unit (required)
source	Σ	1..1	Reference(ehealth-device) {r}	Describes the link to the source Device
operationalStatus	Σ	0..1	code	on | off | standby | entered-in-error Binding: DeviceMetricOperationalStatus (required): Describes the operational status of the DeviceMetric.
color	Σ	0..1	code	black | red | green | yellow | blue | magenta | cyan | white Binding: DeviceMetricColor (required): Describes the typical color of representation.
category	Σ	1..1	code	measurement | setting | calculation | unspecified Binding: DeviceMetricCategory (required): Describes the category of the metric.
measurementPeriod	Σ	0..1	Timing	Describes the measurement repetition time
calibration	Σ	0..*	BackboneElement	Describes the calibrations that have been performed or that are required to be performed
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
calibrationExpires		0..1	dateTime	Date when the current calibration expires. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-calibrationExpires
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	code	unspecified | offset | gain | two-point Binding: DeviceMetricCalibrationType (required): Describes the type of a metric calibration.
state	Σ	0..1	code	not-calibrated | calibration-required | calibrated | unspecified Binding: DeviceMetricCalibrationState (required): Describes the state of a metric calibration.
time	Σ	0..1	instant	Describes the time last calibration has been performed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DeviceMetric.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DeviceMetric.type	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.unit	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.operationalStatus	required	DeviceMetricOperationalStatus http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1 from the FHIR Standard
DeviceMetric.color	required	DeviceMetricColor http://hl7.org/fhir/ValueSet/metric-color|4.0.1 from the FHIR Standard
DeviceMetric.category	required	DeviceMetricCategory http://hl7.org/fhir/ValueSet/metric-category|4.0.1 from the FHIR Standard
DeviceMetric.calibration.type	required	DeviceMetricCalibrationType http://hl7.org/fhir/ValueSet/metric-calibration-type|4.0.1 from the FHIR Standard
DeviceMetric.calibration.state	required	DeviceMetricCalibrationState http://hl7.org/fhir/ValueSet/metric-calibration-state|4.0.1 from the FHIR Standard

Differential View

This structure is derived from DeviceMetric

Name	Flags	Card.	Type	Description & Constraints
DeviceMetric			DeviceMetric
Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url
properties		0..*	(Complex)	Properties of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties
qualities		1..1	(Complex)	Qualities of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities
qualitiyHistory		0..*	(Complex)	History of device quality URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory
templateQualities		3..3	(Complex)	Device quality default settings URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities
type		1..1	CodeableConcept	Identity of metric, for example Heart Rate or PEEP Setting Binding: Device Measurement Unit (required)
unit		0..1	CodeableConcept	Unit of Measure for the Metric Binding: Device Measurement Unit (required)
source		1..1	Reference(ehealth-device) {r}	Describes the link to the source Device
parent		0..0
calibration
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
calibrationExpires		0..1	dateTime	Date when the current calibration expires. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-calibrationExpires
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DeviceMetric.type	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.unit	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
DeviceMetric		0..*	DeviceMetric	Measurement, calculation or setting capability of a medical device dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
properties		0..*	(Complex)	Properties of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
qualities		1..1	(Complex)	Qualities of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
qualitiyHistory		0..*	(Complex)	History of device quality URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
templateQualities		3..3	(Complex)	Device quality default settings URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	Σ	1..1	CodeableConcept	Identity of metric, for example Heart Rate or PEEP Setting Binding: Device Measurement Unit (required) ele-1: All FHIR elements must have a @value or children
unit	Σ	0..1	CodeableConcept	Unit of Measure for the Metric Binding: Device Measurement Unit (required) ele-1: All FHIR elements must have a @value or children
source	Σ	1..1	Reference(ehealth-device) {r}	Describes the link to the source Device ele-1: All FHIR elements must have a @value or children
category	Σ	1..1	code	measurement | setting | calculation | unspecified Binding: DeviceMetricCategory (required): Describes the category of the metric. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DeviceMetric.type	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.unit	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.category	required	DeviceMetricCategory http://hl7.org/fhir/ValueSet/metric-category|4.0.1 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DeviceMetric		0..*	DeviceMetric	Measurement, calculation or setting capability of a medical device
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url
properties		0..*	(Complex)	Properties of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties
qualities		1..1	(Complex)	Qualities of the Device URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities
qualitiyHistory		0..*	(Complex)	History of device quality URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory
templateQualities		3..3	(Complex)	Device quality default settings URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Instance identifier
type	Σ	1..1	CodeableConcept	Identity of metric, for example Heart Rate or PEEP Setting Binding: Device Measurement Unit (required)
unit	Σ	0..1	CodeableConcept	Unit of Measure for the Metric Binding: Device Measurement Unit (required)
source	Σ	1..1	Reference(ehealth-device) {r}	Describes the link to the source Device
operationalStatus	Σ	0..1	code	on | off | standby | entered-in-error Binding: DeviceMetricOperationalStatus (required): Describes the operational status of the DeviceMetric.
color	Σ	0..1	code	black | red | green | yellow | blue | magenta | cyan | white Binding: DeviceMetricColor (required): Describes the typical color of representation.
category	Σ	1..1	code	measurement | setting | calculation | unspecified Binding: DeviceMetricCategory (required): Describes the category of the metric.
measurementPeriod	Σ	0..1	Timing	Describes the measurement repetition time
calibration	Σ	0..*	BackboneElement	Describes the calibrations that have been performed or that are required to be performed
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
calibrationExpires		0..1	dateTime	Date when the current calibration expires. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-calibrationExpires
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	code	unspecified | offset | gain | two-point Binding: DeviceMetricCalibrationType (required): Describes the type of a metric calibration.
state	Σ	0..1	code	not-calibrated | calibration-required | calibrated | unspecified Binding: DeviceMetricCalibrationState (required): Describes the state of a metric calibration.
time	Σ	0..1	instant	Describes the time last calibration has been performed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DeviceMetric.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DeviceMetric.type	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.unit	required	DeviceMeasurementUnit http://ehealth.sundhed.dk/vs/device-measurement-unit from this IG
DeviceMetric.operationalStatus	required	DeviceMetricOperationalStatus http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1 from the FHIR Standard
DeviceMetric.color	required	DeviceMetricColor http://hl7.org/fhir/ValueSet/metric-color|4.0.1 from the FHIR Standard
DeviceMetric.category	required	DeviceMetricCategory http://hl7.org/fhir/ValueSet/metric-category|4.0.1 from the FHIR Standard
DeviceMetric.calibration.type	required	DeviceMetricCalibrationType http://hl7.org/fhir/ValueSet/metric-calibration-type|4.0.1 from the FHIR Standard
DeviceMetric.calibration.state	required	DeviceMetricCalibrationState http://hl7.org/fhir/ValueSet/metric-calibration-state|4.0.1 from the FHIR Standard

This structure is derived from DeviceMetric

Summary

Mandatory: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• ehealth-device (http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device)

Extensions

This structure refers to these extensions:

• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-calibrationExpires