R4 Ballot #1 (Mixed Normative/Trial use)
WorkflowThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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 | 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 Device and Medication. The Supply resource may be used to describe medications and devices when handling them generically (as any other supply). For example, when processing bulk orders, etc. However, when the medication, 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.
This resource is referenced by chargeitem
Structure
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(SupplyDelivery|Contract) 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 dispense event --></type> <suppliedItem> <!-- 0..1 The item that is delivered or supplied --> <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount dispensed --></quantity> <item[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance|Device) Medication, Substance, or Device supplied --></item[x]> </suppliedItem> <occurrence[x]><!-- 0..1 dateTime|Period|Timing When event occurred --></occurrence[x]> <supplier><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization) Dispenser --></supplier> <destination><!-- 0..1 Reference(Location) Where the Supply was sent --></destination> <receiver><!-- 0..* Reference(Practitioner) Who collected the Supply --></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(SupplyDelivery|Contract) }], // 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 dispense event
"suppliedItem" : { // The item that is delivered or supplied
"quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
// item[x]: Medication, Substance, or Device supplied. One of these 2:
"itemCodeableConcept" : { CodeableConcept }
"itemReference" : { Reference(Medication|Substance|Device) }
},
// occurrence[x]: When event occurred. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
"supplier" : { Reference(Practitioner|PractitionerRole|Organization) }, // Dispenser
"destination" : { Reference(Location) }, // Where the Supply was sent
"receiver" : [{ Reference(Practitioner) }] // Who collected the Supply
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R3
| SupplyDelivery | |
| SupplyDelivery.identifier |
|
| SupplyDelivery.suppliedItem.item[x] |
|
| SupplyDelivery.supplier |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4
Structure
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(SupplyDelivery|Contract) }], // 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 dispense event
"suppliedItem" : { // The item that is delivered or supplied
"quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
// item[x]: Medication, Substance, or Device supplied. One of these 2:
"itemCodeableConcept" : { CodeableConcept }
"itemReference" : { Reference(Medication|Substance|Device) }
},
// occurrence[x]: When event occurred. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
"supplier" : { Reference(Practitioner|PractitionerRole|Organization) }, // Dispenser
"destination" : { Reference(Location) }, // Where the Supply was sent
"receiver" : [{ Reference(Practitioner) }] // Who collected the Supply
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| SupplyDelivery | |
| SupplyDelivery.identifier |
|
| SupplyDelivery.suppliedItem.item[x] |
|
| SupplyDelivery.supplier |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4
Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| SupplyDelivery.status | Status of the supply delivery. | Required | SupplyDeliveryStatus |
| SupplyDelivery.type | The type of supply dispense. | Required | Supply Item Type |
| SupplyDelivery.suppliedItem.item[x] | The item that was delivered. | Example | SNOMED CT Supply Item |
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 | 26 Resources |
| patient | reference | Patient for whom the item is supplied | SupplyDelivery.patient (Patient) | 29 Resources |
| receiver | reference | Who collected the Supply | SupplyDelivery.receiver (Practitioner) | |
| status | token | in-progress | completed | abandoned | entered-in-error | SupplyDelivery.status | |
| supplier | reference | Dispenser | SupplyDelivery.supplier (Practitioner, Organization, PractitionerRole) |
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:18+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change