View raw Markdown
type: resource-definitionsresource: DeviceMetric

DeviceMetric Definitions

<a id="DeviceMetric"></a>

DeviceMetric

Measurement, calculation or setting capability of a medical device

Definition: Describes a measurement, calculation or setting capability of a device.

Comments: The DeviceMetric resource is derived from the ISO/IEEE 11073-10201 Domain Information Model standard, but is more widely applicable.

Cardinality: 0..*

Mappings: w5=administrative.device; DIM=Metric; BICEPS=MetricDescriptor

<a id="DeviceMetric.identifier"></a>

DeviceMetric.identifier

Instance identifier

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

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

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier

<a id="DeviceMetric.status"></a>

DeviceMetric.status

active | inactive | entered-in-error | unknown

Definition: Indicates current state of the record.

Comments: 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.

Cardinality: 1..1

Type: code

Binding: required:metric-status

Summary: true

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.)

Mappings: w5=FiveWs.status

<a id="DeviceMetric.operationalStatus"></a>

DeviceMetric.operationalStatus

on | off | standby | unknown

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

Meaning if Missing: If absent, the operational status of the device is unknown.

Cardinality: 0..1

Type: code

Binding: required:metric-operational-status

Summary: true

Is Modifier: false

Mappings: DIM=Metric::Metric-Status; BICEPS=Metric/ActivationState

<a id="DeviceMetric.category"></a>

DeviceMetric.category

The kind of metric represented

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

Cardinality: 1..1

Type: CodeableConcept

Binding: extensible:metric-category

Summary: true

Mappings: w5=FiveWs.class; DIM=Metric::Metric-Specification::category; BICEPS=MetricDescriptor/MetricCategory; ACOM=Filled in when this can be derived from SystemInfo.observation-type-list[i]

<a id="DeviceMetric.type"></a>

DeviceMetric.type

Identity of metric, for example Heart Rate or PEEP Setting

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

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

Cardinality: 1..1

Type: CodeableConcept

Binding: preferred:devicemetric-type

Summary: true

Mappings: w5=FiveWs.what[x]; DIM=type = VMO::Type type.text = VMO::Label-String; BICEPS=MetricDescriptor/Type; ACOM=SystemInfo.observation-type-list[i]

<a id="DeviceMetric.device"></a>

DeviceMetric.device

The device to which this DeviceMetric applies

Definition: The device to which this DeviceMetric applies. The referenced device could be a top-level device or a component of a device.

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).

Cardinality: 1..1

Type: Reference(Device)

Summary: true

Mappings: w5=FiveWs.subject

<a id="DeviceMetric.unit"></a>

DeviceMetric.unit

Unit of Measure for the Metric

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

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

Cardinality: 0..1

Type: CodeableConcept

Binding: preferred:ucum-units

Summary: true

Mappings: DIM=unit = Metric::Unit-Code unit.text = Unit::Label-String; BICEPS=MetricDescriptor/Unit; ACOM=UCUM unit used for SystemInfo.observation-type-list[i] observations

<a id="DeviceMetric.color"></a>

DeviceMetric.color

Color name (from CSS4) or #RRGGBB code

Definition: The preferred color associated with the 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; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta.

Meaning if Missing: If absent, there is no preferred color for rendering.

Cardinality: 0..1

Type: code

Binding: required:color-codes

Summary: false

Mappings: DIM=Metric::Color

<a id="DeviceMetric.measurementFrequency"></a>

DeviceMetric.measurementFrequency

Indicates how often the metric is taken or recorded

Definition: The frequency at which the metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the 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 a 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: 0..1

Type: Quantity

Summary: false

Mappings: DIM=value = Metric::Measure-Period::value or Metric::Metric-Specification::update-period unit = Metric::Measure-Period::unit-code; BICEPS=MetricDescriptor/DeterminationPeriod

<a id="DeviceMetric.availability"></a>

DeviceMetric.availability

The continuity of the metric (e.g., measurement)

Definition: Indicates whether the metric is derived (measured) by a continuous means or by an intermittent means.

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.

Cardinality: 0..1

Type: CodeableConcept

Binding: extensible:metric-availability

Summary: true

Mappings: BICEPS=MetricDescriptor/MetricAvailability

<a id="DeviceMetric.calibration"></a>

DeviceMetric.calibration

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

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

Cardinality: 0..*

Type: BackboneElement

Summary: false

<a id="DeviceMetric.calibration.type"></a>

DeviceMetric.calibration.type

The method of calibration

Definition: Describes the type of the calibration method.

Cardinality: 0..1

Type: CodeableConcept

Binding: extensible:metric-calibration-type

Summary: false

Mappings: DIM=Metric::Metric-Calibration::cal-type

<a id="DeviceMetric.calibration.state"></a>

DeviceMetric.calibration.state

not-calibrated | calibration-required | calibrated | unspecified

Definition: Describes the state of the calibration.

Meaning if Missing: If absent, the calibration state is unknown.

Cardinality: 0..1

Type: code

Binding: required:metric-calibration-state

Summary: false

Mappings: DIM=Metric::Metric-Calibration::cal-state

<a id="DeviceMetric.calibration.time"></a>

DeviceMetric.calibration.time

Describes the time last calibration has been performed

Definition: Describes the time last calibration has been performed.

Cardinality: 0..1

Type: instant

Summary: false

Mappings: DIM=Metric::Metric-Calibration::cal-time