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: SupplyDelivery

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

Record of delivery of what is supplied.

​

Scope and Usage

[%stu-note dstu%] This resource can represent different stages of supply delivery. After a request to create two separate resources to address dispatch vs. reception, current discussion concluded that one resource with multiple, extensible stages provided a better approach to support the variety of needs to document the different steps. HL7 seeks specific feedback on the implementability of one resource type with multiple stages (likely represented in a future IG with specific profiles to determine specific attributes/value sets applicable to each stage - see valueset-supplydelivery-stage), or whether two (or more) resource types would be more adequate. [%end-note%]

​This resource is an event resource from a FHIR workflow perspective - see Workflow. It is the intent of the Orders and Observation Workgroup to align this resource with the workflow pattern for event resources.

The SupplyDelivery is used to document the dispatch (e.g., time of dispatch, content) and/or receipt (e.g., time or receipt, content) of, e.g., supplies, people, devices, patients, biologically derived products. This includes delivery of supplies within or across institution such as transport a set of supplies from materials management to a service unit, e.g., nurse station, or biologically derived products from the supplier to the hospital. This resource does not include the provisioning of transportation services. The SupplyDelivery does not imply that this supply has already been dispensed to the that patient or person, while it could be reserved for that patient or person. Those associations are done in dedicated resources such as the MedicationDispense and DeviceDispense.

Sample use cases include:

  • Movement of bulk supplies between locations
  • Receipt of bulk supplies
  • Rejection of a delivery due to item condition
  • Noting the loss of a delivery due to transportation failure

The SupplyDelivery enables the documentation of the one or more relevant stages, such as dispatch of and reception of a shipment. One may opt to document multiple stages given a particular use case, e.g., shipments of biologically derived products in a tightly controlled process, or only use a singular stage to summarize the shipment. Examples would include the dispatch and reception stages that in certain use cases need to be documented separately using two or more instances.

Boundaries and Relationships

​ The DeviceDispense and MedicationDispense resources are used to associate the device or medication with the specific patient for their use, while SupplyDelivery is solely focused on location and movement where the targeted patient or other person (e.g., devices used by a clinician), if included, are for delivery context only.

​ To determine the purchase date, a search of DeviceRequest, SupplyRequest, DeviceDispense, or SupplyDelivery as defined in an implementation guide can be done, as the context of the use case actually determines which date of either resource is considered the purchase date.

