SupplyRequest - FHIR Resource (r4)
This SupplyRequest Resource uses the FHIR API standard for access and structure.
Validate an SupplyRequest FHIR Resource (r4)
SupplyRequest Attributes
AttributeField is listTypeDescription
Description: Business Identifier for SupplyRequest
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 (SupplyRequest) identifier FHIR attribute
Description: draft | active | suspended +
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": "active"Learn more about the (SupplyRequest) status FHIR attribute
Description: The kind of supply (central, non-stock, etc.)
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:
"category": {
"coding": [
{
"code": "central",
"display": "Central Stock Resupply"
}
]
}Learn more about the (SupplyRequest) category FHIR attribute
Description: routine | urgent | asap | stat
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:
"priority": "asap"Learn more about the (SupplyRequest) priority FHIR attribute
Description:
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:
"item[x]": Learn more about the (SupplyRequest) item[x] FHIR attribute
Description: The requested amount of the item indicated
FHIR Version: r4
Attribute Type : Quantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"quantity": {
"value": 10
}Learn more about the (SupplyRequest) quantity FHIR attribute
Description: Ordered item details
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"parameter": Learn more about the (SupplyRequest) parameter 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 (SupplyRequest) occurrence[x] FHIR attribute
Description: When the request was made
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"authoredOn": "2016-12-31"Learn more about the (SupplyRequest) authoredOn FHIR attribute
Description: "requester" : { Reference(Practitioner|PractitionerRole|Organization|
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:
"requester": {
"display": "Henry Seven"
}Learn more about the (SupplyRequest) requester FHIR attribute
Description: Who is intended to fulfill the request
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:
"supplier": [
{
"display": "Vendor1"
}
]Learn more about the (SupplyRequest) supplier FHIR attribute
Description: The reason why the supply item was requested
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": [
{
"coding": [
{
"code": "stock_low",
"display": "Refill due to low stock"
}
]
}
]Learn more about the (SupplyRequest) reasonCode FHIR attribute
Description: "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
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:
"reasonReference": Learn more about the (SupplyRequest) reasonReference FHIR attribute
Description: The origin of the supply
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:
"deliverFrom": {
"display": "Location 1"
}Learn more about the (SupplyRequest) deliverFrom FHIR attribute
Description: The destination of the supply
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:
"deliverTo": {
"display": "GoodHealth Clinic Receiving"
}Learn more about the (SupplyRequest) deliverTo FHIR attribute
SupplyRequest Example
{
"resourceType": "SupplyRequest",
"id": "simpleorder",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: simpleorder</p><p><b>identifier</b>: Order10284</p><p><b>status</b>: active</p><p><b>category</b>: Central Stock Resupply <span>(Details : {[not stated] code 'central' = 'central', given as 'Central Stock Resupply'})</span></p><p><b>priority</b>: asap</p><p><b>item</b>: Blood collect tubes blue cap <span>(Details : {[not stated] code 'BlueTubes' = 'BlueTubes', given as 'Blood collect tubes blue cap'})</span></p><p><b>quantity</b>: 10</p><p><b>occurrence</b>: 31/12/2016</p><p><b>authoredOn</b>: 31/12/2016</p><p><b>requester</b>: Henry Seven</p><p><b>supplier</b>: Vendor1</p><p><b>reasonCode</b>: Refill due to low stock <span>(Details : {[not stated] code 'stock_low' = 'stock_low', given as 'Refill due to low stock'})</span></p><p><b>deliverFrom</b>: Location 1</p><p><b>deliverTo</b>: GoodHealth Clinic Receiving</p></div>"
},
"identifier": [
{
"value": "Order10284"
}
],
"status": "active",
"category": {
"coding": [
{
"code": "central",
"display": "Central Stock Resupply"
}
]
},
"priority": "asap",
"itemCodeableConcept": {
"coding": [
{
"code": "BlueTubes",
"display": "Blood collect tubes blue cap"
}
]
},
"quantity": {
"value": 10
},
"occurrenceDateTime": "2016-12-31",
"authoredOn": "2016-12-31",
"requester": {
"display": "Henry Seven"
},
"supplier": [
{
"display": "Vendor1"
}
],
"reasonCode": [
{
"coding": [
{
"code": "stock_low",
"display": "Refill due to low stock"
}
]
}
],
"deliverFrom": {
"display": "Location 1"
},
"deliverTo": {
"display": "GoodHealth Clinic Receiving"
}
}SupplyRequest Structure
{
"resourceType" : "SupplyRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier for SupplyRequest
"status" : "<code>", // draft | active | suspended +
"category" : { CodeableConcept }, // The kind of supply (central, non-stock, etc.)
"priority" : "<code>", // routine | urgent | asap | stat
// item[x]: Medication, Substance, or Device requested to be supplied. One of these 2:
"itemCodeableConcept" : { CodeableConcept },
"itemReference" : { Reference(Medication|Substance|Device) },
"quantity" : { Quantity }, // R! The requested amount of the item indicated
"parameter" : [{ // Ordered item details
"code" : { CodeableConcept }, // Item detail
// value[x]: Value of detail. One of these 4:
"valueCodeableConcept" : { CodeableConcept }
"valueQuantity" : { Quantity }
"valueRange" : { Range }
"valueBoolean" : <boolean>
}],
// occurrence[x]: When the request should be fulfilled. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
"authoredOn" : "<dateTime>", // When the request was made
"requester" : { Reference(Practitioner|PractitionerRole|Organization|
Patient|RelatedPerson|Device) }, // Individual making the request
"supplier" : [{ Reference(Organization|HealthcareService) }], // Who is intended to fulfill the request
"reasonCode" : [{ CodeableConcept }], // The reason why the supply item was requested
"reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
DocumentReference) }], // The reason why the supply item was requested
"deliverFrom" : { Reference(Organization|Location) }, // The origin of the supply
"deliverTo" : { Reference(Organization|Location|Patient) } // The destination of the supply
}
SupplyRequest Search Parameters
The following search parameters can be used to query SupplyRequest resources. Just submit them like so:
https://api.1up.health/fhir/r4/SupplyRequest?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
category | text | category |
date | date | authoredOn |
identifier | text | identifier |
requester | reference | requester |
status | text | status |
subject | reference | deliverTo |
supplier | reference | supplier |
