This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0:
R5
-
STU
).
The
This
is
the
current
published
version
which
supercedes
in
it's
permanent
home
(it
will
always
be
available
at
this
version
is
5.0.0
.
URL).
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R5
R4B
R4
R3
R2
Pharmacy
Work
Group
|
Maturity
Level
:
|
Trial Use | Security Category : Business |
Compartments
:
|
This
resource
is
primarily
used
for
the
identification
and
definition
of
a
medication
medication,
including
ingredients,
for
the
purposes
of
prescribing,
dispensing,
and
administering
a
medication
as
well
as
for
making
statements
about
medication
use.
Representing
medications
in
the
majority
of
most
healthcare
settings
is
a
matter
of
identifying
an
item
from
a
list
and
then
conveying
a
reference
for
the
item
selected
either
into
a
patient-related
resource
or
to
other
applications.
Additional
information
about
the
medication
is
frequently
provided
for
human
verification,
verification
(e.g.,
the
product
name),
but
a
full
representation
of
the
details
of
composition
and
efficacy
of
the
medicine
is
conveyed
by
referring
to
drug
dictionaries
by
means
of
the
codes
they
define.
There
are
some
occasions
where
it
is
necessary
to
identify
slightly
more
detail,
such
as
when
dispensing
a
package
containing
a
particular
medication
requires
identification
both
of
the
medicine
and
the
package
at
once.
There
are
also
some
occasions
(e.g.
custom
formulations)
where
the
composition
of
a
medicine
must
be
represented.
In
these
cases,
the
ingredients
of
the
medicine
have
to
must
be
specified
together
with
the
amount
contained,
though
the
Medication
resource
does
not
provide
full
details.
The
Medication
resource
allows
for
medications
to
be
characterized
by
the
form
of
the
drug
and
the
ingredient
(or
ingredients),
as
well
as
and
how
it
is
packaged.
The
medication
will
include
the
ingredient(s)
ingredient(s),
and
their
strength(s)
and
the
package
can
include
the
amount
(for
example,
number
of
tablets,
volume,
etc.)
that
is
contained
in
a
particular
container
(for
example,
100
capsules
of
Amoxicillin
500mg
per
bottle).
The Medication resource can be used to describe a compounded (aka extemporaneous or magistral) product that is manufactured by the pharmacy at the time of dispensing. In this case there will be multiple ingredients which are typically base chemicals (for example, hydrocortisone powder) and there may be other ingredients that are manufactured products (for example, Glaxal Base).
When a medication includes a package, further details about the composition can be provided. A package has a container (vacuum packed box, jar, etc.) and a list of the products or other packages that are in the package.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Definition
of
a
Medication
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Business
identifier
for
this
medication
|
|
Σ | 0..1 | CodeableConcept |
Codes
that
identify
this
medication
Binding: SNOMED CT Medication Codes ( Example ) |
|
?! Σ | 0..1 | code |
active
|
inactive
|
entered-in-error
Binding: Medication Status Codes ( Required ) |
|
Σ | 0..1 | Reference ( Organization ) |
|
|
0..1 | CodeableConcept |
powder
|
tablets
|
capsule
+
Binding: SNOMED CT Form Codes ( Example ) |
|
|
Σ | 0..1 |
|
|
|
0..* | BackboneElement |
Active
or
inactive
ingredient
|
|
|
1..1 | CodeableReference ( Substance | Medication ) |
The
Binding: SNOMED CT Medication Codes ( Example ) |
|
|
0..1 |
|
Active
ingredient
indicator
|
|
|
0..1 |
Binding: Medication Ingredient Strength Codes ( |
||
|
|
|
||
|
|
|||
|
Quantity
|
|||
|
0..1 | BackboneElement |
Details
about
packaged
medications
|
|
|
0..1 | string |
Identifier
assigned
to
batch
|
|
|
0..1 | dateTime |
When
batch
will
expire
|
|
| 0..1 | Reference ( MedicationKnowledge ) |
Knowledge
about
this
medication
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<<Medication xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business identifier for this medication --></identifier> <code><!-- 0..1 CodeableConcept Codes that identify this medication --></code> <status value="[code]"/><!-- 0..1 active | inactive | entered-in-error -->
<</manufacturer> <</form> <</amount><marketingAuthorizationHolder><!-- 0..1 Reference(Organization) Organization that has authorization to market medication --></marketingAuthorizationHolder> <doseForm><!-- 0..1 CodeableConcept powder | tablets | capsule + --></doseForm> <totalVolume><!-- 0..1 Quantity When the specified product code does not infer a package size, this is the specific amount of drug in the product --></totalVolume> <ingredient> <!-- 0..* Active or inactive ingredient --><</item[x]><item><!-- 1..1 CodeableReference(Medication|Substance) The ingredient (substance or medication) that the ingredient.strength relates to --></item> <isActive value="[boolean]"/><!-- 0..1 Active ingredient indicator --><</strength><strength[x]><!-- 0..1 Ratio|CodeableConcept|Quantity Quantity of ingredient present --></strength[x]> </ingredient> <batch> <!-- 0..1 Details about packaged medications --> <lotNumber value="[string]"/><!-- 0..1 Identifier assigned to batch --> <expirationDate value="[dateTime]"/><!-- 0..1 When batch will expire --> </batch> <definition><!-- 0..1 Reference(MedicationKnowledge) Knowledge about this medication --></definition> </Medication>
JSON Template
{
"resourceType" : "",
"resourceType" : "Medication",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier for this medication
"code" : { CodeableConcept }, // Codes that identify this medication
"status" : "<code>", // active | inactive | entered-in-error
"
"
"
"marketingAuthorizationHolder" : { Reference(Organization) }, // Organization that has authorization to market medication
"doseForm" : { CodeableConcept }, // powder | tablets | capsule +
"totalVolume" : { Quantity }, // When the specified product code does not infer a package size, this is the specific amount of drug in the product
"ingredient" : [{ // Active or inactive ingredient
" },
" },
"item" : { CodeableReference(Medication|Substance) }, // R! The ingredient (substance or medication) that the ingredient.strength relates to
"isActive" : <boolean>, // Active ingredient indicator
"
// strength[x]: Quantity of ingredient present. One of these 3:
"strengthRatio" : { Ratio },
"strengthCodeableConcept" : { CodeableConcept },
"strengthQuantity" : { Quantity }
}],
"batch" : { // Details about packaged medications
"lotNumber" : "<string>", // Identifier assigned to batch
"expirationDate" : "<dateTime>" // When batch will expire
}
},
"definition" : { Reference(MedicationKnowledge) } // Knowledge about this medication
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:Medication; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtensionfhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir: fhir: ], ...; fhir: fhir: fhir: ];fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business identifier for this medication fhir:code [ CodeableConcept ] ; # 0..1 Codes that identify this medication fhir:status [ code ] ; # 0..1 active | inactive | entered-in-error fhir:marketingAuthorizationHolder [ Reference(Organization) ] ; # 0..1 Organization that has authorization to market medication fhir:doseForm [ CodeableConcept ] ; # 0..1 powder | tablets | capsule + fhir:totalVolume [ Quantity ] ; # 0..1 When the specified product code does not infer a package size, this is the specific amount of drug in the product fhir:ingredient ( [ # 0..* Active or inactive ingredient fhir:item [ CodeableReference(Medication|Substance) ] ; # 1..1 The ingredient (substance or medication) that the ingredient.strength relates to fhir:isActive [ boolean ] ; # 0..1 Active ingredient indicator # strength[x] : 0..1 Quantity of ingredient present. One of these 3 fhir:strength [ a fhir:Ratio ; Ratio ] fhir:strength [ a fhir:CodeableConcept ; CodeableConcept ] fhir:strength [ a fhir:Quantity ; Quantity ] ] ... ) ; fhir:batch [ # 0..1 Details about packaged medications fhir:lotNumber [ string ] ; # 0..1 Identifier assigned to batch fhir:expirationDate [ dateTime ] ; # 0..1 When batch will expire ] ; fhir:definition [ Reference(MedicationKnowledge) ] ; # 0..1 Knowledge about this medication ]
Changes
since
from
both
R4
and
R4B
| Medication | |
| Medication.marketingAuthorizationHolder |
|
| Medication.doseForm |
|
| Medication.totalVolume |
|
| Medication.ingredient.item |
|
| Medication.ingredient.strength[x] |
|
| Medication.definition |
|
| Medication.manufacturer |
|
| Medication.form |
|
| Medication.amount |
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
Conversions
between
R3
and
R4
for
R4B
as
XML
or
JSON
.
See
R3
<-->
R4
<-->
R5
Conversion
Maps
(status
=
23
tests
that
all
execute
ok.
22
fail
round-trip
testing
and
22
r3
resources
are
invalid
(0
errors).
)
See
Conversions
Summary
.)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Definition
of
a
Medication
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Business
identifier
for
this
medication
|
|
Σ | 0..1 | CodeableConcept |
Codes
that
identify
this
medication
Binding: SNOMED CT Medication Codes ( Example ) |
|
?! Σ | 0..1 | code |
active
|
inactive
|
entered-in-error
Binding: Medication Status Codes ( Required ) |
|
Σ | 0..1 | Reference ( Organization ) |
|
|
0..1 | CodeableConcept |
powder
|
tablets
|
capsule
+
Binding: SNOMED CT Form Codes ( Example ) |
|
|
Σ | 0..1 |
|
|
|
0..* | BackboneElement |
Active
or
inactive
ingredient
|
|
|
1..1 | CodeableReference ( Substance | Medication ) |
The
Binding: SNOMED CT Medication Codes ( Example ) |
|
|
0..1 |
|
Active
ingredient
indicator
|
|
|
0..1 |
Binding: Medication Ingredient Strength Codes ( |
||
|
|
|
||
|
|
|||
|
Quantity
|
|||
|
0..1 | BackboneElement |
Details
about
packaged
medications
|
|
|
0..1 | string |
Identifier
assigned
to
batch
|
|
|
0..1 | dateTime |
When
batch
will
expire
|
|
| 0..1 | Reference ( MedicationKnowledge ) |
Knowledge
about
this
medication
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<<Medication xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business identifier for this medication --></identifier> <code><!-- 0..1 CodeableConcept Codes that identify this medication --></code> <status value="[code]"/><!-- 0..1 active | inactive | entered-in-error -->
<</manufacturer> <</form> <</amount><marketingAuthorizationHolder><!-- 0..1 Reference(Organization) Organization that has authorization to market medication --></marketingAuthorizationHolder> <doseForm><!-- 0..1 CodeableConcept powder | tablets | capsule + --></doseForm> <totalVolume><!-- 0..1 Quantity When the specified product code does not infer a package size, this is the specific amount of drug in the product --></totalVolume> <ingredient> <!-- 0..* Active or inactive ingredient --><</item[x]><item><!-- 1..1 CodeableReference(Medication|Substance) The ingredient (substance or medication) that the ingredient.strength relates to --></item> <isActive value="[boolean]"/><!-- 0..1 Active ingredient indicator --><</strength><strength[x]><!-- 0..1 Ratio|CodeableConcept|Quantity Quantity of ingredient present --></strength[x]> </ingredient> <batch> <!-- 0..1 Details about packaged medications --> <lotNumber value="[string]"/><!-- 0..1 Identifier assigned to batch --> <expirationDate value="[dateTime]"/><!-- 0..1 When batch will expire --> </batch> <definition><!-- 0..1 Reference(MedicationKnowledge) Knowledge about this medication --></definition> </Medication>
JSON Template
{
"resourceType" : "",
"resourceType" : "Medication",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier for this medication
"code" : { CodeableConcept }, // Codes that identify this medication
"status" : "<code>", // active | inactive | entered-in-error
"
"
"
"marketingAuthorizationHolder" : { Reference(Organization) }, // Organization that has authorization to market medication
"doseForm" : { CodeableConcept }, // powder | tablets | capsule +
"totalVolume" : { Quantity }, // When the specified product code does not infer a package size, this is the specific amount of drug in the product
"ingredient" : [{ // Active or inactive ingredient
" },
" },
"item" : { CodeableReference(Medication|Substance) }, // R! The ingredient (substance or medication) that the ingredient.strength relates to
"isActive" : <boolean>, // Active ingredient indicator
"
// strength[x]: Quantity of ingredient present. One of these 3:
"strengthRatio" : { Ratio },
"strengthCodeableConcept" : { CodeableConcept },
"strengthQuantity" : { Quantity }
}],
"batch" : { // Details about packaged medications
"lotNumber" : "<string>", // Identifier assigned to batch
"expirationDate" : "<dateTime>" // When batch will expire
}
},
"definition" : { Reference(MedicationKnowledge) } // Knowledge about this medication
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:Medication; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtensionfhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir: fhir: ], ...; fhir: fhir: fhir: ];fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business identifier for this medication fhir:code [ CodeableConcept ] ; # 0..1 Codes that identify this medication fhir:status [ code ] ; # 0..1 active | inactive | entered-in-error fhir:marketingAuthorizationHolder [ Reference(Organization) ] ; # 0..1 Organization that has authorization to market medication fhir:doseForm [ CodeableConcept ] ; # 0..1 powder | tablets | capsule + fhir:totalVolume [ Quantity ] ; # 0..1 When the specified product code does not infer a package size, this is the specific amount of drug in the product fhir:ingredient ( [ # 0..* Active or inactive ingredient fhir:item [ CodeableReference(Medication|Substance) ] ; # 1..1 The ingredient (substance or medication) that the ingredient.strength relates to fhir:isActive [ boolean ] ; # 0..1 Active ingredient indicator # strength[x] : 0..1 Quantity of ingredient present. One of these 3 fhir:strength [ a fhir:Ratio ; Ratio ] fhir:strength [ a fhir:CodeableConcept ; CodeableConcept ] fhir:strength [ a fhir:Quantity ; Quantity ] ] ... ) ; fhir:batch [ # 0..1 Details about packaged medications fhir:lotNumber [ string ] ; # 0..1 Identifier assigned to batch fhir:expirationDate [ dateTime ] ; # 0..1 When batch will expire ] ; fhir:definition [ Reference(MedicationKnowledge) ] ; # 0..1 Knowledge about this medication ]
Changes
since
Release
4
from
both
R4
and
R4B
| Medication | |
| Medication.marketingAuthorizationHolder |
|
| Medication.doseForm |
|
| Medication.totalVolume |
|
| Medication.ingredient.item |
|
| Medication.ingredient.strength[x] |
|
| Medication.definition |
|
| Medication.manufacturer |
|
| Medication.form |
|
| Medication.amount |
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
Conversions
between
R3
and
R4
for
R4B
as
XML
or
JSON
.
See
R3
<-->
R4
<-->
R5
Conversion
Maps
(status
=
23
tests
that
all
execute
ok.
22
fail
round-trip
testing
and
22
r3
resources
are
invalid
(0
errors).
)
See
Conversions
Summary
.)
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 |
|
|---|---|---|---|
| Medication.code | SNOMEDCTMedicationCodes | Example |
This value set includes all drug or medicament substance codes and all pharmaceutical/biologic products from SNOMED CT - provided as an exemplar value set. |
| Medication.status | MedicationStatusCodes | Required |
Medication Status Codes |
|
|
SNOMEDCTFormCodes | Example |
This value set includes all dose form codes from SNOMED CT - provided as an exemplar. |
| Medication.ingredient.item | SNOMEDCTMedicationCodes | Example |
This value set includes all drug or medicament substance codes and all pharmaceutical/biologic products from SNOMED CT - provided as an exemplar value set. |
| Medication.ingredient.strength[x] | MedicationIngredientStrengthCodes | Preferred |
Medication
|
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 | Returns medications for a specific code | Medication.code | 22 Resources |
| expiration-date | date | Returns medications in a batch with this expiration date | Medication.batch.expirationDate | |
| form | token | Returns medications for a specific dose form |
|
|
| identifier | token | Returns medications with this external identifier | Medication.identifier | 65 Resources |
| ingredient | reference | Returns medications for this ingredient reference |
|
|
| ingredient-code | token | Returns medications for this ingredient code |
|
|
| lot-number | token | Returns medications in a batch with this lot number | Medication.batch.lotNumber | |
|
|
reference |
Returns
medications
made
or
sold
for
this
|
( Organization ) |
|
| serial-number | token | Returns medications in a batch with this lot number | Medication.identifier | |
| status | token | Returns medications for this status | Medication.status |