Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B R4 R3 R2

12.21 12.27 Resource SupplyRequest - Content

Orders and Observations icon Work Group Maturity Level : 1   Trial Use Security Category : Patient Compartments : Device , Patient , Practitioner , RelatedPerson

A record of a request for to deliver a medication, substance or device used in the healthcare setting. setting to a particular destination for a particular person or organization.

12.21.1 12.27.1 Scope and Usage

Trial-Use Note: In terms of scope and usage, the Orders and Observations workgroups wish to draw the attention of reviewers and implementers to the following issues and changes. We are seeking input from the implementation community on whether to combine SupplyRequest and DeviceRequest for R4(B). The parameters element was added to SupplyRequest for representing custom details for ordering devices. Feedback is welcome here

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 SupplyRequest resource expresses the need to deliver an item, while the SupplyDelivery tracks the actual delivery.

The SupplyRequest resource is meant for logistics functions only, not for associating a clinical use of the item, which would be done through the clinical resources such as ServiceRequest, DeviceRequest, MedicationRequest resources. The SupplyRequest relates to the Patient resource (in the deliverTo) but that is meant exclusively only for purposes of having a destination for delivery, not a clinical use.

The scope of the SupplyRequest resource is for recording the request of supplies used in the healthcare process. process to be delivered to a particular location. 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

12.21.2 12.27.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 a 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, DeviceRequest or MedicationRequest should be used instead instead.

For DeviceDispense , MedicationDispense , and BiologicallyDerivedProductDispense (planned), a SupplyRequest does not document the formal association of a device, medication, biologically derived product, or supply item to a patient. The DeviceDispense (or MedicationDispense or BiologicallyDerivceProductDispense) is used to formally document that the device, medication, biologically derived product or supply item is to be used by or for a patient in a medical activity.

To determine the purchase date, a search of DeviceRequest, SupplyRequest, DeviceDispense, or SupplyDelivery as defined in an implementation guide can be done , as the context of the use case actually determines which date of either resource is considered the purchase date.

12.21.3 12.27.3 References to this Resource

This resource is referenced by SupplyDelivery . This resource implements the

12.21.4 12.27.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . SupplyRequest TU 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 Supply Request Status ( Required )
. . category . basedOn Σ 0..1 0..* CodeableConcept Reference ( Any ) The kind of What other request is fulfilled by this supply (central, non-stock, etc.) request

Supply Type ( Example )
. . item[x] . priority Σ 1..1 0..1 code Medication, Substance, or Device requested to be supplied routine | urgent | asap | stat
SNOMED CT Supply Item Binding: RequestPriority ( Example Required )
. . itemCodeableConcept . deliverFor 0..1 CodeableConcept Reference ( Patient ) The patient for who the supply request is for
. . . itemReference item Σ 1..1 Reference CodeableReference ( Medication | Substance | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem ) Medication, Substance, or Device requested to be supplied
Binding: SNOMED CT Supply Item ( Example )
. . . quantity Σ 1..1 Quantity The requested amount of the item indicated
. . . parameter 0..* BackboneElement Ordered item details

. . . . code 0..1 CodeableConcept Item detail
Binding: ParameterCode ( Example )
. . . . 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

. . reasonCode . reason 0..* CodeableConcept The reason why the supply item was requested SupplyRequestReason ( Example ) reasonReference 0..* Reference CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) The reason why the supply item was requested
Binding: Supply Request Reason ( Example )

. . . deliverFrom 0..1 Reference ( Organization | Location ) The origin of the supply
. . . deliverTo 0..1 Reference ( Organization | Location | Patient | RelatedPerson ) The destination of the supply

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