​ The Transport resource documents the movement of the supplies, people, patients, etc. between dispatch and receipt including, e.g., time of movement, transporter, average temperature during transport.

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
.. SupplyDelivery 0..* DomainResource Record of movement of supplies from one location to another

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..* Identifier External identifier
... basedOn Σ 0..* Reference(SupplyRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(SupplyDelivery | Contract) Part of referenced event
... subject 0..1 Reference(Patient | Group | Organization) Individual(s) or organization for whom the item is supplied
... type 0..1 CodeableConcept Category of supply event
Binding: Supply Delivery Supply Item Type (extensible): The type of supply dispense.
... stage Σ 1..1 CodeableConcept Stage or event of delivery
Binding: Supply Delivery Stage (extensible): The stage of supply delivery.
... suppliedItem 0..* BackboneElement The item that is delivered or supplied
.... quantity 0..1 SimpleQuantity Amount supplied
.... condition 0..1 CodeableConcept A description of the supplied item's condition (e.g., box is damaged)
Binding: Supply Delivery Supply Item Condition (example): The condition of the supplied or received item.
.... item[x] 0..1 Medication, Substance, Device or Biologically Derived Product supplied
Binding: Supply Delivery Supply Item Type (example): The item that was delivered.
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Medication | Substance | Device | BiologicallyDerivedProduct | NutritionProduct | InventoryItem)
... occurrence[x] Σ 0..1 When event occurred
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... supplier 0..1 Reference(Practitioner | PractitionerRole | Organization) The item supplier
... destination 0..1 Reference(Location | Practitioner | PractitionerRole | Organization) Where the delivery was sent
... receiver 0..* Reference(Practitioner | PractitionerRole | Organization | Group) Who received the delivery

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SupplyDelivery.status Base required Supply Delivery Status 📦0.1.0 This IG
SupplyDelivery.type Base extensible Supply Delivery Supply Item Type 📦0.1.0 This IG
SupplyDelivery.stage Base extensible Supply Delivery Stage 📦0.1.0 This IG
SupplyDelivery.suppliedItem.​condition Base example Supply Delivery Supply Item Condition 📦0.1.0 This IG
SupplyDelivery.suppliedItem.​item[x] Base example Supply Delivery Supply Item Type 📦0.1.0 This IG 
<SupplyDelivery 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..* * External identifier  --></identifier>
 <basedOn><!-- 0..* * Fulfills plan, proposal or order  --></basedOn>
 <partOf><!-- 0..* * Part of referenced event  --></partOf>
 <status value="[code]"/><!-- 1..1 * in-progress | completed | abandoned | entered-in-error  -->
 <subject><!-- 0..1 * Individual(s) or organization  for whom the item is supplied  --></subject>
 <type><!-- 0..1 * Category of supply event  --></type>
 <stage><!-- 1..1 * Stage or event of delivery  --></stage>
 <suppliedItem> I 0..* *  <!-- I 0..* The item that is delivered or supplied -->
  <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>
  <quantity><!-- 0..1 * Amount supplied   --></quantity>
  <condition><!-- 0..1 * A description of the supplied item's condition (e.g., box is damaged)   --></condition>
  <item[x]><!-- 0..1 CodeableConcept|Reference(BiologicallyDerivedProduct|Device|
    InventoryItem|Medication|NutritionProduct|Substance) Medication, Substance, Device or Biologically Derived Product supplied   --></item[x]>
 </suppliedItem>
 <occurrence[x]><!-- 0..1 dateTime|Period|Timing When event occurred  --></occurrence[x]>
 <supplier><!-- 0..1 * The item supplier  --></supplier>
 <destination><!-- 0..1 * Where the delivery was sent  --></destination>
 <receiver><!-- 0..* * Who received the delivery  --></receiver>
</SupplyDelivery>

{​doco
  "resourceType" : "SupplyDelivery",
  "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..* External identifier
  "basedOn" : [{ Reference(SupplyRequest) }], // 0..* Fulfills plan, proposal or order
  "partOf" : [{ Reference(Contract|SupplyDelivery) }], // 0..* Part of referenced event
  "status" : "<code>", // 1..1 in-progress | completed | abandoned | entered-in-error
  "subject" : { Reference(Group|Organization|Patient) }, // 0..1 Individual(s) or organization  for whom the item is supplied
  "type" : { CodeableConcept }, // 0..1 Category of supply event
  "stage" : { CodeableConcept }, // 1..1 Stage or event of delivery
  "suppliedItem" : [{ BackboneElement }], // I 0..* The item that is delivered or supplied
    "id" : "<id>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "quantity" : { Quantity }, // 0..1 Amount supplied
    "condition" : { CodeableConcept }, // 0..1 A description of the supplied item's condition (e.g., box is damaged)
    // item[x]: Medication, Substance, Device or Biologically Derived Product supplied. One of these 2:
    "itemCodeableConcept" : { CodeableConcept },
    "itemReference" : { Reference(BiologicallyDerivedProduct|Device|InventoryItem|
    Medication|NutritionProduct|Substance) }
  }
  // occurrence[x]: When event occurred. One of these 3:
  "occurrenceDateTime" : "<dateTime>",
  "occurrencePeriod" : { Period },
  "occurrenceTiming" : { Timing },
  "supplier" : { Reference(Organization|Practitioner|PractitionerRole) }, // 0..1 The item supplier
  "destination" : { Reference(Location|Organization|Practitioner|
   PractitionerRole) }, // 0..1 Where the delivery was sent
  "receiver" : [{ Reference(Group|Organization|Practitioner|PractitionerRole) }] // 0..* Who received the delivery
}

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


