This 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 |
Detailed Descriptions for the elements in the DeviceDispense resource.
DeviceDispense | |
Element Id | DeviceDispense |
Definition | A record of dispensation of a device - i.e., assigning a device to a patient, or to a professional for their use. |
Short Display | A record of dispensation of a device |
Cardinality | 0..* |
Type | DomainResource |
Summary | false |
DeviceDispense.identifier | |
Element Id | DeviceDispense.identifier |
Definition | Business identifier for this dispensation. |
Short Display | Business identifier for this dispensation |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Summary | true |
Comments | This is a business identifier, not a resource identifier. |
DeviceDispense.basedOn | |
Element Id | DeviceDispense.basedOn |
Definition | The order or request that this dispense is fulfilling. |
Short Display | The order or request that this dispense is fulfilling |
Cardinality | 0..* |
Type | Reference(CarePlan | DeviceRequest) |
Summary | false |
DeviceDispense.partOf | |
Element Id | DeviceDispense.partOf |
Definition | The bigger event that this dispense is a part of. |
Short Display | The bigger event that this dispense is a part of |
Cardinality | 0..* |
Type | Reference(Procedure) |
Summary | false |
DeviceDispense.status | |
Element Id | DeviceDispense.status |
Definition | A code specifying the state of the set of dispense events. |
Short Display | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown |
Cardinality | 1..1 |
Terminology Binding | DeviceDispense Status Codes (Required) |
Type | code |
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) |
Summary | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
DeviceDispense.statusReason | |
Element Id | DeviceDispense.statusReason |
Definition | Indicates the reason why a dispense was or was not performed. |
Short Display | Why a dispense was or was not performed |
Cardinality | 0..1 |
Terminology Binding | DeviceDispense Status Reason Codes (Example) |
Type | CodeableReference(DetectedIssue) |
Summary | false |
DeviceDispense.category | |
Element Id | DeviceDispense.category |
Definition | Indicates the type of device dispense. |
Short Display | Type of device dispense |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | false |
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 Id | DeviceDispense.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 Display | What device was supplied |
Cardinality | 1..1 |
Type | CodeableReference(Device | DeviceDefinition) |
Summary | true |
DeviceDispense.subject | |
Element Id | DeviceDispense.subject |
Definition | A link to a resource representing the person to whom the device is intended. |
Short Display | Who the dispense is for |
Cardinality | 1..1 |
Type | Reference(Patient | Practitioner) |
Summary | true |
Comments | What about 'this measuring Device is now asigned to Dr X who needs it now'? |
DeviceDispense.receiver | |
Element Id | DeviceDispense.receiver |
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. |
Short Display | Who collected the device or where the medication was delivered |
Cardinality | 0..1 |
Type | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) |
Summary | false |
DeviceDispense.encounter | |
Element Id | DeviceDispense.encounter |
Definition | The encounter that establishes the context for this event. |
Short Display | Encounter associated with event |
Cardinality | 0..1 |
Type | Reference(Encounter) |
Summary | false |
DeviceDispense.supportingInformation | |
Element Id | DeviceDispense.supportingInformation |
Definition | Additional information that supports the device being dispensed. |
Short Display | Information that supports the dispensing of the device |
Cardinality | 0..* |
Type | Reference(Any) |
Summary | false |
DeviceDispense.performer | |
Element Id | DeviceDispense.performer |
Definition | Indicates who or what performed the event. |
Short Display | Who performed event |
Cardinality | 0..* |
Summary | false |
DeviceDispense.performer.function | |
Element Id | DeviceDispense.performer.function |
Definition | Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. |
Short Display | Who performed the dispense and what they did |
Cardinality | 0..1 |
Type | CodeableConcept |
Requirements | Allows disambiguation of the types of involvement of different performers. |
Summary | false |
DeviceDispense.performer.actor | |
Element Id | DeviceDispense.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 Display | Individual who was performing |
Cardinality | 1..1 |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) |
Summary | false |
DeviceDispense.location | |
Element Id | DeviceDispense.location |
Definition | The principal physical location where the dispense was performed. |
Short Display | Where the dispense occurred |
Cardinality | 0..1 |
Type | Reference(Location) |
Summary | false |
DeviceDispense.type | |
Element Id | DeviceDispense.type |
Definition | Indicates the type of dispensing event that is performed. |
Short Display | Trial fill, partial fill, emergency fill, etc |
Cardinality | 0..1 |
Type | CodeableConcept |
Summary | false |
DeviceDispense.quantity | |
Element Id | DeviceDispense.quantity |
Definition | The number of devices that have been dispensed. |
Short Display | Amount dispensed |
Cardinality | 0..1 |
Type | SimpleQuantity |
Summary | false |
DeviceDispense.preparedDate | |
Element Id | DeviceDispense.preparedDate |
Definition | The time when the dispensed product was packaged and reviewed. |
Short Display | When product was packaged and reviewed |
Cardinality | 0..1 |
Type | dateTime |
Summary | true |
DeviceDispense.whenHandedOver | |
Element Id | DeviceDispense.whenHandedOver |
Definition | The time the dispensed product was made available to the patient or their representative. |
Short Display | When product was given out |
Cardinality | 0..1 |
Type | dateTime |
Summary | false |
DeviceDispense.destination | |
Element Id | DeviceDispense.destination |
Definition | Identification of the facility/location where the device was /should be shipped to, as part of the dispense process. |
Short Display | Where the device was sent or should be sent |
Cardinality | 0..1 |
Type | Reference(Location) |
Summary | false |
DeviceDispense.note | |
Element Id | DeviceDispense.note |
Definition | Extra information about the dispense that could not be conveyed in the other attributes. |
Short Display | Information about the dispense |
Cardinality | 0..* |
Type | Annotation |
Summary | false |
DeviceDispense.usageInstruction | |
Element Id | DeviceDispense.usageInstruction |
Definition | The full representation of the instructions. |
Short Display | Full representation of the usage instructions |
Cardinality | 0..1 |
Type | markdown |
Summary | false |
Comments | The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content. |
DeviceDispense.eventHistory | |
Element Id | DeviceDispense.eventHistory |
Definition | A summary of the events of interest that have occurred, such as when the dispense was verified. |
Short Display | A list of relevant lifecycle events |
Cardinality | 0..* |
Type | Reference(Provenance) |
Summary | false |
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.). |