FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.3.0: R4 Ballot 2). 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.24 12.23 Resource SupplyRequest - Content

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

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

12.24.1 12.23.1 Scope and Usage

STU 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.

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

12.24.2 12.23.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, DeviceRequest or MedicationRequest should be used instead

This resource is referenced by supplydelivery

12.24.3 12.23.3 Resource Content

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 Identifier Unique identifier
. . . 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 ( 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 . reasonReference CodeableConcept 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 this supply request identifier : Identifier [0..1] Status of the supply request (this element modifies the meaning of other elements) status : code [0..1] « Status of the supply 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 (Strength=Example) Supply Type ?? » 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 (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) SNOMED CT Supply Item ?? » 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..*] « Why The reason why the supply item was requested (Strength=Example) SupplyRequestReason ?? » The reason why the supply item was requested 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 Quantity | Substance Range | Device ); The item that was requested (Strength=Example) SNOMED CT Supply Item boolean ?? » Requester The device, practitioner, etc. who initiated the request agent : Reference [1..1] Practitioner | Organization | Patient | RelatedPerson | Device The organization Specific parameters for the device or practitioner was acting on behalf ordered item. For example, the size of onBehalfOf : Reference [0..1] Organization The item being requested orderedItem [0..1] The individual who initiated the request and has responsibility for its activation 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><!-- 0..1 Identifier Unique identifier --></identifier>
 <

 <status value="[code]"/><!-- 0..1 draft | active | suspended + -->

 <category><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc.) --></category>
 <
 <
  <</quantity>
  <</item[x]>
 </orderedItem>

 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <item[x]><!-- 1..1 CodeableConcept|Reference(Medication|Substance|Device) 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]>
 <
 <
  <|
    </agent>
  <</onBehalfOf>
 </requester>
 <</supplier>
 <</reason[x]>

 <authoredOn value="[dateTime]"/><!-- 0..1 When the request was made -->
 <requester><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization|
   Patient|RelatedPerson|Device) Individual making the request --></requester>

 <supplier><!-- 0..* Reference(Organization|HealthcareService) Who is intended to fulfill the request --></supplier>
 <reasonCode><!-- 0..* CodeableConcept The reason why the supply item was requested --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) The reason why the supply item was requested --></reasonReference>
 <deliverFrom><!-- 0..1 Reference(Organization|Location) The origin of the supply --></deliverFrom>
 <deliverTo><!-- 0..1 Reference(Organization|Location|Patient) The destination of the supply --></deliverTo>
</SupplyRequest>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "SupplyRequest",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
    "
    
    " }
    " }
  },

  "identifier" : { Identifier }, // Unique identifier
  "status" : "<code>", // draft | active | suspended +
  "category" : { CodeableConcept }, // The kind of supply (central, non-stock, etc.)
  "priority" : "<code>", // routine | urgent | asap | stat
  // item[x]: Medication, Substance, or Device requested to be supplied. One of these 2:

  "itemCodeableConcept" : { CodeableConcept },
  "itemReference" : { Reference(Medication|Substance|Device) },
  "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(Practitioner|PractitionerRole|Organization|
   Patient|RelatedPerson|Device) }, // Individual making the request

  "supplier" : [{ Reference(Organization|HealthcareService) }], // Who is intended to fulfill the request
  "reasonCode" : [{ CodeableConcept }], // The reason why the supply item was requested
  "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) }], // The reason why the supply item was requested

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

}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .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:SupplyRequest.identifier [ Identifier ]; # 0..1 Unique identifier
  fhir:SupplyRequest.status [ code ]; # 0..1 draft | active | suspended +
  fhir:SupplyRequest.category [ CodeableConcept ]; # 0..1 The kind of supply (central, non-stock, etc.)
  fhir:SupplyRequest.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:
    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(Medication|Substance|Device) ]
  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:SupplyRequest.requester [ Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device) ]; # 0..1 Individual making the request
  fhir:SupplyRequest.supplier [ Reference(Organization|HealthcareService) ], ... ; # 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|Observation|DiagnosticReport|DocumentReference) ], ... ; # 0..* The reason why the supply item was requested

  fhir:SupplyRequest.deliverFrom [ Reference(Organization|Location) ]; # 0..1 The origin of the supply
  fhir:SupplyRequest.deliverTo [ Reference(Organization|Location|Patient) ]; # 0..1 The destination of the supply
]