[ a fhir:SupplyDelivery;
  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..* External identifier
  fhir:basedOn  ( [ Reference(SupplyRequest) ] ... ) ; # 0..* Fulfills plan, proposal or order
  fhir:partOf  ( [ Reference(Contract|SupplyDelivery) ] ... ) ; # 0..* Part of referenced event
  fhir:status [ code ] ; # 1..1 in-progress | completed | abandoned | entered-in-error
  fhir:subject [ Reference(Group|Organization|Patient) ] ; # 0..1 Individual(s) or organization  for whom the item is supplied
  fhir:type [ CodeableConcept ] ; # 0..1 Category of supply event
  fhir:stage [ CodeableConcept ] ; # 1..1 Stage or event of delivery
  fhir:suppliedItem  ( [ BackboneElement ] ... ) ; # 0..* I The item that is delivered or supplied
  # occurrence[x] : 0..1 When event occurred. One of these 3
    fhir:occurrence[  a fhir:dateTime ; dateTime ]
    fhir:occurrence[  a fhir:Period ; Period ]
    fhir:occurrence[  a fhir:Timing ; Timing ]
  fhir:supplier [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 The item supplier
  fhir:destination [ Reference(Location|Organization|Practitioner|PractitionerRole) ] ; # 0..1 Where the delivery was sent
  fhir:receiver  ( [ Reference(Group|Organization|Practitioner|PractitionerRole) ] ... ) ; # 0..* Who received the delivery
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SupplyDelivery 0..* DomainResource Record of movement of supplies from one location to another

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..* Identifier External identifier
... basedOn Σ 0..* Reference(SupplyRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(SupplyDelivery | Contract) Part of referenced event
... subject 0..1 Reference(Patient | Group | Organization) Individual(s) or organization for whom the item is supplied
... type 0..1 CodeableConcept Category of supply event
Binding: Supply Delivery Supply Item Type (extensible): The type of supply dispense.
... stage Σ 1..1 CodeableConcept Stage or event of delivery
Binding: Supply Delivery Stage (extensible): The stage of supply delivery.
... suppliedItem 0..* BackboneElement The item that is delivered or supplied
.... quantity 0..1 SimpleQuantity Amount supplied
.... condition 0..1 CodeableConcept A description of the supplied item's condition (e.g., box is damaged)
Binding: Supply Delivery Supply Item Condition (example): The condition of the supplied or received item.
.... item[x] 0..1 Medication, Substance, Device or Biologically Derived Product supplied
Binding: Supply Delivery Supply Item Type (example): The item that was delivered.
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Medication | Substance | Device | BiologicallyDerivedProduct | NutritionProduct | InventoryItem)
... occurrence[x] Σ 0..1 When event occurred
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... supplier 0..1 Reference(Practitioner | PractitionerRole | Organization) The item supplier
... destination 0..1 Reference(Location | Practitioner | PractitionerRole | Organization) Where the delivery was sent
... receiver 0..* Reference(Practitioner | PractitionerRole | Organization | Group) Who received the delivery

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SupplyDelivery.status Base required Supply Delivery Status 📦0.1.0 This IG
SupplyDelivery.type Base extensible Supply Delivery Supply Item Type 📦0.1.0 This IG
SupplyDelivery.stage Base extensible Supply Delivery Stage 📦0.1.0 This IG
SupplyDelivery.suppliedItem.​condition Base example Supply Delivery Supply Item Condition 📦0.1.0 This IG
SupplyDelivery.suppliedItem.​item[x] Base example Supply Delivery Supply Item Type 📦0.1.0 This IG

 

Other representations of resource: CSV, Excel

Notes:

Name Type Description Expression
identifier token

External identifier

 SupplyDelivery.identifier
patient reference

Patient for whom the item is supplied

 SupplyDelivery.subject.where(resolve() is Patient)
receiver reference

Who collected the Supply

 SupplyDelivery.receiver
researchStudy reference

SearchParameter for Research Study Extension

 DomainResource.extension('http://hl7.org/fhir/StructureDefinition/workflow-researchStudy').value
status token

in-progress | completed | abandoned | entered-in-error

 SupplyDelivery.status
subject reference

Individual(s) or organization for whom the item is supplied

 SupplyDelivery.subject
supplier reference

Dispenser

 SupplyDelivery.supplier