DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 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

5.23 Resource Supply - Content

This resource maintained by the Orders and Observations Work Group

A supply - a request for something, and provision of what is supplied.

5.23.1 Scope and Usage

The scope of the supply resource is for 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.

5.23.2 Boundaries and Relationships

This resource overlaps with others such as Device and Medication. The Supply resource may be used to describe medications and devices when handling them generically (as any other supply). For example, when processing bulk orders, etc. However, when the medication, device or other aspects of the resource are important, (e.g. in a MedicationPrescription or when identifying a device as a performer), the more detailed resource must be used.

This resource is referenced by CarePlan, ClinicalImpression and Contract

5.23.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply DomainResourceA supply - request and provision
... kind 0..1CodeableConceptThe kind of supply (central, non-stock, etc)
SupplyKind (Required)
... identifier 0..1IdentifierUnique identifier
... status ?!0..1coderequested | dispensed | received | failed | cancelled
SupplyStatus (Required)
... orderedItem 0..1Medication | Substance | DeviceMedication, Substance, or Device requested to be supplied
... patient 0..1PatientPatient for whom the item is supplied
... dispense 0..*ElementSupply details
.... identifier 0..1IdentifierExternal identifier
.... status ?!0..1codein-progress | dispensed | abandoned
SupplyDispenseStatus (Required)
.... type 0..1CodeableConceptCategory of dispense event
SupplyItemType (Required)
.... quantity 0..1QuantityAmount dispensed
.... suppliedItem 0..1Medication | Substance | DeviceMedication, Substance, or Device supplied
.... supplier 0..1PractitionerDispenser
.... whenPrepared 0..1PeriodDispensing time
.... whenHandedOver 0..1dateTimeHandover time
.... destination 0..1LocationWhere the Supply was sent
.... receiver 0..*PractitionerWho collected the Supply

UML Diagram

Supply (DomainResource)Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply processkind : CodeableConcept 0..1 « Category of supplySupplyKind »Unique identifier for this supply requestidentifier : Identifier 0..1Status of the supply request (this element modifies the meaning of other elements)status : code 0..1 « Status of the supplySupplyStatus »The item that is requested to be suppliedorderedItem : Reference(Medication|Substance|Device) 0..1A link to a resource representing the person whom the ordered item is forpatient : Reference(Patient) 0..1DispenseIdentifier assigned by the dispensing facility when the item(s) is dispensedidentifier : Identifier 0..1A code specifying the state of the dispense event (this element modifies the meaning of other elements)status : code 0..1 « Status of the dispenseSupplyDispenseStatus »Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etctype : CodeableConcept 0..1 « The actual item being suppliedSupplyItemType »The amount of supply that has been dispensed. Includes unit of measurequantity : Quantity 0..1Identifies the medication or substance or device being dispensed. This is either a link to a resource representing the details of the item or a simple attribute carrying a code that identifies the item from a known listsuppliedItem : Reference(Medication|Substance|Device) 0..1The individual responsible for dispensing the medication, supplier or devicesupplier : Reference(Practitioner) 0..1The time the dispense event occurredwhenPrepared : Period 0..1The time the dispensed item was sent or handed to the patient (or agent)whenHandedOver : dateTime 0..1Identification of the facility/location where the Supply was shipped to, as part of the dispense eventdestination : Reference(Location) 0..1Identifies the person who picked up the Supplyreceiver : Reference(Practitioner) 0..*Indicates the details of the dispense event such as the days supply and quantity of a supply dispenseddispense0..*

XML Template

<Supply xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <kind><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc) --></kind>
 <identifier><!-- 0..1 Identifier Unique identifier --></identifier>
 <status value="[code]"/><!-- 0..1 requested | dispensed | received | failed | cancelled -->
 <orderedItem><!-- 0..1 Reference(Medication|Substance|Device) 
     Medication, Substance, or Device requested to be supplied --></orderedItem>
 <patient><!-- 0..1 Reference(Patient) Patient for whom the item is supplied --></patient>
 <dispense>  <!-- 0..* Supply details -->
  <identifier><!-- 0..1 Identifier External identifier --></identifier>
  <status value="[code]"/><!-- 0..1 in-progress | dispensed | abandoned -->
  <type><!-- 0..1 CodeableConcept Category of dispense event --></type>
  <quantity><!-- 0..1 Quantity Amount dispensed --></quantity>
  <suppliedItem><!-- 0..1 Reference(Medication|Substance|Device) 
      Medication, Substance, or Device supplied --></suppliedItem>
  <supplier><!-- 0..1 Reference(Practitioner) Dispenser --></supplier>
  <whenPrepared><!-- 0..1 Period Dispensing time --></whenPrepared>
  <whenHandedOver value="[dateTime]"/><!-- 0..1 Handover time -->
  <destination><!-- 0..1 Reference(Location) Where the Supply was sent --></destination>
  <receiver><!-- 0..* Reference(Practitioner) Who collected the Supply --></receiver>
 </dispense>
