OO Incubator Implementation Guide
0.1.0 - ci-build International flag

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Resource: SupplyRequest

Official URL: http://hl7.org/fhir/StructureDefinition/SupplyRequest Version: 0.1.0
Standards status: Trial-use Draft as of 2021-01-02 Maturity Level: 1 Computable Name: SupplyRequest
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1379

A record of a non-patient specific request for a medication, substance, device, certain types of biologically derived product, and nutrition product used in the healthcare setting.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SupplyRequest 0..* DomainResource Request for a medication, substance or device

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business Identifier for SupplyRequest
... status ?!Σ 0..1 code draft | active | suspended +
Binding: SupplyRequestStatus (required): Status of the supply request.
... intent ?!Σ 1..1 code proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The intent of the order existing.
... replaces Σ 0..* Reference(ServiceRequest | MedicationRequest | RequestOrchestration | CarePlan | DeviceRequest | CommunicationRequest | NutritionOrder | VisionPrescription | SupplyRequest) What request replaces
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... category Σ 0..1 CodeableConcept The kind of supply (central, non-stock, etc.)
Binding: SupplyType (example): Category of supply request.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... deliverFor 0..1 Reference(Patient) The patient for who the supply request is for
... item Σ 1..1 CodeableReference(Medication | Substance | SubstanceDefinition | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem) Medication, Substance, or Device requested to be supplied
Binding: SNOMEDCTSupplyItem (example): The item that was requested.
... quantity Σ 1..1 Quantity The requested amount of the item indicated
... parameter 0..* BackboneElement Ordered item details
.... code 0..1 CodeableConcept Item detail
Binding: request-orderdetail-parameter-code (??) (example): Codes for order detail parameters.
.... value[x] 0..1 Value of detail
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueBoolean boolean
... occurrence[x] Σ 0..1 When the request should be fulfilled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn Σ 0..1 dateTime When the request was made
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam) Individual making the request
... supplier Σ 0..* Reference(Organization | HealthcareService) Who is intended to fulfill the request
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) The reason why the supply item was requested
Binding: SupplyRequestReason (example): The reason why the supply item was requested.
... deliverFrom 0..1 Reference(Organization | Location) The origin of the supply
... deliverTo 0..1 Reference(Organization | Location | Patient | RelatedPerson) The destination of the supply
... requestedPerformer 0..* CodeableReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson | Group) Who should perform the SupplyRequest

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SupplyRequest.status Base required Supply Request Status 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.intent Base required RequestIntent 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.category Base example Supply Type 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.priority Base required RequestPriority 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.item Base example SNOMED CT Supply Item 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.parameter.​code Base example http://hl7.org/fhir/ValueSet/request-orderdetail-parameter-code Not State Unknown
SupplyRequest.reason Base example Supply Request Reason 📦6.0.0-ballot3 FHIR Std. 
​
<SupplyRequest xmlns="http://hl7.org/fhir"> ​​doco
 ​<id value="[id]"/><!-- 0..1 ​* ​Logical id of this artifact  -->
 ​<meta><!-- ​I 0..1 ​* ​Metadata about the resource  --></meta>
 ​<implicitRules value="[uri]"/><!-- ​I 0..1 ​* ​A set of rules under which this content was created  -->
 ​<language value="[code]"/><!-- ​I 0..1 ​* Language of the resource content  -->
 ​<text><!-- ​I 0..1 ​* ​Text summary of the resource, for human interpretation  --></text>
 ​<contained><!-- 0..* ​* ​Contained, inline Resources  --></contained>
 ​<extension><!-- See Extensions  ​Additional content defined by implementations  --></extension>
 ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* ​* ​Business Identifier for SupplyRequest  --></identifier>
 <status value="[code]"/><!-- 0..1 ​* draft | active | suspended +  -->
 <intent value="[code]"/><!-- 1..1 ​* proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option  -->
 <basedOn><!-- 0..* ​* ​What other request is fulfilled by this supply request  --></basedOn>
 <replaces><!-- 0..* ​* ​What request replaces  --></replaces>
 <groupIdentifier><!-- 0..1 ​* ​Composite request this is part of  --></groupIdentifier>
 <category><!-- 0..1 ​* The kind of supply (central, non-stock, etc.)  --></category>
 <priority value="[code]"/><!-- 0..1 ​* routine | urgent | asap | stat  -->
 <deliverFor><!-- 0..1 ​* ​The patient for who the supply request is for  --></deliverFor>
 <item><!-- 1..1 ​* Medication, Substance, or Device requested to be supplied  --></item>
 <quantity><!-- 1..1 ​* ​The requested amount of the item indicated  --></quantity>
 <parameter> ​I 0..* ​*  <!-- ​I 0..* Ordered item details -->
  ​<id value="[id]"/><!-- 0..1 ​* ​Unique id for inter-element referencing   -->
  ​<extension><!-- See Extensions  ​Additional content defined by implementations   --></extension>
  ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <code><!-- 0..1 ​* Item detail   --></code>
  <value[x]><!-- 0..1 CodeableConcept|Quantity|Range|boolean ​Value of detail   --></value[x]>
 </parameter>
 <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 ​* ​Individual making the request  --></requester>
 <supplier><!-- 0..* ​* ​Who is intended to fulfill the request  --></supplier>
 <reason><!-- 0..* ​* The reason why the supply item was requested  --></reason>
 <deliverFrom><!-- 0..1 ​* ​The origin of the supply  --></deliverFrom>
 <deliverTo><!-- 0..1 ​* ​The destination of the supply  --></deliverTo>
 <requestedPerformer><!-- 0..* ​* ​Who should perform the SupplyRequest  --></requestedPerformer>
