STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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

12.14 Resource SupplyRequest - Content

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.

12.14.1 Scope and Usage

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.

12.14.2 Boundaries and Relationships

Note that the SupplyRequest records the fact that a request was made. To actually act on that request, additional workflow beyond simply the existence of a SupplyRequest is required. This can be achieved by using an Task resource, with the SupplyRequest referenced from the 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.

The SupplyRequest resource is used for inventory management. When requesting medication, substances and devices when there is a patient focus or instructions regarding their use, DeviceUseRequest or MedicationOrder should be used instead

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[x]	Σ	0..1		Medication, Substance, or Device requested to be supplied SNOMED CT Supply Item (Example)
orderedItemCodeableConcept			CodeableConcept
orderedItemReference			Reference(Medication \| Substance \| Device)
supplier	Σ	0..*	Reference(Organization)	Who is intended to fulfill the request
reason[x]	Σ	0..1		Why the supply item was requested SupplyRequestReason (Example)
reasonCodeableConcept			CodeableConcept
reasonReference			Reference(Any)
when	Σ	0..1	BackboneElement	When the request should be fulfilled
code	Σ	0..1	CodeableConcept	Fulfilment code Supply Request When (Example)
schedule	Σ	0..1	Timing	Formal fulfillment schedule
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><!-- 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[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance|Device) Medication, Substance, or Device requested to be supplied --></orderedItem[x]>
 <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[x]: Medication, Substance, or Device requested to be supplied. One of these 2:
  "orderedItemCodeableConcept" : { CodeableConcept },
  "orderedItemReference" : { Reference(Medication|Substance|Device) },
  "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
  }
}

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.patient [ Reference(Patient) ]; # 0..1 Patient for whom the item is supplied
  fhir:SupplyRequest.source [ Reference(Practitioner|Organization|Patient) ]; # 0..1 Who initiated this order
  fhir:SupplyRequest.date [ dateTime ]; # 0..1 When the request was made
  fhir:SupplyRequest.identifier [ Identifier ]; # 0..1 Unique identifier
  fhir:SupplyRequest.status [ code ]; # 0..1 requested | completed | failed | cancelled
  fhir:SupplyRequest.kind [ CodeableConcept ]; # 0..1 The kind of supply (central, non-stock, etc.)
  # SupplyRequest.orderedItem[x] : 0..1 Medication, Substance, or Device requested to be supplied. One of these 2
    fhir:SupplyRequest.orderedItemCodeableConcept [ CodeableConcept ]
    fhir:SupplyRequest.orderedItemReference [ Reference(Medication|Substance|Device) ]
  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.when [ # 0..1 When the request should be fulfilled
    fhir:SupplyRequest.when.code [ CodeableConcept ]; # 0..1 Fulfilment code
    fhir:SupplyRequest.when.schedule [ Timing ]; # 0..1 Formal fulfillment schedule
  ];
]

Changes since DSTU2

SupplyRequest

SupplyRequest.orderedItem[x]

Renamed from orderedItem to orderedItem[x]
Add CodeableConcept

See the Full Difference for further information

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[x]	Σ	0..1		Medication, Substance, or Device requested to be supplied SNOMED CT Supply Item (Example)
orderedItemCodeableConcept			CodeableConcept
orderedItemReference			Reference(Medication \| Substance \| Device)
supplier	Σ	0..*	Reference(Organization)	Who is intended to fulfill the request
reason[x]	Σ	0..1		Why the supply item was requested SupplyRequestReason (Example)
reasonCodeableConcept			CodeableConcept
reasonReference			Reference(Any)
when	Σ	0..1	BackboneElement	When the request should be fulfilled
code	Σ	0..1	CodeableConcept	Fulfilment code Supply Request When (Example)
schedule	Σ	0..1	Timing	Formal fulfillment schedule
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><!-- 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[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance|Device) Medication, Substance, or Device requested to be supplied --></orderedItem[x]>
 <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[x]: Medication, Substance, or Device requested to be supplied. One of these 2:
  "orderedItemCodeableConcept" : { CodeableConcept },
  "orderedItemReference" : { Reference(Medication|Substance|Device) },
  "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
  }
}

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.patient [ Reference(Patient) ]; # 0..1 Patient for whom the item is supplied
  fhir:SupplyRequest.source [ Reference(Practitioner|Organization|Patient) ]; # 0..1 Who initiated this order
  fhir:SupplyRequest.date [ dateTime ]; # 0..1 When the request was made
  fhir:SupplyRequest.identifier [ Identifier ]; # 0..1 Unique identifier
  fhir:SupplyRequest.status [ code ]; # 0..1 requested | completed | failed | cancelled
  fhir:SupplyRequest.kind [ CodeableConcept ]; # 0..1 The kind of supply (central, non-stock, etc.)
  # SupplyRequest.orderedItem[x] : 0..1 Medication, Substance, or Device requested to be supplied. One of these 2
    fhir:SupplyRequest.orderedItemCodeableConcept [ CodeableConcept ]
    fhir:SupplyRequest.orderedItemReference [ Reference(Medication|Substance|Device) ]
  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.when [ # 0..1 When the request should be fulfilled
    fhir:SupplyRequest.when.code [ CodeableConcept ]; # 0..1 Fulfilment code
    fhir:SupplyRequest.when.schedule [ Timing ]; # 0..1 Formal fulfillment schedule
  ];
]

Changes since DSTU2

SupplyRequest

SupplyRequest.orderedItem[x]

Renamed from orderedItem to orderedItem[x]
Add CodeableConcept

See the Full Difference for further information

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

12.14.3.1 Terminology Bindings

Path	Definition	Type	Reference
SupplyRequest.status	Status of the supply request	Required	SupplyRequestStatus
SupplyRequest.kind	Category of supply request	Required	Supply Type
SupplyRequest.orderedItem[x]	The item that was requested	Example	SNOMED CT Supply Item
SupplyRequest.reason[x]	Why the supply item was requested	Example	SupplyRequestReason
SupplyRequest.when.code	When the request should be fulfilled	Example	Supply Request When

Path

Definition

Type

Reference

SupplyRequest.status

Status of the supply request

Required

SupplyRequestStatus

SupplyRequest.kind

Category of supply request

Required

Supply Type

SupplyRequest.orderedItem[x]

The item that was requested

Example

SNOMED CT Supply Item

SupplyRequest.reason[x]

Why the supply item was requested

Example

SupplyRequestReason

SupplyRequest.when.code

When the request should be fulfilled

Example

Supply Request When

12.14.4 Search Parameters

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 (Practitioner, Organization, Patient)
status	token	requested \| completed \| failed \| cancelled	SupplyRequest.status
supplier	reference	Who is intended to fulfill the request	SupplyRequest.supplier (Organization)