DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 3). 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 R3 R2

5.24 12.24 Resource SupplyRequest - Content

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

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

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

This resource overlaps with DeviceUseRequest and MedicationOrder . The SupplyRequest resource may be is used to request for inventory management . When requesting medication, substances and devices when handling them generically (as any other supply). For example, when processing bulk orders, etc. TODO - finish defining boundaries. there is a patient focus or instructions regarding their use, DeviceRequest or MedicationRequest should be used instead

This resource is referenced by CarePlan and ClinicalImpression supplydelivery

Structure

Σ Patient for whom the item is supplied Who initiated this order When the request was made Unique identifier ?! 0..1 0..1 Medication, Substance, or Device requested to be supplied 0..* Who is intended to fulfill the request SupplyRequestReason 0..1 When 0..1 Fulfilment code Σ Formal fulfillment schedule
Name Flags Card. Type Description & Constraints doco
. . SupplyRequest DomainResource Request for a medication, substance or device
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . patient . identifier Σ 0..1 Reference ( Patient Identifier ) Unique identifier
. . source . status ?! Σ 0..1 Reference ( Practitioner code draft | Organization active | Patient suspended +
SupplyRequestStatus ( Required )
. . date . category Σ 0..1 dateTime CodeableConcept The kind of supply (central, non-stock, etc.)
Supply Type ( Example )
. . identifier . priority Σ 0..1 Identifier code routine | urgent | asap | stat
RequestPriority ( Required )
. . status . orderedItem Σ 0..1 code BackboneElement The item being requested | completed | failed | cancelled SupplyRequestStatus ( Required )
. . kind . . quantity Σ 1..1 CodeableConcept Quantity The kind requested amount of supply (central, non-stock, etc.) the item indicated
.... item[x] Σ 0..1 Medication, Substance, or Device requested to be supplied
SNOMED CT Supply Type Item ( Required Example )
. . orderedItem . . . itemCodeableConcept Σ CodeableConcept
. . . . . itemReference Reference ( Medication | Substance | Device )
. . supplier . occurrence[x] Σ 0..1 Reference When the request should be fulfilled
.... occurrenceDateTime dateTime ( Organization
. . . . occurrencePeriod Period )
. . . . occurrenceTiming Timing
. . reason[x] . authoredOn Σ 0..1 Why dateTime When the supply item request was requested made
. . . requester ( Example ) Σ 0..1 reasonCodeableConcept BackboneElement Who/what is requesting service
CodeableConcept . . . . agent Σ 1..1 Reference ( Practitioner | Organization | Patient | RelatedPerson | Device ) Individual making the request
. . . . onBehalfOf reasonReference 0..1 Reference ( Any Organization ) Organization agent is acting for
. . when . supplier Σ 0..* BackboneElement Reference ( Organization ) Who is intended to fulfill the request should be fulfilled
. . code . reason[x] Σ 0..1 Why the supply item was requested
SupplyRequestReason ( Example )
. . . . reasonCodeableConcept CodeableConcept Supply Request When
. . . . reasonReference Reference ( Example Any )
. . . deliverFrom schedule 0..1 Reference ( Organization | Location ) The origin of the supply
. . . deliverTo 0..1 Timing Reference ( Organization | Location | Patient ) The destination of the supply

doco Documentation for this format

UML Diagram ( Legend )

SupplyRequest ( DomainResource ) A link to a resource representing the person whom the ordered item is for patient : Reference [0..1] « Patient » The Practitioner , Organization or Patient who initiated this order for the supply source : Reference [0..1] « Practitioner | Organization | Patient » When the request was made date : dateTime [0..1] 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 kind category : CodeableConcept [0..1] « Category of supply request (Strength=Required) (Strength=Example) Supply Type ! » ?? The item that is requested Indicates how quickly this SupplyRequest should be addressed with respect to other requests priority : code [0..1] Identifies the level of importance to be supplied assigned to actioning the request (Strength=Required) orderedItem RequestPriority ! When the request should be fulfilled occurrence[x] : Reference Type [0..1] « Medication dateTime | Substance Period | Device Timing » When the request was made authoredOn : dateTime [0..1] Who is intended to fulfill the request supplier : Reference [0..*] « Organization » Why the supply item was requested reason[x] : Type [0..1] « CodeableConcept | Reference ( Any ); Why the supply item was requested (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 When OrderedItem Code indicating when The amount that is being ordered of the request should be fulfilled indicated item quantity : Quantity [1..1] 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 [0..1] CodeableConcept [0..1] « | Reference ( Medication | Substance | Device ); When the request should be fulfilled The item that was requested (Strength=Example) SNOMED CT Supply Request When Item ?? » Requester Formal fulfillment schedule The device, practitioner, etc. who initiated the request schedule agent : Timing Reference [1..1] Practitioner | Organization | Patient | RelatedPerson | Device The organization the device or practitioner was acting on behalf of onBehalfOf : Reference [0..1] Organization When The item being requested orderedItem [0..1] The individual who initiated the request should be fulfilled and has responsibility for its activation when requester [0..1]

XML Template

<

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

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</patient>
 <</source>
 <
 <</identifier>
 <
 <</kind>
 <</orderedItem>
 <</supplier>
 <</reason[x]>
 <
  <</code>
  <</schedule>
 </when>

 <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>
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <orderedItem>  <!-- 0..1 The item being requested -->
  <quantity><!-- 1..1 Quantity The requested amount of the item indicated --></quantity>
  <item[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance|Device) Medication, Substance, or Device requested to be supplied --></item[x]>
 </orderedItem>
 <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 Who/what is requesting service -->
  <agent><!-- 1..1 Reference(Practitioner|Organization|Patient|RelatedPerson|
    Device) Individual making the request --></agent>

  <onBehalfOf><!-- 0..1 Reference(Organization) Organization agent is acting for --></onBehalfOf>
 </requester>
 <supplier><!-- 0..* Reference(Organization) Who is intended to fulfill the request --></supplier>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Any) Why the supply item was requested --></reason[x]>
 <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

{
  "resourceType" : "",

{doco
  "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
  "orderedItem" : { // The item being requested
    "quantity" : { Quantity }, // R!  The requested amount of the item indicated
    // item[x]: Medication, Substance, or Device requested to be supplied. One of these 2:

    "itemCodeableConcept" : { CodeableConcept }
    "itemReference" : { Reference(Medication|Substance|Device) }
  },
  // 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" : { // Who/what is requesting service
    "agent" : { Reference(Practitioner|Organization|Patient|RelatedPerson|
    Device) }, // R!  Individual making the request

    "onBehalfOf" : { Reference(Organization) } // Organization agent is acting for
  },
  "supplier" : [{ Reference(Organization) }], // Who is intended to fulfill the request

  // reason[x]: Why the supply item was requested. One of these 2:
  " },
  " },
  "
    "
    "
  }

  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "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:SupplyRequest.orderedItem [ # 0..1 The item being requested
    fhir:SupplyRequest.orderedItem.quantity [ Quantity ]; # 1..1 The requested amount of the item indicated
    # SupplyRequest.orderedItem.item[x] : 0..1 Medication, Substance, or Device requested to be supplied. One of these 2
      fhir:SupplyRequest.orderedItem.itemCodeableConcept [ CodeableConcept ]
      fhir:SupplyRequest.orderedItem.itemReference [ Reference(Medication|Substance|Device) ]
  ];
  # 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:SupplyRequest.requester [ # 0..1 Who/what is requesting service
    fhir:SupplyRequest.requester.agent [ Reference(Practitioner|Organization|Patient|RelatedPerson|Device) ]; # 1..1 Individual making the request
    fhir:SupplyRequest.requester.onBehalfOf [ Reference(Organization) ]; # 0..1 Organization agent is acting for
  ];
  fhir:SupplyRequest.supplier [ Reference(Organization) ], ... ; # 0..* Who is intended to fulfill the request
  # SupplyRequest.reason[x] : 0..1 Why the supply item was requested. One of these 2
    fhir:SupplyRequest.reasonCodeableConcept [ CodeableConcept ]
    fhir:SupplyRequest.reasonReference [ Reference(Any) ]
  fhir:SupplyRequest.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
