--- type: "resource" title: "DeviceMetric" resource: "DeviceMetric" --- # DeviceMetric ## Introduction ## Scope and Usage The DeviceMetric resource describes dynamic properties that characterize a direct or derived, quantitative or qualitative setting, or calculation produced by a medical device, i.e., readings and settings of, or from, the device. The DeviceMetric resource can also be used to describe the properties relevant to the metric such as status, last calibration time and type, measurement mode, color, and to link to the parent Device. ## Boundaries and Relationships These are the DeviceMetric-related resources: - [**Device:**](device) The physical, virtual, or software device that this **DeviceMetric** is for. Note that the `Device.property` element is used to record static characteristics or properties of the **Device**. - [**Observation:**](observation) Used to record the particular value of the **DeviceMetric** at a point in time. - [**DeviceAlert:**](devicealert) Can refer to a DeviceMetric to identify the detector of the alert condition via the `device` data element. ## Notes ## Notes: - The codes for the metric types are registered in the [RTM Management service](https://rtmms.nist.gov), but this is not required. See [Terminology Systems](terminologies-systems#urn:iso:std:iso:11073:10101) for the representation of these codes in a [Coding](datatypes#Coding) data type. ## StructureDefinition ### Elements (Simplified) - **[DeviceMetric](/devicemetric-definitions#DeviceMetric)** [0..*]: - Measurement, calculation or setting capability of a medical device - **[DeviceMetric.identifier](/devicemetric-definitions#DeviceMetric.identifier)** [0..*]: [Identifier](/Identifier) Instance identifier - **[DeviceMetric.status](/devicemetric-definitions#DeviceMetric.status)** [1..1]: [code](/code) required:[metric-status](/valueset-metric-status) active | inactive | entered-in-error | unknown - **[DeviceMetric.operationalStatus](/devicemetric-definitions#DeviceMetric.operationalStatus)** [0..1]: [code](/code) required:[metric-operational-status](/valueset-metric-operational-status) on | off | standby | unknown - **[DeviceMetric.category](/devicemetric-definitions#DeviceMetric.category)** [1..1]: [CodeableConcept](/CodeableConcept) extensible:[metric-category](/valueset-metric-category) The kind of metric represented - **[DeviceMetric.type](/devicemetric-definitions#DeviceMetric.type)** [1..1]: [CodeableConcept](/CodeableConcept) preferred:[devicemetric-type](/valueset-devicemetric-type) Identity of metric, for example Heart Rate or PEEP Setting - **[DeviceMetric.device](/devicemetric-definitions#DeviceMetric.device)** [1..1]: Reference([Device](/Device)) The device to which this DeviceMetric applies - **[DeviceMetric.unit](/devicemetric-definitions#DeviceMetric.unit)** [0..1]: [CodeableConcept](/CodeableConcept) preferred:[ucum-units](/valueset-ucum-units) Unit of Measure for the Metric - **[DeviceMetric.color](/devicemetric-definitions#DeviceMetric.color)** [0..1]: [code](/code) required:[color-codes](/valueset-color-codes) Color name (from CSS4) or #RRGGBB code - **[DeviceMetric.measurementFrequency](/devicemetric-definitions#DeviceMetric.measurementFrequency)** [0..1]: [Quantity](/Quantity) Indicates how often the metric is taken or recorded - **[DeviceMetric.availability](/devicemetric-definitions#DeviceMetric.availability)** [0..1]: [CodeableConcept](/CodeableConcept) extensible:[metric-availability](/valueset-metric-availability) The continuity of the metric (e.g., measurement) - **[DeviceMetric.calibration](/devicemetric-definitions#DeviceMetric.calibration)** [0..*]: [BackboneElement](/BackboneElement) Describes the calibrations that have been performed or that are required to be performed - **[DeviceMetric.calibration.type](/devicemetric-definitions#DeviceMetric.calibration.type)** [0..1]: [CodeableConcept](/CodeableConcept) extensible:[metric-calibration-type](/valueset-metric-calibration-type) The method of calibration - **[DeviceMetric.calibration.state](/devicemetric-definitions#DeviceMetric.calibration.state)** [0..1]: [code](/code) required:[metric-calibration-state](/valueset-metric-calibration-state) not-calibrated | calibration-required | calibrated | unspecified - **[DeviceMetric.calibration.time](/devicemetric-definitions#DeviceMetric.calibration.time)** [0..1]: [instant](/instant) Describes the time last calibration has been performed ## Mappings - [DeviceMetric Mappings](/devicemetric-mappings) — 26 mapping entries ## Resource Packs ### list-DeviceMetric-packs.xml ```xml ``` ## Search Parameters - [status](/devicemetric-search#status) — **token** — The status of the metric record — `DeviceMetric.status` - [category](/devicemetric-search#category) — **token** — The category of the metric — `DeviceMetric.category` - [identifier](/devicemetric-search#identifier) — **token** — The identifier of the metric — `DeviceMetric.identifier` - [device](/devicemetric-search#device) — **reference** — The device resource — `DeviceMetric.device` - [type](/devicemetric-search#type) — **token** — The type of metric — `DeviceMetric.type` [Full Search Parameters](/devicemetric-search) ## Examples - [devicemetric-example](/devicemetric-example-devicemetric-example) — devicemetric-example - [devicemetric-examples-header](/devicemetric-example-devicemetric-examples-header) — devicemetric-examples-header - [example](/devicemetric-example-example) — devicemetric-example — General DeviceMetric example [Full Examples](/devicemetric-examples) ## Mapping Exceptions ### devicemetric-fivews-mapping-exceptions.xml ### Unmapped Elements - **FiveWs.recorded** — Not identified as needed in core use cases. - **FiveWs.author** — Not identified as needed in core use cases. - **FiveWs.actor** — Resource does not reflect an activity performed by an actor. - **FiveWs.cause** — Resource does not reflect a prompted activity. - **FiveWs.version** — Not identified as needed in core use cases. - **FiveWs.witness** — Third-party attestation of the resource is not expected. - **FiveWs.where** — To the degree that this resource is associated with any location, it is recorded in the device's location. - **FiveWs.context** — Resource is independent of any specific context. - **FiveWs.init** — Resource does not reflect an activity that occurs. - **FiveWs.why** — Resource does not reflect an activity that occurs. - **FiveWs.source** — Resource does not cover second-hand information. - **FiveWs.who** — Resource does not reflect an activity performed by an actor. - **FiveWs.grade** — Resource does not reflect an activity with a priority/severity. - **FiveWs.planned** — Resource does not reflect a planned activity. - **FiveWs.done** — Resource does not reflect an activity done at a particular time.