Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). 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.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.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 SupplyDelivery is used to document actual movement of supplies (e.g., medications, devices, substances, biologically derived products) from one location to another, where the intended patient or person (e.g., doctor) may also be known. 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. 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.

12.28.2 Boundaries and Relationships

This resource has a boundary with DeviceDispense and Medicationdispense : 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.

12.28.3 References to this Resource

12.28.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . 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

. . . patient 0..1 Reference ( Patient ) Patient for whom the item is supplied
. . . type 0..1 CodeableConcept Category of supply event
Binding: Supply Delivery Supply Item Type ( Required )
. . . suppliedItem 0..* BackboneElement The item that is delivered or supplied

. . . . quantity 0..1 SimpleQuantity Amount supplied
. . . . 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 ) Where the delivery was sent
. . . receiver 0..* Reference ( Practitioner | PractitionerRole | Organization ) 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 systems identifier : Identifier [0..*] A plan, proposal or order that is fulfilled in whole or in part by this event basedOn : Reference [0..*] « SupplyRequest » A larger event of which this particular event is a component or step partOf : Reference [0..*] « SupplyDelivery | Contract » A code specifying the state of the dispense event (this element modifies the meaning of other elements) status : code [0..1] « null (Strength=Required) SupplyDeliveryStatus ! » A link to a resource representing the person whom the delivered item is for patient : Reference [0..1] « Patient » Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Product type : CodeableConcept [0..1] « null (Strength=Required) SupplyDeliverySupplyItemType ! » The date or time(s) the activity occurred occurrence[x] : DataType [0..1] « dateTime | Period | Timing » The individual or organization responsible for supplying the delivery supplier : Reference [0..1] « Practitioner | PractitionerRole | Organization » Identification of the facility/location where the delivery was shipped to destination : Reference [0..1] « Location » Identifies the individual or organization that received the delivery receiver : Reference [0..*] « Practitioner | PractitionerRole | Organization » SuppliedItem The amount of the item that has been supplied. Unit of measure may be included quantity : Quantity ( SimpleQuantity ) [0..1] 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 list item[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 supplied suppliedItem [0..*]

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 ] ; # 0..1 in-progress | completed | abandoned | entered-in-error
  fhir:patient [ Reference(Patient) ] ; # 0..1 Patient for whom the item is supplied
  fhir:type [ CodeableConcept ] ; # 0..1 Category of supply event
  fhir:suppliedItem ( [ # 0..* The item that is delivered or supplied
    fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount supplied
    # 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) ] ; # 0..1 Where the delivery was sent
  fhir:receiver  ( [ Reference(Organization|Practitioner|PractitionerRole) ] ... ) ; # 0..* Who received the delivery
]

Changes from both R4 and R4B

SupplyDelivery
SupplyDelivery.type
  • Change value set from http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.0 to Supply Delivery Supply Item Type
  • Remove codes medication , device
  • Add codes medication , device , biologicallyderivedproduct
SupplyDelivery.suppliedItem
  • Max Cardinality changed from 1 to *
SupplyDelivery.receiver
  • Type Reference: Added Target Type Organization

See the Full Difference for further information

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

See R4 <--> R5 Conversion Maps (status = See Conversions Summary .)

Structure

Name Flags Card. Type Description & Constraints doco
. . 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

. . . patient 0..1 Reference ( Patient ) Patient for whom the item is supplied
. . . type 0..1 CodeableConcept Category of supply event
Binding: Supply Delivery Supply Item Type ( Required )
. . . suppliedItem 0..* BackboneElement The item that is delivered or supplied

. . . . quantity 0..1 SimpleQuantity Amount supplied
. . . . 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 ) Where the delivery was sent
. . . receiver 0..* Reference ( Practitioner | PractitionerRole | Organization ) 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 systems identifier : Identifier [0..*] A plan, proposal or order that is fulfilled in whole or in part by this event basedOn : Reference [0..*] « SupplyRequest » A larger event of which this particular event is a component or step partOf : Reference [0..*] « SupplyDelivery | Contract » A code specifying the state of the dispense event (this element modifies the meaning of other elements) status : code [0..1] « null (Strength=Required) SupplyDeliveryStatus ! » A link to a resource representing the person whom the delivered item is for patient : Reference [0..1] « Patient » Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Product type : CodeableConcept [0..1] « null (Strength=Required) SupplyDeliverySupplyItemType ! » The date or time(s) the activity occurred occurrence[x] : DataType [0..1] « dateTime | Period | Timing » The individual or organization responsible for supplying the delivery supplier : Reference [0..1] « Practitioner | PractitionerRole | Organization » Identification of the facility/location where the delivery was shipped to destination : Reference [0..1] « Location » Identifies the individual or organization that received the delivery receiver : Reference [0..*] « Practitioner | PractitionerRole | Organization » SuppliedItem The amount of the item that has been supplied. Unit of measure may be included quantity : Quantity ( SimpleQuantity ) [0..1] 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 list item[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 supplied suppliedItem [0..*]

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 ] ; # 0..1 in-progress | completed | abandoned | entered-in-error
  fhir:patient [ Reference(Patient) ] ; # 0..1 Patient for whom the item is supplied
  fhir:type [ CodeableConcept ] ; # 0..1 Category of supply event
  fhir:suppliedItem ( [ # 0..* The item that is delivered or supplied
    fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount supplied
    # 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) ] ; # 0..1 Where the delivery was sent
  fhir:receiver  ( [ Reference(Organization|Practitioner|PractitionerRole) ] ... ) ; # 0..* Who received the delivery
]

Changes from both R4 and R4B

SupplyDelivery
SupplyDelivery.type
  • Change value set from http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.0 to Supply Delivery Supply Item Type
  • Remove codes medication , device
  • Add codes medication , device , biologicallyderivedproduct
SupplyDelivery.suppliedItem
  • Max Cardinality changed from 1 to *
SupplyDelivery.receiver
  • Type Reference: Added Target Type Organization

See the Full Difference for further information

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

See R4 <--> R5 Conversion Maps (status = See Conversions Summary .)

 

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 Required

This value sets refers to a specific supply item.

SupplyDelivery.suppliedItem.item[x] SupplyDeliverySupplyItemType Example

This value sets refers to a specific supply item.

12.28.5 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.patient
( Patient ) 		66 Resources
receiver reference Who collected the Supply SupplyDelivery.receiver
( Practitioner , Organization , PractitionerRole )
status token in-progress | completed | abandoned | entered-in-error SupplyDelivery.status
supplier reference Dispenser SupplyDelivery.supplier
( Practitioner , Organization , PractitionerRole )