SupplyRequest.category
  • Renamed from kind 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
SupplyRequest.authoredOn
  • Renamed from date 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

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

Structure

Σ Patient for whom the item is supplied Who initiated this order When the request was made Unique identifier ?! 0..1 0..1 Medication, Substance, or Device requested to be supplied 0..* Who is intended to fulfill the request SupplyRequestReason 0..1 When 0..1 Fulfilment code Σ Formal fulfillment schedule
Name Flags Card. Type Description & Constraints doco
. . SupplyRequest DomainResource Request for a medication, substance or device
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . patient . identifier Σ 0..1 Reference ( Patient Identifier ) Unique identifier
. . source . status ?! Σ 0..1 Reference ( Practitioner code draft | Organization active | Patient suspended +
SupplyRequestStatus ( Required )
. . date . category Σ 0..1 dateTime CodeableConcept The kind of supply (central, non-stock, etc.)
Supply Type ( Example )
. . identifier . priority Σ 0..1 Identifier code routine | urgent | asap | stat
RequestPriority ( Required )
. . status . orderedItem Σ 0..1 code BackboneElement The item being requested | completed | failed | cancelled SupplyRequestStatus ( Required )
. . kind . . quantity Σ 1..1 CodeableConcept Quantity The kind requested amount of supply (central, non-stock, etc.) the item indicated
.... item[x] Σ 0..1 Medication, Substance, or Device requested to be supplied
SNOMED CT Supply Type Item ( Required Example )
. . orderedItem . . . itemCodeableConcept Σ CodeableConcept
. . . . . itemReference Reference ( Medication | Substance | Device )
. . supplier . occurrence[x] Σ 0..1 Reference When the request should be fulfilled
.... occurrenceDateTime dateTime ( Organization
. . . . occurrencePeriod Period )
. . . . occurrenceTiming Timing
. . reason[x] . authoredOn Σ 0..1 Why dateTime When the supply item request was requested made
. . . requester ( Example ) Σ 0..1 reasonCodeableConcept BackboneElement Who/what is requesting service
CodeableConcept . . . . agent Σ 1..1 Reference ( Practitioner | Organization | Patient | RelatedPerson | Device ) Individual making the request
. . . . onBehalfOf reasonReference 0..1 Reference ( Any Organization ) Organization agent is acting for
. . when . supplier Σ 0..* BackboneElement Reference ( Organization ) Who is intended to fulfill the request should be fulfilled
. . code . reason[x] Σ 0..1 Why the supply item was requested
SupplyRequestReason ( Example )
. . . . reasonCodeableConcept CodeableConcept Supply Request When
. . . . reasonReference Reference ( Example Any )
. . . deliverFrom schedule 0..1 Reference ( Organization | Location ) The origin of the supply
. . . deliverTo 0..1 Timing Reference ( Organization | Location | Patient ) The destination of the supply

doco Documentation for this format

UML Diagram ( Legend )

SupplyRequest ( DomainResource ) A link to a resource representing the person whom the ordered item is for patient : Reference [0..1] « Patient » The Practitioner , Organization or Patient who initiated this order for the supply source : Reference [0..1] « Practitioner | Organization | Patient » When the request was made date : dateTime [0..1] 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 kind category : CodeableConcept [0..1] « Category of supply request (Strength=Required) (Strength=Example) Supply Type ! » ?? The item that is requested Indicates how quickly this SupplyRequest should be addressed with respect to other requests priority : code [0..1] Identifies the level of importance to be supplied assigned to actioning the request (Strength=Required) orderedItem RequestPriority ! When the request should be fulfilled occurrence[x] : Reference Type [0..1] « Medication dateTime | Substance Period | Device Timing » When the request was made authoredOn : dateTime [0..1] Who is intended to fulfill the request supplier : Reference [0..*] « Organization » Why the supply item was requested reason[x] : Type [0..1] « CodeableConcept | Reference ( Any ); Why the supply item was requested (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 When OrderedItem Code indicating when The amount that is being ordered of the request should be fulfilled indicated item quantity : Quantity [1..1] 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 [0..1] CodeableConcept [0..1] « | Reference ( Medication | Substance | Device ); When the request should be fulfilled The item that was requested (Strength=Example) SNOMED CT Supply Request When Item ?? » Requester Formal fulfillment schedule The device, practitioner, etc. who initiated the request schedule agent : Timing Reference [1..1] Practitioner | Organization | Patient | RelatedPerson | Device The organization the device or practitioner was acting on behalf of onBehalfOf : Reference [0..1] Organization When The item being requested orderedItem [0..1] The individual who initiated the request should be fulfilled and has responsibility for its activation when requester [0..1]

XML Template

<

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

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</patient>
 <</source>
 <
 <</identifier>
 <
 <</kind>
 <</orderedItem>
 <</supplier>
 <</reason[x]>
 <
  <</code>
  <</schedule>
 </when>

 <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>
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <orderedItem>  <!-- 0..1 The item being requested -->
  <quantity><!-- 1..1 Quantity The requested amount of the item indicated --></quantity>
  <item[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance|Device) Medication, Substance, or Device requested to be supplied --></item[x]>
 </orderedItem>
 <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 Who/what is requesting service -->
  <agent><!-- 1..1 Reference(Practitioner|Organization|Patient|RelatedPerson|
    Device) Individual making the request --></agent>

  <onBehalfOf><!-- 0..1 Reference(Organization) Organization agent is acting for --></onBehalfOf>
 </requester>
 <supplier><!-- 0..* Reference(Organization) Who is intended to fulfill the request --></supplier>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Any) Why the supply item was requested --></reason[x]>
 <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

{
  "resourceType" : "",

{doco
  "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
  "orderedItem" : { // The item being requested
    "quantity" : { Quantity }, // R!  The requested amount of the item indicated
    // item[x]: Medication, Substance, or Device requested to be supplied. One of these 2:

    "itemCodeableConcept" : { CodeableConcept }
    "itemReference" : { Reference(Medication|Substance|Device) }
  },
  // 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" : { // Who/what is requesting service
    "agent" : { Reference(Practitioner|Organization|Patient|RelatedPerson|
    Device) }, // R!  Individual making the request

    "onBehalfOf" : { Reference(Organization) } // Organization agent is acting for
  },
  "supplier" : [{ Reference(Organization) }], // Who is intended to fulfill the request

  // reason[x]: Why the supply item was requested. One of these 2:
  " },
  " },
  "
    "
    "
  }

  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "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:SupplyRequest.orderedItem [ # 0..1 The item being requested
    fhir:SupplyRequest.orderedItem.quantity [ Quantity ]; # 1..1 The requested amount of the item indicated
    # SupplyRequest.orderedItem.item[x] : 0..1 Medication, Substance, or Device requested to be supplied. One of these 2
      fhir:SupplyRequest.orderedItem.itemCodeableConcept [ CodeableConcept ]
      fhir:SupplyRequest.orderedItem.itemReference [ Reference(Medication|Substance|Device) ]
  ];
  # 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:SupplyRequest.requester [ # 0..1 Who/what is requesting service
    fhir:SupplyRequest.requester.agent [ Reference(Practitioner|Organization|Patient|RelatedPerson|Device) ]; # 1..1 Individual making the request
    fhir:SupplyRequest.requester.onBehalfOf [ Reference(Organization) ]; # 0..1 Organization agent is acting for
  ];
  fhir:SupplyRequest.supplier [ Reference(Organization) ], ... ; # 0..* Who is intended to fulfill the request
  # SupplyRequest.reason[x] : 0..1 Why the supply item was requested. One of these 2
    fhir:SupplyRequest.reasonCodeableConcept [ CodeableConcept ]
    fhir:SupplyRequest.reasonReference [ Reference(Any) ]
  fhir:SupplyRequest.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
SupplyRequest.category
  • Renamed from kind 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
SupplyRequest.authoredOn
  • Renamed from date 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

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

 

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

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

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

date
Name Type Description Paths Expression date When the request was made In Common SupplyRequest.date
identifier category token Unique identifier The kind of supply (central, non-stock, etc.) SupplyRequest.identifier SupplyRequest.category
kind date token date The kind of supply (central, non-stock, etc.) When the request was made SupplyRequest.kind SupplyRequest.authoredOn 18 Resources
patient identifier reference token Patient for whom the item is supplied Unique identifier SupplyRequest.patient ( Patient SupplyRequest.identifier 26 Resources )
source requester reference Who initiated this order Individual making the request SupplyRequest.source SupplyRequest.requester.agent
( Patient Practitioner , Organization , Practitioner Device , Patient , RelatedPerson )
status token requested | completed draft | failed active | cancelled suspended + SupplyRequest.status
supplier reference Who is intended to fulfill the request SupplyRequest.supplier
( Organization )