STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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.17 Resource SupplyDelivery - Content

Orders and Observations Work GroupMaturity Level: 0Compartments: Patient, Practitioner

Record of delivery of what is supplied.

12.17.1 Scope and Usage

This resource is an event 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 event resources.

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.

12.17.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 MedicationRequest or when identifying a device as a performer), the more detailed resource must be used.

12.17.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyDelivery ΣDomainResourceDelivery of Supply
... identifier Σ0..1IdentifierExternal identifier
... status ?!Σ0..1codein-progress | completed | abandoned
SupplyDeliveryStatus (Required)
... patient Σ0..1Reference(Patient)Patient for whom the item is supplied
... type Σ0..1CodeableConceptCategory of dispense event
Supply Item Type (Required)
... quantity Σ0..1SimpleQuantityAmount dispensed
... suppliedItem[x] Σ0..1Medication, Substance, or Device supplied
SNOMED CT Supply Item (Example)
.... suppliedItemCodeableConceptCodeableConcept
.... suppliedItemReferenceReference(Medication | Substance | Device)
... supplier Σ0..1Reference(Practitioner)Dispenser
... whenPrepared Σ0..1PeriodDispensing time
... time Σ0..1dateTimeHandover time
... destination Σ0..1Reference(Location)Where the Supply was sent
... receiver Σ0..*Reference(Practitioner)Who collected the Supply

doco Documentation for this format

UML Diagram (Legend)

SupplyDelivery (DomainResource)Identifier assigned by the dispensing facility when the item(s) is dispensedidentifier : Identifier [0..1]A code specifying the state of the dispense event (this element modifies the meaning of other elements)status : code [0..1] « Status of the supply delivery. (Strength=Required)SupplyDeliveryStatus! »A link to a resource representing the person whom the delivered item is forpatient : Reference [0..1] « Patient »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 type of supply dispense. (Strength=Required)Supply Item Type! »The amount of supply that has been dispensed. Includes unit of measurequantity : Quantity(SimpleQuantity) [0..1]Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known listsuppliedItem[x] : Type [0..1] « CodeableConcept|Reference(Medication| Substance|Device); The item that was delivered. (Strength=Example)SNOMED CT Supply Item?? »The individual responsible for dispensing the medication, supplier or devicesupplier : Reference [0..1] « Practitioner »The time the dispense event occurredwhenPrepared : Period [0..1]The time the dispensed item was sent or handed to the patient (or agent)time : dateTime [0..1]Identification of the facility/location where the Supply was shipped to, as part of the dispense eventdestination : Reference [0..1] « Location »Identifies the person who picked up the Supplyreceiver : Reference [0..*] « Practitioner »

XML Template

<SupplyDelivery xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier External identifier --></identifier>
 <status value="[code]"/><!-- 0..1 in-progress | completed | abandoned -->
 <patient><!-- 0..1 Reference(Patient) Patient for whom the item is supplied --></patient>
 <type><!-- 0..1 CodeableConcept Category of dispense event --></type>
 <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount dispensed --></quantity>
 <suppliedItem[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance|Device) Medication, Substance, or Device supplied --></suppliedItem[x]>
 <supplier><!-- 0..1 Reference(Practitioner) Dispenser --></supplier>
 <whenPrepared><!-- 0..1 Period Dispensing time --></whenPrepared>
 <time 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>
</SupplyDelivery>

Turtle Template

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


[ a fhir:SupplyDelivery;
  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:SupplyDelivery.identifier [ Identifier ]; # 0..1 External identifier
  fhir:SupplyDelivery.status [ code ]; # 0..1 in-progress | completed | abandoned
  fhir:SupplyDelivery.patient [ Reference(Patient) ]; # 0..1 Patient for whom the item is supplied
  fhir:SupplyDelivery.type [ CodeableConcept ]; # 0..1 Category of dispense event
  fhir:SupplyDelivery.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount dispensed
  # SupplyDelivery.suppliedItem[x] : 0..1 Medication, Substance, or Device supplied. One of these 2
    fhir:SupplyDelivery.suppliedItemCodeableConcept [ CodeableConcept ]
    fhir:SupplyDelivery.suppliedItemReference [ Reference(Medication|Substance|Device) ]
  fhir:SupplyDelivery.supplier [ Reference(Practitioner) ]; # 0..1 Dispenser
  fhir:SupplyDelivery.whenPrepared [ Period ]; # 0..1 Dispensing time
  fhir:SupplyDelivery.time [ dateTime ]; # 0..1 Handover time
  fhir:SupplyDelivery.destination [ Reference(Location) ]; # 0..1 Where the Supply was sent
  fhir:SupplyDelivery.receiver [ Reference(Practitioner) ], ... ; # 0..* Who collected the Supply
]

Changes since DSTU2