</Supply>

JSON Template

{doco
  "resourceType" : "Supply",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "kind" : { CodeableConcept }, // The kind of supply (central, non-stock, etc)
  "identifier" : { Identifier }, // Unique identifier
  "status" : "<code>", // requested | dispensed | received | failed | cancelled
  "orderedItem" : { Reference(Medication|Substance|Device) }, // 
     Medication, Substance, or Device requested to be supplied
  "patient" : { Reference(Patient) }, // Patient for whom the item is supplied
  "dispense" : [{ // Supply details
    "identifier" : { Identifier }, // External identifier
    "status" : "<code>", // in-progress | dispensed | abandoned
    "type" : { CodeableConcept }, // Category of dispense event
    "quantity" : { Quantity }, // Amount dispensed
    "suppliedItem" : { Reference(Medication|Substance|Device) }, // 
      Medication, Substance, or Device supplied
    "supplier" : { Reference(Practitioner) }, // Dispenser
    "whenPrepared" : { Period }, // Dispensing time
    "whenHandedOver" : "<dateTime>", // Handover time
    "destination" : { Reference(Location) }, // Where the Supply was sent
    "receiver" : [{ Reference(Practitioner) }] // Who collected the Supply
  }]
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply DomainResourceA supply - request and provision
... kind 0..1CodeableConceptThe kind of supply (central, non-stock, etc)
SupplyKind (Required)
... identifier 0..1IdentifierUnique identifier
... status ?!0..1coderequested | dispensed | received | failed | cancelled
SupplyStatus (Required)
... orderedItem 0..1Medication | Substance | DeviceMedication, Substance, or Device requested to be supplied
... patient 0..1PatientPatient for whom the item is supplied
... dispense 0..*ElementSupply details
.... identifier 0..1IdentifierExternal identifier
.... status ?!0..1codein-progress | dispensed | abandoned
SupplyDispenseStatus (Required)
.... type 0..1CodeableConceptCategory of dispense event
SupplyItemType (Required)
.... quantity 0..1QuantityAmount dispensed
.... suppliedItem 0..1Medication | Substance | DeviceMedication, Substance, or Device supplied
.... supplier 0..1PractitionerDispenser
.... whenPrepared 0..1PeriodDispensing time
.... whenHandedOver 0..1dateTimeHandover time
.... destination 0..1LocationWhere the Supply was sent
.... receiver 0..*PractitionerWho collected the Supply

UML Diagram

Supply (DomainResource)Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply processkind : CodeableConcept 0..1 « Category of supplySupplyKind »Unique identifier for this supply requestidentifier : Identifier 0..1Status of the supply request (this element modifies the meaning of other elements)status : code 0..1 « Status of the supplySupplyStatus »The item that is requested to be suppliedorderedItem : Reference(Medication|Substance|Device) 0..1A link to a resource representing the person whom the ordered item is forpatient : Reference(Patient) 0..1DispenseIdentifier assigned by the dispensing facility when the item(s) is dispensedidentifier : Identifier 0..1A code specifying the state of the dispense event (this element modifies the meaning of other elements)status : code 0..1 « Status of the dispenseSupplyDispenseStatus »Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etctype : CodeableConcept 0..1 « The actual item being suppliedSupplyItemType »The amount of supply that has been dispensed. Includes unit of measurequantity : Quantity 0..1Identifies the medication or substance or device being dispensed. This is either a link to a resource representing the details of the item or a simple attribute carrying a code that identifies the item from a known listsuppliedItem : Reference(Medication|Substance|Device) 0..1The individual responsible for dispensing the medication, supplier or devicesupplier : Reference(Practitioner) 0..1The time the dispense event occurredwhenPrepared : Period 0..1The time the dispensed item was sent or handed to the patient (or agent)whenHandedOver : dateTime 0..1Identification of the facility/location where the Supply was shipped to, as part of the dispense eventdestination : Reference(Location) 0..1Identifies the person who picked up the Supplyreceiver : Reference(Practitioner) 0..*Indicates the details of the dispense event such as the days supply and quantity of a supply dispenseddispense0..*

XML Template

<Supply xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <kind><!-- 0..1 CodeableConcept The kind of supply (central, non-stock, etc) --></kind>
 <identifier><!-- 0..1 Identifier Unique identifier --></identifier>
 <status value="[code]"/><!-- 0..1 requested | dispensed | received | failed | cancelled -->
 <orderedItem><!-- 0..1 Reference(Medication|Substance|Device) 
     Medication, Substance, or Device requested to be supplied --></orderedItem>
 <patient><!-- 0..1 Reference(Patient) Patient for whom the item is supplied --></patient>
 <dispense>  <!-- 0..* Supply details -->
  <identifier><!-- 0..1 Identifier External identifier --></identifier>
  <status value="[code]"/><!-- 0..1 in-progress | dispensed | abandoned -->
  <type><!-- 0..1 CodeableConcept Category of dispense event --></type>
  <quantity><!-- 0..1 Quantity Amount dispensed --></quantity>
  <suppliedItem><!-- 0..1 Reference(Medication|Substance|Device) 
      Medication, Substance, or Device supplied --></suppliedItem>
  <supplier><!-- 0..1 Reference(Practitioner) Dispenser --></supplier>
  <whenPrepared><!-- 0..1 Period Dispensing time --></whenPrepared>
  <whenHandedOver value="[dateTime]"/><!-- 0..1 Handover time -->
  <destination><!-- 0..1 Reference(Location) Where the Supply was sent --></destination>
  <receiver><!-- 0..* Reference(Practitioner) Who collected the Supply --></receiver>
 </dispense>
</Supply>

JSON Template

{doco
  "resourceType" : "Supply",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "kind" : { CodeableConcept }, // The kind of supply (central, non-stock, etc)
  "identifier" : { Identifier }, // Unique identifier
  "status" : "<code>", // requested | dispensed | received | failed | cancelled
  "orderedItem" : { Reference(Medication|Substance|Device) }, // 
     Medication, Substance, or Device requested to be supplied
  "patient" : { Reference(Patient) }, // Patient for whom the item is supplied
  "dispense" : [{ // Supply details
    "identifier" : { Identifier }, // External identifier
    "status" : "<code>", // in-progress | dispensed | abandoned
    "type" : { CodeableConcept }, // Category of dispense event
    "quantity" : { Quantity }, // Amount dispensed
    "suppliedItem" : { Reference(Medication|Substance|Device) }, // 
      Medication, Substance, or Device supplied
    "supplier" : { Reference(Practitioner) }, // Dispenser
    "whenPrepared" : { Period }, // Dispensing time
    "whenHandedOver" : "<dateTime>", // Handover time
    "destination" : { Reference(Location) }, // Where the Supply was sent
    "receiver" : [{ Reference(Practitioner) }] // Who collected the Supply
  }]
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON)

5.23.3.1 Terminology Bindings

PathDefinitionTypeReference
Supply.kind Category of supplyRequiredhttp://hl7.org/fhir/vs/supply-kind
Supply.status Status of the supplyRequiredhttp://hl7.org/fhir/valueset-supply-status
Supply.dispense.status Status of the dispenseRequiredhttp://hl7.org/fhir/valueset-supply-dispense-status
Supply.dispense.type The actual item being suppliedRequiredhttp://hl7.org/fhir/vs/supply-item

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

NameTypeDescriptionPaths
dispenseidtokenExternal identifierSupply.dispense.identifier
dispensestatustokenin-progress | dispensed | abandonedSupply.dispense.status
identifiertokenUnique identifierSupply.identifier
kindtokenThe kind of supply (central, non-stock, etc)Supply.kind
patientreferencePatient for whom the item is suppliedSupply.patient
(Patient)
statustokenrequested | dispensed | received | failed | cancelledSupply.status
supplierreferenceDispenserSupply.dispense.supplier
(Practitioner)