eHealth Infrastructure - Local Development build (v2021.3.0). See the Directory of published versions
Defining URL: | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric |
Version: | 2021.3.0 |
Name: | ehealth-devicemetric |
Status: | Active as of 2021-11-25T09:32:14+00:00 |
Publisher: | Systematic | Trifork |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric
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.
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.
The quality of the device can be expressed in a number of ways:
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.
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.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DeviceMetric
Summary
Mandatory: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from DeviceMetric
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceMetric | 0..* | DeviceMetric | Measurement, calculation or setting capability of a medical device | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
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 | |
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 | |
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 | |
ehealth-devicemetric-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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceMetric | 0..* | DeviceMetric | Measurement, calculation or setting capability of a medical device | |
Documentation for this format |
This structure is derived from DeviceMetric
Summary
Mandatory: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from DeviceMetric
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceMetric | 0..* | DeviceMetric | Measurement, calculation or setting capability of a medical device | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
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 | |
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 | |
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 | |
ehealth-devicemetric-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 |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
DeviceMetric.language | preferred | CommonLanguages Max Binding: AllLanguages |
DeviceMetric.type | required | DeviceMeasurementUnit |
DeviceMetric.unit | required | DeviceMeasurementUnit |
DeviceMetric.operationalStatus | required | DeviceMetricOperationalStatus |
DeviceMetric.color | required | DeviceMetricColor |
DeviceMetric.category | required | DeviceMetricCategory |
DeviceMetric.calibration.type | required | DeviceMetricCalibrationType |
DeviceMetric.calibration.state | required | DeviceMetricCalibrationState |
Id | Path | Details | Requirements |
dom-2 | DeviceMetric | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | DeviceMetric | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | DeviceMetric | If 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-5 | DeviceMetric | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | DeviceMetric | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | DeviceMetric.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceMetric.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceMetric.extension:properties | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceMetric.extension:properties | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceMetric.extension:qualities | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceMetric.extension:qualities | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceMetric.extension:qualitiyHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceMetric.extension:qualitiyHistory | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceMetric.extension:templateQualities | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceMetric.extension:templateQualities | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceMetric.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceMetric.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceMetric.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.unit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.operationalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.color | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.measurementPeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.calibration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.calibration.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceMetric.calibration.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceMetric.calibration.extension:calibrationExpires | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceMetric.calibration.extension:calibrationExpires | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceMetric.calibration.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceMetric.calibration.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceMetric.calibration.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.calibration.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceMetric.calibration.time | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |