Workflow
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-draft-final:
Final
QA
Preview
for
R5
-
STU
see
ballot
notes
).
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
|
Orders
and
Observations
Work
Group
|
Maturity Level : 1 | Trial Use | Security Category : Patient | Compartments : Patient , Practitioner |
Record of delivery of what is supplied.
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
SupplyDelivery
is
for
supplies
used
in
to
document
actual
movement
of
supplies
(e.g.,
medications,
devices,
substances,
biologically
derived
products)
from
one
location
to
another,
where
the
healthcare
process.
intended
patient
or
person
(e.g.,
doctor)
may
also
be
known.
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
SupplyDelivery
does
not
imply
that
this
supply
has
already
been
dispensed
to
the
that
patient
or
person,
while
it
could
be
reserved
for
that
patient
or
person.
Those
associations
are
done
in
dedicated
resources
such
as
the
MedicationDispense
and
DeviceDispense.
This
resource
overlaps
has
a
boundary
with
others
such
as
Device
DeviceDispense
and
Medication
.
Medicationdispense
:
The
Supply
resource
may
be
DeviceDispense
and
MedicationDispense
resources
are
used
to
describe
medications
and
devices
when
handling
them
generically
(as
any
other
supply).
For
example,
when
processing
bulk
orders,
etc.
However,
when
associate
the
medication,
device
or
other
aspects
of
medication
with
the
resource
specific
patient
for
their
use,
while
SupplyDelivery
is
solely
focused
on
location
and
movement
where
the
targeted
patient
or
other
person
(e.g.,
devices
used
by
a
clinician),
if
included,
are
important,
(e.g.
in
for
delivery
context
only.
To
determine
the
purchase
date,
a
MedicationRequest
search
of
DeviceRequest,
SupplyRequest,
DeviceDispense,
or
when
identifying
a
device
SupplyDelivery
as
defined
in
an
implementation
guide
can
be
done
,
as
a
performer),
the
more
detailed
context
of
the
use
case
actually
determines
which
date
of
either
resource
must
be
used.
is
considered
the
purchase
date.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
SupplyDelivery
|
TU | DomainResource |
Delivery
of
bulk
Supplies
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
identifier
|
0..* | Identifier |
External
identifier
|
|
basedOn
|
Σ | 0..* | Reference ( SupplyRequest ) |
Fulfills
plan,
proposal
or
order
|
|
partOf
|
Σ | 0..* | Reference ( SupplyDelivery | Contract ) |
Part
of
referenced
event
|
status
|
?! Σ | 0..1 | code |
in-progress
|
completed
|
abandoned
|
entered-in-error
Binding: |
|
patient
|
0..1 | Reference ( Patient ) |
Patient
for
whom
the
item
is
supplied
|
|
|
type
|
0..1 | CodeableConcept |
Category
of
Binding: Supply Delivery Supply Item Type ( Required ) |
|
suppliedItem
|
|
BackboneElement |
The
item
that
is
delivered
or
supplied
|
|
quantity
|
0..1 | SimpleQuantity |
Amount
|
|
item[x]
|
0..1 |
Medication,
Substance,
|
||
itemCodeableConcept
|
CodeableConcept | |||
itemReference
|
Reference ( Medication | Substance | Device | BiologicallyDerivedProduct | NutritionProduct | InventoryItem ) | |||
|
occurrence[x]
|
Σ | 0..1 |
When
event
occurred
|
|
|
occurrenceDateTime
|
dateTime | |||
|
occurrencePeriod
|
Period | |||
|
occurrenceTiming
|
Timing | |||
|
supplier
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
|
|
|
destination
|
0..1 | Reference ( Location ) |
Where
the
|
|
|
receiver
|
0..* | Reference ( Practitioner | PractitionerRole | Organization ) |
Who
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<SupplyDelivery xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifier --></identifier> <basedOn><!-- 0..* Reference(SupplyRequest) Fulfills plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(Contract|SupplyDelivery) Part of referenced event --></partOf> <status value="[code]"/><!-- 0..1 in-progress | completed | abandoned | entered-in-error --> <patient><!-- 0..1 Reference(Patient) Patient for whom the item is supplied --></patient>
<</type> < <</quantity> <</item[x]><type><!-- 0..1 CodeableConcept Category of supply event --></type> <suppliedItem> <!-- 0..* The item that is delivered or supplied --> <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount supplied --></quantity> <item[x]><!-- 0..1 CodeableConcept|Reference(BiologicallyDerivedProduct|Device| InventoryItem|Medication|NutritionProduct|Substance) Medication, Substance, Device or Biologically Derived Product supplied --></item[x]> </suppliedItem> <occurrence[x]><!-- 0..1 dateTime|Period|Timing When event occurred --></occurrence[x]><</supplier> <</destination> <</receiver><supplier><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The item supplier --></supplier> <destination><!-- 0..1 Reference(Location) Where the delivery was sent --></destination> <receiver><!-- 0..* Reference(Organization|Practitioner|PractitionerRole) Who received the delivery --></receiver> </SupplyDelivery>
JSON Template
{
"resourceType" : "SupplyDelivery",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External identifier
"basedOn" : [{ Reference(SupplyRequest) }], // Fulfills plan, proposal or order
"partOf" : [{ Reference(Contract|SupplyDelivery) }], // Part of referenced event
"status" : "<code>", // in-progress | completed | abandoned | entered-in-error
"patient" : { Reference(Patient) }, // Patient for whom the item is supplied
"
"
"
" }
" }
},
"type" : { CodeableConcept }, // Category of supply event
"suppliedItem" : [{ // The item that is delivered or supplied
"quantity" : { Quantity(SimpleQuantity) }, // Amount supplied
// item[x]: Medication, Substance, Device or Biologically Derived Product supplied. One of these 2:
"itemCodeableConcept" : { CodeableConcept },
"itemReference" : { Reference(BiologicallyDerivedProduct|Device|InventoryItem|
Medication|NutritionProduct|Substance) }
}],
// occurrence[x]: When event occurred. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
"
"
"
"supplier" : { Reference(Organization|Practitioner|PractitionerRole) }, // The item supplier
"destination" : { Reference(Location) }, // Where the delivery was sent
"receiver" : [{ Reference(Organization|Practitioner|PractitionerRole) }] // Who received the delivery
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] ]; # . One of these 3 fhir: ] fhir: ] fhir: ] fhir: fhir: fhir:fhir:identifier ( [ Identifier ] ... ) ; # 0..* External identifier fhir:basedOn ( [ Reference(SupplyRequest) ] ... ) ; # 0..* Fulfills plan, proposal or order fhir:partOf ( [ Reference(Contract|SupplyDelivery) ] ... ) ; # 0..* Part of referenced event fhir:status [ code ] ; # 0..1 in-progress | completed | abandoned | entered-in-error fhir:patient [ Reference(Patient) ] ; # 0..1 Patient for whom the item is supplied fhir:type [ CodeableConcept ] ; # 0..1 Category of supply event fhir:suppliedItem ( [ # 0..* The item that is delivered or supplied fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount supplied # item[x] : 0..1 Medication, Substance, Device or Biologically Derived Product supplied. One of these 2 fhir:item [ a fhir:CodeableConcept ; CodeableConcept ] fhir:item [ a fhir:Reference ; Reference(BiologicallyDerivedProduct|Device|InventoryItem|Medication|NutritionProduct| Substance) ] ] ... ) ; # occurrence[x] : 0..1 When event occurred. One of these 3 fhir:occurrence [ a fhir:dateTime ; dateTime ] fhir:occurrence [ a fhir:Period ; Period ] fhir:occurrence [ a fhir:Timing ; Timing ] fhir:supplier [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 The item supplier fhir:destination [ Reference(Location) ] ; # 0..1 Where the delivery was sent fhir:receiver ( [ Reference(Organization|Practitioner|PractitionerRole) ] ... ) ; # 0..* Who received the delivery ]
Changes since R4
| SupplyDelivery | |
| SupplyDelivery.type |
|
| SupplyDelivery.suppliedItem |
|
| SupplyDelivery.receiver |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions
between
R3
and
R4
See
R3
<-->
R4
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
all
r3
resources
are
valid.)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
SupplyDelivery
|
TU | DomainResource |
Delivery
of
bulk
Supplies
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
identifier
|
0..* | Identifier |
External
identifier
|
|
|
basedOn
|
Σ | 0..* | Reference ( SupplyRequest ) |
Fulfills
plan,
proposal
or
order
|
|
partOf
|
Σ | 0..* | Reference ( SupplyDelivery | Contract ) |
Part
of
referenced
event
|
|
status
|
?! Σ | 0..1 | code |
in-progress
|
completed
|
abandoned
|
entered-in-error
Binding: |
|
patient
|
0..1 | Reference ( Patient ) |
Patient
for
whom
the
item
is
supplied
|
|
|
type
|
0..1 | CodeableConcept |
Category
of
Binding: Supply Delivery Supply Item Type ( Required ) |
|
|
suppliedItem
|
|
BackboneElement |
The
item
that
is
delivered
or
supplied
|
|
|
quantity
|
0..1 | SimpleQuantity |
Amount
|
|
|
item[x]
|
0..1 |
Medication,
Substance,
|
||
|
itemCodeableConcept
|
CodeableConcept | |||
|
itemReference
|
Reference ( Medication | Substance | Device | BiologicallyDerivedProduct | NutritionProduct | InventoryItem ) | |||
|
occurrence[x]
|
Σ | 0..1 |
When
event
occurred
|
|
|
occurrenceDateTime
|
dateTime | |||
|
occurrencePeriod
|
Period | |||
|
occurrenceTiming
|
Timing | |||
|
supplier
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
|
|
|
destination
|
0..1 | Reference ( Location ) |
Where
the
|
|
|
receiver
|
0..* | Reference ( Practitioner | PractitionerRole | Organization ) |
Who
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<SupplyDelivery xmlns="http://hl7.org/fhir"><</type> < <</quantity> <</item[x]><type><!-- 0..1 CodeableConcept Category of supply event --></type> <suppliedItem> <!-- 0..* The item that is delivered or supplied --> <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount supplied --></quantity> <item[x]><!-- 0..1 CodeableConcept|Reference(BiologicallyDerivedProduct|Device| InventoryItem|Medication|NutritionProduct|Substance) Medication, Substance, Device or Biologically Derived Product supplied --></item[x]> </suppliedItem> <occurrence[x]><!-- 0..1 dateTime|Period|Timing When event occurred --></occurrence[x]><</supplier> <</destination> <</receiver><supplier><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The item supplier --></supplier> <destination><!-- 0..1 Reference(Location) Where the delivery was sent --></destination> <receiver><!-- 0..* Reference(Organization|Practitioner|PractitionerRole) Who received the delivery --></receiver> </SupplyDelivery>
JSON Template
{
"resourceType" : "SupplyDelivery",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External identifier
"basedOn" : [{ Reference(SupplyRequest) }], // Fulfills plan, proposal or order
"partOf" : [{ Reference(Contract|SupplyDelivery) }], // Part of referenced event
"status" : "<code>", // in-progress | completed | abandoned | entered-in-error
"patient" : { Reference(Patient) }, // Patient for whom the item is supplied
"
"
"
" }
" }
},
"type" : { CodeableConcept }, // Category of supply event
"suppliedItem" : [{ // The item that is delivered or supplied
"quantity" : { Quantity(SimpleQuantity) }, // Amount supplied
// item[x]: Medication, Substance, Device or Biologically Derived Product supplied. One of these 2:
"itemCodeableConcept" : { CodeableConcept },
"itemReference" : { Reference(BiologicallyDerivedProduct|Device|InventoryItem|
Medication|NutritionProduct|Substance) }
}],
// occurrence[x]: When event occurred. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
"
"
"
"supplier" : { Reference(Organization|Practitioner|PractitionerRole) }, // The item supplier
"destination" : { Reference(Location) }, // Where the delivery was sent
"receiver" : [{ Reference(Organization|Practitioner|PractitionerRole) }] // Who received the delivery
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] ]; # . One of these 3 fhir: ] fhir: ] fhir: ] fhir: fhir: fhir:fhir:identifier ( [ Identifier ] ... ) ; # 0..* External identifier fhir:basedOn ( [ Reference(SupplyRequest) ] ... ) ; # 0..* Fulfills plan, proposal or order fhir:partOf ( [ Reference(Contract|SupplyDelivery) ] ... ) ; # 0..* Part of referenced event fhir:status [ code ] ; # 0..1 in-progress | completed | abandoned | entered-in-error fhir:patient [ Reference(Patient) ] ; # 0..1 Patient for whom the item is supplied fhir:type [ CodeableConcept ] ; # 0..1 Category of supply event fhir:suppliedItem ( [ # 0..* The item that is delivered or supplied fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount supplied # item[x] : 0..1 Medication, Substance, Device or Biologically Derived Product supplied. One of these 2 fhir:item [ a fhir:CodeableConcept ; CodeableConcept ] fhir:item [ a fhir:Reference ; Reference(BiologicallyDerivedProduct|Device|InventoryItem|Medication|NutritionProduct| Substance) ] ] ... ) ; # occurrence[x] : 0..1 When event occurred. One of these 3 fhir:occurrence [ a fhir:dateTime ; dateTime ] fhir:occurrence [ a fhir:Period ; Period ] fhir:occurrence [ a fhir:Timing ; Timing ] fhir:supplier [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 The item supplier fhir:destination [ Reference(Location) ] ; # 0..1 Where the delivery was sent fhir:receiver ( [ Reference(Organization|Practitioner|PractitionerRole) ] ... ) ; # 0..* Who received the delivery ]
Changes since Release 4
| SupplyDelivery | |
| SupplyDelivery.type |
|
| SupplyDelivery.suppliedItem |
|
| SupplyDelivery.receiver |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions
between
R3
and
R4
See
R3
<-->
R4
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
all
r3
resources
are
valid.)
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| SupplyDelivery.status | SupplyDeliveryStatus | Required |
Status of the supply delivery. |
| SupplyDelivery.type | SupplyDeliverySupplyItemType | Required |
This value sets refers to a specific supply item. |
| SupplyDelivery.suppliedItem.item[x] | SupplyDeliverySupplyItemType | Example |
This value sets refers to a specific supply item. |
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to 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 |
| identifier | token | External identifier | SupplyDelivery.identifier | 65 Resources |
| patient | reference | Patient for whom the item is supplied |
SupplyDelivery.patient
( Patient ) |
66 Resources |
| receiver | reference | Who collected the Supply |
SupplyDelivery.receiver
( Practitioner , Organization , PractitionerRole ) |
|
| status | token | in-progress | completed | abandoned | entered-in-error | SupplyDelivery.status | |
| supplier | reference | Dispenser |
SupplyDelivery.supplier
( Practitioner , Organization , PractitionerRole ) |
FHIR
®©
HL7.org
2011+.
FHIR
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
hl7.fhir.core#5.0.0-draft-final
generated
on
Sat,
May
28,
2022
12:57+1000.
Wed,
Mar
1,
2023
23:07+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change