SupplyRequest ( DomainResource ) Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server identifier : Identifier [0..*] Status of the supply request (this element modifies the meaning of other elements) status : code [0..1] « null (Strength=Required) SupplyRequestStatus ! » Plan/proposal/order fulfilled by this request basedOn : Reference [0..*] « Any » Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process category : CodeableConcept [0..1] « null (Strength=Example) SupplyType ?? » Indicates how quickly this SupplyRequest should be addressed with respect to other requests priority : code [0..1] « null (Strength=Required) RequestPriority ! » The patient to whom the supply will be given or for whom they will be used deliverFor : Reference [0..1] « Patient » The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list item[x] item : Element CodeableReference [1..1] « CodeableConcept Medication | Reference Substance ( Medication | Device | Substance DeviceDefinition | Device BiologicallyDerivedProduct ); | NutritionProduct | InventoryItem ; null (Strength=Example) SNOMEDCTSupplyItem ?? » The amount that is being ordered of the indicated item quantity : Quantity [1..1] When the request should be fulfilled occurrence[x] : Element DataType [0..1] « dateTime | Period | Timing » When the request was made authoredOn : dateTime [0..1] The device, practitioner, etc. who initiated the request requester : Reference [0..1] « Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam » Who is intended to fulfill the request supplier : Reference [0..*] « Organization | HealthcareService » The reason why the supply item was requested reasonCode : CodeableConcept [0..*] « null (Strength=Example) SupplyRequestReason ?? » The reason why the supply item was requested reasonReference : Reference CodeableReference [0..*] « Condition | Observation | DiagnosticReport | DocumentReference ; null (Strength=Example) SupplyRequestReason ?? » Where the supply is expected to come from deliverFrom : Reference [0..1] « Organization | Location » Where the supply is destined to go deliverTo : Reference [0..1] « Organization | Location | Patient | RelatedPerson » Parameter A code or string that identifies the device detail being asserted code : CodeableConcept [0..1] « null (Strength=Example) ParameterCode?? » The value of the device detail value[x] : Element DataType [0..1] « CodeableConcept | Quantity | Range | boolean » Specific parameters for the ordered item. For example, the size of the indicated item parameter [0..*]

XML Template 

<

<SupplyRequest xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier for SupplyRequest --></identifier>
 <status value="[code]"/><!-- 0..1 draft | active | suspended + -->
 <basedOn><!-- 0..* Reference(Any) What other request is fulfilled by this supply request --></basedOn>

 <category><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc.) --></category>
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <</item[x]>

 <deliverFor><!-- 0..1 Reference(Patient) The patient for who the supply request is for --></deliverFor>
 <item><!-- 1..1 CodeableReference(BiologicallyDerivedProduct|Device|
   DeviceDefinition|InventoryItem|Medication|NutritionProduct|Substance) Medication, Substance, or Device requested to be supplied --></item>
 <quantity><!-- 1..1 Quantity The requested amount of the item indicated --></quantity>
 <parameter>  <!-- 0..* Ordered item details -->
  <code><!-- 0..1 CodeableConcept 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 Reference(CareTeam|Device|Organization|Patient|Practitioner|

   PractitionerRole|RelatedPerson) Individual making the request --></requester>
 <supplier><!-- 0..* Reference(HealthcareService|Organization) Who is intended to fulfill the request --></supplier>
 <</reasonCode>
 <|
   </reasonReference>

 <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) The reason why the supply item was requested --></reason>
 <deliverFrom><!-- 0..1 Reference(Location|Organization) The origin of the supply --></deliverFrom>
 <</deliverTo>

 <deliverTo><!-- 0..1 Reference(Location|Organization|Patient|RelatedPerson) The destination of the supply --></deliverTo>

