DSTU2 STU 3 Ballot
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

5.23 12.13 Resource SupplyDelivery - Content Resource SupplyDelivery - Content

Record of delivery of what is supplied.
Orders and Observations Orders and Observations Work Group Work Group Maturity Level : 0 Maturity Level : 0 Compartments : : Patient , , Practitioner

Record of delivery of what is supplied.

5.23.1 Scope and Usage 12.13.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.

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.

5.23.2 Boundaries and Relationships 12.13.2 Boundaries and Relationships This resource overlaps with others such as

This resource overlaps with others such as Device and and Medication . The . 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 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 MedicationOrder or when identifying a device as a performer), the more detailed resource must be used. or when identifying a device as a performer), the more detailed resource must be used.

5.23.3 Resource Content 12.13.3 Resource Content

Structure

Medication, Substance, or Device supplied
Name Flags Card. Type Description & Constraints Description & Constraints doco
. . SupplyDelivery Σ DomainResource Delivery of Supply Delivery of Supply
. . . identifier Σ 0..1 Identifier External identifier External identifier
. . . status ?! Σ 0..1 code in-progress | completed | abandoned in-progress | completed | abandoned
SupplyDeliveryStatus ( ( Required )
. . . patient Σ 0..1 Reference ( Patient ) Patient for whom the item is supplied Patient for whom the item is supplied
. . . type Σ 0..1 CodeableConcept Category of dispense event Category of dispense event
Supply Item Type ( Supply Item Type ( Required )
. . . quantity Σ 0..1 SimpleQuantity Amount dispensed Amount dispensed
. . suppliedItem . suppliedItem[x] Σ 0..1 Medication, Substance, or Device supplied
SNOMED CT Supply Item ( Example )
.... suppliedItemCodeableConcept CodeableConcept
.... suppliedItemReference Reference ( Medication | | Substance | | Device )
. . . supplier Σ 0..1 Reference ( Practitioner ) Dispenser
. . . whenPrepared Σ 0..1 Period Dispensing time Dispensing time
. . . time Σ 0..1 dateTime Handover time Handover time
. . . destination Σ 0..1 Reference ( Location ) Where the Supply was sent Where the Supply was sent
. . . receiver Σ 0..* Reference ( Practitioner ) Who collected the Supply Who collected the Supply

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram ( Legend )

SupplyDelivery ( ( DomainResource ) Identifier assigned by the dispensing facility when the item(s) is dispensed Identifier assigned by the dispensing facility when the item(s) is dispensed identifier : : Identifier [0..1] [0..1] A code specifying the state of the dispense event (this element modifies the meaning of other elements) A code specifying the state of the dispense event (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « Status of the supply delivery. (Strength=Required) Status of the supply delivery. (Strength=Required) SupplyDeliveryStatus ! » ! » A link to a resource representing the person whom the delivered item is for A link to a resource representing the person whom the delivered item is for patient : : Reference [0..1] « [0..1] « Patient » » Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc type : : CodeableConcept [0..1] « [0..1] « The type of supply dispense. (Strength=Required) The type of supply dispense. (Strength=Required) Supply Item Type ! » Supply Item Type ! » The amount of supply that has been dispensed. Includes unit of measure The amount of supply that has been dispensed. Includes unit of measure quantity : : Quantity ( SimpleQuantity ) [0..1] ) [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 simple attribute carrying a code that identifies the item from a known list 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 list suppliedItem suppliedItem[x] : Type [0..1] « CodeableConcept : | Reference [0..1] « ( Medication | Substance | Device » ); The item that was delivered. (Strength=Example) SNOMED CT Supply Item ?? » The individual responsible for dispensing the medication, supplier or device The individual responsible for dispensing the medication, supplier or device supplier : : Reference [0..1] « [0..1] « Practitioner » » The time the dispense event occurred The time the dispense event occurred whenPrepared : : Period [0..1] [0..1] The time the dispensed item was sent or handed to the patient (or agent) The time the dispensed item was sent or handed to the patient (or agent) time : : dateTime [0..1] [0..1] Identification of the facility/location where the Supply was shipped to, as part of the dispense event Identification of the facility/location where the Supply was shipped to, as part of the dispense event destination : : Reference [0..1] « [0..1] « Location » » Identifies the person who picked up the Supply Identifies the person who picked up the Supply receiver : : Reference [0..*] « [0..*] « Practitioner » »

XML Template XML Template < 

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

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <
 <</patient>
 <</type>
 <</quantity>
 <</suppliedItem>
 <</supplier>
 <</whenPrepared>
 <
 <</destination>
 <</receiver>

 <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

Medication, Substance, or Device supplied
Name Flags Card. Type Description & Constraints Description & Constraints doco
. . SupplyDelivery Σ DomainResource Delivery of Supply Delivery of Supply
. . . identifier Σ 0..1 Identifier External identifier External identifier
. . . status ?! Σ 0..1 code in-progress | completed | abandoned in-progress | completed | abandoned
SupplyDeliveryStatus ( ( Required )
. . . patient Σ 0..1 Reference ( Patient ) Patient for whom the item is supplied Patient for whom the item is supplied
. . . type Σ 0..1 CodeableConcept Category of dispense event Category of dispense event
Supply Item Type ( Supply Item Type ( Required )
. . . quantity Σ 0..1 SimpleQuantity Amount dispensed Amount dispensed
. . suppliedItem . suppliedItem[x] Σ 0..1 Medication, Substance, or Device supplied
SNOMED CT Supply Item ( Example )
.... suppliedItemCodeableConcept CodeableConcept
.... suppliedItemReference Reference ( Medication | | Substance | | Device )
. . . supplier Σ 0..1 Reference ( Practitioner ) Dispenser
. . . whenPrepared Σ 0..1 Period Dispensing time Dispensing time
. . . time Σ 0..1 dateTime Handover time Handover time
. . . destination Σ 0..1 Reference ( Location ) Where the Supply was sent Where the Supply was sent
. . . receiver Σ 0..* Reference ( Practitioner ) Who collected the Supply Who collected the Supply

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram ( Legend )

SupplyDelivery ( ( DomainResource ) Identifier assigned by the dispensing facility when the item(s) is dispensed Identifier assigned by the dispensing facility when the item(s) is dispensed identifier : : Identifier [0..1] [0..1] A code specifying the state of the dispense event (this element modifies the meaning of other elements) A code specifying the state of the dispense event (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « Status of the supply delivery. (Strength=Required) Status of the supply delivery. (Strength=Required) SupplyDeliveryStatus ! » ! » A link to a resource representing the person whom the delivered item is for A link to a resource representing the person whom the delivered item is for patient : : Reference [0..1] « [0..1] « Patient » » Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc type : : CodeableConcept [0..1] « [0..1] « The type of supply dispense. (Strength=Required) The type of supply dispense. (Strength=Required) Supply Item Type ! » Supply Item Type ! » The amount of supply that has been dispensed. Includes unit of measure The amount of supply that has been dispensed. Includes unit of measure quantity : : Quantity ( SimpleQuantity ) [0..1] ) [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 simple attribute carrying a code that identifies the item from a known list 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 list suppliedItem suppliedItem[x] : Type [0..1] « CodeableConcept : | Reference [0..1] « ( Medication | Substance | Device » ); The item that was delivered. (Strength=Example) SNOMED CT Supply Item ?? » The individual responsible for dispensing the medication, supplier or device The individual responsible for dispensing the medication, supplier or device supplier : : Reference [0..1] « [0..1] « Practitioner » » The time the dispense event occurred The time the dispense event occurred whenPrepared : : Period [0..1] [0..1] The time the dispensed item was sent or handed to the patient (or agent) The time the dispensed item was sent or handed to the patient (or agent) time : : dateTime [0..1] [0..1] Identification of the facility/location where the Supply was shipped to, as part of the dispense event Identification of the facility/location where the Supply was shipped to, as part of the dispense event destination : : Reference [0..1] « [0..1] « Location » » Identifies the person who picked up the Supply Identifies the person who picked up the Supply receiver : : Reference [0..*] « [0..*] « Practitioner » »

XML Template XML Template < 

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

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <
 <</patient>
 <</type>
 <</quantity>
 <</suppliedItem>
 <</supplier>
 <</whenPrepared>
 <
 <</destination>
 <</receiver>

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

JSON Template JSON Template { "resourceType" : "",

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 , Resource Profile ( XML , (for ) + JSON Schema , ShEx (for Turtle ), Questionnaire )

5.23.3.1 Terminology Bindings 12.13.3.1 Terminology Bindings

SupplyDelivery.status SupplyDelivery.type
Path Definition Type Reference
SupplyDelivery.status Status of the supply delivery. Status of the supply delivery. Required SupplyDeliveryStatus
SupplyDelivery.type The type of supply dispense. The type of supply dispense. Required Supply Item Type Supply Item Type
SupplyDelivery.suppliedItem[x] The item that was delivered. Example SNOMED CT Supply Item

5.23.4 Search Parameters 12.13.4 Search Parameters Search parameters for this resource. The common parameters also apply. See

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

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:44+1100. Links: Search | Version History | Table of Contents | Compare to DSTU1
Name Type Description Paths
identifier token External identifier External identifier SupplyDelivery.identifier
patient reference Patient for whom the item is supplied Patient for whom the item is supplied SupplyDelivery.patient
( Patient )
receiver reference Who collected the Supply Who collected the Supply SupplyDelivery.receiver
( Practitioner )
status token in-progress | completed | abandoned in-progress | completed | abandoned SupplyDelivery.status
supplier reference Dispenser SupplyDelivery.supplier
( Practitioner )