FHIR Release 3 (STU) Current Build
This page is part of FHIR STU 3 (v3.0.1) in it's permanent home (it will always be available at this URL). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .

12.24 Resource SupplyRequest - Content

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

A record of a request for a medication, substance or device used in the healthcare setting.

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.

  1. We are seeking input from the implementation community on whether to combine SupplyRequest and DeviceRequest for R4.
  2. 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 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 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, DeviceRequest or MedicationRequest should be used instead

This resource is referenced by supplydelivery SupplyDelivery .

This resource implements the Request pattern.

Structure

onBehalfOf 0..1 Reference ( Organization ) Organization agent is acting for
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..1 0..* Identifier Unique identifier Business Identifier for SupplyRequest
. . . status ?! Σ 0..1 code draft | active | suspended +
SupplyRequestStatus ( Required )
. . . category Σ 0..1 CodeableConcept The kind of supply (central, non-stock, etc.)
Supply Type ( Example )
. . . priority Σ 0..1 code routine | urgent | asap | stat
RequestPriority Request priority ( Required )
. . orderedItem . item[x] Σ 1..1 Medication, Substance, or Device requested to be supplied
SNOMED CT Supply Item ( Example )
.... itemCodeableConcept 0..1 BackboneElement CodeableConcept The item being requested
. . . . itemReference Reference ( Medication | Substance | Device )
. . . quantity Σ 1..1 Quantity The requested amount of the item indicated
. . . parameter 0..* BackboneElement Ordered item details
.... code 0..1 CodeableConcept Item detail
. . . . item[x] value[x] Σ 0..1 Value of detail
..... valueCodeableConcept 0..1 Medication, Substance, or Device requested to be supplied SNOMED CT Supply Item CodeableConcept ( Example
. . . . . valueQuantity Quantity )
. . . . . itemCodeableConcept valueRange CodeableConcept Range
. . . . itemReference . valueBoolean Reference ( Medication | Substance | Device 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 BackboneElement Who/what is requesting service agent Σ 1..1 0..1 Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device ) Individual making the request
. . . supplier Σ 0..* Reference ( Organization | HealthcareService ) Who is intended to fulfill the request
. . reason[x] . reasonCode 0..1 0..* CodeableConcept Why The reason why the supply item was requested
SupplyRequestReason ( Example )
. . reasonCodeableConcept CodeableConcept . reasonReference reasonReference 0..* Reference ( Any Condition | Observation | DiagnosticReport | DocumentReference ) 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 ) The destination of the supply

doco Documentation for this format

UML Diagram ( Legend )

