SupplyRequest - FHIR Resource (stu3)
This SupplyRequest Resource uses the FHIR API standard for access and structure.
Validate an SupplyRequest FHIR Resource (stu3)
SupplyRequest Attributes
AttributeField is listTypeDescription
Description: draft | active | suspended +
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (SupplyRequest) status FHIR attribute
Description: The kind of supply (central, non-stock, etc.)
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": Learn more about the (SupplyRequest) category FHIR attribute
Description: When the request was made
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"authoredOn": Learn more about the (SupplyRequest) authoredOn FHIR attribute
Description: "reasonReference" : { Reference(Any) },
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
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: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"deliverFrom": Learn more about the (SupplyRequest) deliverFrom FHIR attribute
Description: The item being requested
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"orderedItem": Learn more about the (SupplyRequest) orderedItem FHIR attribute
Description: routine | urgent | asap | stat
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": Learn more about the (SupplyRequest) priority FHIR attribute
Description: "reasonCodeableConcept" : { CodeableConcept },
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCodeableConcept": Learn more about the (SupplyRequest) reasonCodeableConcept FHIR attribute
Description: "occurrencePeriod" : { Period },
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrencePeriod": Learn more about the (SupplyRequest) occurrencePeriod FHIR attribute
Description: "occurrenceTiming" : { Timing },
FHIR Version: stu3
Attribute Type : Timing
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceTiming": Learn more about the (SupplyRequest) occurrenceTiming FHIR attribute
Description: Who/what is requesting service
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requester": Learn more about the (SupplyRequest) requester FHIR attribute
Description: Who is intended to fulfill the request
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supplier": Learn more about the (SupplyRequest) supplier FHIR attribute
Description: The destination of the supply
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"deliverTo": Learn more about the (SupplyRequest) deliverTo FHIR attribute
Description: "occurrenceDateTime" : "<dateTime>",
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceDateTime": Learn more about the (SupplyRequest) occurrenceDateTime FHIR attribute
Description: Unique identifier
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (SupplyRequest) identifier FHIR attribute
SupplyRequest Structure
{
"resourceType" : "SupplyRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : { Identifier }, // Unique identifier
"status" : "<code>", // draft | active | suspended +
"category" : { CodeableConcept }, // The kind of supply (central, non-stock, etc.)
"priority" : "<code>", // routine | urgent | asap | stat
"orderedItem" : { // The item being requested
"quantity" : { Quantity }, // R! The requested amount of the item indicated
// item[x]: Medication, Substance, or Device requested to be supplied. One of these 2:
"itemCodeableConcept" : { CodeableConcept }
"itemReference" : { Reference(Medication|Substance|Device) }
},
// 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" : { // Who/what is requesting service
"agent" : { Reference(Practitioner|Organization|Patient|RelatedPerson|
Device) }, // R! Individual making the request
"onBehalfOf" : { Reference(Organization) } // Organization agent is acting for
},
"supplier" : [{ Reference(Organization) }], // Who is intended to fulfill the request
// reason[x]: Why the supply item was requested. One of these 2:
"reasonCodeableConcept" : { CodeableConcept },
"reasonReference" : { Reference(Any) },
"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/stu3/SupplyRequest?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
category | text | category |
date | date | authoredOn |
identifier | text | identifier |
requester | reference | requester.agent |
status | text | status |
supplier | reference | supplier |
