eHealth Infrastructure (v2019.6.1)

StructureDefinition: ehealth-devicemetric - Detailed Descriptions

Definitions for the ehealth-devicemetric Profile.

1. DeviceMetric
Definition

Describes a measurement, calculation or setting capability of a medical device.

Control0..*
Comments

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.

InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If 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())
dom-4: 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())
2. DeviceMetric.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. DeviceMetric.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
4. DeviceMetric.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

5. DeviceMetric.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Max Binding: All Languages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

6. DeviceMetric.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

7. DeviceMetric.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

8. DeviceMetric.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on DeviceMetric.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. DeviceMetric.extension:properties
SliceNameproperties
Definition

Properties are static characteristics of the Device and do not change over time or across calibration cycles, such as color, weight, ease-of-use, language, CE-labelling, etc.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(properties) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. DeviceMetric.extension:quality
SliceNamequality
Definition

Qualities are characteristics of the Device which may change over time or across calibration cycles, such as battery state, etc.

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(qualities) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. DeviceMetric.extension:qualitiesHistory
SliceNamequalitiesHistory
Definition

History of device quality. This is maintained by the system.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(qualityHistory) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. DeviceMetric.extension:templateQualities
SliceNametemplateQualities
Definition

Device quality default settings for an initial, a degraded, and an overriden device quality.

Control3..3 This element is affected by the following invariants: ele-1
TypeExtension(templateQualities) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. DeviceMetric.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

14. DeviceMetric.identifier
Definition

Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
15. DeviceMetric.type
Definition

Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.

Control1..1
BindingDescribes the metric type.
The codes SHOULD be taken from Device Metric and Component Types
TypeCodeableConcept
Comments

DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC.

16. DeviceMetric.unit
Definition

Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.

Control0..1
BindingDescribes the unit of the metric.
The codes SHOULD be taken from Device Metric and Component Types
TypeCodeableConcept
Comments

DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system.

17. DeviceMetric.source
Definition

Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.

Control1..1
TypeReference(ehealth-device)
18. DeviceMetric.parent
Definition

Describes the link to the DeviceComponent that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a DeviceComponent that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.

Control0..0
TypeReference(DeviceComponent)
19. DeviceMetric.operationalStatus
Definition

Indicates current operational state of the device. For example: On, Off, Standby, etc.

Control0..1
BindingDescribes the operational status of the DeviceMetric.
The codes SHALL be taken from DeviceMetricOperationalStatus
Typecode
20. DeviceMetric.color
Definition

Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.

Control0..1
BindingDescribes the typical color of representation.
The codes SHALL be taken from DeviceMetricColor
Typecode
21. DeviceMetric.category
Definition

Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

Control1..1
BindingDescribes the category of the metric.
The codes SHALL be taken from DeviceMetricCategory
Typecode
22. DeviceMetric.measurementPeriod
Definition

Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.

Control0..1
TypeTiming
23. DeviceMetric.calibration
Definition

Describes the calibrations that have been performed or that are required to be performed.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
24. DeviceMetric.calibration.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
25. DeviceMetric.calibration.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on DeviceMetric.calibration.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
26. DeviceMetric.calibration.extension:calibrationExpires
SliceNamecalibrationExpires
Definition

Date when the current calibration expires and recalibration is required.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(calibrationExpires) (Extension Type: dateTime)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
27. DeviceMetric.calibration.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

28. DeviceMetric.calibration.type
Definition

Describes the type of the calibration method.

Control0..1
BindingDescribes the type of a metric calibration.
The codes SHALL be taken from DeviceMetricCalibrationType
Typecode
29. DeviceMetric.calibration.state
Definition

Describes the state of the calibration.

Control0..1
BindingDescribes the state of a metric calibration.
The codes SHALL be taken from DeviceMetricCalibrationState
Typecode
30. DeviceMetric.calibration.time
Definition

Describes the time last calibration has been performed.

Control0..1
Typeinstant