</SupplyRequest>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "SupplyRequest",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for SupplyRequest
  "status" : "<code>", // draft | active | suspended +
  "basedOn" : [{ Reference(Any) }], // What other request is fulfilled by this supply request

  "category" : { CodeableConcept }, // The kind of supply (central, non-stock, etc.)
  "priority" : "<code>", // routine | urgent | asap | stat
  
  " },
  " },

  "deliverFor" : { Reference(Patient) }, // The patient for who the supply request is for
  "item" : { CodeableReference(BiologicallyDerivedProduct|Device|
   DeviceDefinition|InventoryItem|Medication|NutritionProduct|Substance) }, // R!  Medication, Substance, or Device requested to be supplied
  "quantity" : { Quantity }, // R!  The requested amount of the item indicated
  "parameter" : [{ // Ordered item details
    "code" : { CodeableConcept }, // 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>", // When the request was made
  "|

  "requester" : { Reference(CareTeam|Device|Organization|Patient|Practitioner|

   PractitionerRole|RelatedPerson) }, // Individual making the request
  "supplier" : [{ Reference(HealthcareService|Organization) }], // Who is intended to fulfill the request
  "
  "|
   

  "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) }], // The reason why the supply item was requested
  "deliverFrom" : { Reference(Location|Organization) }, // The origin of the supply
  "

  "deliverTo" : { Reference(Location|Organization|Patient|RelatedPerson) } // The destination of the supply

}

Turtle Template 

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


[ a 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:
  fhir:
  fhir:
  fhir:
  # . One of these 2
    fhir: ]
    fhir:) ]
  fhir:
  fhir:
    fhir:
    # . One of these 4
      fhir: ]
      fhir: ]
      fhir: ]
      fhir: ]
  ], ...;
  # . One of these 3
    fhir: ]
    fhir: ]
    fhir: ]
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifier for SupplyRequest
  fhir:status [ code ] ; # 0..1 draft | active | suspended +
  fhir:basedOn  ( [ Reference(Any) ] ... ) ; # 0..* What other request is fulfilled by this supply request
  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) ] ; # 1..1 Medication, Substance, or Device requested to be supplied

  fhir:quantity [ Quantity ] ; # 1..1 The requested amount of the item indicated
  fhir:parameter ( [ # 0..* Ordered item details
    fhir:code [ CodeableConcept ] ; # 0..1 Item detail
    # value[x] : 0..1 Value of detail. One of these 4
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
      fhir:value [  a fhir:boolean ; boolean ]
  ] ... ) ;
  # 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

]

Changes since from both R4 and R4B

SupplyRequest
SupplyRequest.basedOn
  • No Changes Added Element
SupplyRequest.deliverFor
  • Added Element
SupplyRequest.item
  • Renamed from item[x] to item
  • Add Type CodeableReference
  • Remove Types CodeableConcept, Reference(Medication | Substance | Device)
SupplyRequest.requester
  • Type Reference: Added Target Type CareTeam
SupplyRequest.reason
  • Added Element
SupplyRequest.deliverTo
  • Type Reference: Added Target Type RelatedPerson
SupplyRequest.reasonCode
  • Deleted (-> reason)
SupplyRequest.reasonReference
  • Deleted (-> reason)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . Conversions between R3 and R4 for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). ) See Conversions Summary .)

Structure

Name Flags Card. Type Description & Constraints doco
. . SupplyRequest TU 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 Supply Request Status ( Required )
. . category . basedOn Σ 0..1 0..* CodeableConcept Reference ( Any ) The kind of What other request is fulfilled by this supply (central, non-stock, etc.) request

Supply Type ( Example )
. . item[x] . priority Σ 1..1 0..1 code Medication, Substance, or Device requested to be supplied routine | urgent | asap | stat
SNOMED CT Supply Item Binding: RequestPriority ( Example Required )
. . itemCodeableConcept . deliverFor 0..1 CodeableConcept Reference ( Patient ) The patient for who the supply request is for
. . . itemReference item Σ 1..1 Reference CodeableReference ( Medication | Substance | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem ) Medication, Substance, or Device requested to be supplied
Binding: SNOMED CT Supply Item ( Example )
. . . quantity Σ 1..1 Quantity The requested amount of the item indicated
. . . parameter 0..* BackboneElement Ordered item details

. . . . code 0..1 CodeableConcept Item detail
Binding: ParameterCode ( Example )
. . . . 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

. . reasonCode . reason 0..* CodeableConcept The reason why the supply item was requested SupplyRequestReason ( Example ) reasonReference 0..* Reference CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) The reason why the supply item was requested
Binding: Supply Request Reason ( Example )

. . . deliverFrom 0..1 Reference ( Organization | Location ) The origin of the supply
. . . deliverTo 0..1 Reference ( Organization | Location | Patient | RelatedPerson ) The destination of the supply

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

