Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

12.24 Resource DeviceDispense - Content

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

A record of dispensation of a device.

Todo

No resources refer to this resource directly.

This resource does not implement any patterns.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDispense TUDomainResourceDevice Dispense
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness 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
... statusReason 0..1CodeableReference(DetectedIssue)Why a dispense was or was not performed
DeviceDispenseStatusReason (Example)
... category 0..*CodeableConceptType of device dispense
... device Σ1..1CodeableReference(Device | DeviceDefinition)What device was supplied
... subject Σ1..1Reference(Patient)Who the dispense is for
... encounter 0..1Reference(Encounter)Encounter associated with event
... supportingInformation 0..*Reference(Any)Information that supports the dispensing of the device
... performer 0..*BackboneElementWho performed event
.... function 0..1CodeableConceptWho performed the dispense and what they did
.... actor 1..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Individual who was performing
... location 0..1Reference(Location)Where the dispense occurred
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
... quantity 0..1SimpleQuantityAmount dispensed
... preparedDate Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the device was sent or should be sent
... note 0..*AnnotationInformation about the dispense
... usageInstruction 0..1stringFull representation of the usage instructions
... eventHistory 0..*Reference(Provenance)A list of relevant lifecycle events

doco Documentation for this format

UML Diagram (Legend)

DeviceDispense (DomainResource)Business identifier for this dispensationidentifier : Identifier [0..*]The order or request that this dispense is fulfillingbasedOn : Reference [0..*] « CarePlan|DeviceRequest »The bigger event that this dispense is a part ofpartOf : Reference [0..*] « Procedure »A code specifying the state of the set of dispense events (this element modifies the meaning of other elements)status : code [1..1] « A coded concept specifying the state of the dispense event. (Strength=Required)DeviceDispense Status ! »Indicates the reason why a dispense was or was not performedstatusReason : DataType [0..1] « DetectedIssue; A code describing why a dispense was or was not performed. (Strength=Example) DeviceDispenseStatusReason?? »Indicates the type of device dispensecategory : CodeableConcept [0..*]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 devicesdevice : DataType [1..1] « Device|DeviceDefinition »A link to a resource representing the person to whom the device is intendedsubject : Reference [1..1] « Patient »The encounter that establishes the context for this eventencounter : Reference [0..1] « Encounter »Additional information that supports the device being dispensedsupportingInformation : Reference [0..*] « Any »The principal physical location where the dispense was performedlocation : Reference [0..1] « Location »Indicates the type of dispensing event that is performedtype : CodeableConcept [0..1]The number of devices that have been dispensedquantity : Quantity(SimpleQuantity) [0..1]The time when the dispensed product was packaged and reviewedpreparedDate : dateTime [0..1]The time the dispensed product was made available to the patient or their representativewhenHandedOver : dateTime [0..1]Identification of the facility/location where the device was /should be shipped to, as part of the dispense processdestination : Reference [0..1] « Location »Extra information about the dispense that could not be conveyed in the other attributesnote : Annotation [0..*]The full representation of the instructionsusageInstruction : string [0..1]A summary of the events of interest that have occurred, such as when the dispense was verifiedeventHistory : Reference [0..*] « Provenance »PerformerDistinguishes the type of performer in the dispense. For example, date enterer, packager, final checkerfunction : CodeableConcept [0..1]The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the deviceactor : Reference [1..1] « Practitioner|PractitionerRole| Organization|Patient|Device|RelatedPerson|CareTeam »Indicates who or what performed the eventperformer[0..*]

XML Template

<DeviceDispense xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


[ 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 R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDispense TUDomainResourceDevice Dispense
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness 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
... statusReason 0..1CodeableReference(DetectedIssue)Why a dispense was or was not performed
DeviceDispenseStatusReason (Example)
... category 0..*CodeableConceptType of device dispense
... device Σ1..1CodeableReference(Device | DeviceDefinition)What device was supplied
... subject Σ1..1Reference(Patient)Who the dispense is for
... encounter 0..1Reference(Encounter)Encounter associated with event
... supportingInformation 0..*Reference(Any)Information that supports the dispensing of the device
... performer 0..*BackboneElementWho performed event
.... function 0..1CodeableConceptWho performed the dispense and what they did
.... actor 1..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Individual who was performing
... location 0..1Reference(Location)Where the dispense occurred
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
... quantity 0..1SimpleQuantityAmount dispensed
... preparedDate Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the device was sent or should be sent
... note 0..*AnnotationInformation about the dispense
... usageInstruction 0..1stringFull representation of the usage instructions
... eventHistory 0..*Reference(Provenance)A list of relevant lifecycle events

doco Documentation for this format

UML Diagram (Legend)

DeviceDispense (DomainResource)Business identifier for this dispensationidentifier : Identifier [0..*]The order or request that this dispense is fulfillingbasedOn : Reference [0..*] « CarePlan|DeviceRequest »The bigger event that this dispense is a part ofpartOf : Reference [0..*] « Procedure »A code specifying the state of the set of dispense events (this element modifies the meaning of other elements)status : code [1..1] « A coded concept specifying the state of the dispense event. (Strength=Required)DeviceDispense Status ! »Indicates the reason why a dispense was or was not performedstatusReason : DataType [0..1] « DetectedIssue; A code describing why a dispense was or was not performed. (Strength=Example) DeviceDispenseStatusReason?? »Indicates the type of device dispensecategory : CodeableConcept [0..*]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 devicesdevice : DataType [1..1] « Device|DeviceDefinition »A link to a resource representing the person to whom the device is intendedsubject : Reference [1..1] « Patient »The encounter that establishes the context for this eventencounter : Reference [0..1] « Encounter »Additional information that supports the device being dispensedsupportingInformation : Reference [0..*] « Any »The principal physical location where the dispense was performedlocation : Reference [0..1] « Location »Indicates the type of dispensing event that is performedtype : CodeableConcept [0..1]The number of devices that have been dispensedquantity : Quantity(SimpleQuantity) [0..1]The time when the dispensed product was packaged and reviewedpreparedDate : dateTime [0..1]The time the dispensed product was made available to the patient or their representativewhenHandedOver : dateTime [0..1]Identification of the facility/location where the device was /should be shipped to, as part of the dispense processdestination : Reference [0..1] « Location »Extra information about the dispense that could not be conveyed in the other attributesnote : Annotation [0..*]The full representation of the instructionsusageInstruction : string [0..1]A summary of the events of interest that have occurred, such as when the dispense was verifiedeventHistory : Reference [0..*] « Provenance »PerformerDistinguishes the type of performer in the dispense. For example, date enterer, packager, final checkerfunction : CodeableConcept [0..1]The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the deviceactor : Reference [1..1] « Practitioner|PractitionerRole| Organization|Patient|Device|RelatedPerson|CareTeam »Indicates who or what performed the eventperformer[0..*]

XML Template

<DeviceDispense xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


[ 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 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

PathDefinitionTypeReference
DeviceDispense.status A coded concept specifying the state of the dispense event.RequiredDeviceDispense Status Codes
DeviceDispense.statusReason A code describing why a dispense was or was not performed.Examplehttp://hl7.org/fhir/ValueSet/devicedispense-status-reason

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
codetokenSearch for devices that match this codeDeviceDispense.device.concept
subjectreferenceThe identity of a patient for whom to list dispensesDeviceDispense.subject
(Patient)