FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

14.5 Resource Medication - Content

Responsible Owner: Pharmacy icon Work Group NormativeSecurity Category: Business Compartments: No defined compartments

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.

Changes since 6.0.0-ballot5:

  • FHIR-48405 icon - The examples no longer use contained Substance resources to describe medication ingredients.
  • FHIR-54375 icon - Corrected the definition of Medication.ingredient.role, which duplicated the definition of isActive.
  • FHIR-54379 icon - Corrected the description of the serial-number search parameter, which referred to a lot number.
  • FHIR-57813 icon - Medication can now optionally be a canonical resource: it has the CanonicalResource elements (url, version, name, title, publisher, jurisdiction and others).
  • FHIR-59543 icon - status is bound to the PublicationStatus value set (draft | active | retired | unknown), as for other canonical resources; the Medication Status code system and value set are removed. From R5: inactive and entered-in-error become retired; active is unchanged.
  • FHIR-59524 icon - The serial-number search parameter now searches Medication.instance.identifier (the serial number of a physical item) instead of Medication.identifier; the build path of lot-number now matches its expression (Medication.instance.lotNumber).
  • FHIR-57429 icon - Clarified the two identifiers in the comments: identifier is the business identifier of the Medication record; instance.identifier is the identifier (typically the serial number) of a physical item, not used for lot numbers. Added a pair of examples for the same product: a kind of medication (medicationexample0324) and a physical item (medicationexample0325).

14.5.1 Scope and Usage

Representing medications in most healthcare settings is a matter of identifying an item from a list and then conveying a reference for the item selected. Additional information about the medication is frequently provided for human 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 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, the ingredient (or ingredients), and 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).

The Medication resource can also be used to describe combination packaged products. In this case, the ingredients will refer to the component products either as codes or as references to Medication resource instances.

14.5.2 References to this Resource

14.5.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication N DomainResource Definition of a Medication

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC 0..1 uri Canonical identifier for this Medication, represented as an absolute URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Business identifier for this medication

... version Σ 0..1 string Business version of the Medication
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name Σ 0..1 string Name for this Medication (computer friendly)
... title Σ 0..1 string Name for this Medication (human friendly)
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMED CT Medication Codes (Example)
... status ?!Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing only - never for real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description 0..1 markdown Natural language description of the Medication
... useContext Σ 0..* UsageContext The context that the content is intended to support

... jurisdiction Σ 0..* CodeableConcept Jurisdiction of the authority that maintains the Medication (if applicable)
Binding: Jurisdiction ValueSet icon (Extensible)

... purpose 0..1 markdown Why this Medication is defined
... copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
... copyrightLabel T 0..1 string Copyright holder and year(s)
... marketingAuthorizationHolder Σ 0..1 Reference(Organization) Organization that has authorization to market medication
... doseForm 0..1 CodeableConcept E.g. powder, tablets, capsule
Binding: SNOMED CT Form Codes (Example)
... packageSize ΣC 0..1 BackboneElement When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package
+ Rule: Either numberOfItems or amountPerItem must exist
.... numberOfItems 0..1 SimpleQuantity The number of items in the package that are represented by the code
.... amountPerItem 0..1 Ratio The amount per each item
... ingredient 0..* BackboneElement Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications

.... item 1..1 CodeableReference(Substance | SubstanceDefinition | Medication) The specific substance or medication that is the ingredient
Binding: SNOMED CT Medication Codes (Example)
.... isActive 0..1 boolean Active ingredient indicator
.... role 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc.
Binding: RoleClassIngredientEntity icon (Example)
.... strength[x] 0..1 Quantity of ingredient present
Binding: Medication Ingredient Strength Codes (Preferred)
..... strengthRatio Ratio
..... strengthCodeableConcept CodeableConcept
..... strengthQuantity Quantity
... instance 0..1 BackboneElement Details about packaged medications
.... identifier 0..* Identifier Identifier for the physical instance, typically a serial number

.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When instance will expire
... definition 0..1 Reference(MedicinalProductDefinition | AdministrableProductDefinition | PackagedProductDefinition | ManufacturedItemDefinition) Formal definition of the medication

doco Documentation for this format icon

UML Diagram (Legend)

