---
type: "resource-definitions"
title: "DeviceDispense Definitions"
resource: "DeviceDispense"
---

# DeviceDispense Definitions

<a id="DeviceDispense"></a>

## DeviceDispense
A record of dispensation of a device

**Definition:** A record of dispensation of a device - i.e., assigning a device to a patient, or to a professional for their use.

**Cardinality:** 0..*

**Mappings:** workflow=Event; w5=administrative.device


<a id="DeviceDispense.identifier"></a>

## DeviceDispense.identifier
Business identifier for this dispensation

**Definition:** Business identifier for this dispensation.

**Comments:** This is a business identifier, not a resource identifier.

**Cardinality:** 0..*

**Type:** [Identifier](/Identifier)

**Summary:** true

**Mappings:** w5=FiveWs.identifier; workflow=Event.identifier


<a id="DeviceDispense.basedOn"></a>

## DeviceDispense.basedOn
The order or request that this dispense is fulfilling

**Definition:** The order or request that this dispense is fulfilling.

**Cardinality:** 0..*

**Type:** Reference([CarePlan](/CarePlan), [DeviceRequest](/DeviceRequest))

**Mappings:** workflow=Event.basedOn


<a id="DeviceDispense.partOf"></a>

## DeviceDispense.partOf
The bigger event that this dispense is a part of

**Definition:** The bigger event that this dispense is a part of.

**Cardinality:** 0..*

**Type:** Reference([Procedure](/Procedure))

**Mappings:** workflow=Event.partOf; rim=.outboundRelationship[typeCode=COMP]/target[classCode=PROC,moodCode=EVN]


<a id="DeviceDispense.status"></a>

## DeviceDispense.status
preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown

**Definition:** A code specifying the state of the set of dispense events.

**Comments:** This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

**Cardinality:** 1..1

**Type:** [code](/code)

**Binding:** required:[devicedispense-status](/valueset-devicedispense-status)

**Summary:** true

**Is Modifier:** true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)

**Mappings:** workflow=Event.status; w5=FiveWs.status; rim=.statusCode


<a id="DeviceDispense.statusReason"></a>

## DeviceDispense.statusReason
Why a dispense was or was not performed

**Definition:** Indicates the reason why a dispense was or was not performed.

**Cardinality:** 0..1

**Type:** [CodeableReference](/CodeableReference)

**Binding:** example:[devicedispense-status-reason](/valueset-devicedispense-status-reason)

**Mappings:** workflow=Event.statusReason; rim=.outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="not done reason"].value


<a id="DeviceDispense.category"></a>

## DeviceDispense.category
Type of device dispense

**Definition:** Indicates the type of device dispense.

**Comments:** The category can be used to include where the device is expected to be consumed or other types of dispenses.  Invariants can be used to bind to different value sets when profiling to bind.

**Cardinality:** 0..*

**Type:** [CodeableConcept](/CodeableConcept)

**Mappings:** workflow=Event.category


<a id="DeviceDispense.device"></a>

## DeviceDispense.device
What device was supplied

**Definition:** Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.

**Cardinality:** 1..1

**Type:** [CodeableReference](/CodeableReference)

**Summary:** true

**Mappings:** workflow=Event.code; w5=FiveWs.what[x]; workflow=Event.product


<a id="DeviceDispense.subject"></a>

## DeviceDispense.subject
Who the dispense is for

**Definition:** A link to a resource representing the person to whom the device is intended.

**Comments:** Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

**Cardinality:** 1..1

**Type:** Reference([Patient](/Patient), [Practitioner](/Practitioner), [Group](/Group))

**Summary:** true

**Mappings:** workflow=Event.subject; w5=FiveWs.subject; v2=PID-3-Patient ID List; rim=.participation[typeCode=SBJ].role[classCode=PAT]


<a id="DeviceDispense.receiver"></a>

## DeviceDispense.receiver
Who collected the device or where the medication was delivered

**Definition:** Identifies the person who picked up the device or the person or location where the device was delivered.  This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.

**Comments:** Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

**Cardinality:** 0..1

**Type:** Reference([Patient](/Patient), [Practitioner](/Practitioner), [RelatedPerson](/RelatedPerson), [Location](/Location), [PractitionerRole](/PractitionerRole), [Group](/Group))

**Mappings:** rim=.participation[typeCode=RCV].role


<a id="DeviceDispense.encounter"></a>

## DeviceDispense.encounter
Encounter associated with event

**Definition:** The encounter that establishes the context for this event.

**Cardinality:** 0..1

**Type:** Reference([Encounter](/Encounter))

**Mappings:** workflow=Event.encounter; rim=.inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code="type of encounter or episode"]


