OO Incubator Implementation Guide
0.1.0 - ci-build International flag

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Resource: DeviceDispense

Official URL: http://hl7.org/fhir/StructureDefinition/DeviceDispense Version: 0.1.0
Standards status: Normative Draft as of 2021-01-02 Maturity Level: 1 Computable Name: DeviceDispense
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1257

Indicates that a device is to be or has been dispensed for a named person/patient. This includes a description of the product (supply) provided and the instructions for using the device.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceDispense 0..* DomainResource A record of dispensation of a device

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business 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..1 CodeableReference(DetectedIssue) Why a dispense was or was not performed
Binding: DeviceDispenseStatusReasonCodes (example)
... category 0..* CodeableConcept Type of device dispense
... device Σ 1..1 CodeableReference(Device | DeviceDefinition) What device was supplied
... subject Σ 1..1 Reference(Patient | Practitioner | Group) Who the dispense is for
... receiver 0..1 Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole | Group) Who collected the device or where the medication was delivered
... encounter 0..1 Reference(Encounter) Encounter associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the device
... performer 0..* BackboneElement Who performed event
.... function 0..1 CodeableConcept Who performed the dispense and what they did
.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam | Group) Individual who was performing
... location 0..1 Reference(Location) Where the dispense occurred
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc
... quantity 0..1 SimpleQuantity Amount dispensed
... preparedDate Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the device was sent or should be sent
... note 0..* Annotation Information about the dispense
... usageInstruction 0..1 markdown Full representation of the usage instructions
... relevantHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceDispense.status Base required DeviceDispense Status Codes 📦6.0.0-ballot3 FHIR Std.
DeviceDispense.statusReason Base example DeviceDispense Status Reason Codes 📦6.0.0-ballot3 FHIR Std. 
<DeviceDispense xmlns="http://hl7.org/fhir"> ​​doco
 ​<id value="[id]"/><!-- 0..1 ​* ​Logical id of this artifact  -->
 ​<meta><!-- ​I 0..1 ​* ​Metadata about the resource  --></meta>
 ​<implicitRules value="[uri]"/><!-- ​I 0..1 ​* ​A set of rules under which this content was created  -->
 ​<language value="[code]"/><!-- ​I 0..1 ​* Language of the resource content  -->
 ​<text><!-- ​I 0..1 ​* ​Text summary of the resource, for human interpretation  --></text>
 ​<contained><!-- 0..* ​* ​Contained, inline Resources  --></contained>
 ​<extension><!-- See Extensions  ​Additional content defined by implementations  --></extension>
 ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* ​* ​Business identifier for this dispensation  --></identifier>
 <basedOn><!-- 0..* ​* ​The order or request that this dispense is fulfilling  --></basedOn>
 <partOf><!-- 0..* ​* ​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 ​* Why a dispense was or was not performed  --></statusReason>
 <category><!-- 0..* ​* ​Type of device dispense  --></category>
 <device><!-- 1..1 ​* ​What device was supplied  --></device>
 <subject><!-- 1..1 ​* ​Who the dispense is for  --></subject>
 <receiver><!-- 0..1 ​* ​Who collected the device or where the medication was delivered  --></receiver>
 <encounter><!-- 0..1 ​* ​Encounter associated with event  --></encounter>
 <supportingInformation><!-- 0..* ​* ​Information that supports the dispensing of the device  --></supportingInformation>
 <performer> ​I 0..* ​*  <!-- ​I 0..* Who performed event -->
  ​<id value="[id]"/><!-- 0..1 ​* ​Unique id for inter-element referencing   -->
  ​<extension><!-- See Extensions  ​Additional content defined by implementations   --></extension>
  ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <function><!-- 0..1 ​* ​Who performed the dispense and what they did   --></function>
  <actor><!-- 1..1 ​* ​Individual who was performing   --></actor>
 </performer>
 <location><!-- 0..1 ​* ​Where the dispense occurred  --></location>
 <type><!-- 0..1 ​* ​Trial fill, partial fill, emergency fill, etc  --></type>
 <quantity><!-- 0..1 ​* ​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 ​* ​Where the device was sent or should be sent  --></destination>
 <note><!-- 0..* ​* ​Information about the dispense  --></note>
 <usageInstruction value="[markdown]"/><!-- 0..1 ​* ​Full representation of the usage instructions  -->
 <relevantHistory><!-- 0..* ​* ​A list of relevant lifecycle events  --></relevantHistory>
