Release 4B 5 Ballot

This page is part of the FHIR Specification ~~(v4.3.0: R4B~~ (v5.0.0-ballot: R5 Ballot - ~~STU~~ see ballot notes ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

12.22 12.28 Resource SupplyDelivery - Content

Orders and Observations icon

Work Group

Maturity Level : 1

Trial Use

Security Category : Patient

Compartments : Patient , Practitioner

Record of delivery of what is supplied.

12.22.1 12.28.1 Scope and Usage

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 scope of the supply resource is for supplies used in the healthcare process. This includes supplies specifically used in the treatment of patients as well as supply movement within an institution (transport a set of supplies from materials management to a service unit (nurse station). This resource does not include the provisioning of transportation services.

12.22.2 12.28.2 Boundaries and Relationships

This resource overlaps with others such as ~~Device~~ DeviceDispense and ~~Medication~~ Medicationdispense . The ~~Supply~~ SupplyDelivery resource may be used ~~to describe medications~~ for medications, biologically derived products, and devices when handling them generically (as any other supply). For example, when processing bulk orders, etc. However, when the medication, biologically derived product, device or other aspects of the resource are important, (e.g. in a MedicationRequest or when identifying a device as a performer), the more detailed resource must be used.

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.

12.22.3 12.28.3 References to this Resource

~~This resource is referenced by ChargeItem and itself. This resource implements the~~

Implements: Event ~~pattern.~~
Resource References: ChargeItem and itself

Structure

Name	Flags	Card.	Type	Description & Constraints
SupplyDelivery	TU		DomainResource	Delivery of bulk Supplies 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
status	?! Σ	0..1	code	in-progress \| completed \| abandoned \| entered-in-error SupplyDeliveryStatus ( Required )
patient		0..1	Reference ( Patient )	Patient for whom the item is supplied
type		0..1	CodeableConcept	Category of ~~dispense~~ supply event ~~Supply Item Type~~ SupplyDeliverySupplyItemType ( Required )
suppliedItem		~~0..1~~ 0..*	BackboneElement	The item that is delivered or supplied
quantity		0..1	SimpleQuantity	Amount ~~dispensed~~ supplied
item[x]		0..1		Medication, Substance, or Device or Biologically Derived Product supplied ~~SNOMED CT Supply Item~~ SupplyDeliverySupplyItemType ( Example )
itemCodeableConcept			CodeableConcept
itemReference			Reference ( Medication \| Substance \| Device \| BiologicallyDerivedProduct )
occurrence[x]	Σ	0..1		When event occurred
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrenceTiming			Timing
supplier		0..1	Reference ( Practitioner \| PractitionerRole \| Organization )	~~Dispenser~~ The item supplier
destination		0..1	Reference ( Location )	Where the ~~Supply~~ delivery was sent
receiver		0..*	Reference ( Practitioner \| PractitionerRole )	Who ~~collected~~ received the ~~Supply~~ delivery
Documentation for this format

See the Extensions for this resource

UML Diagram ( Legend )

XML Template

<SupplyDelivery xmlns="http://hl7.org/fhir"> 
 <!-- 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]"/><!-- 0..1 in-progress | completed | abandoned | entered-in-error -->
 <patient><!-- 0..1 Reference(Patient) Patient for whom the item is supplied --></patient>
 <</type>
 <
  <</quantity>
  <</item[x]>

 <type><!-- 0..1 CodeableConcept Category of supply event --></type>
 <suppliedItem>  <!-- 0..* The item that is delivered or supplied -->
  <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount supplied --></quantity>
  <item[x]><!-- 0..1 CodeableConcept|Reference(BiologicallyDerivedProduct|Device|
    Medication|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>
 <</destination>
 <</receiver>

 <supplier><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The item supplier --></supplier>
 <destination><!-- 0..1 Reference(Location) Where the delivery was sent --></destination>
 <receiver><!-- 0..* Reference(Practitioner|PractitionerRole) Who received the delivery --></receiver>

</SupplyDelivery>

JSON Template

{
  "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>", // in-progress | completed | abandoned | entered-in-error
  "patient" : { Reference(Patient) }, // Patient for whom the item is supplied
  "
  "
    "
    
    " }
    " }
  },

  "type" : { CodeableConcept }, // Category of supply event
  "suppliedItem" : [{ // The item that is delivered or supplied
    "quantity" : { Quantity(SimpleQuantity) }, // Amount supplied
    // item[x]: Medication, Substance, Device or Biologically Derived Product supplied. One of these 2:

    "itemCodeableConcept" : { CodeableConcept },
    "itemReference" : { Reference(BiologicallyDerivedProduct|Device|Medication|
    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) }, // Where the delivery was sent
  "receiver" : [{ Reference(Practitioner|PractitionerRole) }] // Who received the delivery

}

Turtle Template

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


[ 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:SupplyDelivery.identifier [ Identifier ], ... ; # 0..* External identifier
  fhir:SupplyDelivery.basedOn [ Reference(SupplyRequest) ], ... ; # 0..* Fulfills plan, proposal or order
  fhir:SupplyDelivery.partOf [ Reference(Contract|SupplyDelivery) ], ... ; # 0..* Part of referenced event
  fhir:SupplyDelivery.status [ code ]; # 0..1 in-progress | completed | abandoned | entered-in-error
  fhir:SupplyDelivery.patient [ Reference(Patient) ]; # 0..1 Patient for whom the item is supplied
  fhir:
  fhir:
    fhir:
    # . One of these 2
      fhir: ]
      fhir:) ]
  ];

  fhir:SupplyDelivery.type [ CodeableConcept ]; # 0..1 Category of supply event
  fhir:SupplyDelivery.suppliedItem [ # 0..* The item that is delivered or supplied
    fhir:SupplyDelivery.suppliedItem.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount supplied
    # SupplyDelivery.suppliedItem.item[x] : 0..1 Medication, Substance, Device or Biologically Derived Product supplied. One of these 2
      fhir:SupplyDelivery.suppliedItem.itemCodeableConcept [ CodeableConcept ]
      fhir:SupplyDelivery.suppliedItem.itemReference [ Reference(BiologicallyDerivedProduct|Device|Medication|Substance) ]
  ], ...;

  # SupplyDelivery.occurrence[x] : 0..1 When event occurred. One of these 3
    fhir:SupplyDelivery.occurrenceDateTime [ dateTime ]
    fhir:SupplyDelivery.occurrencePeriod [ Period ]
    fhir:SupplyDelivery.occurrenceTiming [ Timing ]
  fhir:
  fhir:
  fhir:

  fhir:SupplyDelivery.supplier [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 The item supplier
  fhir:SupplyDelivery.destination [ Reference(Location) ]; # 0..1 Where the delivery was sent
  fhir:SupplyDelivery.receiver [ Reference(Practitioner|PractitionerRole) ], ... ; # 0..* Who received the delivery

]

Changes since R4

SupplyDelivery

SupplyDelivery.type

~~No Changes~~ Change value set from http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.0 to http://hl7.org/fhir/ValueSet/supplydelivery-supplyitemtype|5.0.0-ballot
Change value set from http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.0 to http://hl7.org/fhir/ValueSet/supplydelivery-supplyitemtype|5.0.0-ballot

SupplyDelivery.suppliedItem

Max Cardinality changed from 1 to *
Max Cardinality changed from 1 to *

See the Full Difference for further information

This analysis is available as XML or JSON .

~~Conversions between R3 and R4~~ See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)

