FHIR CI-Build

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

12.28 Resource SupplyDelivery - Content

Orders and Observations icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Patient Compartments: Group, Patient, Practitioner

Record of movement of supplies from one location to another.

12.28.1 Scope and Usage

Note to Implementers: 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.

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.

12.28.2 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.

12.28.3 References to this Resource

12.28.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SupplyDelivery TU 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)
... stage Σ 1..1 CodeableConcept Stage or event of delivery
Binding: Supply Delivery Stage (Extensible)
... 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)
.... item[x] 0..1 Medication, Substance, Device or Biologically Derived Product supplied
Binding: Supply Delivery Supply Item Type (Example)
..... 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 icon

See the Extensions for this resource

UML Diagram (Legend)

SupplyDelivery (DomainResource)Identifier for the supply delivery event that is used to identify it across multiple disparate systemsidentifier : Identifier [0..*]A plan, proposal or order that is fulfilled in whole or in part by this eventbasedOn : Reference [0..*] « SupplyRequest »A larger event of which this particular event is a component or steppartOf : Reference [0..*] « SupplyDelivery|Contract »A code specifying the state of the dispense event (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)SupplyDeliveryStatus! »A link to a resource representing the person whom the delivered item is forsubject : Reference [0..1] « Patient|Group|Organization »Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Producttype : CodeableConcept [0..1] « null (Strength=Extensible)SupplyDeliverySupplyItemType+ »Indicates the stage of the delivery. In case the delivery is tracked only at the specific events (e.g. receipt), this resource represents the stage represented, not the entire history nor previous delivery stagesstage : CodeableConcept [1..1] « null (Strength=Extensible)SupplyDeliveryStage+ »The date or time(s) the activity occurredoccurrence[x] : DataType [0..1] « dateTime|Period|Timing »The individual or organization responsible for supplying the deliverysupplier : Reference [0..1] « Practitioner|PractitionerRole| Organization »Identification of the facility, location or person where the delivery is shipped todestination : Reference [0..1] « Location|Practitioner| PractitionerRole|Organization »Identifies the individual(s) or organization that received the deliveryreceiver : Reference [0..*] « Practitioner|PractitionerRole| Organization|Group »SuppliedItemThe amount of the item that has been supplied. Unit of measure may be includedquantity : Quantity(SimpleQuantity) [0..1]The condition in which the supplied item was at the event (shipment, or receipt, etc.). For example, to indicate when the supplied item is not suitable for use (e.g., damaged or out of temperature control)condition : CodeableConcept [0..1] « null (Strength=Example) SupplyDeliverySupplyItemCondi...?? »Identifies the medication, substance, device or biologically derived product being supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known listitem[x] : DataType [0..1] « CodeableConcept|Reference(Medication| Substance|Device|BiologicallyDerivedProduct|NutritionProduct| InventoryItem); null (Strength=Example)SupplyDeliverySupplyItemType?? »The item that is being delivered or has been suppliedsuppliedItem[0..*]

XML Template

<SupplyDelivery xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External identifier --></identifier>
 <basedOn><!-- 0..* Reference(SupplyRequest) Fulfills plan, proposal or order --></basedOn>
 <partOf><!-- 0..* Reference(Contract|SupplyDelivery) Part of referenced event --></partOf>
 <status value="[code]"/><!-- 1..1 in-progress | completed | abandoned | entered-in-error -->
 <subject><!-- 0..1 Reference(Group|Organization|Patient) Individual(s) or organization  for whom the item is supplied --></subject>
 <type><!-- 0..1 CodeableConcept Category of supply event --></type>
 <stage><!-- 1..1 CodeableConcept Stage or event of delivery --></stage>
 <suppliedItem>  <!-- 0..* The item that is delivered or supplied -->
  <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount supplied --></quantity>
  <condition><!-- 0..1 CodeableConcept 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 Reference(Organization|Practitioner|PractitionerRole) The item supplier --></supplier>
 <destination><!-- 0..1 Reference(Location|Organization|Practitioner|
   PractitionerRole) Where the delivery was sent --></destination>
 <receiver><!-- 0..* Reference(Group|Organization|Practitioner|PractitionerRole) Who received the delivery --></receiver>