</DeviceDispense>

​
{​​doco
  "resourceType" : "DeviceDispense",
  "id" : "<id>", // 0..1 ​Logical id of this artifact
  "meta" : { Meta }, // ​I 0..1 ​Metadata about the resource
  "implicitRules" : "<uri>", // ​I 0..1 ​A set of rules under which this content was created
  "language" : "<code>", // ​I 0..1 Language of the resource content
  "text" : { Narrative }, // ​I 0..1 ​Text summary of the resource, for human interpretation
  "contained" : [{ ​Resource }], // 0..* ​Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
  "identifier" : [{ Identifier }], // 0..* ​Business identifier for this dispensation
  "basedOn" : [{ Reference(CarePlan|DeviceRequest) }], // 0..* ​The order or request that this dispense is fulfilling
  "partOf" : [{ Reference(Procedure) }], // 0..* ​The bigger event that this dispense is a part of
  "status" : "<code>", // 1..1 preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
  "statusReason" : { CodeableReference(DetectedIssue) }, // 0..1 Why a dispense was or was not performed
  "category" : [{ CodeableConcept }], // 0..* ​Type of device dispense
  "device" : { CodeableReference(Device|DeviceDefinition) }, // 1..1 ​What device was supplied
  "subject" : { Reference(Group|Patient|Practitioner) }, // 1..1 ​Who the dispense is for
  "receiver" : { Reference(Group|Location|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // 0..1 ​Who collected the device or where the medication was delivered
  "encounter" : { Reference(Encounter) }, // 0..1 ​Encounter associated with event
  "supportingInformation" : [{ Reference(Resource) }], // 0..* ​Information that supports the dispensing of the device
  "performer" : [{ BackboneElement }], // ​I 0..* ​Who performed event
    "id" : "<id>", // 0..1 ​Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "function" : { CodeableConcept }, // 0..1 ​Who performed the dispense and what they did
    "actor" : { Reference(CareTeam|Device|Group|Organization|Patient|
    Practitioner|PractitionerRole|RelatedPerson) } // 1..1 ​Individual who was performing
  }
  "location" : { Reference(Location) }, // 0..1 ​Where the dispense occurred
  "type" : { CodeableConcept }, // 0..1 ​Trial fill, partial fill, emergency fill, etc
  "quantity" : { Quantity }, // 0..1 ​Amount dispensed
  "preparedDate" : "<dateTime>", // 0..1 ​When product was packaged and reviewed
  "whenHandedOver" : "<dateTime>", // 0..1 ​When product was given out
  "destination" : { Reference(Location) }, // 0..1 ​Where the device was sent or should be sent
  "note" : [{ Annotation }], // 0..* ​Information about the dispense
  "usageInstruction" : "<markdown>", // 0..1 ​Full representation of the usage instructions
  "relevantHistory" : [{ Reference(Provenance) }] // 0..* ​A list of relevant lifecycle events
}

​
@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DeviceDispense;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  fhir:id [ id ] ; # 0..1 Logical id of this artifact
  fhir:meta [ Meta ] ; # 0..1 ​I Metadata about the resource
  fhir:implicitRules [ uri ] ; # 0..1 ​I A set of rules under which this content was created
  fhir:language [ code ] ; # 0..1 ​I Language of the resource content
  fhir:text [ Narrative ] ; # 0..1 ​I Text summary of the resource, for human interpretation
  fhir:contained  ( [ Resource ] ... ) ; # 0..* Contained, inline Resources
  fhir:extension  ( [ Extension ] ... ) ; # 0..* ​I Additional content defined by implementations
  fhir:modifierExtension  ( [ Extension ] ... ) ; # 0..* ​I Extensions that cannot be ignored
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for this dispensation
  fhir:basedOn  ( [ Reference(CarePlan|DeviceRequest) ] ... ) ; # 0..* The order or request that this dispense is fulfilling
  fhir:partOf  ( [ Reference(Procedure) ] ... ) ; # 0..* The bigger event that this dispense is a part of
  fhir:status [ code ] ; # 1..1 preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
  fhir:statusReason [ CodeableReference(DetectedIssue) ] ; # 0..1 Why a dispense was or was not performed
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Type of device dispense
  fhir:device [ CodeableReference(Device|DeviceDefinition) ] ; # 1..1 What device was supplied
  fhir:subject [ Reference(Group|Patient|Practitioner) ] ; # 1..1 Who the dispense is for
  fhir:receiver [ Reference(Group|Location|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who collected the device or where the medication was delivered
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter associated with event
  fhir:supportingInformation  ( [ Reference(Resource) ] ... ) ; # 0..* Information that supports the dispensing of the device
  fhir:performer  ( [ BackboneElement ] ... ) ; # 0..* ​I Who performed event
  fhir:location [ Reference(Location) ] ; # 0..1 Where the dispense occurred
  fhir:type [ CodeableConcept ] ; # 0..1 Trial fill, partial fill, emergency fill, etc
  fhir:quantity [ Quantity ] ; # 0..1 Amount dispensed
  fhir:preparedDate [ dateTime ] ; # 0..1 When product was packaged and reviewed
  fhir:whenHandedOver [ dateTime ] ; # 0..1 When product was given out
  fhir:destination [ Reference(Location) ] ; # 0..1 Where the device was sent or should be sent
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Information about the dispense
  fhir:usageInstruction [ markdown ] ; # 0..1 Full representation of the usage instructions
  fhir:relevantHistory  ( [ Reference(Provenance) ] ... ) ; # 0..* A list of relevant lifecycle events
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceDispense 0..* DomainResource A record of dispensation of a device

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business 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..1 CodeableReference(DetectedIssue) Why a dispense was or was not performed
Binding: DeviceDispenseStatusReasonCodes (example)
... category 0..* CodeableConcept Type of device dispense
... device Σ 1..1 CodeableReference(Device | DeviceDefinition) What device was supplied
... subject Σ 1..1 Reference(Patient | Practitioner | Group) Who the dispense is for
... receiver 0..1 Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole | Group) Who collected the device or where the medication was delivered
... encounter 0..1 Reference(Encounter) Encounter associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the device
... performer 0..* BackboneElement Who performed event
.... function 0..1 CodeableConcept Who performed the dispense and what they did
.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam | Group) Individual who was performing
... location 0..1 Reference(Location) Where the dispense occurred
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc
... quantity 0..1 SimpleQuantity Amount dispensed
... preparedDate Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the device was sent or should be sent
... note 0..* Annotation Information about the dispense
... usageInstruction 0..1 markdown Full representation of the usage instructions
... relevantHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceDispense.status Base required DeviceDispense Status Codes 📦6.0.0-ballot3 FHIR Std.
DeviceDispense.statusReason Base example DeviceDispense Status Reason Codes 📦6.0.0-ballot3 FHIR Std.

 

Other representations of resource: CSV, Excel

Notes:

Name Type Description Expression
code token

Search for devices that match this code

 DeviceDispense.device.concept
identifier token

The identifier of the dispense

 DeviceDispense.identifier
patient reference

Returns device dispenses for a specific patient

 DeviceDispense.subject.where(resolve() is Patient)
status token

The status of the dispense

 DeviceDispense.status
subject reference

The identity of a patient for whom to list dispenses

 DeviceDispense.subject