SupplyRequest ( DomainResource ) Unique identifier for Business identifiers assigned to this supply request 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..1] [0..*] Status of the supply request (this element modifies the meaning of other elements) status : code [0..1] « Status of the supply request request. (Strength=Required) SupplyRequestStatus ! » 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] « Category of supply request request. (Strength=Example) Supply Type SupplyType ?? » Indicates how quickly this SupplyRequest should be addressed with respect to other requests priority : code [0..1] « Identifies the level of importance to be assigned to actioning the request request. (Strength=Required) RequestPriority ! » 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] : Type [1..1] « CodeableConcept | Reference ( Medication | Substance | Device ); The item that was requested. (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] : Type [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 » Who is intended to fulfill the request supplier : Reference [0..*] « Organization | HealthcareService » Why The reason why the supply item was requested reason[x] reasonCode : Type [0..1] CodeableConcept | Reference ( Any [0..*] « The reason why the supply item was requested. (Strength=Example) SupplyRequestReason ); ?? » Why The reason why the supply item was requested (Strength=Example) reasonReference : Reference [0..*] « Condition | Observation | SupplyRequestReason DiagnosticReport ?? | DocumentReference » 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 » OrderedItem Parameter The amount A code or string that is being ordered of identifies the indicated item device detail being asserted quantity code : Quantity CodeableConcept [1..1] [0..1] The item that is requested to be supplied. This is either a link to a resource representing the details value of the item or a code that identifies the item from a known list device detail item[x] value[x] : Type [0..1] « CodeableConcept | Reference ( Medication | Substance | Device ); The item that was requested (Strength=Example) SNOMED CT Supply Item ?? Requester The device, practitioner, etc. who initiated the request agent : Reference [1..1] Practitioner | Organization | Patient Quantity | RelatedPerson Range | Device The organization the device or practitioner was acting on behalf of onBehalfOf : Reference [0..1] Organization boolean » The item being requested orderedItem [0..1] The individual who initiated the request and has responsibility Specific parameters for its activation the ordered item. For example, the size of the indicated item requester parameter [0..1] [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>

 <identifier><!-- 0..* Identifier Business Identifier for SupplyRequest --></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 -->
 <
  <</quantity>
  <</item[x]>
 </orderedItem>

 <item[x]><!-- 1..1 CodeableConcept|Reference(Device|Medication|Substance) Medication, Substance, or Device requested to be supplied --></item[x]>
 <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 -->
 <
  <|
    </agent>
  <</onBehalfOf>
 </requester>
 <</supplier>
 <</reason[x]>
 <</deliverFrom>
 <</deliverTo>

 <requester><!-- 0..1 Reference(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><!-- 0..* CodeableConcept The reason why the supply item was requested --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition|DiagnosticReport|
   DocumentReference|Observation) The reason why the supply item was requested --></reasonReference>
 <deliverFrom><!-- 0..1 Reference(Location|Organization) The origin of the supply --></deliverFrom>
 <deliverTo><!-- 0..1 Reference(Location|Organization|Patient) The destination of the supply --></deliverTo>

</SupplyRequest>

JSON Template

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

  // item[x]: Medication, Substance, or Device requested to be supplied. One of these 2:
  "itemCodeableConcept" : { CodeableConcept },
  "itemReference" : { Reference(Device|Medication|Substance) },
  "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(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // Individual making the request
  "supplier" : [{ Reference(HealthcareService|Organization) }], // Who is intended to fulfill the request
  "reasonCode" : [{ CodeableConcept }], // The reason why the supply item was requested
  "reasonReference" : [{ Reference(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) } // The destination of the supply

}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ 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:SupplyRequest.identifier [ Identifier ], ... ; # 0..* Business Identifier for SupplyRequest

  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:
    fhir:
    # . One of these 2
      fhir: ]
      fhir:) ]
  ];

  # SupplyRequest.item[x] : 1..1 Medication, Substance, or Device requested to be supplied. One of these 2
    fhir:SupplyRequest.itemCodeableConcept [ CodeableConcept ]
    fhir:SupplyRequest.itemReference [ Reference(Device|Medication|Substance) ]
  fhir:SupplyRequest.quantity [ Quantity ]; # 1..1 The requested amount of the item indicated
  fhir:SupplyRequest.parameter [ # 0..* Ordered item details
    fhir:SupplyRequest.parameter.code [ CodeableConcept ]; # 0..1 Item detail
    # SupplyRequest.parameter.value[x] : 0..1 Value of detail. One of these 4
      fhir:SupplyRequest.parameter.valueCodeableConcept [ CodeableConcept ]
      fhir:SupplyRequest.parameter.valueQuantity [ Quantity ]
      fhir:SupplyRequest.parameter.valueRange [ Range ]
      fhir:SupplyRequest.parameter.valueBoolean [ boolean ]
  ], ...;

  # 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:
    fhir:
    fhir:
  ];
  fhir:
  # . One of these 2
    fhir: ]
    fhir:) ]
  fhir:
  fhir:

  fhir:SupplyRequest.requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Individual making the request
  fhir:SupplyRequest.supplier [ Reference(HealthcareService|Organization) ], ... ; # 0..* Who is intended to fulfill the request
  fhir:SupplyRequest.reasonCode [ CodeableConcept ], ... ; # 0..* The reason why the supply item was requested
  fhir:SupplyRequest.reasonReference [ Reference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* The reason why the supply item was requested
  fhir:SupplyRequest.deliverFrom [ Reference(Location|Organization) ]; # 0..1 The origin of the supply
  fhir:SupplyRequest.deliverTo [ Reference(Location|Organization|Patient) ]; # 0..1 The destination of the supply

]

