Release 5 Draft Ballot
MedicationsThis page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - 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
| Pharmacy Work Group | Maturity Level: 3 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
This resource has been identified by it's owning workgroup as a normative candidate for R5. Ballot comment is requested on this.
This resource is primarily used for the identification and definition of a 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 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, 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 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 how it is packaged. The medication will include the 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.
This resource is referenced by ActivityDefinition, AdverseEvent, CarePlan, ChargeItem, ChargeItemDefinition, ClinicalUseIssue, DiagnosticReport, Flag, Group, MedicationKnowledge, Observation, ResearchSubject and SupplyDelivery.
This resource does not implement any patterns.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication | TU | DomainResource | Definition of a Medication Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
  identifier | Σ | 0..* | Identifier | Business identifier for this medication |
| code | Σ | 0..1 | CodeableConcept | Codes that identify this medication SNOMED CT Medication Codes (Example) |
 status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Medication Status Codes (Required) |
 sponsor | Σ | 0..1 | Reference(Organization) | Organization responsible for manufacturing the item |
| doseForm | 0..1 | CodeableConcept | powder | tablets | capsule + SNOMED CT Form Codes (Example) | |
| amount | Σ | 0..1 | Ratio | Amount of drug in package |
  ingredient | 0..* | BackboneElement | Active or inactive ingredient | |
 item | 1..1 | CodeableReference(Substance | Medication) | The ingredient (substance or medication) that the ingredient.strength relates to | |
| isActive | 0..1 | boolean | Active ingredient indicator | |
  strength[x] | 0..1 | Quantity of ingredient present Medication Ingredient Strength Codes (Example) | ||
 strengthRatio | Ratio | |||
| strengthCodeableConcept | CodeableConcept | |||
 strengthQuantity | Quantity | |||
| batch | 0..1 | BackboneElement | Details about packaged medications | |
| lotNumber | 0..1 | string | Identifier assigned to batch | |
| expirationDate | 0..1 | dateTime | When batch will expire | |
| Documentation for this format | ||||
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 --> <sponsor><!-- 0..1 Reference(Organization) Organization responsible for manufacturing the item --></sponsor> <doseForm><!-- 0..1 CodeableConcept powder | tablets | capsule + --></doseForm> <amount><!-- 0..1 Ratio Amount of drug in package --></amount> <ingredient> <!-- 0..* Active or inactive ingredient --> <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[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> </Medication>
JSON Template
{
"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
"sponsor" : { Reference(Organization) }, // Organization responsible for manufacturing the item
"doseForm" : { CodeableConcept }, // powder | tablets | capsule +
"amount" : { Ratio }, // Amount of drug in package
"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
}
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R3
| Medication | |
| Medication.status |
|
| Medication.sponsor |
|
| Medication.doseForm |
|
| Medication.ingredient.item |
|
| Medication.ingredient.strength[x] |
|
| Medication.manufacturer |
|
| Medication.form |
|
| Medication.ingredient.item[x] |
|
| Medication.ingredient.strength |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 23 tests that all execute ok. 22 fail round-trip testing and 22 r3 resources are invalid (0 errors).)
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | TU | DomainResource | Definition of a Medication Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| identifier | Σ | 0..* | Identifier | Business identifier for this medication |
| code | Σ | 0..1 | CodeableConcept | Codes that identify this medication SNOMED CT Medication Codes (Example) |
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Medication Status Codes (Required) |
| sponsor | Σ | 0..1 | Reference(Organization) | Organization responsible for manufacturing the item |
| doseForm | 0..1 | CodeableConcept | powder | tablets | capsule + SNOMED CT Form Codes (Example) | |
| amount | Σ | 0..1 | Ratio | Amount of drug in package |
| ingredient | 0..* | BackboneElement | Active or inactive ingredient | |
| item | 1..1 | CodeableReference(Substance | Medication) | The ingredient (substance or medication) that the ingredient.strength relates to | |
| isActive | 0..1 | boolean | Active ingredient indicator | |
| strength[x] | 0..1 | Quantity of ingredient present Medication Ingredient Strength Codes (Example) | ||
| strengthRatio | Ratio | |||
| strengthCodeableConcept | CodeableConcept | |||
| strengthQuantity | Quantity | |||
| batch | 0..1 | BackboneElement | Details about packaged medications | |
| lotNumber | 0..1 | string | Identifier assigned to batch | |
| expirationDate | 0..1 | dateTime | When batch will expire | |
| Documentation for this format | ||||
XML Template
<Medication xmlns="http://hl7.org/fhir">
JSON Template
{
"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
"sponsor" : { Reference(Organization) }, // Organization responsible for manufacturing the item
"doseForm" : { CodeableConcept }, // powder | tablets | capsule +
"amount" : { Ratio }, // Amount of drug in package
"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
}
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since Release 3
| Medication | |
| Medication.status |
|
| Medication.sponsor |
|
| Medication.doseForm |
|
| Medication.ingredient.item |
|
| Medication.ingredient.strength[x] |
|
| Medication.manufacturer |
|
| Medication.form |
|
| Medication.ingredient.item[x] |
|
| Medication.ingredient.strength |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 23 tests that all execute ok. 22 fail round-trip testing and 22 r3 resources are invalid (0 errors).)
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a
| Path | Definition | Type | Reference |
|---|---|---|---|
| Medication.code | Example | SNOMEDCTMedicationCodes | |
| Medication.status | Required | Medication Status Codes | |
| Medication.doseForm | Example | SNOMEDCTFormCodes | |
| Medication.ingredient.strength[x] | Example | Medication Ingredient Strength Codes |
Search parameters for 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 | |
| expiration-date N | 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 | |
| ingredient D | reference | Returns medications for this ingredient reference | Medication.ingredient.item.reference | |
| ingredient-code D | token | Returns medications for this ingredient code | Medication.ingredient.item.concept | |
| lot-number N | token | Returns medications in a batch with this lot number | Medication.batch.lotNumber | |
| sponsor | reference | Returns medications made or sold for this manufacturer | Medication.sponsor (Organization) | |
| status N | token | Returns medications for this status | Medication.status |
FHIR ®© HL7.org 2011+. FHIR R5 Draft Ballot hl7.fhir.core#4.6.0 generated on Thu, Apr 15, 2021 12:29+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change