</SupplyRequest>

​
{​​doco
  "resourceType" : "SupplyRequest",
  "id" : "<id>", // 0..1 ​Logical id of this artifact
  "meta" : { Meta }, // ​I 0..1 ​Metadata about the resource
  "implicitRules" : "<uri>", // ​I 0..1 ​A set of rules under which this content was created
  "language" : "<code>", // ​I 0..1 Language of the resource content
  "text" : { Narrative }, // ​I 0..1 ​Text summary of the resource, for human interpretation
  "contained" : [{ ​Resource }], // 0..* ​Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
  "identifier" : [{ Identifier }], // 0..* ​Business Identifier for SupplyRequest
  "status" : "<code>", // 0..1 draft | active | suspended +
  "intent" : "<code>", // 1..1 proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "basedOn" : [{ Reference(Resource) }], // 0..* ​What other request is fulfilled by this supply request
  "replaces" : [{ Reference(CarePlan|CommunicationRequest|DeviceRequest|
   MedicationRequest|NutritionOrder|RequestOrchestration|ServiceRequest|
   SupplyRequest|VisionPrescription) }], // 0..* ​What request replaces
  "groupIdentifier" : { Identifier }, // 0..1 ​Composite request this is part of
  "category" : { CodeableConcept }, // 0..1 The kind of supply (central, non-stock, etc.)
  "priority" : "<code>", // 0..1 routine | urgent | asap | stat
  "deliverFor" : { Reference(Patient) }, // 0..1 ​The patient for who the supply request is for
  "item" : { CodeableReference(BiologicallyDerivedProduct|Device|
   DeviceDefinition|InventoryItem|Medication|NutritionProduct|Substance|
   SubstanceDefinition) }, // 1..1 Medication, Substance, or Device requested to be supplied
  "quantity" : { Quantity }, // 1..1 ​The requested amount of the item indicated
  "parameter" : [{ BackboneElement }], // ​I 0..* ​Ordered item details
    "id" : "<id>", // 0..1 ​Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "code" : { CodeableConcept }, // 0..1 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>", // 0..1 ​When the request was made
  "requester" : { Reference(CareTeam|Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // 0..1 ​Individual making the request
  "supplier" : [{ Reference(HealthcareService|Organization) }], // 0..* ​Who is intended to fulfill the request
  "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) }], // 0..* The reason why the supply item was requested
  "deliverFrom" : { Reference(Location|Organization) }, // 0..1 ​The origin of the supply
  "deliverTo" : { Reference(Location|Organization|Patient|RelatedPerson) }, // 0..1 ​The destination of the supply
  "requestedPerformer" : [{ CodeableReference(CareTeam|Device|Group|
   HealthcareService|Organization|Patient|Practitioner|PractitionerRole|
   RelatedPerson) }] // 0..* ​Who should perform the SupplyRequest
}

​
@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:SupplyRequest;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  fhir:id [ id ] ; # 0..1 Logical id of this artifact
  fhir:meta [ Meta ] ; # 0..1 ​I Metadata about the resource
  fhir:implicitRules [ uri ] ; # 0..1 ​I A set of rules under which this content was created
  fhir:language [ code ] ; # 0..1 ​I Language of the resource content
  fhir:text [ Narrative ] ; # 0..1 ​I Text summary of the resource, for human interpretation
  fhir:contained  ( [ Resource ] ... ) ; # 0..* Contained, inline Resources
  fhir:extension  ( [ Extension ] ... ) ; # 0..* ​I Additional content defined by implementations
  fhir:modifierExtension  ( [ Extension ] ... ) ; # 0..* ​I Extensions that cannot be ignored
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifier for SupplyRequest
  fhir:status [ code ] ; # 0..1 draft | active | suspended +
  fhir:intent [ code ] ; # 1..1 proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:basedOn  ( [ Reference(Resource) ] ... ) ; # 0..* What other request is fulfilled by this supply request
  fhir:replaces  ( [ Reference(CarePlan|CommunicationRequest|DeviceRequest|MedicationRequest|NutritionOrder|
  RequestOrchestration|ServiceRequest|SupplyRequest|VisionPrescription) ] ... ) ; # 0..* What request replaces
  fhir:groupIdentifier [ Identifier ] ; # 0..1 Composite request this is part of
  fhir:category [ CodeableConcept ] ; # 0..1 The kind of supply (central, non-stock, etc.)
  fhir:priority [ code ] ; # 0..1 routine | urgent | asap | stat
  fhir:deliverFor [ Reference(Patient) ] ; # 0..1 The patient for who the supply request is for
  fhir:item [ CodeableReference(BiologicallyDerivedProduct|Device|DeviceDefinition|InventoryItem|Medication|
  NutritionProduct|Substance|SubstanceDefinition) ] ; # 1..1 Medication, Substance, or Device requested to be supplied
  fhir:quantity [ Quantity ] ; # 1..1 The requested amount of the item indicated
  fhir:parameter  ( [ BackboneElement ] ... ) ; # 0..* ​I Ordered item details
  # occurrence[x] : 0..1 When the request should be fulfilled. One of these 3
    fhir:occurrence [  a fhir:dateTime ; dateTime ]
    fhir:occurrence [  a fhir:Period ; Period ]
    fhir:occurrence [  a fhir:Timing ; Timing ]
  fhir:authoredOn [ dateTime ] ; # 0..1 When the request was made
  fhir:requester [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Individual making the request
  fhir:supplier  ( [ Reference(HealthcareService|Organization) ] ... ) ; # 0..* Who is intended to fulfill the request
  fhir:reason  ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ] ... ) ; # 0..* The reason why the supply item was requested
  fhir:deliverFrom [ Reference(Location|Organization) ] ; # 0..1 The origin of the supply
  fhir:deliverTo [ Reference(Location|Organization|Patient|RelatedPerson) ] ; # 0..1 The destination of the supply
  fhir:requestedPerformer  ( [ CodeableReference(CareTeam|Device|Group|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who should perform the SupplyRequest
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SupplyRequest 0..* DomainResource Request for a medication, substance or device

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business Identifier for SupplyRequest
... status ?!Σ 0..1 code draft | active | suspended +
Binding: SupplyRequestStatus (required): Status of the supply request.
... intent ?!Σ 1..1 code proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The intent of the order existing.
... replaces Σ 0..* Reference(ServiceRequest | MedicationRequest | RequestOrchestration | CarePlan | DeviceRequest | CommunicationRequest | NutritionOrder | VisionPrescription | SupplyRequest) What request replaces
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... category Σ 0..1 CodeableConcept The kind of supply (central, non-stock, etc.)
Binding: SupplyType (example): Category of supply request.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... deliverFor 0..1 Reference(Patient) The patient for who the supply request is for
... item Σ 1..1 CodeableReference(Medication | Substance | SubstanceDefinition | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem) Medication, Substance, or Device requested to be supplied
Binding: SNOMEDCTSupplyItem (example): The item that was requested.
... quantity Σ 1..1 Quantity The requested amount of the item indicated
... parameter 0..* BackboneElement Ordered item details
.... code 0..1 CodeableConcept Item detail
Binding: request-orderdetail-parameter-code (??) (example): Codes for order detail parameters.
.... value[x] 0..1 Value of detail
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueBoolean boolean
... occurrence[x] Σ 0..1 When the request should be fulfilled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn Σ 0..1 dateTime When the request was made
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam) Individual making the request
... supplier Σ 0..* Reference(Organization | HealthcareService) Who is intended to fulfill the request
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) The reason why the supply item was requested
Binding: SupplyRequestReason (example): The reason why the supply item was requested.
... deliverFrom 0..1 Reference(Organization | Location) The origin of the supply
... deliverTo 0..1 Reference(Organization | Location | Patient | RelatedPerson) The destination of the supply
... requestedPerformer 0..* CodeableReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson | Group) Who should perform the SupplyRequest

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SupplyRequest.status Base required Supply Request Status 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.intent Base required RequestIntent 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.category Base example Supply Type 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.priority Base required RequestPriority 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.item Base example SNOMED CT Supply Item 📦6.0.0-ballot3 FHIR Std.
SupplyRequest.parameter.​code Base example http://hl7.org/fhir/ValueSet/request-orderdetail-parameter-code Not State Unknown
SupplyRequest.reason Base example Supply Request Reason 📦6.0.0-ballot3 FHIR Std.

 

Other representations of resource: CSV, Excel

Notes:

Name Type Description Expression
category token

The kind of supply (central, non-stock, etc.)

 SupplyRequest.category
date date

When the request was made

 SupplyRequest.authoredOn
identifier token

Business Identifier for SupplyRequest

 SupplyRequest.identifier
patient reference

The patient or subject for whom the supply is destined

 SupplyRequest.deliverFor
replaces reference

What request replaces

 SupplyRequest.replaces
requester reference

Individual making the request

 SupplyRequest.requester
status token

draft | active | suspended +

 SupplyRequest.status
subject reference

The destination of the supply

 SupplyRequest.deliverTo
supplier reference

Who is intended to fulfill the request

 SupplyRequest.supplier