Release 5
WorkflowThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Orders and Observations Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: No defined compartments |
A record of dispensation of a device - i.e., assigning a device to a patient, or to a professional for their use.
The DeviceDispense resource is used to capture the assignment of a Device to a patient or practitioner for the purpose of care. The dispense may include a description of the device and the instructions for using the device. The request to initiate a DeviceDispense may be via a DeviceRequest resource but may be implicitly triggered by for example a ServiceRequest, or without any request. The details of the clinical application of the dispensed device may be captured in a Procedure resource.
To determine the purchase date, a search of DeviceRequest, SupplyRequest, DeviceDispense, or SupplyDelivery as defined in an implementation guide can be done , as the context of the use case actually determines which date of either resource is considered the purchase date.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DeviceDispense | TU | DomainResource | A record of dispensation of a device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
  identifier | Σ | 0..* | Identifier | Business identifier for this dispensation |
 basedOn | 0..* | Reference(CarePlan | DeviceRequest) | The order or request that this dispense is fulfilling | |
| partOf | 0..* | Reference(Procedure) | The bigger event that this dispense is a part of | |
 status | ?!Σ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: DeviceDispense Status Codes (Required) |
| statusReason | 0..1 | CodeableReference(DetectedIssue) | Why a dispense was or was not performed Binding: DeviceDispense Status Reason Codes (Example) | |
| category | 0..* | CodeableConcept | Type of device dispense | |
| device | Σ | 1..1 | CodeableReference(Device | DeviceDefinition) | What device was supplied |
| subject | Σ | 1..1 | Reference(Patient | Practitioner) | Who the dispense is for |
| receiver | 0..1 | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the device or where the medication was delivered | |
| encounter | 0..1 | Reference(Encounter) | Encounter associated with event | |
| supportingInformation | 0..* | Reference(Any) | Information that supports the dispensing of the device | |
  performer | 0..* | BackboneElement | Who performed event | |
 function | 0..1 | CodeableConcept | Who performed the dispense and what they did | |
 actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | |
| location | 0..1 | Reference(Location) | Where the dispense occurred | |
| type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc | |
| quantity | 0..1 | SimpleQuantity | Amount dispensed | |
| preparedDate | Σ | 0..1 | dateTime | When product was packaged and reviewed |
| whenHandedOver | 0..1 | dateTime | When product was given out | |
| destination | 0..1 | Reference(Location) | Where the device was sent or should be sent | |
| note | 0..* | Annotation | Information about the dispense | |
| usageInstruction | 0..1 | markdown | Full representation of the usage instructions | |
| eventHistory | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |
| Documentation for this format |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<DeviceDispense xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business identifier for this dispensation --></identifier> <basedOn><!-- 0..* Reference(CarePlan|DeviceRequest) The order or request that this dispense is fulfilling --></basedOn> <partOf><!-- 0..* Reference(Procedure) The bigger event that this dispense is a part of --></partOf> <status value="[code]"/><!-- 1..1 preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown --> <statusReason><!-- 0..1 CodeableReference(DetectedIssue) Why a dispense was or was not performed --></statusReason> <category><!-- 0..* CodeableConcept Type of device dispense --></category> <device><!-- 1..1 CodeableReference(Device|DeviceDefinition) What device was supplied --></device> <subject><!-- 1..1 Reference(Patient|Practitioner) Who the dispense is for --></subject> <receiver><!-- 0..1 Reference(Location|Patient|Practitioner|PractitionerRole| RelatedPerson) Who collected the device or where the medication was delivered --></receiver> <encounter><!-- 0..1 Reference(Encounter) Encounter associated with event --></encounter> <supportingInformation><!-- 0..* Reference(Any) Information that supports the dispensing of the device --></supportingInformation> <performer> <!-- 0..* Who performed event --> <function><!-- 0..1 CodeableConcept Who performed the dispense and what they did --></function> <actor><!-- 1..1 Reference(CareTeam|Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Individual who was performing --></actor> </performer> <location><!-- 0..1 Reference(Location) Where the dispense occurred --></location> <type><!-- 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc --></type> <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount dispensed --></quantity> <preparedDate value="[dateTime]"/><!-- 0..1 When product was packaged and reviewed --> <whenHandedOver value="[dateTime]"/><!-- 0..1 When product was given out --> <destination><!-- 0..1 Reference(Location) Where the device was sent or should be sent --></destination> <note><!-- 0..* Annotation Information about the dispense --></note> <usageInstruction value="[markdown]"/><!-- 0..1 Full representation of the usage instructions --> <eventHistory><!-- 0..* Reference(Provenance) A list of relevant lifecycle events --></eventHistory> </DeviceDispense>
JSON Template
{
"resourceType" : "DeviceDispense",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier for this dispensation
"basedOn" : [{ Reference(CarePlan|DeviceRequest) }], // The order or request that this dispense is fulfilling
"partOf" : [{ Reference(Procedure) }], // The bigger event that this dispense is a part of
"status" : "<code>", // R! preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
"statusReason" : { CodeableReference(DetectedIssue) }, // Why a dispense was or was not performed
"category" : [{ CodeableConcept }], // Type of device dispense
"device" : { CodeableReference(Device|DeviceDefinition) }, // R! What device was supplied
"subject" : { Reference(Patient|Practitioner) }, // R! Who the dispense is for
"receiver" : { Reference(Location|Patient|Practitioner|PractitionerRole|
RelatedPerson) }, // Who collected the device or where the medication was delivered
"encounter" : { Reference(Encounter) }, // Encounter associated with event
"supportingInformation" : [{ Reference(Any) }], // Information that supports the dispensing of the device
"performer" : [{ // Who performed event
"function" : { CodeableConcept }, // Who performed the dispense and what they did
"actor" : { Reference(CareTeam|Device|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) } // R! Individual who was performing
}],
"location" : { Reference(Location) }, // Where the dispense occurred
"type" : { CodeableConcept }, // Trial fill, partial fill, emergency fill, etc
"quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
"preparedDate" : "<dateTime>", // When product was packaged and reviewed
"whenHandedOver" : "<dateTime>", // When product was given out
"destination" : { Reference(Location) }, // Where the device was sent or should be sent
"note" : [{ Annotation }], // Information about the dispense
"usageInstruction" : "<markdown>", // Full representation of the usage instructions
"eventHistory" : [{ Reference(Provenance) }] // A list of relevant lifecycle events
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DeviceDispense | TU | DomainResource | A record of dispensation of a device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| identifier | Σ | 0..* | Identifier | Business identifier for this dispensation |
| basedOn | 0..* | Reference(CarePlan | DeviceRequest) | The order or request that this dispense is fulfilling | |
| partOf | 0..* | Reference(Procedure) | The bigger event that this dispense is a part of | |
| status | ?!Σ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: DeviceDispense Status Codes (Required) |
| statusReason | 0..1 | CodeableReference(DetectedIssue) | Why a dispense was or was not performed Binding: DeviceDispense Status Reason Codes (Example) | |
| category | 0..* | CodeableConcept | Type of device dispense | |
| device | Σ | 1..1 | CodeableReference(Device | DeviceDefinition) | What device was supplied |
| subject | Σ | 1..1 | Reference(Patient | Practitioner) | Who the dispense is for |
| receiver | 0..1 | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the device or where the medication was delivered | |
| encounter | 0..1 | Reference(Encounter) | Encounter associated with event | |
| supportingInformation | 0..* | Reference(Any) | Information that supports the dispensing of the device | |
| performer | 0..* | BackboneElement | Who performed event | |
| function | 0..1 | CodeableConcept | Who performed the dispense and what they did | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | |
| location | 0..1 | Reference(Location) | Where the dispense occurred | |
| type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc | |
| quantity | 0..1 | SimpleQuantity | Amount dispensed | |
| preparedDate | Σ | 0..1 | dateTime | When product was packaged and reviewed |
| whenHandedOver | 0..1 | dateTime | When product was given out | |
| destination | 0..1 | Reference(Location) | Where the device was sent or should be sent | |
| note | 0..* | Annotation | Information about the dispense | |
| usageInstruction | 0..1 | markdown | Full representation of the usage instructions | |
| eventHistory | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |
| Documentation for this format |
See the Extensions for this resource
XML Template
<DeviceDispense xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "DeviceDispense",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier for this dispensation
"basedOn" : [{ Reference(CarePlan|DeviceRequest) }], // The order or request that this dispense is fulfilling
"partOf" : [{ Reference(Procedure) }], // The bigger event that this dispense is a part of
"status" : "<code>", // R! preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
"statusReason" : { CodeableReference(DetectedIssue) }, // Why a dispense was or was not performed
"category" : [{ CodeableConcept }], // Type of device dispense
"device" : { CodeableReference(Device|DeviceDefinition) }, // R! What device was supplied
"subject" : { Reference(Patient|Practitioner) }, // R! Who the dispense is for
"receiver" : { Reference(Location|Patient|Practitioner|PractitionerRole|
RelatedPerson) }, // Who collected the device or where the medication was delivered
"encounter" : { Reference(Encounter) }, // Encounter associated with event
"supportingInformation" : [{ Reference(Any) }], // Information that supports the dispensing of the device
"performer" : [{ // Who performed event
"function" : { CodeableConcept }, // Who performed the dispense and what they did
"actor" : { Reference(CareTeam|Device|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) } // R! Individual who was performing
}],
"location" : { Reference(Location) }, // Where the dispense occurred
"type" : { CodeableConcept }, // Trial fill, partial fill, emergency fill, etc
"quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
"preparedDate" : "<dateTime>", // When product was packaged and reviewed
"whenHandedOver" : "<dateTime>", // When product was given out
"destination" : { Reference(Location) }, // Where the device was sent or should be sent
"note" : [{ Annotation }], // Information about the dispense
"usageInstruction" : "<markdown>", // Full representation of the usage instructions
"eventHistory" : [{ Reference(Provenance) }] // A list of relevant lifecycle events
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| DeviceDispense.status | DeviceDispenseStatusCodes | Required | DeviceDispense Status Codes |
| DeviceDispense.statusReason | DeviceDispenseStatusReasonCodes | Example | DeviceDispense Status Reason Codes |
Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| code | token | Search for devices that match this code | DeviceDispense.device.concept | |
| identifier | token | The identifier of the dispense | DeviceDispense.identifier | |
| patient | reference | Returns device dispenses for a specific patient | DeviceDispense.subject.where(resolve() is Patient) (Patient) | |
| status | token | The status of the dispense | DeviceDispense.status | |
| subject | reference | The identity of a patient for whom to list dispenses | DeviceDispense.subject (Practitioner, Patient) |
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:24+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change