This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 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
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
Compartments
|
Record of delivery of what is supplied.
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 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.
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 0..1 | Identifier |
|
|
|
0..1 | code |
SupplyDeliveryStatus |
|
Σ | 0..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..1 | SimpleQuantity |
|
|
Σ | 0..1 |
Reference
(
Medication
|
|
|
Σ | 0..1 | Reference ( Practitioner ) | Dispenser |
|
Σ | 0..1 | Period |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 | Reference ( Location ) |
|
|
Σ | 0..* | Reference ( Practitioner ) |
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
XML Template
<SupplyDelivery xmlns="http://hl7.org/fhir"><!-- 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><!-- 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> <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" : "SupplyDelivery",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : { Identifier }, // External identifier
"status" : "<code>", // in-progress | completed | abandoned
"patient" : { Reference(Patient) }, // Patient for whom the item is supplied
"type" : { CodeableConcept }, // Category of dispense event
"quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
"suppliedItem" : { Reference(Medication|Substance|Device) }, // Medication, Substance, or Device supplied
"supplier" : { Reference(Practitioner) }, // Dispenser
"whenPrepared" : { Period }, // Dispensing time
"time" : "<dateTime>", // Handover time
"destination" : { Reference(Location) }, // Where the Supply was sent
"receiver" : [{ Reference(Practitioner) }] // Who collected the Supply
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 0..1 | Identifier |
|
|
|
0..1 | code |
SupplyDeliveryStatus |
|
Σ | 0..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..1 | SimpleQuantity |
|
|
Σ | 0..1 |
Reference
(
Medication
|
|
|
Σ | 0..1 | Reference ( Practitioner ) | Dispenser |
|
Σ | 0..1 | Period |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 | Reference ( Location ) |
|
|
Σ | 0..* | Reference ( Practitioner ) |
|
Documentation for this format
|
||||
XML
Template
XML Template
<SupplyDelivery xmlns="http://hl7.org/fhir"><!-- 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><!-- 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> <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" : "SupplyDelivery",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : { Identifier }, // External identifier
"status" : "<code>", // in-progress | completed | abandoned
"patient" : { Reference(Patient) }, // Patient for whom the item is supplied
"type" : { CodeableConcept }, // Category of dispense event
"quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
"suppliedItem" : { Reference(Medication|Substance|Device) }, // Medication, Substance, or Device supplied
"supplier" : { Reference(Practitioner) }, // Dispenser
"whenPrepared" : { Period }, // Dispensing time
"time" : "<dateTime>", // Handover time
"destination" : { Reference(Location) }, // Where the Supply was sent
"receiver" : [{ Reference(Practitioner) }] // Who collected the Supply
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
Required | SupplyDeliveryStatus |
|
|
|
Required |
|
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.
| Name | Type | Description | Paths |
| identifier | token |
|
SupplyDelivery.identifier |
| patient | reference |
|
SupplyDelivery.patient
( Patient ) |
| receiver | reference |
|
SupplyDelivery.receiver
( Practitioner ) |
| status | token |
|
SupplyDelivery.status |
| supplier | reference | Dispenser |
SupplyDelivery.supplier
( Practitioner ) |