Changes since DSTU2 R3

SupplyRequest
SupplyRequest.category SupplyRequest.status
  • Renamed Change value set from kind http://hl7.org/fhir/ValueSet/supplyrequest-status|4.0.0 to category Remove Binding http://hl7.org/fhir/ValueSet/supplyrequest-kind (required) SupplyRequest.priority Added Element SupplyRequest.orderedItem Remove Reference(Medication), Remove Reference(Substance), Remove Reference(Device) SupplyRequest.orderedItem.quantity Added Element SupplyRequest.orderedItem.item[x] Added Element SupplyRequest.occurrence[x] Added Element http://hl7.org/fhir/ValueSet/supplyrequest-status|4.1.0
SupplyRequest.authoredOn SupplyRequest.priority
  • Renamed Change value set from date http://hl7.org/fhir/ValueSet/request-priority|4.0.0 to authoredOn SupplyRequest.requester Added Element SupplyRequest.requester.agent Added Element SupplyRequest.requester.onBehalfOf Added Element SupplyRequest.deliverFrom Added Element SupplyRequest.deliverTo Added Element SupplyRequest.patient deleted SupplyRequest.source deleted SupplyRequest.when deleted http://hl7.org/fhir/ValueSet/request-priority|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

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

Structure

onBehalfOf 0..1 Reference ( Organization ) Organization agent is acting for
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..1 0..* Identifier Unique identifier Business Identifier for SupplyRequest
. . . status ?! Σ 0..1 code draft | active | suspended +
SupplyRequestStatus ( Required )
. . . category Σ 0..1 CodeableConcept The kind of supply (central, non-stock, etc.)
Supply Type ( Example )
. . . priority Σ 0..1 code routine | urgent | asap | stat
RequestPriority Request priority ( Required )
. . orderedItem . item[x] Σ 1..1 Medication, Substance, or Device requested to be supplied
SNOMED CT Supply Item ( Example )
.... itemCodeableConcept 0..1 BackboneElement CodeableConcept The item being requested
. . . . itemReference Reference ( Medication | Substance | Device )
. . . quantity Σ 1..1 Quantity The requested amount of the item indicated
. . . parameter 0..* BackboneElement Ordered item details
.... code 0..1 CodeableConcept Item detail
. . . . item[x] value[x] Σ 0..1 Value of detail
..... valueCodeableConcept 0..1 Medication, Substance, or Device requested to be supplied SNOMED CT Supply Item CodeableConcept ( Example
. . . . . valueQuantity Quantity )
. . . . . itemCodeableConcept valueRange CodeableConcept Range
. . . . itemReference . valueBoolean Reference ( Medication | Substance | Device 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 BackboneElement Who/what is requesting service agent Σ 1..1 0..1 Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device ) Individual making the request
. . . supplier Σ 0..* Reference ( Organization | HealthcareService ) Who is intended to fulfill the request
. . reason[x] . reasonCode 0..1 0..* CodeableConcept Why The reason why the supply item was requested
SupplyRequestReason ( Example )
. . reasonCodeableConcept CodeableConcept . reasonReference reasonReference 0..* Reference ( Any Condition | Observation | DiagnosticReport | DocumentReference ) 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 ) The destination of the supply

doco Documentation for this format

UML Diagram ( Legend )

