DeviceDispense
Indicates that a device is to be or has been dispensed for a named person/patient. This includes a description of the product (supply) provided and the instructions for using the device.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/DeviceDispense| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/DeviceDispense/[id] |
| Vread | GET | /fhir/R5/DeviceDispense/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/DeviceDispense/[id] |
| Patch | PATCH | /fhir/R5/DeviceDispense/[id] |
| Delete | DELETE | /fhir/R5/DeviceDispense/[id] |
| Create | POST | /fhir/R5/DeviceDispense |
| Search | GET | /fhir/R5/DeviceDispense?... |
| History | GET | /fhir/R5/DeviceDispense/[id]/_history |
| Type-history | GET | /fhir/R5/DeviceDispense/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | Business identifier for this dispensation |
basedOn | Reference | 0..* | The order or request that this dispense is fulfilling |
partOf | Reference | 0..* | The bigger event that this dispense is a part of |
status | code | 1..1 | preparation |
statusReason | CodeableReference | 0..1 | Why a dispense was or was not performed |
category | CodeableConcept | 0..* | Type of device dispense |
device | CodeableReference | 1..1 | What device was supplied |
subject | Reference | 1..1 | Who the dispense is for |
receiver | Reference | 0..1 | Who collected the device or where the medication was delivered |
encounter | Reference | 0..1 | Encounter associated with event |
supportingInformation | Reference | 0..* | Information that supports the dispensing of the device |
performer | BackboneElement | 0..* | Who performed event |
location | Reference | 0..1 | Where the dispense occurred |
type | CodeableConcept | 0..1 | Trial fill, partial fill, emergency fill, etc |
quantity | Quantity | 0..1 | Amount dispensed |
preparedDate | dateTime | 0..1 | When product was packaged and reviewed |
whenHandedOver | dateTime | 0..1 | When product was given out |
destination | Reference | 0..1 | Where the device was sent or should be sent |
note | Annotation | 0..* | Information about the dispense |
usageInstruction | markdown | 0..1 | Full representation of the usage instructions |
eventHistory | Reference | 0..* | A list of relevant lifecycle events |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
code | token | Search for devices that match this code |
identifier | token | The identifier of the dispense |
patient | reference | Returns device dispenses for a specific patient |
status | token | The status of the dispense |
subject | reference | The identity of a patient for whom to list dispenses |
Reference
- Official FHIR R5 spec:
DeviceDispense - Maturity: Draft (FMM 0).