Medication (DomainResource) +CanonicalResourceAn absolute URI that is used to identify this Medication when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Medication is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Medication is stored on different serversurl : uri [0..1]Business identifier for this medicationidentifier : Identifier [0..*]The identifier that is used to identify this version of the Medication when it is referenced in a specificationversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the Medication. This name should be usable as an identifier for the resource by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the Medicationtitle : string [0..1]A code (or set of codes) that specify this medication, or a textual description. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. The name of the medication can be conveyed in the code.text even if it is different from any of the coding displayName valuescode : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTMedicationCodes?? »The status of this Medication: whether the medication record is in use (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this Medication is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the Medication was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the Medication changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the Medicationpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the Medication from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate MedicationsuseContext : UsageContext [0..*]A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of usejurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this Medication is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the Medication and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the Medicationcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations)marketingAuthorizationHolder : Reference [0..1] « Organization »Describes the form of the item. Powder; tablets; capsuledoseForm : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTFormCodes?? »A reference to a definitional resource that provides more information about this medicationdefinition : Reference [0..1] « MedicinalProductDefinition| AdministrableProductDefinition|PackagedProductDefinition| ManufacturedItemDefinition »PackageSizeThe number of items in the package that are represented by the code, e.g. 5 vials or 100 tabletsnumberOfItems : Quantity(SimpleQuantity) [0..1]The amount per each item, e.g. 10 ml / vialamountPerItem : Ratio [0..1]IngredientThe ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication)item : CodeableReference [1..1] « Substance|SubstanceDefinition| Medication; null (Strength=Example)SNOMEDCTMedicationCodes?? »Indication of whether this ingredient affects the therapeutic action of the drugisActive : boolean [0..1]The (typically coded) functional role of the ingredient - for example active, excipient, adjuvant, solvent etcrole : CodeableConcept [0..1] « null (Strength=Example)RoleClassIngredientEntity?? »Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tabletstrength[x] : DataType [0..1] « Ratio|CodeableConcept|Quantity; null (Strength=Preferred) MedicationIngredientStrengthC...? »InstanceIdentifier for the physical instance, typically a serial numberidentifier : Identifier [0..*]The assigned lot number of a batch of the specified productlotNumber : string [0..1]When this specific instance of product will expireexpirationDate : dateTime [0..1]When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the packagepackageSize[0..1]Identifies a particular constituent of interest in the productingredient[0..*]Information that only applies to packages (not products)instance[0..1]

XML Template