SupplyRequest ( DomainResource ) Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server identifier : Identifier [0..*] Status of the supply request (this element modifies the meaning of other elements) status : code [0..1] « null (Strength=Required) SupplyRequestStatus ! » Plan/proposal/order fulfilled by this request basedOn : Reference [0..*] « Any » Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process category : CodeableConcept [0..1] « null (Strength=Example) SupplyType ?? » Indicates how quickly this SupplyRequest should be addressed with respect to other requests priority : code [0..1] « null (Strength=Required) RequestPriority ! » The patient to whom the supply will be given or for whom they will be used deliverFor : Reference [0..1] « Patient » The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list item[x] item : Element CodeableReference [1..1] « CodeableConcept Medication | Reference Substance ( Medication | Device | Substance DeviceDefinition | Device BiologicallyDerivedProduct ); | NutritionProduct | InventoryItem ; null (Strength=Example) SNOMEDCTSupplyItem ?? » The amount that is being ordered of the indicated item quantity : Quantity [1..1] When the request should be fulfilled occurrence[x] : Element DataType [0..1] « dateTime | Period | Timing » When the request was made authoredOn : dateTime [0..1] The device, practitioner, etc. who initiated the request requester : Reference [0..1] « Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam » Who is intended to fulfill the request supplier : Reference [0..*] « Organization | HealthcareService » The reason why the supply item was requested reasonCode : CodeableConcept [0..*] « null (Strength=Example) SupplyRequestReason ?? » The reason why the supply item was requested reasonReference : Reference CodeableReference [0..*] « Condition | Observation | DiagnosticReport | DocumentReference ; null (Strength=Example) SupplyRequestReason ?? » Where the supply is expected to come from deliverFrom : Reference [0..1] « Organization | Location » Where the supply is destined to go deliverTo : Reference [0..1] « Organization | Location | Patient | RelatedPerson » Parameter A code or string that identifies the device detail being asserted code : CodeableConcept [0..1] « null (Strength=Example) ParameterCode?? » The value of the device detail value[x] : Element DataType [0..1] « CodeableConcept | Quantity | Range | boolean » Specific parameters for the ordered item. For example, the size of the indicated item parameter [0..*]

XML Template 

<

<SupplyRequest xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier for SupplyRequest --></identifier>
 <status value="[code]"/><!-- 0..1 draft | active | suspended + -->
 <basedOn><!-- 0..* Reference(Any) What other request is fulfilled by this supply request --></basedOn>

 <category><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc.) --></category>
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <</item[x]>

 <deliverFor><!-- 0..1 Reference(Patient) The patient for who the supply request is for --></deliverFor>
 <item><!-- 1..1 CodeableReference(BiologicallyDerivedProduct|Device|
   DeviceDefinition|InventoryItem|Medication|NutritionProduct|Substance) Medication, Substance, or Device requested to be supplied --></item>
 <quantity><!-- 1..1 Quantity The requested amount of the item indicated --></quantity>
 <parameter>  <!-- 0..* Ordered item details -->
  <code><!-- 0..1 CodeableConcept 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 Reference(CareTeam|Device|Organization|Patient|Practitioner|

   PractitionerRole|RelatedPerson) Individual making the request --></requester>
 <supplier><!-- 0..* Reference(HealthcareService|Organization) Who is intended to fulfill the request --></supplier>
 <</reasonCode>
 <|
   </reasonReference>

 <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) The reason why the supply item was requested --></reason>
 <deliverFrom><!-- 0..1 Reference(Location|Organization) The origin of the supply --></deliverFrom>
 <</deliverTo>

 <deliverTo><!-- 0..1 Reference(Location|Organization|Patient|RelatedPerson) The destination of the supply --></deliverTo>

