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: Patient, Practitioner

Record of delivery of what is supplied.

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.

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.

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. SupplyDelivery TUDomainResourceDelivery of bulk Supplies

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierExternal identifier

... basedOn Σ0..*Reference(SupplyRequest)Fulfills plan, proposal or order

... partOf Σ0..*Reference(SupplyDelivery | Contract)Part of referenced event

... patient 0..1Reference(Patient)Patient for whom the item is supplied
... type 0..1CodeableConceptCategory of supply event
SupplyDeliverySupplyItemType (Required)
... suppliedItem 0..*BackboneElementThe item that is delivered or supplied

.... quantity 0..1SimpleQuantityAmount supplied
.... item[x] 0..1Medication, Substance, Device or Biologically Derived Product supplied
SupplyDeliverySupplyItemType (Example)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Medication | Substance | Device | BiologicallyDerivedProduct)
... occurrence[x] Σ0..1When event occurred
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... supplier 0..1Reference(Practitioner | PractitionerRole | Organization)The item supplier
... destination 0..1Reference(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 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 [0..1] « null (Strength=Required)SupplyDeliveryStatus! »A link to a resource representing the person whom the delivered item is forpatient : Reference [0..1] « Patient »Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Producttype : CodeableConcept [0..1] « null (Strength=Required)SupplyDeliverySupplyItemType! »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 where the delivery was shipped todestination : Reference [0..1] « Location »Identifies the individual or organization that received the deliveryreceiver : Reference [0..*] « Practitioner|PractitionerRole| Organization »SuppliedItemThe amount of the item that has been supplied. Unit of measure may be includedquantity : 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 listitem[x] : DataType [0..1] « CodeableConcept|Reference(Medication| Substance|Device|BiologicallyDerivedProduct); null (Strength=Example) SupplyDeliverySupplyItemType?? »The item that is being delivered or has been suppliedsuppliedItem[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: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: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: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(Organization|Practitioner|PractitionerRole) ], ... ; # 0..* Who received the delivery
]

Changes since R4

SupplyDelivery
SupplyDelivery.type
  • 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-cibuild
  • 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-cibuild
SupplyDelivery.suppliedItem
  • Max Cardinality changed from 1 to *
  • Max Cardinality changed from 1 to *
SupplyDelivery.receiver
  • Type Reference: Added Target Type Organization
  • Type Reference: Added Target Type Organization

See the Full Difference for further information

This analysis is available as XML or JSON.

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 iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. SupplyDelivery TUDomainResourceDelivery of bulk Supplies

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierExternal identifier

... basedOn Σ0..*Reference(SupplyRequest)Fulfills plan, proposal or order

... partOf Σ0..*Reference(SupplyDelivery | Contract)Part of referenced event

... patient 0..1Reference(Patient)Patient for whom the item is supplied
... type 0..1CodeableConceptCategory of supply event
SupplyDeliverySupplyItemType (Required)
... suppliedItem 0..*BackboneElementThe item that is delivered or supplied

.... quantity 0..1SimpleQuantityAmount supplied
.... item[x] 0..1Medication, Substance, Device or Biologically Derived Product supplied
SupplyDeliverySupplyItemType (Example)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Medication | Substance | Device | BiologicallyDerivedProduct)
... occurrence[x] Σ0..1When event occurred
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... supplier 0..1Reference(Practitioner | PractitionerRole | Organization)The item supplier
... destination 0..1Reference(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 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 [0..1] « null (Strength=Required)SupplyDeliveryStatus! »A link to a resource representing the person whom the delivered item is forpatient : Reference [0..1] « Patient »Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Producttype : CodeableConcept [0..1] « null (Strength=Required)SupplyDeliverySupplyItemType! »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 where the delivery was shipped todestination : Reference [0..1] « Location »Identifies the individual or organization that received the deliveryreceiver : Reference [0..*] « Practitioner|PractitionerRole| Organization »SuppliedItemThe amount of the item that has been supplied. Unit of measure may be includedquantity : 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 listitem[x] : DataType [0..1] « CodeableConcept|Reference(Medication| Substance|Device|BiologicallyDerivedProduct); null (Strength=Example) SupplyDeliverySupplyItemType?? »The item that is being delivered or has been suppliedsuppliedItem[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: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: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: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(Organization|Practitioner|PractitionerRole) ], ... ; # 0..* Who received the delivery
]

Changes since Release 4

SupplyDelivery
SupplyDelivery.type
  • 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-cibuild
  • 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-cibuild
SupplyDelivery.suppliedItem
  • Max Cardinality changed from 1 to *
  • Max Cardinality changed from 1 to *
SupplyDelivery.receiver
  • Type Reference: Added Target Type Organization
  • Type Reference: Added Target Type Organization

See the Full Difference for further information

This analysis is available as XML or JSON.

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

 

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

PathDefinitionTypeReference
SupplyDelivery.status

Status of the supply delivery.

RequiredSupplyDeliveryStatus
SupplyDelivery.type

This value sets refers to a specific supply item.

RequiredSupplyDeliverySupplyItemType
SupplyDelivery.suppliedItem.item[x]

This value sets refers to a specific supply item.

ExampleSupplyDeliverySupplyItemType

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
identifiertokenExternal identifierSupplyDelivery.identifier30 Resources
patientreferencePatient for whom the item is suppliedSupplyDelivery.patient
(Patient)
33 Resources
receiverreferenceWho collected the SupplySupplyDelivery.receiver
(Practitioner, Organization, PractitionerRole)
statustokenin-progress | completed | abandoned | entered-in-errorSupplyDelivery.status
supplierreferenceDispenserSupplyDelivery.supplier
(Practitioner, Organization, PractitionerRole)