<Medication xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this Medication, represented as an absolute URI (globally unique) -->
 <identifier><!-- 0..* Identifier Business identifier for this medication --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the Medication -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- 0..1 Name for this Medication (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this Medication (human friendly) -->
 <code><!-- 0..1 CodeableConcept Codes that identify this medication --></code>
 <status value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the Medication -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the Medication (if applicable) icon --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this Medication is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <marketingAuthorizationHolder><!-- 0..1 Reference(Organization) Organization that has authorization to market medication --></marketingAuthorizationHolder>
 <doseForm><!-- 0..1 CodeableConcept E.g. powder, tablets, capsule --></doseForm>
 <packageSize>  <!-- 0..1 When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package -->
  <numberOfItems><!-- 0..1 Quantity(SimpleQuantity) The number of items in the package that are represented by the code --></numberOfItems>
  <amountPerItem><!-- 0..1 Ratio The amount per each item --></amountPerItem>
 </packageSize>
 <ingredient>  <!-- 0..* Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications -->
  <item><!-- 1..1 CodeableReference(Medication|Substance|SubstanceDefinition) The specific substance or medication that is the ingredient --></item>
  <isActive value="[boolean]"/><!-- 0..1 Active ingredient indicator -->
  <role><!-- 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc. icon --></role>
  <strength[x]><!-- 0..1 Ratio|CodeableConcept|Quantity Quantity of ingredient present --></strength[x]>
 </ingredient>
 <instance>  <!-- 0..1 Details about packaged medications -->
  <identifier><!-- 0..* Identifier Identifier for the physical instance, typically a serial number --></identifier>
  <lotNumber value="[string]"/><!-- 0..1 Identifier assigned to batch -->
  <expirationDate value="[dateTime]"/><!-- 0..1 When instance will expire -->
 </instance>
 <definition><!-- 0..1 Reference(AdministrableProductDefinition|
   ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition) Formal definition of the medication --></definition>
</Medication>

JSON Template

{doco
  "resourceType" : "Medication",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this Medication, represented as an absolute URI (globally unique)
  "identifier" : [{ Identifier }], // Business identifier for this medication
  "version" : "<string>", // Business version of the Medication
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // Name for this Medication (computer friendly)
  "title" : "<string>", // Name for this Medication (human friendly)
  "code" : { CodeableConcept }, // Codes that identify this medication
  "status" : "<code>", // draft | active | retired | unknown
  "experimental" : <boolean>, // For testing only - never for real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the Medication
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the Medication (if applicable) icon
  "purpose" : "<markdown>", // Why this Medication is defined
  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "marketingAuthorizationHolder" : { Reference(Organization) }, // Organization that has authorization to market medication
  "doseForm" : { CodeableConcept }, // E.g. powder, tablets, capsule
  "packageSize" : { // When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package
    "numberOfItems" : { Quantity(SimpleQuantity) }, // The number of items in the package that are represented by the code
    "amountPerItem" : { Ratio } // The amount per each item
  },
  "ingredient" : [{ // Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications
    "item" : { CodeableReference(Medication|Substance|SubstanceDefinition) }, // R!  The specific substance or medication that is the ingredient
    "isActive" : <boolean>, // Active ingredient indicator
    "role" : { CodeableConcept }, // A code that defines the type of ingredient, active, base, etc. icon
    // strength[x]: Quantity of ingredient present. One of these 3:
    "strengthRatio" : { Ratio },
    "strengthCodeableConcept" : { CodeableConcept },
    "strengthQuantity" : { Quantity }
  }],
  "instance" : { // Details about packaged medications
    "identifier" : [{ Identifier }], // Identifier for the physical instance, typically a serial number
    "lotNumber" : "<string>", // Identifier assigned to batch
    "expirationDate" : "<dateTime>" // When instance will expire
  },
  "definition" : { Reference(AdministrableProductDefinition|
   ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition) } // Formal definition of the medication
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Medication;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this Medication, represented as an absolute URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for this medication
  fhir:version [ string ] ; # 0..1 Business version of the Medication
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:String ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 Name for this Medication (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this Medication (human friendly)
  fhir:code [ CodeableConcept ] ; # 0..1 Codes that identify this medication
  fhir:status [ code ] ; # 0..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the Medication
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the Medication (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this Medication is defined
  fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:marketingAuthorizationHolder [ Reference(Organization) ] ; # 0..1 Organization that has authorization to market medication
  fhir:doseForm [ CodeableConcept ] ; # 0..1 E.g. powder, tablets, capsule
  fhir:packageSize [ # 0..1 When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package
    fhir:numberOfItems [ Quantity(SimpleQuantity) ] ; # 0..1 The number of items in the package that are represented by the code
    fhir:amountPerItem [ Ratio ] ; # 0..1 The amount per each item
  ] ;
  fhir:ingredient ( [ # 0..* Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications
    fhir:item [ CodeableReference(Medication|Substance|SubstanceDefinition) ] ; # 1..1 The specific substance or medication that is the ingredient
    fhir:isActive [ boolean ] ; # 0..1 Active ingredient indicator
    fhir:role [ CodeableConcept ] ; # 0..1 A code that defines the type of ingredient, active, base, etc.
    # 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:instance [ # 0..1 Details about packaged medications
    fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifier for the physical instance, typically a serial number
    fhir:lotNumber [ string ] ; # 0..1 Identifier assigned to batch
    fhir:expirationDate [ dateTime ] ; # 0..1 When instance will expire
  ] ;
  fhir:definition [ Reference(AdministrableProductDefinition|ManufacturedItemDefinition|
  MedicinalProductDefinition|PackagedProductDefinition) ] ; # 0..1 Formal definition of the medication
]

Changes from R5 to R6

Medication
Medication.url
  • Added Element
Medication.version
  • Added Element
Medication.versionAlgorithm[x]
  • Added Element
Medication.name
  • Added Element
Medication.title
  • Added Element
Medication.status
  • Change value set from http://hl7.org/fhir/ValueSet/medication-status|5.0.0 to PublicationStatus
  • Remove codes inactive, entered-in-error
  • Add codes draft, retired, unknown
Medication.experimental
  • Added Element
Medication.date
  • Added Element
Medication.publisher
  • Added Element
Medication.contact
  • Added Element
Medication.description
  • Added Element
Medication.useContext
  • Added Element
Medication.jurisdiction
  • Added Element
Medication.purpose
  • Added Element
Medication.copyright
  • Added Element
Medication.copyrightLabel
  • Added Element
Medication.packageSize
  • Added Element
Medication.packageSize.numberOfItems
  • Added Element
Medication.packageSize.amountPerItem
  • Added Element
Medication.ingredient.role
  • Added Element
Medication.instance
  • Renamed from batch to instance
Medication.instance.identifier
  • Added Element
Medication.instance.lotNumber
  • Moved from Medication.batch to Medication.instance
Medication.instance.expirationDate
  • Moved from Medication.batch to Medication.instance
Medication.definition
  • Type Reference: Added Target Types MedicinalProductDefinition, AdministrableProductDefinition, PackagedProductDefinition, ManufacturedItemDefinition
  • Type Reference: Removed Target Type MedicationKnowledge
Medication.totalVolume
  • Deleted (-> Medication.packageSize, though is not a direct mapping)

Changes from R4B to R6

Medication
Medication.url
  • Added Element
Medication.version
  • Added Element
Medication.versionAlgorithm[x]
  • Added Element
Medication.name
  • Added Element
Medication.title
  • Added Element
Medication.status
  • Change value set from http://hl7.org/fhir/ValueSet/medication-status|4.3.0 to PublicationStatus
  • Remove codes inactive, entered-in-error
  • Add codes draft, retired, unknown
Medication.experimental
  • Added Element
Medication.date
  • Added Element
Medication.publisher
  • Added Element
Medication.contact
  • Added Element
Medication.description
  • Added Element
Medication.useContext
  • Added Element
Medication.jurisdiction
  • Added Element
Medication.purpose
  • Added Element
Medication.copyright
  • Added Element
Medication.copyrightLabel
  • Added Element
Medication.marketingAuthorizationHolder
  • Renamed from manufacturer to marketingAuthorizationHolder
Medication.doseForm
  • Renamed from form to doseForm
Medication.packageSize
  • Added Element
Medication.packageSize.numberOfItems
  • Added Element
Medication.packageSize.amountPerItem
  • Added Element
Medication.ingredient.item
  • Renamed from item[x] to item
  • Add Type CodeableReference
  • Remove Types CodeableConcept, Reference(Substance | Medication)
Medication.ingredient.role
  • Added Element
Medication.ingredient.strength[x]
  • Renamed from strength to strength[x]
  • Add Types CodeableConcept, Quantity
Medication.instance
  • Renamed from batch to instance
Medication.instance.identifier
  • Added Element
Medication.instance.lotNumber
  • Moved from Medication.batch to Medication.instance
Medication.instance.expirationDate
  • Moved from Medication.batch to Medication.instance
Medication.definition
  • Added Element
Medication.amount
  • Deleted

Changes from R4 to R6

Medication
Medication.url
  • Added Element
Medication.version
  • Added Element
Medication.versionAlgorithm[x]
  • Added Element
Medication.name
  • Added Element
Medication.title
  • Added Element
Medication.status
  • Change value set from http://hl7.org/fhir/ValueSet/medication-status|4.0.0 to PublicationStatus
  • Remove codes inactive, entered-in-error
  • Add codes draft, retired, unknown
Medication.experimental
  • Added Element
Medication.date
  • Added Element
Medication.publisher
  • Added Element
Medication.contact
  • Added Element
Medication.description
  • Added Element
Medication.useContext
  • Added Element
Medication.jurisdiction
  • Added Element
Medication.purpose
  • Added Element
Medication.copyright
  • Added Element
Medication.copyrightLabel
  • Added Element
Medication.marketingAuthorizationHolder
  • Renamed from manufacturer to marketingAuthorizationHolder
Medication.doseForm
  • Renamed from form to doseForm
Medication.packageSize
  • Added Element
Medication.packageSize.numberOfItems
  • Added Element
Medication.packageSize.amountPerItem
  • Added Element
Medication.ingredient.item
  • Renamed from item[x] to item
  • Add Type CodeableReference
  • Remove Types CodeableConcept, Reference(Substance | Medication)
Medication.ingredient.role
  • Added Element
Medication.ingredient.strength[x]
  • Renamed from strength to strength[x]
  • Add Types CodeableConcept, Quantity
Medication.instance
  • Renamed from batch to instance
Medication.instance.identifier
  • Added Element
Medication.instance.lotNumber
  • Moved from Medication.batch to Medication.instance
Medication.instance.expirationDate
  • Moved from Medication.batch to Medication.instance
Medication.definition
  • Added Element
Medication.amount
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication N DomainResource Definition of a Medication

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC 0..1 uri Canonical identifier for this Medication, represented as an absolute URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Business identifier for this medication

... version Σ 0..1 string Business version of the Medication
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name Σ 0..1 string Name for this Medication (computer friendly)
... title Σ 0..1 string Name for this Medication (human friendly)
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMED CT Medication Codes (Example)
... status ?!Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing only - never for real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description 0..1 markdown Natural language description of the Medication
... useContext Σ 0..* UsageContext The context that the content is intended to support

... jurisdiction Σ 0..* CodeableConcept Jurisdiction of the authority that maintains the Medication (if applicable)
Binding: Jurisdiction ValueSet icon (Extensible)

... purpose 0..1 markdown Why this Medication is defined
... copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
... copyrightLabel T 0..1 string Copyright holder and year(s)
... marketingAuthorizationHolder Σ 0..1 Reference(Organization) Organization that has authorization to market medication
... doseForm 0..1 CodeableConcept E.g. powder, tablets, capsule
Binding: SNOMED CT Form Codes (Example)
... packageSize ΣC 0..1 BackboneElement When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package
+ Rule: Either numberOfItems or amountPerItem must exist
.... numberOfItems 0..1 SimpleQuantity The number of items in the package that are represented by the code
.... amountPerItem 0..1 Ratio The amount per each item
... ingredient 0..* BackboneElement Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications

.... item 1..1 CodeableReference(Substance | SubstanceDefinition | Medication) The specific substance or medication that is the ingredient
Binding: SNOMED CT Medication Codes (Example)
.... isActive 0..1 boolean Active ingredient indicator
.... role 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc.
Binding: RoleClassIngredientEntity icon (Example)
.... strength[x] 0..1 Quantity of ingredient present
Binding: Medication Ingredient Strength Codes (Preferred)
..... strengthRatio Ratio
..... strengthCodeableConcept CodeableConcept
..... strengthQuantity Quantity
... instance 0..1 BackboneElement Details about packaged medications
.... identifier 0..* Identifier Identifier for the physical instance, typically a serial number

.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When instance will expire
... definition 0..1 Reference(MedicinalProductDefinition | AdministrableProductDefinition | PackagedProductDefinition | ManufacturedItemDefinition) Formal definition of the medication

doco Documentation for this format icon

UML Diagram (Legend)

Medication (DomainResource) +CanonicalResourceAn absolute URI that is used to identify this Medication when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Medication is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Medication is stored on different serversurl : uri [0..1]Business identifier for this medicationidentifier : Identifier [0..*]The identifier that is used to identify this version of the Medication when it is referenced in a specificationversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the Medication. This name should be usable as an identifier for the resource by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the Medicationtitle : string [0..1]A code (or set of codes) that specify this medication, or a textual description. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. The name of the medication can be conveyed in the code.text even if it is different from any of the coding displayName valuescode : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTMedicationCodes?? »The status of this Medication: whether the medication record is in use (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this Medication is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the Medication was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the Medication changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the Medicationpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the Medication from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate MedicationsuseContext : UsageContext [0..*]A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of usejurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this Medication is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the Medication and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the Medicationcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations)marketingAuthorizationHolder : Reference [0..1] « Organization »Describes the form of the item. Powder; tablets; capsuledoseForm : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTFormCodes?? »A reference to a definitional resource that provides more information about this medicationdefinition : Reference [0..1] « MedicinalProductDefinition| AdministrableProductDefinition|PackagedProductDefinition| ManufacturedItemDefinition »PackageSizeThe number of items in the package that are represented by the code, e.g. 5 vials or 100 tabletsnumberOfItems : Quantity(SimpleQuantity) [0..1]The amount per each item, e.g. 10 ml / vialamountPerItem : Ratio [0..1]IngredientThe ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication)item : CodeableReference [1..1] « Substance|SubstanceDefinition| Medication; null (Strength=Example)SNOMEDCTMedicationCodes?? »Indication of whether this ingredient affects the therapeutic action of the drugisActive : boolean [0..1]The (typically coded) functional role of the ingredient - for example active, excipient, adjuvant, solvent etcrole : CodeableConcept [0..1] « null (Strength=Example)RoleClassIngredientEntity?? »Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tabletstrength[x] : DataType [0..1] « Ratio|CodeableConcept|Quantity; null (Strength=Preferred) MedicationIngredientStrengthC...? »InstanceIdentifier for the physical instance, typically a serial numberidentifier : Identifier [0..*]The assigned lot number of a batch of the specified productlotNumber : string [0..1]When this specific instance of product will expireexpirationDate : dateTime [0..1]When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the packagepackageSize[0..1]Identifies a particular constituent of interest in the productingredient[0..*]Information that only applies to packages (not products)instance[0..1]

XML Template

<Medication xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this Medication, represented as an absolute URI (globally unique) -->
 <identifier><!-- 0..* Identifier Business identifier for this medication --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the Medication -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- 0..1 Name for this Medication (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this Medication (human friendly) -->
 <code><!-- 0..1 CodeableConcept Codes that identify this medication --></code>
 <status value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the Medication -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the Medication (if applicable) icon --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this Medication is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <marketingAuthorizationHolder><!-- 0..1 Reference(Organization) Organization that has authorization to market medication --></marketingAuthorizationHolder>
 <doseForm><!-- 0..1 CodeableConcept E.g. powder, tablets, capsule --></doseForm>
 <packageSize>  <!-- 0..1 When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package -->
  <numberOfItems><!-- 0..1 Quantity(SimpleQuantity) The number of items in the package that are represented by the code --></numberOfItems>
  <amountPerItem><!-- 0..1 Ratio The amount per each item --></amountPerItem>
 </packageSize>
 <ingredient>  <!-- 0..* Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications -->
  <item><!-- 1..1 CodeableReference(Medication|Substance|SubstanceDefinition) The specific substance or medication that is the ingredient --></item>
  <isActive value="[boolean]"/><!-- 0..1 Active ingredient indicator -->
  <role><!-- 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc. icon --></role>
  <strength[x]><!-- 0..1 Ratio|CodeableConcept|Quantity Quantity of ingredient present --></strength[x]>
 </ingredient>
 <instance>  <!-- 0..1 Details about packaged medications -->
  <identifier><!-- 0..* Identifier Identifier for the physical instance, typically a serial number --></identifier>
  <lotNumber value="[string]"/><!-- 0..1 Identifier assigned to batch -->
  <expirationDate value="[dateTime]"/><!-- 0..1 When instance will expire -->
 </instance>
 <definition><!-- 0..1 Reference(AdministrableProductDefinition|
   ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition) Formal definition of the medication --></definition>
</Medication>

JSON Template

{doco
  "resourceType" : "Medication",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this Medication, represented as an absolute URI (globally unique)
  "identifier" : [{ Identifier }], // Business identifier for this medication
  "version" : "<string>", // Business version of the Medication
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // Name for this Medication (computer friendly)
  "title" : "<string>", // Name for this Medication (human friendly)
  "code" : { CodeableConcept }, // Codes that identify this medication
  "status" : "<code>", // draft | active | retired | unknown
  "experimental" : <boolean>, // For testing only - never for real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the Medication
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the Medication (if applicable) icon
  "purpose" : "<markdown>", // Why this Medication is defined
  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "marketingAuthorizationHolder" : { Reference(Organization) }, // Organization that has authorization to market medication
  "doseForm" : { CodeableConcept }, // E.g. powder, tablets, capsule
  "packageSize" : { // When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package
    "numberOfItems" : { Quantity(SimpleQuantity) }, // The number of items in the package that are represented by the code
    "amountPerItem" : { Ratio } // The amount per each item
  },
  "ingredient" : [{ // Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications
    "item" : { CodeableReference(Medication|Substance|SubstanceDefinition) }, // R!  The specific substance or medication that is the ingredient
    "isActive" : <boolean>, // Active ingredient indicator
    "role" : { CodeableConcept }, // A code that defines the type of ingredient, active, base, etc. icon
    // strength[x]: Quantity of ingredient present. One of these 3:
    "strengthRatio" : { Ratio },
    "strengthCodeableConcept" : { CodeableConcept },
    "strengthQuantity" : { Quantity }
  }],
  "instance" : { // Details about packaged medications
    "identifier" : [{ Identifier }], // Identifier for the physical instance, typically a serial number
    "lotNumber" : "<string>", // Identifier assigned to batch
    "expirationDate" : "<dateTime>" // When instance will expire
  },
  "definition" : { Reference(AdministrableProductDefinition|
   ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition) } // Formal definition of the medication
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Medication;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this Medication, represented as an absolute URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for this medication
  fhir:version [ string ] ; # 0..1 Business version of the Medication
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:String ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 Name for this Medication (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this Medication (human friendly)
  fhir:code [ CodeableConcept ] ; # 0..1 Codes that identify this medication
  fhir:status [ code ] ; # 0..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the Medication
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the Medication (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this Medication is defined
  fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:marketingAuthorizationHolder [ Reference(Organization) ] ; # 0..1 Organization that has authorization to market medication
  fhir:doseForm [ CodeableConcept ] ; # 0..1 E.g. powder, tablets, capsule
  fhir:packageSize [ # 0..1 When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package
    fhir:numberOfItems [ Quantity(SimpleQuantity) ] ; # 0..1 The number of items in the package that are represented by the code
    fhir:amountPerItem [ Ratio ] ; # 0..1 The amount per each item
  ] ;
  fhir:ingredient ( [ # 0..* Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications
    fhir:item [ CodeableReference(Medication|Substance|SubstanceDefinition) ] ; # 1..1 The specific substance or medication that is the ingredient
    fhir:isActive [ boolean ] ; # 0..1 Active ingredient indicator
    fhir:role [ CodeableConcept ] ; # 0..1 A code that defines the type of ingredient, active, base, etc.
    # 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:instance [ # 0..1 Details about packaged medications
    fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifier for the physical instance, typically a serial number
    fhir:lotNumber [ string ] ; # 0..1 Identifier assigned to batch
    fhir:expirationDate [ dateTime ] ; # 0..1 When instance will expire
  ] ;
  fhir:definition [ Reference(AdministrableProductDefinition|ManufacturedItemDefinition|
  MedicinalProductDefinition|PackagedProductDefinition) ] ; # 0..1 Formal definition of the medication
]

Changes from R5 to R6

Medication
Medication.url
  • Added Element
Medication.version
  • Added Element
Medication.versionAlgorithm[x]
  • Added Element
Medication.name
  • Added Element
Medication.title
  • Added Element
Medication.status
  • Change value set from http://hl7.org/fhir/ValueSet/medication-status|5.0.0 to PublicationStatus
  • Remove codes inactive, entered-in-error
  • Add codes draft, retired, unknown
Medication.experimental
  • Added Element
Medication.date
  • Added Element
Medication.publisher
  • Added Element
Medication.contact
  • Added Element
Medication.description
  • Added Element
Medication.useContext
  • Added Element
Medication.jurisdiction
  • Added Element
Medication.purpose
  • Added Element
Medication.copyright
  • Added Element
Medication.copyrightLabel
  • Added Element
Medication.packageSize
  • Added Element
Medication.packageSize.numberOfItems
  • Added Element
Medication.packageSize.amountPerItem
  • Added Element
Medication.ingredient.role
  • Added Element
Medication.instance
  • Renamed from batch to instance
Medication.instance.identifier
  • Added Element
Medication.instance.lotNumber
  • Moved from Medication.batch to Medication.instance
Medication.instance.expirationDate
  • Moved from Medication.batch to Medication.instance
Medication.definition
  • Type Reference: Added Target Types MedicinalProductDefinition, AdministrableProductDefinition, PackagedProductDefinition, ManufacturedItemDefinition
  • Type Reference: Removed Target Type MedicationKnowledge
Medication.totalVolume
  • Deleted (-> Medication.packageSize, though is not a direct mapping)

Changes from R4B to R6

Medication
Medication.url
  • Added Element
Medication.version
  • Added Element
Medication.versionAlgorithm[x]
  • Added Element
Medication.name
  • Added Element
Medication.title
  • Added Element
Medication.status
  • Change value set from http://hl7.org/fhir/ValueSet/medication-status|4.3.0 to PublicationStatus
  • Remove codes inactive, entered-in-error
  • Add codes draft, retired, unknown
Medication.experimental
  • Added Element
Medication.date
  • Added Element
Medication.publisher
  • Added Element
Medication.contact
  • Added Element
Medication.description
  • Added Element
Medication.useContext
  • Added Element
Medication.jurisdiction
  • Added Element
Medication.purpose
  • Added Element
Medication.copyright
  • Added Element
Medication.copyrightLabel
  • Added Element
Medication.marketingAuthorizationHolder
  • Renamed from manufacturer to marketingAuthorizationHolder
Medication.doseForm
  • Renamed from form to doseForm
Medication.packageSize
  • Added Element
Medication.packageSize.numberOfItems
  • Added Element
Medication.packageSize.amountPerItem
  • Added Element
Medication.ingredient.item
  • Renamed from item[x] to item
  • Add Type CodeableReference
  • Remove Types CodeableConcept, Reference(Substance | Medication)
Medication.ingredient.role
  • Added Element
Medication.ingredient.strength[x]
  • Renamed from strength to strength[x]
  • Add Types CodeableConcept, Quantity
Medication.instance
  • Renamed from batch to instance
Medication.instance.identifier
  • Added Element
Medication.instance.lotNumber
  • Moved from Medication.batch to Medication.instance
Medication.instance.expirationDate
  • Moved from Medication.batch to Medication.instance
Medication.definition
  • Added Element
Medication.amount
  • Deleted

Changes from R4 to R6

Medication
Medication.url
  • Added Element
Medication.version
  • Added Element
Medication.versionAlgorithm[x]
  • Added Element
Medication.name
  • Added Element
Medication.title
  • Added Element
Medication.status
  • Change value set from http://hl7.org/fhir/ValueSet/medication-status|4.0.0 to PublicationStatus
  • Remove codes inactive, entered-in-error
  • Add codes draft, retired, unknown
Medication.experimental
  • Added Element
Medication.date
  • Added Element
Medication.publisher
  • Added Element
Medication.contact
  • Added Element
Medication.description
  • Added Element
Medication.useContext
  • Added Element
Medication.jurisdiction
  • Added Element
Medication.purpose
  • Added Element
Medication.copyright
  • Added Element
Medication.copyrightLabel
  • Added Element
Medication.marketingAuthorizationHolder
  • Renamed from manufacturer to marketingAuthorizationHolder
Medication.doseForm
  • Renamed from form to doseForm
Medication.packageSize
  • Added Element
Medication.packageSize.numberOfItems
  • Added Element
Medication.packageSize.amountPerItem
  • Added Element
Medication.ingredient.item
  • Renamed from item[x] to item
  • Add Type CodeableReference
  • Remove Types CodeableConcept, Reference(Substance | Medication)
Medication.ingredient.role
  • Added Element
Medication.ingredient.strength[x]
  • Renamed from strength to strength[x]
  • Add Types CodeableConcept, Quantity
Medication.instance
  • Renamed from batch to instance
Medication.instance.identifier
  • Added Element
Medication.instance.lotNumber
  • Moved from Medication.batch to Medication.instance
Medication.instance.expirationDate
  • Moved from Medication.batch to Medication.instance
Medication.definition
  • Added Element
Medication.amount
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis, and See the Extensions for this resource.

14.5.3.1 Terminology Bindings

Path ValueSet Type Documentation
Medication.versionAlgorithm[x] VersionAlgorithm (a valid code from http://hl7.org/fhir/version-algorithm) Extensible

Indicates the mechanism used to compare versions to determine which is more current.
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 PublicationStatus (a valid code from http://hl7.org/fhir/publication-status) Required

The lifecycle status of an artifact.
Medication.jurisdiction JurisdictionValueSet icon Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
Medication.doseForm 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.role RoleClassIngredientEntity icon Example

Relates a component (player) to a mixture (scoper). E.g., Glucose and Water are ingredients of D5W, latex may be an ingredient in a tracheal tube.
Medication.ingredient.strength[x] MedicationIngredientStrengthCodes (a valid code from http://hl7.org/fhir/CodeSystem/medication-ingredientstrength) Preferred

Medication Ingredient Strength Codes

14.5.3.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-1Warning Medication.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
img med-1Rule Medication.packageSizeEither numberOfItems or amountPerItem must existnumberOfItems.exists() or amountPerItem.exists()

14.5.4 Search Parameters

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 19 Resources
expiration-date date Returns medications in a batch with this expiration date Medication.instance.expirationDate
form token Returns medications for a specific dose form Medication.doseForm
identifier token Returns medications with this external identifier Medication.identifier 55 Resources
ingredient reference Returns medications for this ingredient reference Medication.ingredient.item.reference
ingredient-code token Returns medications for this ingredient code Medication.ingredient.item.concept
lot-number token Returns medications in a batch with this lot number Medication.instance.lotNumber
marketingauthorizationholder reference Returns medications made or sold for this marketing authorization holder Medication.marketingAuthorizationHolder
(Organization)
serial-number token Returns instance(s) of Medication resource that have this serial number Medication.instance.identifier
status token Returns medications for this status Medication.status 29 Resources