<a id="DeviceDispense.supportingInformation"></a>

## DeviceDispense.supportingInformation
Information that supports the dispensing of the device

**Definition:** Additional information that supports the device being dispensed.

**Cardinality:** 0..*

**Type:** Reference([Resource](/Resource))

**Mappings:** w5=FiveWs.context


<a id="DeviceDispense.performer"></a>

## DeviceDispense.performer
Who performed event

**Definition:** Indicates who or what performed the event.

**Cardinality:** 0..*

**Type:** [BackboneElement](/BackboneElement)

**Mappings:** workflow=Event.performer; rim=.participation[typeCode=PRF]


<a id="DeviceDispense.performer.function"></a>

## DeviceDispense.performer.function
Who performed the dispense and what they did

**Definition:** Distinguishes the type of performer in the dispense.  For example, date enterer, packager, final checker.

**Requirements:** Allows disambiguation of the types of involvement of different performers.

**Cardinality:** 0..1

**Type:** [CodeableConcept](/CodeableConcept)

**Mappings:** rim=participation[typeCode=PRF].functionCode


<a id="DeviceDispense.performer.actor"></a>

## DeviceDispense.performer.actor
Individual who was performing

**Definition:** The device, practitioner, etc. who performed the action.  It should be assumed that the actor is the dispenser of the device.

**Comments:** Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

**Cardinality:** 1..1

**Type:** Reference([Practitioner](/Practitioner), [PractitionerRole](/PractitionerRole), [Organization](/Organization), [Patient](/Patient), [Device](/Device), [RelatedPerson](/RelatedPerson), [CareTeam](/CareTeam), [Group](/Group))

**Mappings:** workflow=Event.performer.actor; rim=.role


<a id="DeviceDispense.location"></a>

## DeviceDispense.location
Where the dispense occurred

**Definition:** The principal physical location where the dispense was performed.

**Cardinality:** 0..1

**Type:** Reference([Location](/Location))

**Mappings:** rim=.participation[typeCode=LOC].role; workflow=Event.location


<a id="DeviceDispense.type"></a>

## DeviceDispense.type
Trial fill, partial fill, emergency fill, etc

**Definition:** Indicates the type of dispensing event that is performed.

**Cardinality:** 0..1

**Type:** [CodeableConcept](/CodeableConcept)


<a id="DeviceDispense.quantity"></a>

## DeviceDispense.quantity
Amount dispensed

**Definition:** The number of devices that have been dispensed.

**Cardinality:** 0..1

**Type:** [Quantity](/Quantity)([SimpleQuantity](/SimpleQuantity))

**Mappings:** rim=.quantity


<a id="DeviceDispense.preparedDate"></a>

## DeviceDispense.preparedDate
When product was packaged and reviewed

**Definition:** The time when the dispensed product was packaged and reviewed.

**Cardinality:** 0..1

**Type:** [dateTime](/dateTime)

**Summary:** true

**Mappings:** rim=.effectiveTime[xmi:type=IVL_TS].low


<a id="DeviceDispense.whenHandedOver"></a>

## DeviceDispense.whenHandedOver
When product was given out

**Definition:** The time the dispensed product was made available to the patient or their representative.

**Cardinality:** 0..1

**Type:** [dateTime](/dateTime)

**Mappings:** workflow=Event.occurrence[x]; rim=.effectiveTime[xmi:type=IVL_TS].high


<a id="DeviceDispense.destination"></a>

## DeviceDispense.destination
Where the device was sent or should be sent

**Definition:** Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.

**Cardinality:** 0..1

**Type:** Reference([Location](/Location))

**Mappings:** rim=.participation[typeCode=DST].role


<a id="DeviceDispense.note"></a>

## DeviceDispense.note
Information about the dispense

**Definition:** Extra information about the dispense that could not be conveyed in the other attributes.

**Cardinality:** 0..*

**Type:** [Annotation](/Annotation)

**Mappings:** workflow=Event.note; rim=.inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN]


<a id="DeviceDispense.usageInstruction"></a>

## DeviceDispense.usageInstruction
Full representation of the usage instructions

**Definition:** The full representation of the instructions.

**Comments:** The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.

**Cardinality:** 0..1

**Type:** [markdown](/markdown)


<a id="DeviceDispense.relevantHistory"></a>

## DeviceDispense.relevantHistory
A list of relevant lifecycle events

**Definition:** A summary of the events of interest that have occurred, such as when the dispense was verified.

**Comments:** This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

**Cardinality:** 0..*

**Type:** Reference([Provenance](/Provenance))

**Mappings:** rim=.inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]; workflow=Event.relevantHistory