# DeviceMetric

Canonical page: https://docs.ovok.com/api/fhir/r4/device-metric

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/DeviceMetric/[id]` |
| Vread | `GET` | `/fhir/R4/DeviceMetric/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/DeviceMetric/[id]` |
| Patch | `PATCH` | `/fhir/R4/DeviceMetric/[id]` |
| Delete | `DELETE` | `/fhir/R4/DeviceMetric/[id]` |
| Create | `POST` | `/fhir/R4/DeviceMetric` |
| Search | `GET` | `/fhir/R4/DeviceMetric` |
| History | `GET` | `/fhir/R4/DeviceMetric/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Instance identifier |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | Identity of metric, for example Heart Rate or PEEP Setting |
| <span id="element-unit"></span>`unit` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Unit of Measure for the Metric |
| <span id="element-source"></span>`source` | [Reference](/fhir-elements/complex/reference) | `0..1` | Describes the link to the source Device |
| <span id="element-parent"></span>`parent` | [Reference](/fhir-elements/complex/reference) | `0..1` | Describes the link to the parent Device |
| <span id="element-operational-status"></span>`operationalStatus` | [code](/fhir-elements/primitive/code) | `0..1` | on \| off \| standby \| entered-in-error |
| <span id="element-color"></span>`color` | [code](/fhir-elements/primitive/code) | `0..1` | black \| red \| green \| yellow \| blue \| magenta \| cyan \| white |
| <span id="element-category"></span>`category` | [code](/fhir-elements/primitive/code) | `1..1` | measurement \| setting \| calculation \| unspecified |
| <span id="element-measurement-period"></span>`measurementPeriod` | [Timing](/fhir-elements/complex/timing) | `0..1` | Describes the measurement repetition time |
| <span id="element-calibration"></span>`calibration` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Describes the calibrations that have been performed or that are required to be performed |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `category` | token | The category of the metric |
| `identifier` | token | The identifier of the metric |
| `parent` | reference | The parent DeviceMetric resource |
| `source` | reference | The device resource |
| `type` | token | The component type |

## Reference [#reference]

Official FHIR R4 spec: [DeviceMetric](https://hl7.org/fhir/R4/devicemetric.html).  
Maturity: Trial Use 1 (FMM 1).
