eHealth Infrastructure (v2020.4)

StructureDefinition: ehealth-devicemetric

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.

Formal Views of Profile Content

The official URL for this profile is:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric

This profile builds on DeviceMetric.

This profile was published on Fri May 22 12:11:22 UTC 2020 as a draft by ehealth.sundhed.dk.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from DeviceMetric

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric 0..*DeviceMetricDescribes a measurement, calculation or setting capability of a medical device.
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-devicemetric-properties 0..*(Complex)Properties of the Device
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties
... ehealth-devicemetric-qualities 1..1(Complex)Qualities of the Device
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities
... ehealth-devicemetric-qualityHistory 0..*(Complex)History of device quality
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory
... ehealth-devicemetric-templateQualities 3..3(Complex)Device quality default settings
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities
... type 1..1CodeableConceptIdentity of metric, for example Heart Rate or PEEP Setting
Binding: Device Measurement Unit (preferred)
... unit 0..1CodeableConceptUnit of Measure for the Metric
Binding: Device Measurement Unit (preferred)
... source 1..1Reference(eHealth Device) {r}Describes the link to the source Device
... parent 0..0
... calibration 0..*BackboneElementDescribes the calibrations that have been performed or that are required to be performed.
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-devicemetric-calibrationExpires 0..1dateTimeDate when the current calibration expires.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-calibrationExpires

doco Documentation for this format

This structure is derived from DeviceMetric

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric I0..*DeviceMetricDescribes a measurement, calculation or setting capability of a medical device.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-devicemetric-properties I0..*(Complex)Properties of the Device
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties
... ehealth-devicemetric-qualities I1..1(Complex)Qualities of the Device
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities
... ehealth-devicemetric-qualityHistory I0..*(Complex)History of device quality
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory
... ehealth-devicemetric-templateQualities I3..3(Complex)Device quality default settings
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierUnique identifier of this DeviceMetric
... type Σ1..1CodeableConceptIdentity of metric, for example Heart Rate or PEEP Setting
Binding: Device Measurement Unit (preferred)
... unit Σ0..1CodeableConceptUnit of Measure for the Metric
Binding: Device Measurement Unit (preferred)
... source Σ1..1Reference(eHealth Device) {r}Describes the link to the source Device
... operationalStatus Σ0..1codeon | off | standby | entered-in-error
Binding: DeviceMetricOperationalStatus (required)
... color Σ0..1codeblack | red | green | yellow | blue | magenta | cyan | white
Binding: DeviceMetricColor (required)
... category Σ1..1codemeasurement | setting | calculation | unspecified
Binding: DeviceMetricCategory (required)
... measurementPeriod Σ0..1TimingDescribes the measurement repetition time
... calibration ΣI0..*BackboneElementDescribes the calibrations that have been performed or that are required to be performed.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-devicemetric-calibrationExpires I0..1dateTimeDate when the current calibration expires.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-calibrationExpires
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ0..1codeunspecified | offset | gain | two-point
Binding: DeviceMetricCalibrationType (required)
.... state Σ0..1codenot-calibrated | calibration-required | calibrated | unspecified
Binding: DeviceMetricCalibrationState (required)
.... time Σ0..1instantDescribes the time last calibration has been performed

doco Documentation for this format

Differential View

This structure is derived from DeviceMetric

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric 0..*DeviceMetricDescribes a measurement, calculation or setting capability of a medical device.
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-devicemetric-properties 0..*(Complex)Properties of the Device
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties
... ehealth-devicemetric-qualities 1..1(Complex)Qualities of the Device
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities
... ehealth-devicemetric-qualityHistory 0..*(Complex)History of device quality
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory
... ehealth-devicemetric-templateQualities 3..3(Complex)Device quality default settings
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities
... type 1..1CodeableConceptIdentity of metric, for example Heart Rate or PEEP Setting
Binding: Device Measurement Unit (preferred)
... unit 0..1CodeableConceptUnit of Measure for the Metric
Binding: Device Measurement Unit (preferred)
... source 1..1Reference(eHealth Device) {r}Describes the link to the source Device
... parent 0..0
... calibration 0..*BackboneElementDescribes the calibrations that have been performed or that are required to be performed.
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-devicemetric-calibrationExpires 0..1dateTimeDate when the current calibration expires.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-calibrationExpires

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric I0..*DeviceMetricDescribes a measurement, calculation or setting capability of a medical device.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-devicemetric-properties I0..*(Complex)Properties of the Device
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-properties
... ehealth-devicemetric-qualities I1..1(Complex)Qualities of the Device
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities
... ehealth-devicemetric-qualityHistory I0..*(Complex)History of device quality
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualityHistory
... ehealth-devicemetric-templateQualities I3..3(Complex)Device quality default settings
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierUnique identifier of this DeviceMetric
... type Σ1..1CodeableConceptIdentity of metric, for example Heart Rate or PEEP Setting
Binding: Device Measurement Unit (preferred)
... unit Σ0..1CodeableConceptUnit of Measure for the Metric
Binding: Device Measurement Unit (preferred)
... source Σ1..1Reference(eHealth Device) {r}Describes the link to the source Device
... operationalStatus Σ0..1codeon | off | standby | entered-in-error
Binding: DeviceMetricOperationalStatus (required)
... color Σ0..1codeblack | red | green | yellow | blue | magenta | cyan | white
Binding: DeviceMetricColor (required)
... category Σ1..1codemeasurement | setting | calculation | unspecified
Binding: DeviceMetricCategory (required)
... measurementPeriod Σ0..1TimingDescribes the measurement repetition time
... calibration ΣI0..*BackboneElementDescribes the calibrations that have been performed or that are required to be performed.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-devicemetric-calibrationExpires I0..1dateTimeDate when the current calibration expires.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-calibrationExpires
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ0..1codeunspecified | offset | gain | two-point
Binding: DeviceMetricCalibrationType (required)
.... state Σ0..1codenot-calibrated | calibration-required | calibrated | unspecified
Binding: DeviceMetricCalibrationState (required)
.... time Σ0..1instantDescribes the time last calibration has been performed

doco Documentation for this format

 

Terminology Bindings

PathConformanceValueSet
DeviceMetric.languageextensibleCommon Languages
Max Binding: All Languages
DeviceMetric.typepreferredDeviceMeasurementUnit
DeviceMetric.unitpreferredDeviceMeasurementUnit
DeviceMetric.operationalStatusrequiredDeviceMetricOperationalStatus
DeviceMetric.colorrequiredDeviceMetricColor
DeviceMetric.categoryrequiredDeviceMetricCategory
DeviceMetric.calibration.typerequiredDeviceMetricCalibrationType
DeviceMetric.calibration.staterequiredDeviceMetricCalibrationState

Constraints

IdPathDetailsRequirements
dom-2DeviceMetricIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1DeviceMetricIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4DeviceMetricIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3DeviceMetricIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1DeviceMetric.extension:propertiesAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1DeviceMetric.extension:propertiesMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceMetric.extension:qualityAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1DeviceMetric.extension:qualityMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceMetric.extension:qualitiesHistoryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1DeviceMetric.extension:qualitiesHistoryMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceMetric.extension:templateQualitiesAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1DeviceMetric.extension:templateQualitiesMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceMetric.calibrationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1DeviceMetric.calibration.extension:calibrationExpiresAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1DeviceMetric.calibration.extension:calibrationExpiresMust have either extensions or value[x], not both
: extension.exists() != value.exists()
.