# Device

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

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-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/Device/[id]` |
| Vread | `GET` | `/fhir/R4/Device/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Device/[id]` |
| Patch | `PATCH` | `/fhir/R4/Device/[id]` |
| Delete | `DELETE` | `/fhir/R4/Device/[id]` |
| Create | `POST` | `/fhir/R4/Device` |
| Search | `GET` | `/fhir/R4/Device` |
| History | `GET` | `/fhir/R4/Device/[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-definition"></span>`definition` | [Reference](/fhir-elements/complex/reference) | `0..1` | The reference to the definition for the device |
| <span id="element-udi-carrier"></span>`udiCarrier` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Unique Device Identifier (UDI) Barcode string |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `0..1` | active \| inactive \| entered-in-error \| unknown |
| <span id="element-status-reason"></span>`statusReason` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | online \| paused \| standby \| offline \| not-ready \| transduc-discon \| hw-discon \| off |
| <span id="element-distinct-identifier"></span>`distinctIdentifier` | [string](/fhir-elements/primitive/string) | `0..1` | The distinct identification string |
| <span id="element-manufacturer"></span>`manufacturer` | [string](/fhir-elements/primitive/string) | `0..1` | Name of device manufacturer |
| <span id="element-manufacture-date"></span>`manufactureDate` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date when the device was made |
| <span id="element-expiration-date"></span>`expirationDate` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date and time of expiry of this device (if applicable) |
| <span id="element-lot-number"></span>`lotNumber` | [string](/fhir-elements/primitive/string) | `0..1` | Lot number of manufacture |
| <span id="element-serial-number"></span>`serialNumber` | [string](/fhir-elements/primitive/string) | `0..1` | Serial number assigned by the manufacturer |
| <span id="element-device-name"></span>`deviceName` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | The name of the device as given by the manufacturer |
| <span id="element-model-number"></span>`modelNumber` | [string](/fhir-elements/primitive/string) | `0..1` | The model number for the device |
| <span id="element-part-number"></span>`partNumber` | [string](/fhir-elements/primitive/string) | `0..1` | The part number of the device |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | The kind or type of device |
| <span id="element-specialization"></span>`specialization` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication |
| <span id="element-version"></span>`version` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | The actual design of the device or software version running on the device |
| <span id="element-property"></span>`property` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties |
| <span id="element-patient"></span>`patient` | [Reference](/fhir-elements/complex/reference) | `0..1` | Patient to whom Device is affixed |
| <span id="element-owner"></span>`owner` | [Reference](/fhir-elements/complex/reference) | `0..1` | Organization responsible for device |
| <span id="element-contact"></span>`contact` | [ContactPoint](/fhir-elements/complex/contact-point) | `0..*` | Details for human/organization for support |
| <span id="element-location"></span>`location` | [Reference](/fhir-elements/complex/reference) | `0..1` | Where the device is found |
| <span id="element-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `0..1` | Network address to contact device |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Device notes and comments |
| <span id="element-safety"></span>`safety` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Safety Characteristics of Device |
| <span id="element-parent"></span>`parent` | [Reference](/fhir-elements/complex/reference) | `0..1` | The parent device |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `device-name` | string | A server defined search that may match any of the string fields in Device.deviceName or Device.type. |
| `din` | token | The donation identification number (DIN) |
| `identifier` | token | Instance id from manufacturer, owner, and others |
| `location` | reference | A location, where the resource is found |
| `manufacturer` | string | The manufacturer of the device |
| `model` | string | The model of the device |
| `organization` | reference | The organization responsible for the device |
| `patient` | reference | Patient information, if the resource is affixed to a person |
| `status` | token | active \| inactive \| entered-in-error \| unknown |
| `type` | token | The type of the device |
| `udi-carrier` | string | UDI Barcode (RFID or other technology) string in *HRF; format. |
| `udi-di` | string | The udi Device Identifier (DI) |
| `url` | uri | Network address to contact device |

## Reference [#reference]

Official FHIR R4 spec: [Device](https://hl7.org/fhir/R4/device.html).  
Maturity: Trial Use 2 (FMM 2).
