Release 4 FHIR CI-Build

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 icon . Page versions: R5 R4B R4 R3 R2

Responsible Owner: Health Care Devices icon Work Group Maturity Level : 1   Trial Use Normative Security Category : Anonymous Compartments : Not linked to any defined compartments Device

Detailed Descriptions for the elements in the DeviceMetric resource.

Element Id DeviceMetric
Definition

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

Short Display Measurement, calculation or setting capability of a medical device
Cardinality 0..*
Type DomainResource
Summary true false
Comments

For the initial scope, this The 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 derived from the ISO/IEEE 11073 standard. 11073-10201 Domain Information Model standard, but is more widely applicable.

Element Id DeviceMetric.identifier
Definition

Unique instance Instance identifiers assigned to a device device, by the device or gateway software, manufacturers, other organizations or owners. For example: example, handle ID.

Note Short Display Instance identifier
Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Summary true
Comments

For identifiers assigned to a device by the device or gateway software, the system element of the identifier should be set to the unique any identifier of the device.

Element Id DeviceMetric.type DeviceMetric.status
Definition

Describes the type Indicates current state of the metric. For example: Heart Rate, PEEP Setting, etc. record.

Short Display active | inactive | entered-in-error | unknown
Cardinality 1..1
Terminology Binding Device Metric and Component Types Status ( Preferred Required )
Type code
CodeableConcept Is Modifier true (Reason: This element is labeled as a modifier because the status contains the codes entered-in-error and inactive that mark the resource as not currently valid.)
Summary true
Comments

DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC. Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

Element Id DeviceMetric.unit DeviceMetric.operationalStatus
Definition

Describes Indicates current operational state of the unit that an observed value determined for this metric will have. device. For example: Percent, Seconds, On, Off, Standby, etc.

Short Display on | off | standby | unknown
Cardinality 0..1
Terminology Binding Device Metric and Component Types Operational Status ( Preferred Required )
Type CodeableConcept code
Meaning if Missing If absent, the operational status of the device is unknown.
Summary true
Comments Element Id DeviceMetric.category
Definition

DeviceMetric.unit Indicates the category of the observation generation process. A DeviceMetric can refer to either UCUM or preferable be, for example, a RTMMS coding system. setting, measurement, or calculation.

Short Display The kind of metric represented
Cardinality 1..1
Terminology Binding Device Metric Category ( Extensible )
Type CodeableConcept
Summary true
Element Id DeviceMetric.source DeviceMetric.type
Definition

Describes the link to type of the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, metric. For example: Heart Rate, PEEP Setting, etc.

Short Display Identity of metric, for example Heart Rate or PEEP Setting
Cardinality 0..1 1..1
Type Terminology Binding Reference Device Metric and Component Types ( Device Preferred )
Type CodeableConcept
Summary true
Comments

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

Element Id DeviceMetric.parent DeviceMetric.device
Definition

Describes the link to the Device that this DeviceMetric belongs The device to and that provide information about the location of which this DeviceMetric in the containment structure of the parent Device. An example would applies. The referenced device could be a Device that represents top-level device or a Channel. This reference can be used by component of a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location. device.

Short Display The device to which this DeviceMetric applies
Cardinality 0..1 1..1
Type Reference ( Device )
Summary true
Comments

If the reference is not to a top-level device, the top-level device is reached through the device's parent element (possibly recursively).

Element Id DeviceMetric.operationalStatus DeviceMetric.unit
Definition

Indicates current operational state of Describes the device. unit that an observed value determined for this metric will have. For example: On, Off, Standby, Percent, Seconds, etc.

Short Display Unit of Measure for the Metric
Cardinality 0..1
Terminology Binding DeviceMetricOperationalStatus UCUM Codes ( Required Preferred )
Type code CodeableConcept
Summary true
Comments

DeviceMetric.unit can refer to either UCUM icon or preferably an RTMMS icon coding system.

Element Id DeviceMetric.color
Definition

Describes the The preferred color representation for associated with the metric. metric (e.g., display color). 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; Pleth; the parameters metrics are displayed in different characteristic colors, such as HR-blue, BP-green, HR in blue, BP in green, and PR and SpO2- SpO2 in magenta.

Short Display Color name (from CSS4) or #RRGGBB code
Cardinality 0..1
Terminology Binding DeviceMetricColor Color Codes (Names or RGB Values) ( Required )
Type code
Meaning if Missing If absent, there is no preferred color for rendering.
Summary true false
Element Id DeviceMetric.category DeviceMetric.measurementFrequency
Definition

Indicates The frequency at which the category metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the observation generation process. A DeviceMetric can be millisecond range, while an NIBP might trigger only once an hour. Less often, the measurementFrequency is based on a unit other than time, such as distance (e.g., for example a setting, measurement, or calculation. measuring wheel). The update period could be different than the measurement frequency, if the device does not update the published observed value with the same frequency as it was measured.

Cardinality Short Display 1..1 Indicates how often the metric is taken or recorded
Terminology Binding Cardinality DeviceMetricCategory ( Required ) 0..1
Type code Quantity
Summary true false
Element Id DeviceMetric.measurementPeriod DeviceMetric.availability
Definition

Describes Indicates whether the measurement repetition time. This metric is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for derived (measured) by a measurement repetition time in the range of milliseconds is the sampling rate of continuous means or by an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. intermittent means.

Short Display The update period may be different than the measurement repetition time, if the device does not update the published observed value with continuity of the same frequency as it was measured. metric (e.g., measurement)
Cardinality 0..1
Terminology Binding Device Metric Availability ( Extensible )
Type Timing CodeableConcept
Summary true
Comments

For example, a gauge on a pressurized vessel showing current pressure is a continuous measurement, while a thermometer that produces readings on demand is an intermittent measurement. Note that metric availability is typically a static characteristic and is distinct from the operational status.

Element Id DeviceMetric.calibration
Definition

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

Short Display Describes the calibrations that have been performed or that are required to be performed
Cardinality 0..*
Summary true false
Element Id DeviceMetric.calibration.type
Definition

Describes the type of the calibration method.

Short Display The method of calibration
Cardinality 0..1
Terminology Binding DeviceMetricCalibrationType Device Metric Calibration Type ( Required Extensible )
Type code CodeableConcept
Summary true false
Element Id DeviceMetric.calibration.state
Definition

Describes the state of the calibration.

Short Display not-calibrated | calibration-required | calibrated | unspecified
Cardinality 0..1
Terminology Binding DeviceMetricCalibrationState Device Metric Calibration State ( Required )
Type code
Meaning if Missing If absent, the calibration state is unknown.
Summary true false
Element Id DeviceMetric.calibration.time
Definition

Describes the time last calibration has been performed.

Short Display Describes the time last calibration has been performed
Cardinality 0..1
Type instant
Summary true false