Structure

Name	Flags	Card.	Type	Description & Constraints
SupplyDelivery	TU		DomainResource	Delivery of bulk Supplies 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
status	?! Σ	0..1	code	in-progress \| completed \| abandoned \| entered-in-error SupplyDeliveryStatus ( Required )
patient		0..1	Reference ( Patient )	Patient for whom the item is supplied
type		0..1	CodeableConcept	Category of ~~dispense~~ supply event ~~Supply Item Type~~ SupplyDeliverySupplyItemType ( Required )
suppliedItem		~~0..1~~ 0..*	BackboneElement	The item that is delivered or supplied
quantity		0..1	SimpleQuantity	Amount ~~dispensed~~ supplied
item[x]		0..1		Medication, Substance, or Device or Biologically Derived Product supplied ~~SNOMED CT Supply Item~~ SupplyDeliverySupplyItemType ( Example )
itemCodeableConcept			CodeableConcept
itemReference			Reference ( Medication \| Substance \| Device \| BiologicallyDerivedProduct )
occurrence[x]	Σ	0..1		When event occurred
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrenceTiming			Timing
supplier		0..1	Reference ( Practitioner \| PractitionerRole \| Organization )	~~Dispenser~~ The item supplier
destination		0..1	Reference ( Location )	Where the ~~Supply~~ delivery was sent
receiver		0..*	Reference ( Practitioner \| PractitionerRole )	Who ~~collected~~ received the ~~Supply~~ delivery
Documentation for this format

See the Extensions for this resource

UML Diagram ( Legend )

XML Template