SupplyDelivery
SupplyDelivery.suppliedItem[x] Renamed from suppliedItem to suppliedItem[x]
Add CodeableConcept

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyDelivery ΣDomainResourceDelivery of Supply
... identifier Σ0..1IdentifierExternal identifier
... status ?!Σ0..1codein-progress | completed | abandoned
SupplyDeliveryStatus (Required)
... patient Σ0..1Reference(Patient)Patient for whom the item is supplied
... type Σ0..1CodeableConceptCategory of dispense event
Supply Item Type (Required)
... quantity Σ0..1SimpleQuantityAmount dispensed
... suppliedItem[x] Σ0..1Medication, Substance, or Device supplied
SNOMED CT Supply Item (Example)
.... suppliedItemCodeableConceptCodeableConcept
.... suppliedItemReferenceReference(Medication | Substance | Device)
... supplier Σ0..1Reference(Practitioner)Dispenser
... whenPrepared Σ0..1PeriodDispensing time
... time Σ0..1dateTimeHandover time
... destination Σ0..1Reference(Location)Where the Supply was sent
... receiver Σ0..*Reference(Practitioner)Who collected the Supply

doco Documentation for this format

UML Diagram (Legend)

SupplyDelivery (DomainResource)Identifier assigned by the dispensing facility when the item(s) is dispensedidentifier : Identifier [0..1]A code specifying the state of the dispense event (this element modifies the meaning of other elements)status : code [0..1] « Status of the supply delivery. (Strength=Required)SupplyDeliveryStatus! »A link to a resource representing the person whom the delivered item is forpatient : Reference [0..1] « Patient »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 type of supply dispense. (Strength=Required)Supply Item Type! »The amount of supply that has been dispensed. Includes unit of measurequantity : Quantity(SimpleQuantity) [0..1]Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known listsuppliedItem[x] : Type [0..1] « CodeableConcept|Reference(Medication| Substance|Device); The item that was delivered. (Strength=Example)SNOMED CT Supply Item?? »The individual responsible for dispensing the medication, supplier or devicesupplier : Reference [0..1] « Practitioner »The time the dispense event occurredwhenPrepared : Period [0..1]The time the dispensed item was sent or handed to the patient (or agent)time : dateTime [0..1]Identification of the facility/location where the Supply was shipped to, as part of the dispense eventdestination : Reference [0..1] « Location »Identifies the person who picked up the Supplyreceiver : Reference [0..*] « Practitioner »

XML Template

<SupplyDelivery xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier External identifier --></identifier>
 <status value="[code]"/><!-- 0..1 in-progress | completed | abandoned -->
 <patient><!-- 0..1 Reference(Patient) Patient for whom the item is supplied --></patient>
 <type><!-- 0..1 CodeableConcept Category of dispense event --></type>
 <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount dispensed --></quantity>
 <suppliedItem[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance|Device) Medication, Substance, or Device supplied --></suppliedItem[x]>
 <supplier><!-- 0..1 Reference(Practitioner) Dispenser --></supplier>
 <whenPrepared><!-- 0..1 Period Dispensing time --></whenPrepared>
 <time 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>
</SupplyDelivery>

Turtle Template

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


[ a fhir:SupplyDelivery;
  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:SupplyDelivery.identifier [ Identifier ]; # 0..1 External identifier
  fhir:SupplyDelivery.status [ code ]; # 0..1 in-progress | completed | abandoned
  fhir:SupplyDelivery.patient [ Reference(Patient) ]; # 0..1 Patient for whom the item is supplied
  fhir:SupplyDelivery.type [ CodeableConcept ]; # 0..1 Category of dispense event
  fhir:SupplyDelivery.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount dispensed
  # SupplyDelivery.suppliedItem[x] : 0..1 Medication, Substance, or Device supplied. One of these 2
    fhir:SupplyDelivery.suppliedItemCodeableConcept [ CodeableConcept ]
    fhir:SupplyDelivery.suppliedItemReference [ Reference(Medication|Substance|Device) ]
  fhir:SupplyDelivery.supplier [ Reference(Practitioner) ]; # 0..1 Dispenser
  fhir:SupplyDelivery.whenPrepared [ Period ]; # 0..1 Dispensing time
  fhir:SupplyDelivery.time [ dateTime ]; # 0..1 Handover time
  fhir:SupplyDelivery.destination [ Reference(Location) ]; # 0..1 Where the Supply was sent
  fhir:SupplyDelivery.receiver [ Reference(Practitioner) ], ... ; # 0..* Who collected the Supply
]

Changes since DSTU2

SupplyDelivery
SupplyDelivery.suppliedItem[x] Renamed from suppliedItem to suppliedItem[x]
Add CodeableConcept

See the Full Difference for further information

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),

12.17.3.1 Terminology Bindings

PathDefinitionTypeReference
SupplyDelivery.status Status of the supply delivery.RequiredSupplyDeliveryStatus
SupplyDelivery.type The type of supply dispense.RequiredSupply Item Type
SupplyDelivery.suppliedItem[x] The item that was delivered.ExampleSNOMED CT Supply Item

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

NameTypeDescriptionPathsIn Common
identifiertokenExternal identifierSupplyDelivery.identifier26 Resources
patientreferencePatient for whom the item is suppliedSupplyDelivery.patient
(Patient)		31 Resources
receiverreferenceWho collected the SupplySupplyDelivery.receiver
(Practitioner)
statustokenin-progress | completed | abandonedSupplyDelivery.status
supplierreferenceDispenserSupplyDelivery.supplier
(Practitioner)