# DeviceDefinition

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

The characteristics, operational status and capabilities of a medical-related component 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/DeviceDefinition/[id]` |
| Vread | `GET` | `/fhir/R4/DeviceDefinition/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/DeviceDefinition/[id]` |
| Patch | `PATCH` | `/fhir/R4/DeviceDefinition/[id]` |
| Delete | `DELETE` | `/fhir/R4/DeviceDefinition/[id]` |
| Create | `POST` | `/fhir/R4/DeviceDefinition` |
| Search | `GET` | `/fhir/R4/DeviceDefinition` |
| History | `GET` | `/fhir/R4/DeviceDefinition/[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-udi-device-identifier"></span>`udiDeviceIdentifier` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Unique Device Identifier (UDI) Barcode string |
| <span id="element-manufacturer-x"></span>`manufacturer[x]` | [string](/fhir-elements/primitive/string), [Reference](/fhir-elements/complex/reference) | `0..1` | Name of device manufacturer |
| <span id="element-device-name"></span>`deviceName` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | A name given to the device to identify it |
| <span id="element-model-number"></span>`modelNumber` | [string](/fhir-elements/primitive/string) | `0..1` | The model number for the device |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | What kind of device or device system this is |
| <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` | [string](/fhir-elements/primitive/string) | `0..*` | Available versions |
| <span id="element-safety"></span>`safety` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Safety characteristics of the device |
| <span id="element-shelf-life-storage"></span>`shelfLifeStorage` | [ProductShelfLife](/fhir-elements/complex/product-shelf-life) | `0..*` | Shelf Life and storage information |
| <span id="element-physical-characteristics"></span>`physicalCharacteristics` | [ProdCharacteristic](/fhir-elements/complex/prod-characteristic) | `0..1` | Dimensions, color etc. |
| <span id="element-language-code"></span>`languageCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Language code for the human-readable text strings produced by the device (all supported) |
| <span id="element-capability"></span>`capability` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Device capabilities |
| <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-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-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `0..1` | Network address to contact device |
| <span id="element-online-information"></span>`onlineInformation` | [uri](/fhir-elements/primitive/uri) | `0..1` | Access to on-line information |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Device notes and comments |
| <span id="element-quantity"></span>`quantity` | [Quantity](/fhir-elements/complex/quantity) | `0..1` | The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product) |
| <span id="element-parent-device"></span>`parentDevice` | [Reference](/fhir-elements/complex/reference) | `0..1` | The parent device it can be part of |
| <span id="element-material"></span>`material` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | A substance used to create the material(s) of which the device is made |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `identifier` | token | The identifier of the component |
| `parent` | reference | The parent DeviceDefinition resource |
| `type` | token | The device component type |

## Reference [#reference]

Official FHIR R4 spec: [DeviceDefinition](https://hl7.org/fhir/R4/devicedefinition.html).  
Maturity: Draft (FMM 0).
