type: resource-definitionsresource: DeviceDispense

DeviceDispense Definitions

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

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

Summary: true

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

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, DeviceRequest)

Mappings: workflow=Event.basedOn

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)

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

DeviceDispense.status

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

Binding: required: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

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

Binding: example:devicedispense-status-reason

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

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

Mappings: workflow=Event.category

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

Summary: true

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

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, Practitioner, Group)

Summary: true

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

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.

Cardinality: 0..1

Type: Reference(Patient, Practitioner, RelatedPerson, Location, PractitionerRole, Group)

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

DeviceDispense.encounter

Encounter associated with event

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

Cardinality: 0..1

Type: Reference(Encounter)

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

DeviceDispense.supportingInformation

Information that supports the dispensing of the device

Definition: Additional information that supports the device being dispensed.

Cardinality: 0..*

Type: Reference(Resource)

Mappings: w5=FiveWs.context

DeviceDispense.performer

Who performed event

Definition: Indicates who or what performed the event.

Cardinality: 0..*

Type: BackboneElement

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

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

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

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.

Cardinality: 1..1

Type: Reference(Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson, CareTeam, Group)

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

DeviceDispense.location

Where the dispense occurred

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

Cardinality: 0..1

Type: Reference(Location)

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

DeviceDispense.type

Trial fill, partial fill, emergency fill, etc

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

Cardinality: 0..1

Type: CodeableConcept

DeviceDispense.quantity

Amount dispensed

Definition: The number of devices that have been dispensed.

Cardinality: 0..1

Type: Quantity(SimpleQuantity)

Mappings: rim=.quantity

DeviceDispense.preparedDate

When product was packaged and reviewed

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

Cardinality: 0..1

Type: dateTime

Summary: true

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

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

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

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)

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

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

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

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

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)

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