SupplyDelivery - FHIR Resource (r4)
This SupplyDelivery Resource uses the FHIR API standard for access and structure.
Validate an SupplyDelivery FHIR Resource (r4)
SupplyDelivery Attributes
AttributeField is listTypeDescription
Description: External identifier
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"value": "Order10284"
}
]Learn more about the (SupplyDelivery) identifier FHIR attribute
Description: Fulfills plan, proposal or order
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"basedOn": [
{
"reference": "SupplyRequest/simpleorder"
}
]Learn more about the (SupplyDelivery) basedOn FHIR attribute
Description: Part of referenced event
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": [
{
"display": "Central Supply Restock"
}
]Learn more about the (SupplyDelivery) partOf FHIR attribute
Description: in-progress | completed | abandoned | entered-in-error
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "completed"Learn more about the (SupplyDelivery) status FHIR attribute
Description: Patient for whom the item is supplied
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": Learn more about the (SupplyDelivery) patient FHIR attribute
Description: Category of dispense event
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/supply-item-type",
"code": "device"
}
],
"text": "Blood collect tubes blue cap"
}Learn more about the (SupplyDelivery) type FHIR attribute
Description: The item that is delivered or supplied
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"suppliedItem": {
"quantity": {
"value": 10
},
"itemCodeableConcept": {
"coding": [
{
"code": "BlueTubes",
"display": "Blood collect tubes blue cap"
}
]
}
}Learn more about the (SupplyDelivery) suppliedItem FHIR attribute
Description:
FHIR Version: r4
Attribute Type : dateTime|Period|Timing
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrence[x]": Learn more about the (SupplyDelivery) occurrence[x] FHIR attribute
Description: Dispenser
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supplier": {
"display": "Vendor1"
}Learn more about the (SupplyDelivery) supplier FHIR attribute
Description: Where the Supply was sent
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"destination": {
"display": "Location 1"
}Learn more about the (SupplyDelivery) destination FHIR attribute
Description: Who collected the Supply
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"receiver": Learn more about the (SupplyDelivery) receiver FHIR attribute
SupplyDelivery Example
{
"resourceType": "SupplyDelivery",
"id": "simpledelivery",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: simpledelivery</p><p><b>identifier</b>: Order10284</p><p><b>basedOn</b>: <a>SupplyRequest/simpleorder</a></p><p><b>partOf</b>: Central Supply Restock</p><p><b>status</b>: completed</p><p><b>type</b>: Blood collect tubes blue cap <span>(Details : {http://terminology.hl7.org/CodeSystem/supply-item-type code 'device' = 'Device)</span></p><h3>SuppliedItems</h3><table><tr><td>-</td><td><b>Quantity</b></td><td><b>Item[x]</b></td></tr><tr><td>*</td><td>10</td><td>Blood collect tubes blue cap <span>(Details : {[not stated] code 'BlueTubes' = 'BlueTubes', given as 'Blood collect tubes blue cap'})</span></td></tr></table><p><b>occurrence</b>: 31/12/2016</p><p><b>supplier</b>: Vendor1</p><p><b>destination</b>: Location 1</p></div>"
},
"identifier": [
{
"value": "Order10284"
}
],
"basedOn": [
{
"reference": "SupplyRequest/simpleorder"
}
],
"partOf": [
{
"display": "Central Supply Restock"
}
],
"status": "completed",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/supply-item-type",
"code": "device"
}
],
"text": "Blood collect tubes blue cap"
},
"suppliedItem": {
"quantity": {
"value": 10
},
"itemCodeableConcept": {
"coding": [
{
"code": "BlueTubes",
"display": "Blood collect tubes blue cap"
}
]
}
},
"occurrenceDateTime": "2016-12-31",
"supplier": {
"display": "Vendor1"
},
"destination": {
"display": "Location 1"
}
}SupplyDelivery Structure
{
"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|PractitionerRole) }] // Who collected the Supply
}
SupplyDelivery Search Parameters
The following search parameters can be used to query SupplyDelivery resources. Just submit them like so:
https://api.1up.health/fhir/r4/SupplyDelivery?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
identifier | text | identifier |
patient | reference | patient |
receiver | reference | receiver |
status | text | status |
supplier | reference | supplier |
