Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Orders and Observations Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the DeviceDispense resource.

DeviceDispense
Element IdDeviceDispense
Definition

A record of dispensation of a device.

Short DisplayDevice Dispense
Cardinality0..*
TypeDomainResource
Summaryfalse
DeviceDispense.identifier
Element IdDeviceDispense.identifier
Definition

Business identifier for this dispensation.

Short DisplayBusiness identifier for this dispensation
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
Comments

This is a business identifier, not a resource identifier.

DeviceDispense.basedOn
Element IdDeviceDispense.basedOn
Definition

The order or request that this dispense is fulfilling.

Short DisplayThe order or request that this dispense is fulfilling
Cardinality0..*
TypeReference(CarePlan | DeviceRequest)
Summaryfalse
DeviceDispense.partOf
Element IdDeviceDispense.partOf
Definition

The bigger event that this dispense is a part of.

Short DisplayThe bigger event that this dispense is a part of
Cardinality0..*
TypeReference(Procedure)
Summaryfalse
DeviceDispense.status
Element IdDeviceDispense.status
Definition

A code specifying the state of the set of dispense events.

Short Displaypreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Cardinality1..1
Terminology BindingDeviceDispense Status Codes (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
Comments

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

DeviceDispense.statusReason
Element IdDeviceDispense.statusReason
Definition

Indicates the reason why a dispense was or was not performed.

Short DisplayWhy a dispense was or was not performed
Cardinality0..1
Terminology BindingDeviceDispense Status Reason Codes (Example)
TypeCodeableReference(DetectedIssue)
Summaryfalse
DeviceDispense.category
Element IdDeviceDispense.category
Definition

Indicates the type of device dispense.

Short DisplayType of device dispense
Cardinality0..*
TypeCodeableConcept
Summaryfalse
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.

DeviceDispense.device
Element IdDeviceDispense.device
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.

Short DisplayWhat device was supplied
Cardinality1..1
TypeCodeableReference(Device | DeviceDefinition)
Summarytrue
DeviceDispense.subject
Element IdDeviceDispense.subject
Definition

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

Short DisplayWho the dispense is for
Cardinality1..1
TypeReference(Patient)
Summarytrue
Comments

What about 'this measuring Device is now asigned to Dr X who needs it now'?

DeviceDispense.encounter
Element IdDeviceDispense.encounter
Definition

The encounter that establishes the context for this event.

Short DisplayEncounter associated with event
Cardinality0..1
TypeReference(Encounter)
Summaryfalse
DeviceDispense.supportingInformation
Element IdDeviceDispense.supportingInformation
Definition

Additional information that supports the device being dispensed.

Short DisplayInformation that supports the dispensing of the device
Cardinality0..*
TypeReference(Any)
Summaryfalse
DeviceDispense.performer
Element IdDeviceDispense.performer
Definition

Indicates who or what performed the event.

Short DisplayWho performed event
Cardinality0..*
Summaryfalse
DeviceDispense.performer.function
Element IdDeviceDispense.performer.function
Definition

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

Short DisplayWho performed the dispense and what they did
Cardinality0..1
TypeCodeableConcept
Requirements

Allows disambiguation of the types of involvement of different performers.

Summaryfalse
DeviceDispense.performer.actor
Element IdDeviceDispense.performer.actor
Definition

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

Short DisplayIndividual who was performing
Cardinality1..1
TypeReference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)
Summaryfalse
DeviceDispense.location
Element IdDeviceDispense.location
Definition

The principal physical location where the dispense was performed.

Short DisplayWhere the dispense occurred
Cardinality0..1
TypeReference(Location)
Summaryfalse
DeviceDispense.type
Element IdDeviceDispense.type
Definition

Indicates the type of dispensing event that is performed.

Short DisplayTrial fill, partial fill, emergency fill, etc.
Cardinality0..1
TypeCodeableConcept
Summaryfalse
DeviceDispense.quantity
Element IdDeviceDispense.quantity
Definition

The number of devices that have been dispensed.

Short DisplayAmount dispensed
Cardinality0..1
TypeSimpleQuantity
Summaryfalse
DeviceDispense.preparedDate
Element IdDeviceDispense.preparedDate
Definition

The time when the dispensed product was packaged and reviewed.

Short DisplayWhen product was packaged and reviewed
Cardinality0..1
TypedateTime
Summarytrue
DeviceDispense.whenHandedOver
Element IdDeviceDispense.whenHandedOver
Definition

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

Short DisplayWhen product was given out
Cardinality0..1
TypedateTime
Summaryfalse
DeviceDispense.destination
Element IdDeviceDispense.destination
Definition

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

Short DisplayWhere the device was sent or should be sent
Cardinality0..1
TypeReference(Location)
Summaryfalse
DeviceDispense.note
Element IdDeviceDispense.note
Definition

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

Short DisplayInformation about the dispense
Cardinality0..*
TypeAnnotation
Summaryfalse
DeviceDispense.usageInstruction
Element IdDeviceDispense.usageInstruction
Definition

The full representation of the instructions.

Short DisplayFull representation of the usage instructions
Cardinality0..1
Typestring
Summaryfalse
Comments

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

DeviceDispense.eventHistory
Element IdDeviceDispense.eventHistory
Definition

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

Short DisplayA list of relevant lifecycle events
Cardinality0..*
TypeReference(Provenance)
Summaryfalse
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.).