<SupplyDelivery xmlns="http://hl7.org/fhir"> 
 <!-- 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]"/><!-- 0..1 in-progress | completed | abandoned | entered-in-error -->
 <patient><!-- 0..1 Reference(Patient) Patient for whom the item is supplied --></patient>
 <</type>
 <
  <</quantity>
  <</item[x]>

 <type><!-- 0..1 CodeableConcept Category of supply event --></type>
 <suppliedItem>  <!-- 0..* The item that is delivered or supplied -->
  <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount supplied --></quantity>
  <item[x]><!-- 0..1 CodeableConcept|Reference(BiologicallyDerivedProduct|Device|
    Medication|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>
 <</destination>
 <</receiver>

 <supplier><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The item supplier --></supplier>
 <destination><!-- 0..1 Reference(Location) Where the delivery was sent --></destination>
 <receiver><!-- 0..* Reference(Practitioner|PractitionerRole) Who received the delivery --></receiver>

</SupplyDelivery>

JSON Template

{
  "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>", // in-progress | completed | abandoned | entered-in-error
  "patient" : { Reference(Patient) }, // Patient for whom the item is supplied
  "
  "
    "
    
    " }
    " }
  },

  "type" : { CodeableConcept }, // Category of supply event
  "suppliedItem" : [{ // The item that is delivered or supplied
    "quantity" : { Quantity(SimpleQuantity) }, // Amount supplied
    // item[x]: Medication, Substance, Device or Biologically Derived Product supplied. One of these 2:

    "itemCodeableConcept" : { CodeableConcept },
    "itemReference" : { Reference(BiologicallyDerivedProduct|Device|Medication|
    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) }, // Where the delivery was sent
  "receiver" : [{ Reference(Practitioner|PractitionerRole) }] // Who received the delivery

}

Turtle Template

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


[ 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:SupplyDelivery.identifier [ Identifier ], ... ; # 0..* External identifier
  fhir:SupplyDelivery.basedOn [ Reference(SupplyRequest) ], ... ; # 0..* Fulfills plan, proposal or order
  fhir:SupplyDelivery.partOf [ Reference(Contract|SupplyDelivery) ], ... ; # 0..* Part of referenced event
  fhir:SupplyDelivery.status [ code ]; # 0..1 in-progress | completed | abandoned | entered-in-error
  fhir:SupplyDelivery.patient [ Reference(Patient) ]; # 0..1 Patient for whom the item is supplied
  fhir:
  fhir:
    fhir:
    # . One of these 2
      fhir: ]
      fhir:) ]
  ];

  fhir:SupplyDelivery.type [ CodeableConcept ]; # 0..1 Category of supply event
  fhir:SupplyDelivery.suppliedItem [ # 0..* The item that is delivered or supplied
    fhir:SupplyDelivery.suppliedItem.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount supplied
    # SupplyDelivery.suppliedItem.item[x] : 0..1 Medication, Substance, Device or Biologically Derived Product supplied. One of these 2
      fhir:SupplyDelivery.suppliedItem.itemCodeableConcept [ CodeableConcept ]
      fhir:SupplyDelivery.suppliedItem.itemReference [ Reference(BiologicallyDerivedProduct|Device|Medication|Substance) ]
  ], ...;

  # SupplyDelivery.occurrence[x] : 0..1 When event occurred. One of these 3
    fhir:SupplyDelivery.occurrenceDateTime [ dateTime ]
    fhir:SupplyDelivery.occurrencePeriod [ Period ]
    fhir:SupplyDelivery.occurrenceTiming [ Timing ]
  fhir:
  fhir:
  fhir:

  fhir:SupplyDelivery.supplier [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 The item supplier
  fhir:SupplyDelivery.destination [ Reference(Location) ]; # 0..1 Where the delivery was sent
  fhir:SupplyDelivery.receiver [ Reference(Practitioner|PractitionerRole) ], ... ; # 0..* Who received the delivery

]

Changes since Release 4

SupplyDelivery

SupplyDelivery.type

~~No Changes~~ Change value set from http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.0 to http://hl7.org/fhir/ValueSet/supplydelivery-supplyitemtype|5.0.0-ballot
Change value set from http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.0 to http://hl7.org/fhir/ValueSet/supplydelivery-supplyitemtype|5.0.0-ballot

SupplyDelivery.suppliedItem

Max Cardinality changed from 1 to *
Max Cardinality changed from 1 to *

See the Full Difference for further information

This analysis is available as XML or JSON .

~~Conversions between R3 and R4~~ See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)

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

12.22.4.1 12.28.4.1 Terminology Bindings

Path	Definition	Type	Reference
SupplyDelivery.status	Status of the supply delivery.	Required	SupplyDeliveryStatus
SupplyDelivery.type	This value sets refers to a specific supply item.	Required	~~SupplyItemType~~ SupplyDeliverySupplyItemType
SupplyDelivery.suppliedItem.item[x]	This value sets refers to a specific supply item.	Example	~~SNOMEDCTSupplyItem~~ SupplyDeliverySupplyItemType

Path

Definition

Type

Reference

SupplyDelivery.status

Status of the supply delivery.

Required

SupplyDeliveryStatus

SupplyDelivery.type

This value sets refers to a specific supply item.

Required

~~SupplyItemType~~ SupplyDeliverySupplyItemType

SupplyDelivery.suppliedItem.item[x]

This value sets refers to a specific supply item.

Example

~~SNOMEDCTSupplyItem~~ SupplyDeliverySupplyItemType

12.22.5 12.28.5 Search Parameters

Search parameters for 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
patient	reference	Patient for whom the item is supplied	SupplyDelivery.patient ( Patient )
receiver	reference	Who collected the Supply	SupplyDelivery.receiver ( Practitioner , PractitionerRole )
status N	token	in-progress \| completed \| abandoned \| entered-in-error	SupplyDelivery.status
supplier	reference	Dispenser	SupplyDelivery.supplier ( Practitioner , Organization , PractitionerRole )