SupplyRequest ( DomainResource ) Unique identifier for Business identifiers assigned to this supply request 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..1] [0..*] Status of the supply request (this element modifies the meaning of other elements) status : code [0..1] « Status of the supply request request. (Strength=Required) SupplyRequestStatus ! » 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] « Category of supply request request. (Strength=Example) Supply Type SupplyType ?? » Indicates how quickly this SupplyRequest should be addressed with respect to other requests priority : code [0..1] « Identifies the level of importance to be assigned to actioning the request request. (Strength=Required) RequestPriority ! » 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] : Type [1..1] « CodeableConcept | Reference ( Medication | Substance | Device ); The item that was requested. (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] : Type [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 » Who is intended to fulfill the request supplier : Reference [0..*] « Organization | HealthcareService » Why The reason why the supply item was requested reason[x] reasonCode : Type [0..1] CodeableConcept | Reference ( Any [0..*] « The reason why the supply item was requested. (Strength=Example) SupplyRequestReason ); ?? » Why The reason why the supply item was requested (Strength=Example) reasonReference : Reference [0..*] « Condition | Observation | SupplyRequestReason DiagnosticReport ?? | DocumentReference » 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 » OrderedItem Parameter The amount A code or string that is being ordered of identifies the indicated item device detail being asserted quantity code : Quantity CodeableConcept [1..1] [0..1] The item that is requested to be supplied. This is either a link to a resource representing the details value of the item or a code that identifies the item from a known list device detail item[x] value[x] : Type [0..1] « CodeableConcept | Reference ( Medication | Substance | Device ); The item that was requested (Strength=Example) SNOMED CT Supply Item ?? Requester The device, practitioner, etc. who initiated the request agent : Reference [1..1] Practitioner | Organization | Patient Quantity | RelatedPerson Range | Device The organization the device or practitioner was acting on behalf of onBehalfOf : Reference [0..1] Organization boolean » The item being requested orderedItem [0..1] The individual who initiated the request and has responsibility Specific parameters for its activation the ordered item. For example, the size of the indicated item requester parameter [0..1] [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>

 <identifier><!-- 0..* Identifier Business Identifier for SupplyRequest --></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 -->
 <
  <</quantity>
  <</item[x]>
 </orderedItem>

 <item[x]><!-- 1..1 CodeableConcept|Reference(Device|Medication|Substance) Medication, Substance, or Device requested to be supplied --></item[x]>
 <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 -->
 <
  <|
    </agent>
  <</onBehalfOf>
 </requester>
 <</supplier>
 <</reason[x]>
 <</deliverFrom>
 <</deliverTo>

 <requester><!-- 0..1 Reference(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><!-- 0..* CodeableConcept The reason why the supply item was requested --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition|DiagnosticReport|
   DocumentReference|Observation) The reason why the supply item was requested --></reasonReference>
 <deliverFrom><!-- 0..1 Reference(Location|Organization) The origin of the supply --></deliverFrom>
 <deliverTo><!-- 0..1 Reference(Location|Organization|Patient) The destination of the supply --></deliverTo>

</SupplyRequest>

JSON Template

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

  // item[x]: Medication, Substance, or Device requested to be supplied. One of these 2:
  "itemCodeableConcept" : { CodeableConcept },
  "itemReference" : { Reference(Device|Medication|Substance) },
  "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(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // Individual making the request
  "supplier" : [{ Reference(HealthcareService|Organization) }], // Who is intended to fulfill the request
  "reasonCode" : [{ CodeableConcept }], // The reason why the supply item was requested
  "reasonReference" : [{ Reference(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) } // The destination of the supply

}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ 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:SupplyRequest.identifier [ Identifier ], ... ; # 0..* Business Identifier for SupplyRequest

  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:
    fhir:
    # . One of these 2
      fhir: ]
      fhir:) ]
  ];

  # SupplyRequest.item[x] : 1..1 Medication, Substance, or Device requested to be supplied. One of these 2
    fhir:SupplyRequest.itemCodeableConcept [ CodeableConcept ]
    fhir:SupplyRequest.itemReference [ Reference(Device|Medication|Substance) ]
  fhir:SupplyRequest.quantity [ Quantity ]; # 1..1 The requested amount of the item indicated
  fhir:SupplyRequest.parameter [ # 0..* Ordered item details
    fhir:SupplyRequest.parameter.code [ CodeableConcept ]; # 0..1 Item detail
    # SupplyRequest.parameter.value[x] : 0..1 Value of detail. One of these 4
      fhir:SupplyRequest.parameter.valueCodeableConcept [ CodeableConcept ]
      fhir:SupplyRequest.parameter.valueQuantity [ Quantity ]
      fhir:SupplyRequest.parameter.valueRange [ Range ]
      fhir:SupplyRequest.parameter.valueBoolean [ boolean ]
  ], ...;

  # 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:
    fhir:
    fhir:
  ];
  fhir:
  # . One of these 2
    fhir: ]
    fhir:) ]
  fhir:
  fhir:

  fhir:SupplyRequest.requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Individual making the request
  fhir:SupplyRequest.supplier [ Reference(HealthcareService|Organization) ], ... ; # 0..* Who is intended to fulfill the request
  fhir:SupplyRequest.reasonCode [ CodeableConcept ], ... ; # 0..* The reason why the supply item was requested
  fhir:SupplyRequest.reasonReference [ Reference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* The reason why the supply item was requested
  fhir:SupplyRequest.deliverFrom [ Reference(Location|Organization) ]; # 0..1 The origin of the supply
  fhir:SupplyRequest.deliverTo [ Reference(Location|Organization|Patient) ]; # 0..1 The destination of the supply

]