</SupplyDelivery>

JSON Template

{doco
  "resourceType" : "SupplyDelivery",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External identifier
  "basedOn" : [{ Reference(SupplyRequest) }], // Fulfills plan, proposal or order
  "partOf" : [{ Reference(Contract|SupplyDelivery) }], // Part of referenced event
  "status" : "<code>", // R!  in-progress | completed | abandoned | entered-in-error
  "subject" : { Reference(Group|Organization|Patient) }, // Individual(s) or organization  for whom the item is supplied
  "type" : { CodeableConcept }, // Category of supply event
  "stage" : { CodeableConcept }, // R!  Stage or event of delivery
  "suppliedItem" : [{ // The item that is delivered or supplied
    "quantity" : { Quantity(SimpleQuantity) }, // Amount supplied
    "condition" : { CodeableConcept }, // 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) }, // The item supplier
  "destination" : { Reference(Location|Organization|Practitioner|
   PractitionerRole) }, // Where the delivery was sent
  "receiver" : [{ Reference(Group|Organization|Practitioner|PractitionerRole) }] // Who received the delivery
}

Turtle Template

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


[ a fhir:SupplyDelivery;
  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: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 ( [ # 0..* The item that is delivered or supplied
    fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount supplied
    fhir:condition [ CodeableConcept ] ; # 0..1 A description of the supplied item's condition (e.g., box is damaged)
    # item[x] : 0..1 Medication, Substance, Device or Biologically Derived Product supplied. One of these 2
      fhir:item [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:item [  a fhir:Reference ; Reference(BiologicallyDerivedProduct|Device|InventoryItem|Medication|NutritionProduct|
  Substance) ]
  ] ... ) ;
  # 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
]

Changes from both R4 and R4B

SupplyDelivery
SupplyDelivery.status
  • Min Cardinality changed from 0 to 1
SupplyDelivery.subject
  • Added Element
SupplyDelivery.type
  • Change binding strength from required to extensible
  • Change value set from http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.0 to Supply Delivery Supply Item Type
SupplyDelivery.stage
  • Added Mandatory Element
SupplyDelivery.suppliedItem
  • Max Cardinality changed from 1 to *
SupplyDelivery.suppliedItem.condition
  • Added Element
SupplyDelivery.destination
  • Type Reference: Added Target Types Practitioner, PractitionerRole, Organization
SupplyDelivery.receiver
  • Type Reference: Added Target Types Organization, Group
SupplyDelivery.patient
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SupplyDelivery TU 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)
... stage Σ 1..1 CodeableConcept Stage or event of delivery
Binding: Supply Delivery Stage (Extensible)
... 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)
.... item[x] 0..1 Medication, Substance, Device or Biologically Derived Product supplied
Binding: Supply Delivery Supply Item Type (Example)
..... 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 icon

See the Extensions for this resource

UML Diagram (Legend)

SupplyDelivery (DomainResource)Identifier for the supply delivery event that is used to identify it across multiple disparate systemsidentifier : Identifier [0..*]A plan, proposal or order that is fulfilled in whole or in part by this eventbasedOn : Reference [0..*] « SupplyRequest »A larger event of which this particular event is a component or steppartOf : Reference [0..*] « SupplyDelivery|Contract »A code specifying the state of the dispense event (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)SupplyDeliveryStatus! »A link to a resource representing the person whom the delivered item is forsubject : Reference [0..1] « Patient|Group|Organization »Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Producttype : CodeableConcept [0..1] « null (Strength=Extensible)SupplyDeliverySupplyItemType+ »Indicates the stage of the delivery. In case the delivery is tracked only at the specific events (e.g. receipt), this resource represents the stage represented, not the entire history nor previous delivery stagesstage : CodeableConcept [1..1] « null (Strength=Extensible)SupplyDeliveryStage+ »The date or time(s) the activity occurredoccurrence[x] : DataType [0..1] « dateTime|Period|Timing »The individual or organization responsible for supplying the deliverysupplier : Reference [0..1] « Practitioner|PractitionerRole| Organization »Identification of the facility, location or person where the delivery is shipped todestination : Reference [0..1] « Location|Practitioner| PractitionerRole|Organization »Identifies the individual(s) or organization that received the deliveryreceiver : Reference [0..*] « Practitioner|PractitionerRole| Organization|Group »SuppliedItemThe amount of the item that has been supplied. Unit of measure may be includedquantity : Quantity(SimpleQuantity) [0..1]The condition in which the supplied item was at the event (shipment, or receipt, etc.). For example, to indicate when the supplied item is not suitable for use (e.g., damaged or out of temperature control)condition : CodeableConcept [0..1] « null (Strength=Example) SupplyDeliverySupplyItemCondi...?? »Identifies the medication, substance, device or biologically derived product being supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known listitem[x] : DataType [0..1] « CodeableConcept|Reference(Medication| Substance|Device|BiologicallyDerivedProduct|NutritionProduct| InventoryItem); null (Strength=Example)SupplyDeliverySupplyItemType?? »The item that is being delivered or has been suppliedsuppliedItem[0..*]

XML Template

<SupplyDelivery xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External identifier --></identifier>
 <basedOn><!-- 0..* Reference(SupplyRequest) Fulfills plan, proposal or order --></basedOn>
 <partOf><!-- 0..* Reference(Contract|SupplyDelivery) Part of referenced event --></partOf>
 <status value="[code]"/><!-- 1..1 in-progress | completed | abandoned | entered-in-error -->
 <subject><!-- 0..1 Reference(Group|Organization|Patient) Individual(s) or organization  for whom the item is supplied --></subject>
 <type><!-- 0..1 CodeableConcept Category of supply event --></type>
 <stage><!-- 1..1 CodeableConcept Stage or event of delivery --></stage>
 <suppliedItem>  <!-- 0..* The item that is delivered or supplied -->
  <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount supplied --></quantity>
  <condition><!-- 0..1 CodeableConcept 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 Reference(Organization|Practitioner|PractitionerRole) The item supplier --></supplier>
 <destination><!-- 0..1 Reference(Location|Organization|Practitioner|
   PractitionerRole) Where the delivery was sent --></destination>
 <receiver><!-- 0..* Reference(Group|Organization|Practitioner|PractitionerRole) Who received the delivery --></receiver>
</SupplyDelivery>

JSON Template

{doco
  "resourceType" : "SupplyDelivery",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External identifier
  "basedOn" : [{ Reference(SupplyRequest) }], // Fulfills plan, proposal or order
  "partOf" : [{ Reference(Contract|SupplyDelivery) }], // Part of referenced event
  "status" : "<code>", // R!  in-progress | completed | abandoned | entered-in-error
  "subject" : { Reference(Group|Organization|Patient) }, // Individual(s) or organization  for whom the item is supplied
  "type" : { CodeableConcept }, // Category of supply event
  "stage" : { CodeableConcept }, // R!  Stage or event of delivery
  "suppliedItem" : [{ // The item that is delivered or supplied
    "quantity" : { Quantity(SimpleQuantity) }, // Amount supplied
    "condition" : { CodeableConcept }, // 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) }, // The item supplier
  "destination" : { Reference(Location|Organization|Practitioner|
   PractitionerRole) }, // Where the delivery was sent
  "receiver" : [{ Reference(Group|Organization|Practitioner|PractitionerRole) }] // Who received the delivery
}

Turtle Template

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


[ a fhir:SupplyDelivery;
  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: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 ( [ # 0..* The item that is delivered or supplied
    fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount supplied
    fhir:condition [ CodeableConcept ] ; # 0..1 A description of the supplied item's condition (e.g., box is damaged)
    # item[x] : 0..1 Medication, Substance, Device or Biologically Derived Product supplied. One of these 2
      fhir:item [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:item [  a fhir:Reference ; Reference(BiologicallyDerivedProduct|Device|InventoryItem|Medication|NutritionProduct|
  Substance) ]
  ] ... ) ;
  # 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
]

Changes from both R4 and R4B

SupplyDelivery
SupplyDelivery.status
  • Min Cardinality changed from 0 to 1
SupplyDelivery.subject
  • Added Element
SupplyDelivery.type
  • Change binding strength from required to extensible
  • Change value set from http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.0 to Supply Delivery Supply Item Type
SupplyDelivery.stage
  • Added Mandatory Element
SupplyDelivery.suppliedItem
  • Max Cardinality changed from 1 to *
SupplyDelivery.suppliedItem.condition
  • Added Element
SupplyDelivery.destination
  • Type Reference: Added Target Types Practitioner, PractitionerRole, Organization
SupplyDelivery.receiver
  • Type Reference: Added Target Types Organization, Group
SupplyDelivery.patient
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

12.28.4.1 Terminology Bindings

Path ValueSet Type Documentation
SupplyDelivery.status SupplyDeliveryStatus Required

Status of the supply delivery.
SupplyDelivery.type SupplyDeliverySupplyItemType Extensible

This value sets refers to a specific supply item.
SupplyDelivery.stage SupplyDeliveryStage Extensible

Stage of the supply delivery.
SupplyDelivery.suppliedItem.condition SupplyDeliverySupplyItemCondition Example

This value sets refers to the condition of a specific supply item.
SupplyDelivery.suppliedItem.item[x] SupplyDeliverySupplyItemType Example

This value sets refers to a specific supply item.

12.28.5 Workflow Considerations

For some SupplyDelivery instances there is a specific need to articulate if the event represents a dispatch or receipt, due to unique traceability requirements inherent to some transported products. This is particularly true when dispatch and receipt occurs across organizational boundaries with each party only having their "half" of the conversation. SupplyDelivery can be used for these events through the use of the SupplyDelivery.stage element.

Example scenario using the resource:

  1. A hospital transfusion laboratory places a SupplyRequest order for blood stock replenishment. The order is for 40 x O+ red blood cells, 35 x A+ red cells, 10 x O- red cells and 10 x A- red cells.
  2. The community blood bank receives the order and prepares the consignment. A SupplyDelivery representing a dispatch event is created that corresponds to the physical dispatch advice note.
  3. On receipt of the consignment the transfusion laboratory inspects and scans each received unit, and a SupplyDelivery representing the receipt event is created.

Some connected systems would see both instances of the SupplyDelivery events while others would only see the portion their organization is responsible for.

It is intended that a delivery and subsequent return would be documented as two different instances of the SupplyDelivery resource. In workflow terms a SupplyDelivery is the response to a SupplyRequest, and in the case of a return, you would still have a SupplyRequest initiating that return. The SupplyDelivery instances represent one or more distinct stages of the response to a SupplyRequest from beginning to end, and receiving the product (even if you will ultimately ship it back) is a terminal event.

12.28.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
identifier token External identifier SupplyDelivery.identifier 65 Resources
patient reference Patient for whom the item is supplied SupplyDelivery.subject.where(resolve() is Patient)
(Patient)		 65 Resources
receiver reference Who collected the Supply SupplyDelivery.receiver
(Practitioner, Group, Organization, PractitionerRole)
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
(Group, Organization, Patient)
supplier reference Dispenser SupplyDelivery.supplier
(Practitioner, Organization, PractitionerRole)