Release 5 Ballot
WorkflowThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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
| Orders and Observations Work Group | Maturity Level: 1 | Trial Use | Security 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 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.
This resource overlaps with others such as DeviceDispense and Medicationdispense. The SupplyDelivery resource may be used 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.
Structure
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><!-- 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><!-- 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/> .
Changes since R4
| SupplyDelivery | |
| SupplyDelivery.type |
|
| SupplyDelivery.suppliedItem |
|
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
See the Extensions for this resource
XML Template
<SupplyDelivery xmlns="http://hl7.org/fhir">
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/> .
Changes since Release 4
| SupplyDelivery | |
| SupplyDelivery.type |
|
| SupplyDelivery.suppliedItem |
|
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
| 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 | SupplyDeliverySupplyItemType |
| SupplyDelivery.suppliedItem.item[x] | This value sets refers to a specific supply item. | Example | SupplyDeliverySupplyItemType |
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) |
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:11+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change