This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). 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: 0 | Compartments: Patient |
A record of a request for a medication, substance or device used in the healthcare setting.
The scope of the SupplyRequest resource is for recording the request of 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.
Note that the SupplyRequest a record of the fact that a request was made. To actually request that a a supply be ordered, additional workflow beyond simply the existence of a SupplyRequest is required. This can be achieved by using an Order resource, with the SupplyRequest referenced from the Order.details, or by using the SupplyRequest resource in the context of an messaging or service workflow where the request is explicit or implicit.
This resource overlaps with DeviceUseRequest and MedicationOrder. The SupplyRequest resource may be used to request medication, substances and devices when handling them generically (as any other supply). For example, when processing bulk orders, etc. TODO - finish defining boundaries.
This resource is referenced by CarePlan and ClinicalImpression
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SupplyRequest | Σ | DomainResource | Request for a medication, substance or device | |
patient | Σ | 0..1 | Reference(Patient) | Patient for whom the item is supplied |
source | Σ | 0..1 | Reference(Practitioner | Organization | Patient) | Who initiated this order |
date | Σ | 0..1 | dateTime | When the request was made |
identifier | Σ | 0..1 | Identifier | Unique identifier |
status | ?! Σ | 0..1 | code | requested | completed | failed | cancelled SupplyRequestStatus (Required) |
kind | Σ | 0..1 | CodeableConcept | The kind of supply (central, non-stock, etc) Supply Type (Required) |
orderedItem | Σ | 0..1 | Reference(Medication | Substance | Device) | Medication, Substance, or Device requested to be supplied |
supplier | Σ | 0..* | Reference(Organization) | Who is intended to fulfill the request |
reason[x] | Σ | 0..1 | Why the supply item was requested | |
reasonCodeableConcept | CodeableConcept | |||
reasonReference | Reference(any) | |||
when | Σ | 0..1 | BackboneElement | When the request should be fulfilled |
code | Σ | 0..1 | CodeableConcept | Fulfilment code |
schedule | Σ | 0..1 | Timing | Formal fulfillment schedule |
Documentation for this format |
UML Diagram
XML Template
<SupplyRequest xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <patient><!-- 0..1 Reference(Patient) Patient for whom the item is supplied --></patient> <source><!-- 0..1 Reference(Practitioner|Organization|Patient) Who initiated this order --></source> <date value="[dateTime]"/><!-- 0..1 When the request was made --> <identifier><!-- 0..1 Identifier Unique identifier --></identifier> <status value="[code]"/><!-- 0..1 requested | completed | failed | cancelled --> <kind><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc) --></kind> <orderedItem><!-- 0..1 Reference(Medication|Substance|Device) Medication, Substance, or Device requested to be supplied --></orderedItem> <supplier><!-- 0..* Reference(Organization) Who is intended to fulfill the request --></supplier> <reason[x]><!-- 0..1 CodeableConcept|Reference(any) Why the supply item was requested --></reason[x]> <when> <!-- 0..1 When the request should be fulfilled --> <code><!-- 0..1 CodeableConcept Fulfilment code --></code> <schedule><!-- 0..1 Timing Formal fulfillment schedule --></schedule> </when> </SupplyRequest>
JSON Template
{ "resourceType" : "SupplyRequest", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "patient" : { Reference(Patient) }, // Patient for whom the item is supplied "source" : { Reference(Practitioner|Organization|Patient) }, // Who initiated this order "date" : "<dateTime>", // When the request was made "identifier" : { Identifier }, // Unique identifier "status" : "<code>", // requested | completed | failed | cancelled "kind" : { CodeableConcept }, // The kind of supply (central, non-stock, etc) "orderedItem" : { Reference(Medication|Substance|Device) }, // Medication, Substance, or Device requested to be supplied "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) }, "when" : { // When the request should be fulfilled "code" : { CodeableConcept }, // Fulfilment code "schedule" : { Timing } // Formal fulfillment schedule } }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SupplyRequest | Σ | DomainResource | Request for a medication, substance or device | |
patient | Σ | 0..1 | Reference(Patient) | Patient for whom the item is supplied |
source | Σ | 0..1 | Reference(Practitioner | Organization | Patient) | Who initiated this order |
date | Σ | 0..1 | dateTime | When the request was made |
identifier | Σ | 0..1 | Identifier | Unique identifier |
status | ?! Σ | 0..1 | code | requested | completed | failed | cancelled SupplyRequestStatus (Required) |
kind | Σ | 0..1 | CodeableConcept | The kind of supply (central, non-stock, etc) Supply Type (Required) |
orderedItem | Σ | 0..1 | Reference(Medication | Substance | Device) | Medication, Substance, or Device requested to be supplied |
supplier | Σ | 0..* | Reference(Organization) | Who is intended to fulfill the request |
reason[x] | Σ | 0..1 | Why the supply item was requested | |
reasonCodeableConcept | CodeableConcept | |||
reasonReference | Reference(any) | |||
when | Σ | 0..1 | BackboneElement | When the request should be fulfilled |
code | Σ | 0..1 | CodeableConcept | Fulfilment code |
schedule | Σ | 0..1 | Timing | Formal fulfillment schedule |
Documentation for this format |
XML Template
<SupplyRequest xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <patient><!-- 0..1 Reference(Patient) Patient for whom the item is supplied --></patient> <source><!-- 0..1 Reference(Practitioner|Organization|Patient) Who initiated this order --></source> <date value="[dateTime]"/><!-- 0..1 When the request was made --> <identifier><!-- 0..1 Identifier Unique identifier --></identifier> <status value="[code]"/><!-- 0..1 requested | completed | failed | cancelled --> <kind><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc) --></kind> <orderedItem><!-- 0..1 Reference(Medication|Substance|Device) Medication, Substance, or Device requested to be supplied --></orderedItem> <supplier><!-- 0..* Reference(Organization) Who is intended to fulfill the request --></supplier> <reason[x]><!-- 0..1 CodeableConcept|Reference(any) Why the supply item was requested --></reason[x]> <when> <!-- 0..1 When the request should be fulfilled --> <code><!-- 0..1 CodeableConcept Fulfilment code --></code> <schedule><!-- 0..1 Timing Formal fulfillment schedule --></schedule> </when> </SupplyRequest>
JSON Template
{ "resourceType" : "SupplyRequest", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "patient" : { Reference(Patient) }, // Patient for whom the item is supplied "source" : { Reference(Practitioner|Organization|Patient) }, // Who initiated this order "date" : "<dateTime>", // When the request was made "identifier" : { Identifier }, // Unique identifier "status" : "<code>", // requested | completed | failed | cancelled "kind" : { CodeableConcept }, // The kind of supply (central, non-stock, etc) "orderedItem" : { Reference(Medication|Substance|Device) }, // Medication, Substance, or Device requested to be supplied "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) }, "when" : { // When the request should be fulfilled "code" : { CodeableConcept }, // Fulfilment code "schedule" : { Timing } // Formal fulfillment schedule } }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
SupplyRequest.status | Status of the supply request | Required | SupplyRequestStatus |
SupplyRequest.kind | Category of supply request | Required | Supply Type |
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 | Paths |
date | date | When the request was made | SupplyRequest.date |
identifier | token | Unique identifier | SupplyRequest.identifier |
kind | token | The kind of supply (central, non-stock, etc) | SupplyRequest.kind |
patient | reference | Patient for whom the item is supplied | SupplyRequest.patient (Patient) |
source | reference | Who initiated this order | SupplyRequest.source (Patient, Organization, Practitioner) |
status | token | requested | completed | failed | cancelled | SupplyRequest.status |
supplier | reference | Who is intended to fulfill the request | SupplyRequest.supplier (Organization) |