Changes since DSTU2 R3

SupplyRequest.category
SupplyRequest Renamed from kind to category Remove Binding http://hl7.org/fhir/ValueSet/supplyrequest-kind (required)
SupplyRequest.priority SupplyRequest.item[x]
  • Added Element
SupplyRequest.orderedItem SupplyRequest.quantity
  • Remove Reference(Medication), Remove Reference(Substance), Remove Reference(Device) Added Element
SupplyRequest.orderedItem.quantity SupplyRequest.parameter
  • Added Element
SupplyRequest.orderedItem.item[x] SupplyRequest.parameter.code
  • Added Element
SupplyRequest.occurrence[x] SupplyRequest.parameter.value[x]
  • Added Element
SupplyRequest.authoredOn SupplyRequest.requester
  • Renamed Type changed from date BackboneElement to authoredOn SupplyRequest.requester Added Element Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device)
SupplyRequest.requester.agent SupplyRequest.supplier
  • Added Element Type changed from Reference(Organization) to Reference(Organization|HealthcareService)
SupplyRequest.requester.onBehalfOf SupplyRequest.reasonCode
  • Added Element
SupplyRequest.deliverFrom SupplyRequest.reasonReference
  • Added Element
SupplyRequest.deliverTo SupplyRequest.orderedItem
  • Added Element deleted
SupplyRequest.patient SupplyRequest.requester.agent
  • deleted
SupplyRequest.source SupplyRequest.requester.onBehalfOf
  • deleted
SupplyRequest.when SupplyRequest.reason[x]
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4

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 Identifier Unique identifier
. . . 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 ( 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 . reasonReference CodeableConcept 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 this supply request identifier : Identifier [0..1] Status of the supply request (this element modifies the meaning of other elements) status : code [0..1] « Status of the supply 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 (Strength=Example) Supply Type ?? » 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 (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) SNOMED CT Supply Item ?? » 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..*] « Why The reason why the supply item was requested (Strength=Example) SupplyRequestReason ?? » The reason why the supply item was requested 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 Quantity | Substance Range | Device ); The item that was requested (Strength=Example) SNOMED CT Supply Item boolean ?? » Requester The device, practitioner, etc. who initiated the request agent : Reference [1..1] Practitioner | Organization | Patient | RelatedPerson | Device The organization Specific parameters for the device or practitioner was acting on behalf ordered item. For example, the size of onBehalfOf : Reference [0..1] Organization The item being requested orderedItem [0..1] The individual who initiated the request and has responsibility for its activation 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><!-- 0..1 Identifier Unique identifier --></identifier>
 <

 <status value="[code]"/><!-- 0..1 draft | active | suspended + -->

 <category><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc.) --></category>
 <
 <
  <</quantity>
  <</item[x]>
 </orderedItem>

 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <item[x]><!-- 1..1 CodeableConcept|Reference(Medication|Substance|Device) 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]>
 <
 <
  <|
    </agent>
  <</onBehalfOf>
 </requester>
 <</supplier>
 <</reason[x]>

 <authoredOn value="[dateTime]"/><!-- 0..1 When the request was made -->
 <requester><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization|
   Patient|RelatedPerson|Device) Individual making the request --></requester>

 <supplier><!-- 0..* Reference(Organization|HealthcareService) Who is intended to fulfill the request --></supplier>
 <reasonCode><!-- 0..* CodeableConcept The reason why the supply item was requested --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) The reason why the supply item was requested --></reasonReference>
 <deliverFrom><!-- 0..1 Reference(Organization|Location) The origin of the supply --></deliverFrom>
 <deliverTo><!-- 0..1 Reference(Organization|Location|Patient) The destination of the supply --></deliverTo>
