FHIR
Release
3
(STU)
CI-Build
Medications
This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
|
Responsible
Owner:
Pharmacy
Work
Group
|
|
Security Category : Patient | Compartments : Encounter , Group , Patient , Practitioner |
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
This
resource
covers
the
supply
of
medications
to
a
patient.
Examples
include
dispensing
and
pick-up
from
an
out-patient
outpatient
or
community
pharmacy,
dispensing
patient-specific
medications
from
in-patient
inpatient
pharmacy
to
ward,
as
well
as
issuing
a
single
dose
from
ward
stock
to
a
patient
for
consumption.
The
medication
dispense
is
can
be
the
result
of
a
pharmacy
system
responding
to
a
medication
order.
MedicationDispense is an event resource from a FHIR workflow perspective - see Workflow Event
The Medication domain includes a number of related resources
| MedicationRequest | An order for both supply of the medication and the instructions for administration of the medicine to a patient. |
| MedicationDispense | Provision of a supply of a medication with the intention that it is subsequently consumed by a patient (usually in response to a prescription). |
| MedicationAdministration |
When
a
patient
actually
consumes
a
medicine,
or
|
| MedicationStatement |
This
is
a
record
of
a
medication
being
taken
by
a
patient
or
that
a
medication
has
been
given
to
a
patient,
where
the
record
is
the
result
of
a
report
from
the
patient
or
another
clinician.
A
medication
statement
is
not
a
part
of
the
prescribe->dispense->administer
|
This resource does not deal with the supply or transfer of non-medication related items to a patient.
The
supply
and
the
associated
administration
instructions
may
might
not
exactly
follow
the
original
order
(prescription),
either
because
some
details
were
left
for
completion
at
this
point
in
the
process
or
because
the
dispenser
exercised
their
clinical
judgment
to
make
some
appropriate
modification.
This resourceNote to Balloters: The code system used in medication dispense category isreferenced by ChargeItempresented here but is expected to move to terminology.hl7.org
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
MedicationDispense
|
|
DomainResource |
Dispensing
a
medication
to
a
named
patient
+ Rule: whenHandedOver cannot be before whenPrepared Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
identifier
|
0..* | Identifier |
External
identifier
|
|
|
0..* | Reference ( CarePlan ) |
Plan
that
is
fulfilled
by
this
dispense
|
|
|
partOf
| 0..* | Reference ( Procedure | MedicationAdministration ) |
Event
that
dispense
is
part
of
|
|
status
|
?! Σ | 1..1 | code |
preparation
|
in-progress
|
cancelled
|
on-hold
|
completed
|
entered-in-error
|
|
|
notPerformedReason
|
0..1 |
|
Why
a
dispense
was
not
performed
|
|
|
statusChanged
|
0..1 |
dateTime
|
When
the
status
changed
|
|
|
category
|
0..* | CodeableConcept |
Type
of
medication
dispense
Binding: MedicationDispense Category Codes ( Example ) |
|
|
|
Σ
|
1..1 | CodeableReference ( Medication ) |
What
medication
was
(or
was
intended
to
be)
supplied
Binding: SNOMED CT Medication Codes ( Example ) |
|
subject
|
Σ | 1..1 | Reference ( Patient | Group ) |
Who
the
dispense
is
for
|
|
|
0..1 |
Reference
(
Encounter
|
Encounter
|
|
|
supportingInformation
|
0..* | Reference ( Any ) |
Information
that
supports
the
dispensing
of
the
medication
|
|
performer
|
0..* | BackboneElement |
Who
performed
event
|
|
function
| 0..1 | CodeableConcept |
Who
performed
the
dispense
and
what
they
did
Binding: MedicationDispense Performer Function Codes ( Example ) | |
actor
|
1..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam | Group ) |
Individual
who
was
performing
|
|
|
location
|
0..1 |
Reference
(
|
Where
the
dispense
occurred
|
|
|
authorizingPrescription
|
0..* | Reference ( MedicationRequest ) |
Medication
order
that
authorizes
the
dispense
|
|
|
type
|
0..1 | CodeableConcept |
Trial
fill,
partial
fill,
emergency
fill,
Binding: ActPharmacySupplyType
(
Example
)
|
|
|
quantity
|
0..1 | SimpleQuantity |
Amount
|
|
|
daysSupply
|
0..1 | SimpleQuantity |
Amount
of
medication
expressed
as
a
timing
amount
|
|
|
|
0..1 |
|
A
number
that
represents
the
known
fill
this
dispense
represents
|
|
|
recorded
| 0..1 | dateTime |
When
the
recording
of
the
dispense
started
|
|
|
whenPrepared
| Σ C | 0..1 | dateTime |
When
product
was
packaged
and
reviewed
|
|
whenHandedOver
|
C | 0..1 | dateTime |
When
product
was
given
out
|
|
destination
|
0..1 | Reference ( Location ) |
Where
the
medication
|
|
|
receiver
|
0..* | Reference ( Patient | Practitioner | RelatedPerson | Location | PractitionerRole | Organization | Group ) |
Who
collected
the
medication
or
where
the
medication
was
delivered
|
|
|
note
|
0..* | Annotation |
Information
about
the
dispense
|
|
|
renderedDosageInstruction
| 0..1 | markdown |
Full
representation
of
the
dosage
instructions
| |
|
dosageInstruction
|
0..* | Dosage |
How
the
medication
is
to
be
used
by
the
patient
or
administered
by
the
caregiver
|
|
|
doseAdministrationAid
| 0..1 | CodeableConcept |
Type
of
adherence
packaging
to
use
for
the
dispense
Binding: Medication Dose Aids ( Example ) | |
|
substitution
|
0..1 | BackboneElement |
Whether
a
substitution
was
performed
on
the
dispense
|
|
|
wasSubstituted
|
1..1 | boolean |
Whether
a
substitution
was
or
was
not
performed
on
the
dispense
|
|
|
type
|
0..1 | CodeableConcept |
Code
signifying
whether
a
different
drug
was
dispensed
from
what
was
prescribed
Binding: ActSubstanceAdminSubstitutionCode
(
Example
)
|
|
|
reason
|
0..* | CodeableConcept |
Why
was
substitution
made
Binding: SubstanceAdminSubstitutionReason
(
Example
)
|
|
|
responsibleParty
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Who
is
responsible
for
the
substitution
|
|
eventHistory
|
0..* | Reference ( Provenance ) |
A
list
of
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<<MedicationDispense xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> <</partOf> < <</category> <</medication[x]> <</subject> <</context> <</supportingInformation> < <| </actor> <</onBehalfOf><identifier><!-- 0..* Identifier External identifier --></identifier> <basedOn><!-- 0..* Reference(CarePlan) Plan that is fulfilled by this dispense --></basedOn> <partOf><!-- 0..* Reference(MedicationAdministration|Procedure) Event that dispense is part of --></partOf> <status value="[code]"/><!-- 1..1 preparation | in-progress | cancelled | on-hold | completed | entered-in-error | unfulfilled | declined | unknown --> <notPerformedReason><!-- 0..1 CodeableReference(DetectedIssue) Why a dispense was not performed --></notPerformedReason> <statusChanged value="[dateTime]"/><!-- 0..1 When the status changed --> <category><!-- 0..* CodeableConcept Type of medication dispense --></category> <medication><!-- 1..1 CodeableReference(Medication) What medication was (or was intended to be) supplied --></medication> <subject><!-- 1..1 Reference(Group|Patient) Who the dispense is for --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter associated with event --></encounter> <supportingInformation><!-- 0..* Reference(Any) Information that supports the dispensing of the medication --></supportingInformation> <performer> <!-- 0..* Who performed event --> <function><!-- 0..1 CodeableConcept Who performed the dispense and what they did --></function> <actor><!-- 1..1 Reference(CareTeam|Device|Group|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Individual who was performing --></actor> </performer> <location><!-- 0..1 Reference(Location) Where the dispense occurred --></location> <authorizingPrescription><!-- 0..* Reference(MedicationRequest) Medication order that authorizes the dispense --></authorizingPrescription><</type> <</quantity><type><!-- 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc< < <</destination> <</receiver><fillNumber value="[positiveInt]"/><!-- 0..1 A number that represents the known fill this dispense represents --> <recorded value="[dateTime]"/><!-- 0..1 When the recording of the dispense started --> <whenPrepared value="[dateTime]"/><!-- I 0..1 When product was packaged and reviewed --> <whenHandedOver value="[dateTime]"/><!-- I 0..1 When product was given out --> <destination><!-- 0..1 Reference(Location) Where the medication was/will be sent --></destination> <receiver><!-- 0..* Reference(Group|Location|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who collected the medication or where the medication was delivered --></receiver> <note><!-- 0..* Annotation Information about the dispense --></note> <renderedDosageInstruction value="[markdown]"/><!-- 0..1 Full representation of the dosage instructions --> <dosageInstruction><!-- 0..* Dosage How the medication is to be used by the patient or administered by the caregiver --></dosageInstruction>< < <</type> <</reason> <</responsibleParty><doseAdministrationAid><!-- 0..1 CodeableConcept Type of adherence packaging to use for the dispense --></doseAdministrationAid> <substitution> <!-- 0..1 Whether a substitution was performed on the dispense --> <wasSubstituted value="[boolean]"/><!-- 1..1 Whether a substitution was or was not performed on the dispense --> <type><!-- 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed<</detectedIssue> < <</notDoneReason[x]> <</eventHistory><eventHistory><!-- 0..* Reference(Provenance) A list of relevant lifecycle events --></eventHistory> </MedicationDispense>
JSON Template
{
"resourceType" : "",
"resourceType" : "MedicationDispense",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
" },
" },
"
"
"
"
"|
"
"identifier" : [{ Identifier }], // External identifier
"basedOn" : [{ Reference(CarePlan) }], // Plan that is fulfilled by this dispense
"partOf" : [{ Reference(MedicationAdministration|Procedure) }], // Event that dispense is part of
"status" : "<code>", // R! preparation | in-progress | cancelled | on-hold | completed | entered-in-error | unfulfilled | declined | unknown
"notPerformedReason" : { CodeableReference(DetectedIssue) }, // Why a dispense was not performed
"statusChanged" : "<dateTime>", // When the status changed
"category" : [{ CodeableConcept }], // Type of medication dispense
"medication" : { CodeableReference(Medication) }, // R! What medication was (or was intended to be) supplied
"subject" : { Reference(Group|Patient) }, // R! Who the dispense is for
"encounter" : { Reference(Encounter) }, // Encounter associated with event
"supportingInformation" : [{ Reference(Any) }], // Information that supports the dispensing of the medication
"performer" : [{ // Who performed event
"function" : { CodeableConcept }, // Who performed the dispense and what they did
"actor" : { Reference(CareTeam|Device|Group|Organization|Patient|
Practitioner|PractitionerRole|RelatedPerson) } // R! Individual who was performing
}],
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"location" : { Reference(Location) }, // Where the dispense occurred
"authorizingPrescription" : [{ Reference(MedicationRequest) }], // Medication order that authorizes the dispense
"type" : { CodeableConcept }, // Trial fill, partial fill, emergency fill, etc
"quantity" : { Quantity(SimpleQuantity) }, // Amount of medication
"daysSupply" : { Quantity(SimpleQuantity) }, // Amount of medication expressed as a timing amount
"fillNumber" : "<positiveInt>", // A number that represents the known fill this dispense represents
"recorded" : "<dateTime>", // When the recording of the dispense started
"whenPrepared" : "<dateTime>", // I When product was packaged and reviewed
"whenHandedOver" : "<dateTime>", // I When product was given out
"destination" : { Reference(Location) }, // Where the medication was/will be sent
"receiver" : [{ Reference(Group|Location|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }], // Who collected the medication or where the medication was delivered
"note" : [{ Annotation }], // Information about the dispense
"renderedDosageInstruction" : "<markdown>", // Full representation of the dosage instructions
"dosageInstruction" : [{ Dosage }], // How the medication is to be used by the patient or administered by the caregiver
"doseAdministrationAid" : { CodeableConcept }, // Type of adherence packaging to use for the dispense
"substitution" : { // Whether a substitution was performed on the dispense
"wasSubstituted" : <boolean>, // R! Whether a substitution was or was not performed on the dispense
"type" : { CodeableConcept }, // Code signifying whether a different drug was dispensed from what was prescribed
"reason" : [{ CodeableConcept }], // Why was substitution made
"responsibleParty" : { Reference(Organization|Practitioner|
PractitionerRole) } // Who is responsible for the substitution
},
"
"
" },
" },
"
"eventHistory" : [{ Reference(Provenance) }] // A list of relevant lifecycle events
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .# from # from fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ]; fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir:# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* External identifier fhir:basedOn ( [ Reference(CarePlan) ] ... ) ; # 0..* Plan that is fulfilled by this dispense fhir:partOf ( [ Reference(MedicationAdministration|Procedure) ] ... ) ; # 0..* Event that dispense is part of fhir:status [ code ] ; # 1..1 preparation | in-progress | cancelled | on-hold | completed | entered-in-error | unfulfilled | declined | unknown fhir:notPerformedReason [ CodeableReference(DetectedIssue) ] ; # 0..1 Why a dispense was not performed fhir:statusChanged [ dateTime ] ; # 0..1 When the status changed fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Type of medication dispense fhir:medication [ CodeableReference(Medication) ] ; # 1..1 What medication was (or was intended to be) supplied fhir:subject [ Reference(Group|Patient) ] ; # 1..1 Who the dispense is for fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter associated with event fhir:supportingInformation ( [ Reference(Any) ] ... ) ; # 0..* Information that supports the dispensing of the medication fhir:performer ( [ # 0..* Who performed event fhir:function [ CodeableConcept ] ; # 0..1 Who performed the dispense and what they did fhir:actor [ Reference(CareTeam|Device|Group|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) ] ; # 1..1 Individual who was performing ] ... ) ; fhir:location [ Reference(Location) ] ; # 0..1 Where the dispense occurred fhir:authorizingPrescription ( [ Reference(MedicationRequest) ] ... ) ; # 0..* Medication order that authorizes the dispense fhir:type [ CodeableConcept ] ; # 0..1 Trial fill, partial fill, emergency fill, etc fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount of medication fhir:daysSupply [ Quantity(SimpleQuantity) ] ; # 0..1 Amount of medication expressed as a timing amount fhir:fillNumber [ positiveInt ] ; # 0..1 A number that represents the known fill this dispense represents fhir:recorded [ dateTime ] ; # 0..1 When the recording of the dispense started fhir:whenPrepared [ dateTime ] ; # 0..1 I When product was packaged and reviewed fhir:whenHandedOver [ dateTime ] ; # 0..1 I When product was given out fhir:destination [ Reference(Location) ] ; # 0..1 Where the medication was/will be sent fhir:receiver ( [ Reference(Group|Location|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who collected the medication or where the medication was delivered fhir:note ( [ Annotation ] ... ) ; # 0..* Information about the dispense fhir:renderedDosageInstruction [ markdown ] ; # 0..1 Full representation of the dosage instructions fhir:dosageInstruction ( [ Dosage ] ... ) ; # 0..* How the medication is to be used by the patient or administered by the caregiver fhir:doseAdministrationAid [ CodeableConcept ] ; # 0..1 Type of adherence packaging to use for the dispense fhir:substitution [ # 0..1 Whether a substitution was performed on the dispense fhir:wasSubstituted [ boolean ] ; # 1..1 Whether a substitution was or was not performed on the dispense fhir:type [ CodeableConcept ] ; # 0..1 Code signifying whether a different drug was dispensed from what was prescribed fhir:reason ( [ CodeableConcept ] ... ) ; # 0..* Why was substitution made fhir:responsibleParty [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Who is responsible for the substitution ] ; fhir:eventHistory ( [ Reference(Provenance) ] ... ) ; # 0..* A list of relevant lifecycle events ]
Changes
since
DSTU2
from
both
R4
and
R4B
| MedicationDispense |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R2
<-->
R3
Conversion
Maps
(status
=
7
tests
that
all
execute
ok.
7
fail
round-trip
testing
and
1
r3
resources
are
invalid
(2
errors).
).
for
R4B
as
XML
or
JSON
.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
MedicationDispense
|
|
DomainResource |
Dispensing
a
medication
to
a
named
patient
+ Rule: whenHandedOver cannot be before whenPrepared Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
identifier
|
0..* | Identifier |
External
identifier
|
|
|
|
0..* | Reference ( CarePlan ) |
Plan
that
is
fulfilled
by
this
dispense
|
|
|
partOf
| 0..* | Reference ( Procedure | MedicationAdministration ) |
Event
that
dispense
is
part
of
|
|
|
status
|
?! Σ | 1..1 | code |
preparation
|
in-progress
|
cancelled
|
on-hold
|
completed
|
entered-in-error
|
|
|
notPerformedReason
|
0..1 |
|
Why
a
dispense
was
not
performed
|
|
|
statusChanged
|
0..1 |
dateTime
|
When
the
status
changed
|
|
|
category
|
0..* | CodeableConcept |
Type
of
medication
dispense
Binding: MedicationDispense Category Codes ( Example ) |
|
|
|
Σ
|
1..1 | CodeableReference ( Medication ) |
What
medication
was
(or
was
intended
to
be)
supplied
Binding: SNOMED CT Medication Codes ( Example ) |
|
subject
|
Σ | 1..1 | Reference ( Patient | Group ) |
Who
the
dispense
is
for
|
|
|
0..1 |
Reference
(
Encounter
|
Encounter
|
|
|
supportingInformation
|
0..* | Reference ( Any ) |
Information
that
supports
the
dispensing
of
the
medication
|
|
|
performer
|
0..* | BackboneElement |
Who
performed
event
|
|
|
function
| 0..1 | CodeableConcept |
Who
performed
the
dispense
and
what
they
did
Binding: MedicationDispense Performer Function Codes ( Example ) | |
|
actor
|
1..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam | Group ) |
Individual
who
was
performing
|
|
|
location
|
0..1 |
Reference
(
|
Where
the
dispense
occurred
|
|
|
authorizingPrescription
|
0..* | Reference ( MedicationRequest ) |
Medication
order
that
authorizes
the
dispense
|
|
|
type
|
0..1 | CodeableConcept |
Trial
fill,
partial
fill,
emergency
fill,
Binding: ActPharmacySupplyType
(
Example
)
|
|
|
quantity
|
0..1 | SimpleQuantity |
Amount
|
|
|
daysSupply
|
0..1 | SimpleQuantity |
Amount
of
medication
expressed
as
a
timing
amount
|
|
|
|
0..1 |
|
A
number
that
represents
the
known
fill
this
dispense
represents
|
|
|
recorded
| 0..1 | dateTime |
When
the
recording
of
the
dispense
started
|
|
|
whenPrepared
| Σ C | 0..1 | dateTime |
When
product
was
packaged
and
reviewed
|
|
whenHandedOver
|
C | 0..1 | dateTime |
When
product
was
given
out
|
|
destination
|
0..1 | Reference ( Location ) |
Where
the
medication
|
|
|
receiver
|
0..* | Reference ( Patient | Practitioner | RelatedPerson | Location | PractitionerRole | Organization | Group ) |
Who
collected
the
medication
or
where
the
medication
was
delivered
|
|
|
note
|
0..* | Annotation |
Information
about
the
dispense
|
|
|
renderedDosageInstruction
| 0..1 | markdown |
Full
representation
of
the
dosage
instructions
| |
|
dosageInstruction
|
0..* | Dosage |
How
the
medication
is
to
be
used
by
the
patient
or
administered
by
the
caregiver
|
|
|
doseAdministrationAid
| 0..1 | CodeableConcept |
Type
of
adherence
packaging
to
use
for
the
dispense
Binding: Medication Dose Aids ( Example ) | |
|
substitution
|
0..1 | BackboneElement |
Whether
a
substitution
was
performed
on
the
dispense
|
|
|
wasSubstituted
|
1..1 | boolean |
Whether
a
substitution
was
or
was
not
performed
on
the
dispense
|
|
|
type
|
0..1 | CodeableConcept |
Code
signifying
whether
a
different
drug
was
dispensed
from
what
was
prescribed
Binding: ActSubstanceAdminSubstitutionCode
(
Example
)
|
|
|
reason
|
0..* | CodeableConcept |
Why
was
substitution
made
Binding: SubstanceAdminSubstitutionReason
(
Example
)
|
|
|
responsibleParty
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Who
is
responsible
for
the
substitution
|
|
eventHistory
|
0..* | Reference ( Provenance ) |
A
list
of
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<<MedicationDispense xmlns="http://hl7.org/fhir"><</identifier> <</partOf> < <</category> <</medication[x]> <</subject> <</context> <</supportingInformation> < <| </actor> <</onBehalfOf><identifier><!-- 0..* Identifier External identifier --></identifier> <basedOn><!-- 0..* Reference(CarePlan) Plan that is fulfilled by this dispense --></basedOn> <partOf><!-- 0..* Reference(MedicationAdministration|Procedure) Event that dispense is part of --></partOf> <status value="[code]"/><!-- 1..1 preparation | in-progress | cancelled | on-hold | completed | entered-in-error | unfulfilled | declined | unknown --> <notPerformedReason><!-- 0..1 CodeableReference(DetectedIssue) Why a dispense was not performed --></notPerformedReason> <statusChanged value="[dateTime]"/><!-- 0..1 When the status changed --> <category><!-- 0..* CodeableConcept Type of medication dispense --></category> <medication><!-- 1..1 CodeableReference(Medication) What medication was (or was intended to be) supplied --></medication> <subject><!-- 1..1 Reference(Group|Patient) Who the dispense is for --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter associated with event --></encounter> <supportingInformation><!-- 0..* Reference(Any) Information that supports the dispensing of the medication --></supportingInformation> <performer> <!-- 0..* Who performed event --> <function><!-- 0..1 CodeableConcept Who performed the dispense and what they did --></function> <actor><!-- 1..1 Reference(CareTeam|Device|Group|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Individual who was performing --></actor> </performer> <location><!-- 0..1 Reference(Location) Where the dispense occurred --></location> <authorizingPrescription><!-- 0..* Reference(MedicationRequest) Medication order that authorizes the dispense --></authorizingPrescription><</type> <</quantity><type><!-- 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc< < <</destination> <</receiver><fillNumber value="[positiveInt]"/><!-- 0..1 A number that represents the known fill this dispense represents --> <recorded value="[dateTime]"/><!-- 0..1 When the recording of the dispense started --> <whenPrepared value="[dateTime]"/><!-- I 0..1 When product was packaged and reviewed --> <whenHandedOver value="[dateTime]"/><!-- I 0..1 When product was given out --> <destination><!-- 0..1 Reference(Location) Where the medication was/will be sent --></destination> <receiver><!-- 0..* Reference(Group|Location|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who collected the medication or where the medication was delivered --></receiver> <note><!-- 0..* Annotation Information about the dispense --></note> <renderedDosageInstruction value="[markdown]"/><!-- 0..1 Full representation of the dosage instructions --> <dosageInstruction><!-- 0..* Dosage How the medication is to be used by the patient or administered by the caregiver --></dosageInstruction>< < <</type> <</reason> <</responsibleParty><doseAdministrationAid><!-- 0..1 CodeableConcept Type of adherence packaging to use for the dispense --></doseAdministrationAid> <substitution> <!-- 0..1 Whether a substitution was performed on the dispense --> <wasSubstituted value="[boolean]"/><!-- 1..1 Whether a substitution was or was not performed on the dispense --> <type><!-- 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed<</detectedIssue> < <</notDoneReason[x]> <</eventHistory><eventHistory><!-- 0..* Reference(Provenance) A list of relevant lifecycle events --></eventHistory> </MedicationDispense>
JSON Template
{
"resourceType" : "",
"resourceType" : "MedicationDispense",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
" },
" },
"
"
"
"
"|
"
"identifier" : [{ Identifier }], // External identifier
"basedOn" : [{ Reference(CarePlan) }], // Plan that is fulfilled by this dispense
"partOf" : [{ Reference(MedicationAdministration|Procedure) }], // Event that dispense is part of
"status" : "<code>", // R! preparation | in-progress | cancelled | on-hold | completed | entered-in-error | unfulfilled | declined | unknown
"notPerformedReason" : { CodeableReference(DetectedIssue) }, // Why a dispense was not performed
"statusChanged" : "<dateTime>", // When the status changed
"category" : [{ CodeableConcept }], // Type of medication dispense
"medication" : { CodeableReference(Medication) }, // R! What medication was (or was intended to be) supplied
"subject" : { Reference(Group|Patient) }, // R! Who the dispense is for
"encounter" : { Reference(Encounter) }, // Encounter associated with event
"supportingInformation" : [{ Reference(Any) }], // Information that supports the dispensing of the medication
"performer" : [{ // Who performed event
"function" : { CodeableConcept }, // Who performed the dispense and what they did
"actor" : { Reference(CareTeam|Device|Group|Organization|Patient|
Practitioner|PractitionerRole|RelatedPerson) } // R! Individual who was performing
}],
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"location" : { Reference(Location) }, // Where the dispense occurred
"authorizingPrescription" : [{ Reference(MedicationRequest) }], // Medication order that authorizes the dispense
"type" : { CodeableConcept }, // Trial fill, partial fill, emergency fill, etc
"quantity" : { Quantity(SimpleQuantity) }, // Amount of medication
"daysSupply" : { Quantity(SimpleQuantity) }, // Amount of medication expressed as a timing amount
"fillNumber" : "<positiveInt>", // A number that represents the known fill this dispense represents
"recorded" : "<dateTime>", // When the recording of the dispense started
"whenPrepared" : "<dateTime>", // I When product was packaged and reviewed
"whenHandedOver" : "<dateTime>", // I When product was given out
"destination" : { Reference(Location) }, // Where the medication was/will be sent
"receiver" : [{ Reference(Group|Location|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }], // Who collected the medication or where the medication was delivered
"note" : [{ Annotation }], // Information about the dispense
"renderedDosageInstruction" : "<markdown>", // Full representation of the dosage instructions
"dosageInstruction" : [{ Dosage }], // How the medication is to be used by the patient or administered by the caregiver
"doseAdministrationAid" : { CodeableConcept }, // Type of adherence packaging to use for the dispense
"substitution" : { // Whether a substitution was performed on the dispense
"wasSubstituted" : <boolean>, // R! Whether a substitution was or was not performed on the dispense
"type" : { CodeableConcept }, // Code signifying whether a different drug was dispensed from what was prescribed
"reason" : [{ CodeableConcept }], // Why was substitution made
"responsibleParty" : { Reference(Organization|Practitioner|
PractitionerRole) } // Who is responsible for the substitution
},
"
"
" },
" },
"
"eventHistory" : [{ Reference(Provenance) }] // A list of relevant lifecycle events
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .# from # from fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ]; fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir:# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* External identifier fhir:basedOn ( [ Reference(CarePlan) ] ... ) ; # 0..* Plan that is fulfilled by this dispense fhir:partOf ( [ Reference(MedicationAdministration|Procedure) ] ... ) ; # 0..* Event that dispense is part of fhir:status [ code ] ; # 1..1 preparation | in-progress | cancelled | on-hold | completed | entered-in-error | unfulfilled | declined | unknown fhir:notPerformedReason [ CodeableReference(DetectedIssue) ] ; # 0..1 Why a dispense was not performed fhir:statusChanged [ dateTime ] ; # 0..1 When the status changed fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Type of medication dispense fhir:medication [ CodeableReference(Medication) ] ; # 1..1 What medication was (or was intended to be) supplied fhir:subject [ Reference(Group|Patient) ] ; # 1..1 Who the dispense is for fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter associated with event fhir:supportingInformation ( [ Reference(Any) ] ... ) ; # 0..* Information that supports the dispensing of the medication fhir:performer ( [ # 0..* Who performed event fhir:function [ CodeableConcept ] ; # 0..1 Who performed the dispense and what they did fhir:actor [ Reference(CareTeam|Device|Group|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) ] ; # 1..1 Individual who was performing ] ... ) ; fhir:location [ Reference(Location) ] ; # 0..1 Where the dispense occurred fhir:authorizingPrescription ( [ Reference(MedicationRequest) ] ... ) ; # 0..* Medication order that authorizes the dispense fhir:type [ CodeableConcept ] ; # 0..1 Trial fill, partial fill, emergency fill, etc fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount of medication fhir:daysSupply [ Quantity(SimpleQuantity) ] ; # 0..1 Amount of medication expressed as a timing amount fhir:fillNumber [ positiveInt ] ; # 0..1 A number that represents the known fill this dispense represents fhir:recorded [ dateTime ] ; # 0..1 When the recording of the dispense started fhir:whenPrepared [ dateTime ] ; # 0..1 I When product was packaged and reviewed fhir:whenHandedOver [ dateTime ] ; # 0..1 I When product was given out fhir:destination [ Reference(Location) ] ; # 0..1 Where the medication was/will be sent fhir:receiver ( [ Reference(Group|Location|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who collected the medication or where the medication was delivered fhir:note ( [ Annotation ] ... ) ; # 0..* Information about the dispense fhir:renderedDosageInstruction [ markdown ] ; # 0..1 Full representation of the dosage instructions fhir:dosageInstruction ( [ Dosage ] ... ) ; # 0..* How the medication is to be used by the patient or administered by the caregiver fhir:doseAdministrationAid [ CodeableConcept ] ; # 0..1 Type of adherence packaging to use for the dispense fhir:substitution [ # 0..1 Whether a substitution was performed on the dispense fhir:wasSubstituted [ boolean ] ; # 1..1 Whether a substitution was or was not performed on the dispense fhir:type [ CodeableConcept ] ; # 0..1 Code signifying whether a different drug was dispensed from what was prescribed fhir:reason ( [ CodeableConcept ] ... ) ; # 0..* Why was substitution made fhir:responsibleParty [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Who is responsible for the substitution ] ; fhir:eventHistory ( [ Reference(Provenance) ] ... ) ; # 0..* A list of relevant lifecycle events ]
Changes
since
DSTU2
from
both
R4
and
R4B
| MedicationDispense |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R2
<-->
R3
Conversion
Maps
(status
=
7
tests
that
all
execute
ok.
7
fail
round-trip
testing
and
1
r3
resources
are
invalid
(2
errors).
).
for
R4B
as
XML
or
JSON
.
Alternate
Additional
definitions:
Master
Definition
(
XML
,
+
JSON
),
,
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| MedicationDispense.status |
|
Required |
MedicationDispense Status Codes |
| MedicationDispense.notPerformedReason |
|
Example | MedicationDispense Status Reason Codes |
| MedicationDispense.category |
|
|
MedicationDispense Category Codes |
|
|
SNOMEDCTMedicationCodes | Example |
This
value
set
includes
all
drug
or
|
| MedicationDispense.performer.function | MedicationDispensePerformerFunctionCodes | Example |
MedicationDispense Performer Function Codes |
| MedicationDispense.type |
ActPharmacySupplyType
| Example |
Identifies
types
of
dispensing
|
| MedicationDispense.doseAdministrationAid | MedicationDoseAids (a valid code from Medication dose aid ) | Example |
Medication Dose Aids |
| MedicationDispense.substitution.type |
|
Example |
No description |
| MedicationDispense.substitution.reason |
|
Example |
No description |
| UniqueKey | Level | Location | Description | Expression |
mdd-1
| Rule | (base) |
whenHandedOver
cannot
be
before
whenPrepared
|
|
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 |
| code | token |
|
|
|
|
|
reference |
Returns
dispenses
|
( |
|
|
encounter
|
reference |
|
( |
27 Resources |
| identifier | token |
|
MedicationDispense.identifier |
|
| location | reference | Returns dispense for a given location |
MedicationDispense.location
( Location ) | |
| medication | reference |
|
|
|
| patient | reference | The identity of a patient to list dispenses for |
( Patient ) |
|
| performer | reference |
|
MedicationDispense.performer.actor
( Practitioner , Group , Organization , CareTeam , Device , Patient , PractitionerRole , RelatedPerson ) |
|
| prescription | reference | The identity of a prescription to list dispenses from |
MedicationDispense.authorizingPrescription
( MedicationRequest ) |
1 Resources |
| receiver | reference | The identity of a receiver to list dispenses for |
MedicationDispense.receiver
( Practitioner , Group , Organization , Patient , PractitionerRole , RelatedPerson , Location ) |
|
| recorded | date | Returns dispenses where dispensing activity began on this date | MedicationDispense.recorded | |
| responsibleparty | reference |
|
MedicationDispense.substitution.responsibleParty
( Practitioner , Organization , PractitionerRole ) |
|
| status | token |
|
MedicationDispense.status |
|
| subject | reference |
The
identity
of
a
patient
for
whom
to
list
dispenses
|
MedicationDispense.subject
( Group , Patient ) |
|
| type | token |
|
MedicationDispense.type | 10 Resources |
| whenhandedover | date | Returns dispenses handed over on this date | MedicationDispense.whenHandedOver | |
| whenprepared | date | Returns dispenses prepared on this date | MedicationDispense.whenPrepared |
FHIR
®©
HL7.org
2011+.
FHIR
Release
3
(STU;
v3.0.2-11200)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Thurs,
Oct
24,
2019
11:53+1100.
QA
Page
Mon,
Nov
10,
2025
15:22+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
DSTU2
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change