</SupplyRequest>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "SupplyRequest",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for SupplyRequest
  "status" : "<code>", // draft | active | suspended +
  "basedOn" : [{ Reference(Any) }], // What other request is fulfilled by this supply request

  "category" : { CodeableConcept }, // The kind of supply (central, non-stock, etc.)
  "priority" : "<code>", // routine | urgent | asap | stat
  
  " },
  " },

  "deliverFor" : { Reference(Patient) }, // The patient for who the supply request is for
  "item" : { CodeableReference(BiologicallyDerivedProduct|Device|
   DeviceDefinition|InventoryItem|Medication|NutritionProduct|Substance) }, // R!  Medication, Substance, or Device requested to be supplied
  "quantity" : { Quantity }, // R!  The requested amount of the item indicated
  "parameter" : [{ // Ordered item details
    "code" : { CodeableConcept }, // 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>", // When the request was made
  "|

  "requester" : { Reference(CareTeam|Device|Organization|Patient|Practitioner|

   PractitionerRole|RelatedPerson) }, // Individual making the request
  "supplier" : [{ Reference(HealthcareService|Organization) }], // Who is intended to fulfill the request
  "
  "|
   

  "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) }], // The reason why the supply item was requested
  "deliverFrom" : { Reference(Location|Organization) }, // The origin of the supply
  "

  "deliverTo" : { Reference(Location|Organization|Patient|RelatedPerson) } // The destination of the supply

}

Turtle Template 

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


[ a 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:
  fhir:
  fhir:
  fhir:
  # . One of these 2
    fhir: ]
    fhir:) ]
  fhir:
  fhir:
    fhir:
    # . One of these 4
      fhir: ]
      fhir: ]
      fhir: ]
      fhir: ]
  ], ...;
  # . One of these 3
    fhir: ]
    fhir: ]
    fhir: ]
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifier for SupplyRequest
  fhir:status [ code ] ; # 0..1 draft | active | suspended +
  fhir:basedOn  ( [ Reference(Any) ] ... ) ; # 0..* What other request is fulfilled by this supply request
  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) ] ; # 1..1 Medication, Substance, or Device requested to be supplied

  fhir:quantity [ Quantity ] ; # 1..1 The requested amount of the item indicated
  fhir:parameter ( [ # 0..* Ordered item details
    fhir:code [ CodeableConcept ] ; # 0..1 Item detail
    # value[x] : 0..1 Value of detail. One of these 4
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
      fhir:value [  a fhir:boolean ; boolean ]
  ] ... ) ;
  # 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

]

Changes since Release 4 from both R4 and R4B

SupplyRequest
SupplyRequest.basedOn
  • No Changes Added Element
SupplyRequest.deliverFor
  • Added Element
SupplyRequest.item
  • Renamed from item[x] to item
  • Add Type CodeableReference
  • Remove Types CodeableConcept, Reference(Medication | Substance | Device)
SupplyRequest.requester
  • Type Reference: Added Target Type CareTeam
SupplyRequest.reason
  • Added Element
SupplyRequest.deliverTo
  • Type Reference: Added Target Type RelatedPerson
SupplyRequest.reasonCode
  • Deleted (-> reason)
SupplyRequest.reasonReference
  • Deleted (-> reason)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . Conversions between R3 and R4 for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). ) See Conversions Summary .)

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

12.21.4.1 12.27.4.1 Terminology Bindings

SupplyRequest.reasonCode
Path Definition ValueSet Type Reference Documentation
SupplyRequest.status SupplyRequestStatus Required SupplyRequestStatus

Status of the supply request.

SupplyRequest.category SupplyType Example SupplyType

This value sets refers to a Category of supply.

SupplyRequest.priority RequestPriority Required RequestPriority

Identifies the level of importance to be assigned to actioning the request.

SupplyRequest.item[x] SupplyRequest.item SNOMEDCTSupplyItem Example SNOMEDCTSupplyItem

This value set includes SNOMED CT icon where concept is-a 105590001 (Substance (substance)) or concept is-a 260787004 (Physical object) and provided as an example value set.

SupplyRequest.parameter.code ?? Example ??
SupplyRequest.reason SupplyRequestReason Example SupplyRequestReason

The reason why the supply item was requested.

12.21.5 12.27.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
category token The kind of supply (central, non-stock, etc.) SupplyRequest.category
date date When the request was made SupplyRequest.authoredOn 27 Resources
identifier token Business Identifier for SupplyRequest SupplyRequest.identifier 65 Resources
patient reference The patient or subject for whom the supply is destined SupplyRequest.deliverFor
( Patient ) 		66 Resources
requester reference Individual making the request SupplyRequest.requester
( Practitioner , Organization , CareTeam , Device , Patient , PractitionerRole , RelatedPerson )
status token draft | active | suspended + SupplyRequest.status
subject reference The destination of the supply SupplyRequest.deliverTo
( Organization , Patient , RelatedPerson , Location )
supplier reference Who is intended to fulfill the request SupplyRequest.supplier
( Organization , HealthcareService )