</SupplyRequest>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "SupplyRequest",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
    "
    
    " }
    " }
  },

  "identifier" : { Identifier }, // Unique identifier
  "status" : "<code>", // draft | active | suspended +
  "category" : { CodeableConcept }, // The kind of supply (central, non-stock, etc.)
  "priority" : "<code>", // routine | urgent | asap | stat
  // item[x]: Medication, Substance, or Device requested to be supplied. One of these 2:

  "itemCodeableConcept" : { CodeableConcept },
  "itemReference" : { Reference(Medication|Substance|Device) },
  "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(Practitioner|PractitionerRole|Organization|
   Patient|RelatedPerson|Device) }, // Individual making the request

  "supplier" : [{ Reference(Organization|HealthcareService) }], // Who is intended to fulfill the request
  "reasonCode" : [{ CodeableConcept }], // The reason why the supply item was requested
  "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) }], // The reason why the supply item was requested

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

}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .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:SupplyRequest.identifier [ Identifier ]; # 0..1 Unique identifier
  fhir:SupplyRequest.status [ code ]; # 0..1 draft | active | suspended +
  fhir:SupplyRequest.category [ CodeableConcept ]; # 0..1 The kind of supply (central, non-stock, etc.)
  fhir:SupplyRequest.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:
    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(Medication|Substance|Device) ]
  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:SupplyRequest.requester [ Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device) ]; # 0..1 Individual making the request
  fhir:SupplyRequest.supplier [ Reference(Organization|HealthcareService) ], ... ; # 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|Observation|DiagnosticReport|DocumentReference) ], ... ; # 0..* The reason why the supply item was requested

  fhir:SupplyRequest.deliverFrom [ Reference(Organization|Location) ]; # 0..1 The origin of the supply
  fhir:SupplyRequest.deliverTo [ Reference(Organization|Location|Patient) ]; # 0..1 The destination of the supply
]

Changes since DSTU2

SupplyRequest.category
SupplyRequest Renamed from kind to category Remove Binding http://hl7.org/fhir/ValueSet/supplyrequest-kind (required)
SupplyRequest.priority SupplyRequest.item[x]
  • Added Element
SupplyRequest.orderedItem SupplyRequest.quantity
  • Remove Reference(Medication), Remove Reference(Substance), Remove Reference(Device) Added Element
SupplyRequest.orderedItem.quantity SupplyRequest.parameter
  • Added Element
SupplyRequest.orderedItem.item[x] SupplyRequest.parameter.code
  • Added Element
SupplyRequest.occurrence[x] SupplyRequest.parameter.value[x]
  • Added Element
SupplyRequest.authoredOn SupplyRequest.requester
  • Renamed Type changed from date BackboneElement to authoredOn SupplyRequest.requester Added Element Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device)
SupplyRequest.requester.agent SupplyRequest.supplier
  • Added Element Type changed from Reference(Organization) to Reference(Organization|HealthcareService)
SupplyRequest.requester.onBehalfOf SupplyRequest.reasonCode
  • Added Element
SupplyRequest.deliverFrom SupplyRequest.reasonReference
  • Added Element
SupplyRequest.deliverTo SupplyRequest.orderedItem
  • Added Element deleted
SupplyRequest.patient SupplyRequest.requester.agent
  • deleted
SupplyRequest.source SupplyRequest.requester.onBehalfOf
  • deleted
SupplyRequest.when SupplyRequest.reason[x]
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4

 

Alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

12.24.3.1 12.23.3.1 Terminology Bindings

Path Definition Type Reference
SupplyRequest.status Status of the supply request Required SupplyRequestStatus
SupplyRequest.category Category of supply request Example Supply Type
SupplyRequest.priority Identifies the level of importance to be assigned to actioning the request Required RequestPriority
SupplyRequest.orderedItem.item[x] SupplyRequest.item[x] The item that was requested Example SNOMED CT Supply Item
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 Example SupplyRequestReason

12.24.4 12.23.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 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 SupplyRequest.identifier 26 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
supplier reference Who is intended to fulfill the request SupplyRequest.supplier
( Organization , HealthcareService )