This
page
is
part
of
the
FHIR
Specification
(v1.0.2:
DSTU
(v3.0.2:
STU
2).
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
R3
R2
Orders
and
Observations
Work
Group
|
Maturity
Level
:
| Trial Use | Compartments : Device , Patient , Practitioner , RelatedPerson |
A record of a request for a medication, substance or device used in the healthcare setting.
This resource is a request 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 request resources .
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.
The SupplyRequest resource allows requesting only a single item. If a workflow requires requesting multiple items simultaneously, this is done using multiple instances of this resource. These instances can be linked in different ways, depending on the needs of the workflow. For guidance, refer to the Request pattern
Note
that
the
SupplyRequest
a
record
of
records
the
fact
that
a
request
was
made.
To
actually
request
act
on
that
a
a
supply
be
ordered,
request,
additional
workflow
beyond
simply
the
existence
of
a
SupplyRequest
is
required.
This
can
be
achieved
by
using
an
Order
Task
resource,
with
the
SupplyRequest
referenced
from
the
Order.details
,
Task.focus,
or
by
using
the
SupplyRequest
resource
in
the
context
of
an
messaging
or
service
workflow
where
the
request
is
explicit
or
implicit.
The
SupplyDelivery
resource
represents
the
fulfillment
as
a
result
of
SupplyRequest
being
acted
upon.
This
resource
overlaps
with
DeviceUseRequest
and
MedicationOrder
.
The
SupplyRequest
resource
may
be
is
used
to
request
for
inventory
management
.
When
requesting
medication,
substances
and
devices
when
handling
them
generically
(as
any
other
supply).
For
example,
when
processing
bulk
orders,
etc.
TODO
-
finish
defining
boundaries.
there
is
a
patient
focus
or
instructions
regarding
their
use,
DeviceRequest
or
MedicationRequest
should
be
used
instead
This
resource
is
referenced
by
CarePlan
and
ClinicalImpression
supplydelivery
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
DomainResource |
Request
for
a
medication,
substance
or
device
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
||
|
Σ | 0..1 |
|
Unique identifier |
|
?! Σ | 0..1 |
|
draft
|
SupplyRequestStatus ( Required ) |
|
Σ | 0..1 |
|
The
kind
of
supply
(central,
non-stock,
etc.)
Supply Type ( Example ) |
|
Σ | 0..1 |
|
routine
|
urgent
|
asap
|
stat
RequestPriority ( Required ) |
|
Σ | 0..1 |
|
The
item
being
requested
|
|
Σ | 1..1 |
|
The
|
![]() ![]() ![]() | Σ | 0..1 |
Medication,
Substance,
or
Device
requested
to
be
supplied
SNOMED CT Supply |
|
|
CodeableConcept | |||
|
Reference ( Medication | Substance | Device ) | |||
|
Σ | 0..1 | When the request should be fulfilled | |
![]() ![]() ![]() |
dateTime
|
|||
|
Period
|
|||
|
Timing | |||
|
Σ | 0..1 |
|
When
the
|
|
Σ | 0..1 |
|
Who/what is requesting service |
|
Σ | 1..1 | Reference ( Practitioner | Organization | Patient | RelatedPerson | Device ) | Individual making the request |
|
0..1 |
Reference
(
|
Organization agent is acting for | |
|
Σ | 0..* |
|
Who
is
intended
to
fulfill
the
request
|
|
0..1 |
Why
the
supply
item
was
requested
SupplyRequestReason ( Example ) |
||
|
CodeableConcept | |||
|
Reference
(
|
|||
|
0..1 | Reference ( Organization | Location ) | The origin of the supply | |
|
0..1 |
|
The destination of the supply | |
Documentation
for
this
format
|
||||
UML Diagram ( Legend )
XML Template
<<SupplyRequest xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</patient> <</source> < <</identifier> < <</kind> <</orderedItem> <</supplier> <</reason[x]> < <</code> <</schedule> </when><identifier><!-- 0..1 Identifier Unique identifier --></identifier> <status value="[code]"/><!-- 0..1 draft | active | suspended + --> <category><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc.) --></category> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <orderedItem> <!-- 0..1 The item being requested --> <quantity><!-- 1..1 Quantity The requested amount of the item indicated --></quantity> <item[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance|Device) Medication, Substance, or Device requested to be supplied --></item[x]> </orderedItem> <occurrence[x]><!-- 0..1 dateTime|Period|Timing When the request should be fulfilled --></occurrence[x]> <authoredOn value="[dateTime]"/><!-- 0..1 When the request was made --> <requester> <!-- 0..1 Who/what is requesting service --> <agent><!-- 1..1 Reference(Practitioner|Organization|Patient|RelatedPerson| Device) Individual making the request --></agent> <onBehalfOf><!-- 0..1 Reference(Organization) Organization agent is acting for --></onBehalfOf> </requester> <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]> <deliverFrom><!-- 0..1 Reference(Organization|Location) The origin of the supply --></deliverFrom> <deliverTo><!-- 0..1 Reference(Organization|Location|Patient) The destination of the supply --></deliverTo> </SupplyRequest>
JSON Template
{ "resourceType" : "",{"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 }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:SupplyRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:SupplyRequest.identifier [ Identifier ]; # 0..1 Unique identifier fhir:SupplyRequest.status [ code ]; # 0..1 draft | active | suspended + fhir:SupplyRequest.category [ CodeableConcept ]; # 0..1 The kind of supply (central, non-stock, etc.) fhir:SupplyRequest.priority [ code ]; # 0..1 routine | urgent | asap | stat fhir:SupplyRequest.orderedItem [ # 0..1 The item being requested fhir:SupplyRequest.orderedItem.quantity [ Quantity ]; # 1..1 The requested amount of the item indicated # SupplyRequest.orderedItem.item[x] : 0..1 Medication, Substance, or Device requested to be supplied. One of these 2 fhir:SupplyRequest.orderedItem.itemCodeableConcept [ CodeableConcept ] fhir:SupplyRequest.orderedItem.itemReference [ Reference(Medication|Substance|Device) ] ]; # SupplyRequest.occurrence[x] : 0..1 When the request should be fulfilled. One of these 3 fhir:SupplyRequest.occurrenceDateTime [ dateTime ] fhir:SupplyRequest.occurrencePeriod [ Period ] fhir:SupplyRequest.occurrenceTiming [ Timing ] fhir:SupplyRequest.authoredOn [ dateTime ]; # 0..1 When the request was made fhir:SupplyRequest.requester [ # 0..1 Who/what is requesting service fhir:SupplyRequest.requester.agent [ Reference(Practitioner|Organization|Patient|RelatedPerson|Device) ]; # 1..1 Individual making the request fhir:SupplyRequest.requester.onBehalfOf [ Reference(Organization) ]; # 0..1 Organization agent is acting for ]; fhir:SupplyRequest.supplier [ Reference(Organization) ], ... ; # 0..* Who is intended to fulfill the request # SupplyRequest.reason[x] : 0..1 Why the supply item was requested. One of these 2 fhir:SupplyRequest.reasonCodeableConcept [ CodeableConcept ] fhir:SupplyRequest.reasonReference [ Reference(Any) ] fhir:SupplyRequest.deliverFrom [ Reference(Organization|Location) ]; # 0..1 The origin of the supply fhir:SupplyRequest.deliverTo [ Reference(Organization|Location|Patient) ]; # 0..1 The destination of the supply ]
Changes since DSTU2
| SupplyRequest | |
| SupplyRequest.category |
|
| SupplyRequest.priority |
|
| SupplyRequest.orderedItem |
|
| SupplyRequest.orderedItem.quantity |
|
| SupplyRequest.orderedItem.item[x] |
|
| SupplyRequest.occurrence[x] |
|
| SupplyRequest.authoredOn |
|
| SupplyRequest.requester |
|
| SupplyRequest.requester.agent |
|
| SupplyRequest.requester.onBehalfOf |
|
| SupplyRequest.deliverFrom |
|
| SupplyRequest.deliverTo |
|
| SupplyRequest.patient |
|
| SupplyRequest.source |
|
| SupplyRequest.when |
|
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.).
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
DomainResource |
Request
for
a
medication,
substance
or
device
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
||
|
Σ | 0..1 |
|
Unique identifier |
|
?! Σ | 0..1 |
|
draft
|
SupplyRequestStatus ( Required ) |
|
Σ | 0..1 |
|
The
kind
of
supply
(central,
non-stock,
etc.)
Supply Type ( Example ) |
|
Σ | 0..1 |
|
routine
|
urgent
|
asap
|
stat
RequestPriority ( Required ) |
|
Σ | 0..1 |
|
The
item
being
requested
|
|
Σ | 1..1 |
|
The
|
![]() ![]() ![]() | Σ | 0..1 |
Medication,
Substance,
or
Device
requested
to
be
supplied
SNOMED CT Supply |
|
|
CodeableConcept | |||
|
Reference ( Medication | Substance | Device ) | |||
|
Σ | 0..1 | When the request should be fulfilled | |
![]() ![]() ![]() |
dateTime
|
|||
|
Period
|
|||
|
Timing | |||
|
Σ | 0..1 |
|
When
the
|
|
Σ | 0..1 |
|
Who/what is requesting service |
|
Σ | 1..1 | Reference ( Practitioner | Organization | Patient | RelatedPerson | Device ) | Individual making the request |
|
0..1 |
Reference
(
|
Organization agent is acting for | |
|
Σ | 0..* |
|
Who
is
intended
to
fulfill
the
request
|
|
0..1 |
Why
the
supply
item
was
requested
SupplyRequestReason ( Example ) |
||
|
CodeableConcept | |||
|
Reference
(
|
|||
|
0..1 | Reference ( Organization | Location ) | The origin of the supply | |
|
0..1 |
|
The destination of the supply | |
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> <</source> < <</identifier> < <</kind> <</orderedItem> <</supplier> <</reason[x]> < <</code> <</schedule> </when><identifier><!-- 0..1 Identifier Unique identifier --></identifier> <status value="[code]"/><!-- 0..1 draft | active | suspended + --> <category><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc.) --></category> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <orderedItem> <!-- 0..1 The item being requested --> <quantity><!-- 1..1 Quantity The requested amount of the item indicated --></quantity> <item[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance|Device) Medication, Substance, or Device requested to be supplied --></item[x]> </orderedItem> <occurrence[x]><!-- 0..1 dateTime|Period|Timing When the request should be fulfilled --></occurrence[x]> <authoredOn value="[dateTime]"/><!-- 0..1 When the request was made --> <requester> <!-- 0..1 Who/what is requesting service --> <agent><!-- 1..1 Reference(Practitioner|Organization|Patient|RelatedPerson| Device) Individual making the request --></agent> <onBehalfOf><!-- 0..1 Reference(Organization) Organization agent is acting for --></onBehalfOf> </requester> <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]> <deliverFrom><!-- 0..1 Reference(Organization|Location) The origin of the supply --></deliverFrom> <deliverTo><!-- 0..1 Reference(Organization|Location|Patient) The destination of the supply --></deliverTo> </SupplyRequest>
JSON Template
{ "resourceType" : "",{"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 }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:SupplyRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:SupplyRequest.identifier [ Identifier ]; # 0..1 Unique identifier fhir:SupplyRequest.status [ code ]; # 0..1 draft | active | suspended + fhir:SupplyRequest.category [ CodeableConcept ]; # 0..1 The kind of supply (central, non-stock, etc.) fhir:SupplyRequest.priority [ code ]; # 0..1 routine | urgent | asap | stat fhir:SupplyRequest.orderedItem [ # 0..1 The item being requested fhir:SupplyRequest.orderedItem.quantity [ Quantity ]; # 1..1 The requested amount of the item indicated # SupplyRequest.orderedItem.item[x] : 0..1 Medication, Substance, or Device requested to be supplied. One of these 2 fhir:SupplyRequest.orderedItem.itemCodeableConcept [ CodeableConcept ] fhir:SupplyRequest.orderedItem.itemReference [ Reference(Medication|Substance|Device) ] ]; # SupplyRequest.occurrence[x] : 0..1 When the request should be fulfilled. One of these 3 fhir:SupplyRequest.occurrenceDateTime [ dateTime ] fhir:SupplyRequest.occurrencePeriod [ Period ] fhir:SupplyRequest.occurrenceTiming [ Timing ] fhir:SupplyRequest.authoredOn [ dateTime ]; # 0..1 When the request was made fhir:SupplyRequest.requester [ # 0..1 Who/what is requesting service fhir:SupplyRequest.requester.agent [ Reference(Practitioner|Organization|Patient|RelatedPerson|Device) ]; # 1..1 Individual making the request fhir:SupplyRequest.requester.onBehalfOf [ Reference(Organization) ]; # 0..1 Organization agent is acting for ]; fhir:SupplyRequest.supplier [ Reference(Organization) ], ... ; # 0..* Who is intended to fulfill the request # SupplyRequest.reason[x] : 0..1 Why the supply item was requested. One of these 2 fhir:SupplyRequest.reasonCodeableConcept [ CodeableConcept ] fhir:SupplyRequest.reasonReference [ Reference(Any) ] fhir:SupplyRequest.deliverFrom [ Reference(Organization|Location) ]; # 0..1 The origin of the supply fhir:SupplyRequest.deliverTo [ Reference(Organization|Location|Patient) ]; # 0..1 The destination of the supply ]
Changes
since
DSTU2
| SupplyRequest | |
| SupplyRequest.category |
|
| SupplyRequest.priority |
|
| SupplyRequest.orderedItem |
|
| SupplyRequest.orderedItem.quantity |
|
| SupplyRequest.orderedItem.item[x] |
|
| SupplyRequest.occurrence[x] |
|
| SupplyRequest.authoredOn |
|
| SupplyRequest.requester |
|
| SupplyRequest.requester.agent |
|
| SupplyRequest.requester.onBehalfOf |
|
| SupplyRequest.deliverFrom |
|
| SupplyRequest.deliverTo |
|
| SupplyRequest.patient |
|
| SupplyRequest.source |
|
| SupplyRequest.when |
|
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.).
Alternate
definitions:
Schema
/
Schematron
,
Resource
Profile
Master
Definition
(
XML
,
JSON
),
Questionnaire
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| SupplyRequest.status | Status of the supply request | Required | SupplyRequestStatus |
| SupplyRequest.category | Category of supply request |
|
Supply Type |
| SupplyRequest.priority |
| Required | RequestPriority |
| SupplyRequest.orderedItem.item[x] | The item that was requested | Example |
|
| SupplyRequest.reason[x] |
|
Example |
|
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 |
|
|
|
|
token |
|
|
|
|
|
|
|
| 18 Resources |
|
|
|
|
|
26
Resources
|
|
|
reference |
|
( |
|
| status | token |
|
SupplyRequest.status | |
| supplier | reference | Who is intended to fulfill the request |
SupplyRequest.supplier
( Organization ) |