Changes since DSTU2 Release 3

SupplyRequest
SupplyRequest.category SupplyRequest.status
  • Renamed Change value set from kind http://hl7.org/fhir/ValueSet/supplyrequest-status|4.0.0 to category Remove Binding http://hl7.org/fhir/ValueSet/supplyrequest-kind (required) SupplyRequest.priority Added Element SupplyRequest.orderedItem Remove Reference(Medication), Remove Reference(Substance), Remove Reference(Device) SupplyRequest.orderedItem.quantity Added Element SupplyRequest.orderedItem.item[x] Added Element SupplyRequest.occurrence[x] Added Element http://hl7.org/fhir/ValueSet/supplyrequest-status|4.1.0
SupplyRequest.authoredOn SupplyRequest.priority
  • Renamed Change value set from date http://hl7.org/fhir/ValueSet/request-priority|4.0.0 to authoredOn SupplyRequest.requester Added Element SupplyRequest.requester.agent Added Element SupplyRequest.requester.onBehalfOf Added Element SupplyRequest.deliverFrom Added Element SupplyRequest.deliverTo Added Element SupplyRequest.patient deleted SupplyRequest.source deleted SupplyRequest.when deleted http://hl7.org/fhir/ValueSet/request-priority|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

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

 

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

Path Definition Type Reference
SupplyRequest.status Status of the supply request request. Required SupplyRequestStatus
SupplyRequest.category Category of supply request request. Example Supply Type SupplyType
SupplyRequest.priority Identifies the level of importance to be assigned to actioning the request request. Required RequestPriority
SupplyRequest.orderedItem.item[x] SupplyRequest.item[x] The item that was requested requested. Example SNOMED CT Supply Item SNOMEDCTSupplyItem
SupplyRequest.parameter.code A code that identifies the device detail. Unknown No details provided yet
SupplyRequest.reason[x] SupplyRequest.reasonCode Why The reason why the supply item was requested requested. Example SupplyRequestReason

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 Expression In Common
category token The kind of supply (central, non-stock, etc.) SupplyRequest.category
date date When the request was made SupplyRequest.authoredOn 18 17 Resources
identifier token Unique identifier Business Identifier for SupplyRequest SupplyRequest.identifier 26 30 Resources
requester reference Individual making the request SupplyRequest.requester.agent SupplyRequest.requester
( Practitioner , Organization , Device , Patient , PractitionerRole , RelatedPerson )
status token draft | active | suspended + SupplyRequest.status
subject reference The destination of the supply SupplyRequest.deliverTo
( Organization , Patient , Location )
supplier reference Who is intended to fulfill the request SupplyRequest.supplier
( Organization , HealthcareService )