This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

12.25 Resource DeviceDispense - Content

Orders and Observations icon

Work Group

Maturity Level: 0

Trial Use

Security Category: Business

Compartments: Not linked to any defined compartments

A record of dispensation of a device.

12.25.1 Scope and Usage

Todo

12.25.2 Boundaries and Relationships

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.

12.25.3 References to this Resource

No references for this Resource.

Structure

Name	Flags	Card.	Type	Description & Constraints
DeviceDispense	TU		DomainResource	Device Dispense 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 DeviceDispense Status Codes (Required)
statusReason		0..1	CodeableReference(DetectedIssue)	Why a dispense was or was not performed 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)	Who the dispense is for
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	string	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) Who the dispense is for --></subject>
 <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="[string]"/><!-- 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) }, // R!  Who the dispense is for
  "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" : "<string>", // Full representation of the usage instructions
  "eventHistory" : [{ Reference(Provenance) }] // A list of relevant lifecycle events
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:DeviceDispense;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:DeviceDispense.identifier [ Identifier ], ... ; # 0..* Business identifier for this dispensation
  fhir:DeviceDispense.basedOn [ Reference(CarePlan|DeviceRequest) ], ... ; # 0..* The order or request that this dispense is fulfilling
  fhir:DeviceDispense.partOf [ Reference(Procedure) ], ... ; # 0..* The bigger event that this dispense is a part of
  fhir:DeviceDispense.status [ code ]; # 1..1 preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
  fhir:DeviceDispense.statusReason [ CodeableReference(DetectedIssue) ]; # 0..1 Why a dispense was or was not performed
  fhir:DeviceDispense.category [ CodeableConcept ], ... ; # 0..* Type of device dispense
  fhir:DeviceDispense.device [ CodeableReference(Device|DeviceDefinition) ]; # 1..1 What device was supplied
  fhir:DeviceDispense.subject [ Reference(Patient) ]; # 1..1 Who the dispense is for
  fhir:DeviceDispense.encounter [ Reference(Encounter) ]; # 0..1 Encounter associated with event
  fhir:DeviceDispense.supportingInformation [ Reference(Any) ], ... ; # 0..* Information that supports the dispensing of the device
  fhir:DeviceDispense.performer [ # 0..* Who performed event
    fhir:DeviceDispense.performer.function [ CodeableConcept ]; # 0..1 Who performed the dispense and what they did
    fhir:DeviceDispense.performer.actor [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 1..1 Individual who was performing
  ], ...;
  fhir:DeviceDispense.location [ Reference(Location) ]; # 0..1 Where the dispense occurred
  fhir:DeviceDispense.type [ CodeableConcept ]; # 0..1 Trial fill, partial fill, emergency fill, etc.
  fhir:DeviceDispense.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount dispensed
  fhir:DeviceDispense.preparedDate [ dateTime ]; # 0..1 When product was packaged and reviewed
  fhir:DeviceDispense.whenHandedOver [ dateTime ]; # 0..1 When product was given out
  fhir:DeviceDispense.destination [ Reference(Location) ]; # 0..1 Where the device was sent or should be sent
  fhir:DeviceDispense.note [ Annotation ], ... ; # 0..* Information about the dispense
  fhir:DeviceDispense.usageInstruction [ string ]; # 0..1 Full representation of the usage instructions
  fhir:DeviceDispense.eventHistory [ Reference(Provenance) ], ... ; # 0..* A list of relevant lifecycle events
]

Changes since R4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
DeviceDispense	TU		DomainResource	Device Dispense 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 DeviceDispense Status Codes (Required)
statusReason		0..1	CodeableReference(DetectedIssue)	Why a dispense was or was not performed 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)	Who the dispense is for
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	string	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) Who the dispense is for --></subject>
 <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="[string]"/><!-- 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) }, // R!  Who the dispense is for
  "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" : "<string>", // Full representation of the usage instructions
  "eventHistory" : [{ Reference(Provenance) }] // A list of relevant lifecycle events
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:DeviceDispense;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:DeviceDispense.identifier [ Identifier ], ... ; # 0..* Business identifier for this dispensation
  fhir:DeviceDispense.basedOn [ Reference(CarePlan|DeviceRequest) ], ... ; # 0..* The order or request that this dispense is fulfilling
  fhir:DeviceDispense.partOf [ Reference(Procedure) ], ... ; # 0..* The bigger event that this dispense is a part of
  fhir:DeviceDispense.status [ code ]; # 1..1 preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
  fhir:DeviceDispense.statusReason [ CodeableReference(DetectedIssue) ]; # 0..1 Why a dispense was or was not performed
  fhir:DeviceDispense.category [ CodeableConcept ], ... ; # 0..* Type of device dispense
  fhir:DeviceDispense.device [ CodeableReference(Device|DeviceDefinition) ]; # 1..1 What device was supplied
  fhir:DeviceDispense.subject [ Reference(Patient) ]; # 1..1 Who the dispense is for
  fhir:DeviceDispense.encounter [ Reference(Encounter) ]; # 0..1 Encounter associated with event
  fhir:DeviceDispense.supportingInformation [ Reference(Any) ], ... ; # 0..* Information that supports the dispensing of the device
  fhir:DeviceDispense.performer [ # 0..* Who performed event
    fhir:DeviceDispense.performer.function [ CodeableConcept ]; # 0..1 Who performed the dispense and what they did
    fhir:DeviceDispense.performer.actor [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 1..1 Individual who was performing
  ], ...;
  fhir:DeviceDispense.location [ Reference(Location) ]; # 0..1 Where the dispense occurred
  fhir:DeviceDispense.type [ CodeableConcept ]; # 0..1 Trial fill, partial fill, emergency fill, etc.
  fhir:DeviceDispense.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount dispensed
  fhir:DeviceDispense.preparedDate [ dateTime ]; # 0..1 When product was packaged and reviewed
  fhir:DeviceDispense.whenHandedOver [ dateTime ]; # 0..1 When product was given out
  fhir:DeviceDispense.destination [ Reference(Location) ]; # 0..1 Where the device was sent or should be sent
  fhir:DeviceDispense.note [ Annotation ], ... ; # 0..* Information about the dispense
  fhir:DeviceDispense.usageInstruction [ string ]; # 0..1 Full representation of the usage instructions
  fhir:DeviceDispense.eventHistory [ Reference(Provenance) ], ... ; # 0..* A list of relevant lifecycle events
]

Changes since Release 4

This resource did not exist in Release 3

This analysis is available 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

12.25.4.1 Terminology Bindings

Path	Definition	Type	Reference
DeviceDispense.status	DeviceDispense Status Codes	Required	DeviceDispenseStatusCodes
DeviceDispense.statusReason	DeviceDispense Status Reason Codes	Example	DeviceDispenseStatusReasonCodes

Path

Definition

Type

Reference

DeviceDispense.status

DeviceDispense Status Codes

Required

DeviceDispenseStatusCodes

DeviceDispense.statusReason

DeviceDispense Status Reason Codes

Example

DeviceDispenseStatusReasonCodes

12.25.5 Search Parameters

Search parameters for 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
subject	reference	The identity of a patient for whom to list dispenses	DeviceDispense.subject (Patient)