## On this page

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

### Elements

| Name        | Required | Type                                                                                                        | Description |
|-------------|----------|-------------------------------------------------------------------------------------------------------------|-------------|
| identifier  |          | [Identifier](/content/docs/api/fhir/datatypes/identifier/index.html)[]                                | Instance identifier<br>Details<br>Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.<br>For identifiers assigned to a device by the device or gateway software, the `system` element of the identifier should be set to the unique identifier of the device. |
| type        | ✓        | [CodeableConcept](/content/docs/api/fhir/datatypes/codeableconcept/index.html)                        | Identity of metric, for example Heart Rate or PEEP Setting<br>Details<br>Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.<br>DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC. |
| unit        |          | [CodeableConcept](/content/docs/api/fhir/datatypes/codeableconcept/index.html)                        | Unit of Measure for the Metric<br>Details<br>Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.<br>DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system. |
| source      |          | Reference<[Device](/content/docs/api/fhir/resources/device/index.html)>                                | Describes the link to the source Device<br>Details<br>Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc. |
| parent      |          | Reference<[Device](/content/docs/api/fhir/resources/device/index.html)>                                | Describes the link to the parent Device<br>Details<br>Describes the link to the Device 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 Device 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. |
| operationalStatus |  | code                                                                                                       | on | off | standby | entered-in-error<br>Details<br>Indicates current operational state of the device. For example: On, Off, Standby, etc. |
| color       |          | code                                                                                                       | black | red | green | yellow | blue | magenta | cyan | white<br>Details<br>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. |
| category    | ✓        | code                                                                                                       | measurement | setting | calculation | unspecified<br>Details<br>Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. |
| measurementPeriod |  | [Timing](/content/docs/api/fhir/datatypes/timing/index.html)                                       | Describes the measurement repetition time<br>Details<br>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. |
| calibration  |          | DeviceMetricCalibration[]                                                                                 | Describes the calibrations that have been performed or that are required to be performed<br>Details<br>Describes the calibrations that have been performed or that are required to be performed. |
| id          |          | string                                                                                                     | Unique id for inter-element referencing<br>Details<br>Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| extension   |          | [Extension](/content/docs/api/fhir/datatypes/extension/index.html)[]                                 | Additional content defined by implementations<br>Details<br>May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.<br>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. |
| modifierExtension |      | [Extension](/content/docs/api/fhir/datatypes/extension/index.html)[]                                 | Extensions that cannot be ignored even if unrecognized<br>Details<br>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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.<br>Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).<br>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. |
| type        |          | code                                                                                                       | unspecified | offset | gain | two-point<br>Details<br>Describes the type of the calibration method. |
| state       |          | code                                                                                                       | not-calibrated | calibration-required | calibrated | unspecified<br>Details<br>Describes the state of the calibration. |
| time        |          | instant                                                                                                    | Describes the time last calibration has been performed<br>Details<br>Describes the time last calibration has been performed. |

### Search Parameters

| Name       | Type      | Description                     | Expression                      |
|------------|-----------|---------------------------------|---------------------------------|
| category   | token     | The category of the metric      | DeviceMetric.category           |
| identifier | token     | The identifier of the metric    | DeviceMetric.identifier         |
| parent     | reference | The parent DeviceMetric resource | DeviceMetric.parent             |
| source     | reference | The device resource             | DeviceMetric.source             |
| type       | token     | The component type              | DeviceMetric.type               |

### Inherited Elements

| Name              | Required | Type                                                                                              | Description |
|-------------------|----------|---------------------------------------------------------------------------------------------------|-------------|
| id                |          | string                                                                                            | Logical id of this artifact<br>Details<br>The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.<br>The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta              |          | [Meta](/content/docs/api/fhir/datatypes/meta/index.html)                                   | Metadata about the resource<br>Details<br>The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| implicitRules     |          | uri                                                                                               | A set of rules under which this content was created<br>Details<br>A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| language          |          | code                                                                                              | Language of the resource content<br>Details<br>The base language in which the resource is written. |
| text              |          | [Narrative](/content/docs/api/fhir/datatypes/narrative/index.html)                        | Text summary of the resource, for human interpretation<br>Details<br>A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. |
| contained         |          | Resource[]                                                                                         | Contained, inline Resources<br>Details<br>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. |
| extension         |          | [Extension](/content/docs/api/fhir/datatypes/extension/index.html)[]                       | Additional content defined by implementations<br>Details<br>May be used to represent additional information that is not part of the basic definition of the resource. |
| modifierExtension  |          | [Extension](/content/docs/api/fhir/datatypes/extension/index.html)[]                       | Extensions that cannot be ignored<br>Details<br>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 and/or the understanding of the containing element's descendants. |

The [DeviceMetric](/content/docs/api/fhir/resources/devicemetric/index.html) resource describes mandatory static properties that characterize a direct or derived, quantitative or qualitative biosignal measurement, setting, or calculation produced by a medical device. The [DeviceMetric](/content/docs/api/fhir/resources/devicemetric/index.html) resource can also be used to describe the non-static but highly relevant properties to the metric such as metric status, metric last calibration time and type, measurement mode, color, reference link to the parent DeviceComponent to where it belongs, and any capabilities that the metric offers (for example: setting the metric label).

Note:

For the initial scope, this [DeviceMetric](/content/docs/api/fhir/resources/devicemetric/index.html) 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.

### Related Resources

- [Device](/content/docs/api/fhir/resources/device/index.html) - The physical device that this [DeviceMetric](/content/docs/api/fhir/resources/devicemetric/index.html) belongs to.
- [Media](/content/docs/api/fhir/resources/media/index.html)
- [Observation](/content/docs/api/fhir/resources/observation/index.html)  
- [Elements](/content/docs/api/fhir/resources/devicemetric#elements/index.html)  
- [Search Parameters](/content/docs/api/fhir/resources/devicemetric#search-parameters/index.html)  
- [Inherited Elements](/content/docs/api/fhir/resources/devicemetric#inherited-elements/index.html)