R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

Pharmacy icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the MedicationKnowledge resource.

MedicationKnowledge
Element IdMedicationKnowledge
Definition

Information about a medication that is used to support knowledge.

Short DisplayDefinition of Medication Knowledge
Cardinality0..*
TypeMetadataResource
Summaryfalse
MedicationKnowledge.identifier
Element IdMedicationKnowledge.identifier
Definition

Business identifier for this medication.

Short DisplayBusiness identifier for this medication
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
Comments

This is a business identifier, not a resource identifier (see discussion).

MedicationKnowledge.code
Element IdMedicationKnowledge.code
Definition

A code that specifies this medication, or a textual description if no code is available. 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.

Short DisplayCode that identifies this medication
Cardinality0..1
Terminology BindingSNOMED CT Medication Codes (Example)
TypeCodeableConcept
Summarytrue
Comments

Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).

MedicationKnowledge.status
Element IdMedicationKnowledge.status
Definition

A code to indicate if the medication referred to by this MedicationKnowledge is in active use within the drug database or inventory system. The status refers to the validity about the information of the medication and not to its medicinal properties.

Short Displayactive | entered-in-error | inactive
Cardinality0..1
Terminology BindingMedicationKnowledge Status Codes (Required)
Typecode
Is Modifiertrue (Reason: This element changes the interpretation of all descriptive attributes.)
Summarytrue
Comments

This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.

MedicationKnowledge.author
Element IdMedicationKnowledge.author
Definition

The creator or owner of the knowledge or information about the medication.

Short DisplayCreator or owner of the knowledge or information about the medication
Cardinality0..1
TypeReference(Organization)
Summaryfalse
MedicationKnowledge.intendedJurisdiction
Element IdMedicationKnowledge.intendedJurisdiction
Definition

Lists the jurisdictions that this medication knowledge was written for.

Short DisplayCodes that identify the different jurisdictions for which the information of this resource was created
Cardinality0..*
TypeCodeableConcept
Summaryfalse
Comments

The codes could have varying granularity from a country or group of countries down to a specific district.

MedicationKnowledge.name
Element IdMedicationKnowledge.name
Definition

All of the names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.

Short DisplayA name associated with the medication being described
Cardinality0..*
Typestring
Summarytrue
MedicationKnowledge.relatedMedicationKnowledge
Element IdMedicationKnowledge.relatedMedicationKnowledge
Definition

Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor.

Short DisplayAssociated or related medication information
Cardinality0..*
Summaryfalse
MedicationKnowledge.relatedMedicationKnowledge.type
Element IdMedicationKnowledge.relatedMedicationKnowledge.type
Definition

The category of the associated medication knowledge reference.

Short DisplayCategory of medicationKnowledge
Cardinality1..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.relatedMedicationKnowledge.reference
Element IdMedicationKnowledge.relatedMedicationKnowledge.reference
Definition

Associated documentation about the associated medication knowledge.

Short DisplayAssociated documentation about the associated medication knowledge
Cardinality1..*
TypeReference(MedicationKnowledge)
Summaryfalse
MedicationKnowledge.associatedMedication
Element IdMedicationKnowledge.associatedMedication
Definition

Links to associated medications that could be prescribed, dispensed or administered.

Short DisplayThe set of medication resources that are associated with this medication
Cardinality0..*
TypeReference(Medication)
Summaryfalse
MedicationKnowledge.productType
Element IdMedicationKnowledge.productType
Definition

Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).

Short DisplayCategory of the medication or product
Cardinality0..*
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.monograph
Element IdMedicationKnowledge.monograph
Definition

Associated documentation about the medication.

Short DisplayAssociated documentation about the medication
Cardinality0..*
Summaryfalse
MedicationKnowledge.monograph.type
Element IdMedicationKnowledge.monograph.type
Definition

The category of documentation about the medication. (e.g. professional monograph, patient education monograph).

Short DisplayThe category of medication document
Cardinality0..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.monograph.source
Element IdMedicationKnowledge.monograph.source
Definition

Associated documentation about the medication.

Short DisplayAssociated documentation about the medication
Cardinality0..1
TypeReference(DocumentReference)
Summaryfalse
MedicationKnowledge.preparationInstruction
Element IdMedicationKnowledge.preparationInstruction
Definition

The instructions for preparing the medication.

Short DisplayThe instructions for preparing the medication
Cardinality0..1
Typemarkdown
Summaryfalse
MedicationKnowledge.cost
Element IdMedicationKnowledge.cost
Definition

The price of the medication.

Short DisplayThe pricing of the medication
Cardinality0..*
Summaryfalse
MedicationKnowledge.cost.effectiveDate
Element IdMedicationKnowledge.cost.effectiveDate
Definition

The date range for which the cost information of the medication is effective.

Short DisplayThe date range for which the cost is effective
Cardinality0..*
TypePeriod
Summaryfalse
MedicationKnowledge.cost.type
Element IdMedicationKnowledge.cost.type
Definition

The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.

Short DisplayThe category of the cost information
Cardinality1..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.cost.source
Element IdMedicationKnowledge.cost.source
Definition

The source or owner that assigns the price to the medication.

Short DisplayThe source or owner for the price information
Cardinality0..1
Typestring
Summaryfalse
MedicationKnowledge.cost.cost[x]
Element IdMedicationKnowledge.cost.cost[x]
Definition

The price or representation of the cost (for example, Band A, Band B or $, $$) of the medication.

Short DisplayThe price or category of the cost of the medication
Cardinality1..1
Terminology BindingMedication Cost Category Codes (Example)
TypeMoney|CodeableConcept
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
MedicationKnowledge.monitoringProgram
Element IdMedicationKnowledge.monitoringProgram
Definition

The program under which the medication is reviewed.

Short DisplayProgram under which a medication is reviewed
Cardinality0..*
Summarytrue
MedicationKnowledge.monitoringProgram.type
Element IdMedicationKnowledge.monitoringProgram.type
Definition

Type of program under which the medication is monitored.

Short DisplayType of program under which the medication is monitored
Cardinality0..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.monitoringProgram.name
Element IdMedicationKnowledge.monitoringProgram.name
Definition

Name of the reviewing program.

Short DisplayName of the reviewing program
Cardinality0..1
Typestring
Summaryfalse
MedicationKnowledge.indicationGuideline
Element IdMedicationKnowledge.indicationGuideline
Definition

Guidelines or protocols that are applicable for the administration of the medication based on indication.

Short DisplayGuidelines or protocols for administration of the medication for an indication
Cardinality0..*
Summaryfalse
MedicationKnowledge.indicationGuideline.indication
Element IdMedicationKnowledge.indicationGuideline.indication
Definition

Indication or reason for use of the medication that applies to the specific administration guideline.

Short DisplayIndication for use that applies to the specific administration guideline
Cardinality0..*
TypeCodeableReference(ClinicalUseDefinition)
Summaryfalse
MedicationKnowledge.indicationGuideline.dosingGuideline
Element IdMedicationKnowledge.indicationGuideline.dosingGuideline
Definition

The guidelines for the dosage of the medication for the indication.

Short DisplayGuidelines for dosage of the medication
Cardinality0..*
Summaryfalse
MedicationKnowledge.indicationGuideline.dosingGuideline.treatmentIntent
Element IdMedicationKnowledge.indicationGuideline.dosingGuideline.treatmentIntent
Definition

The overall intention of the treatment, for example, prophylactic, supporative, curative, etc.

Short DisplayIntention of the treatment
Cardinality0..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.indicationGuideline.dosingGuideline.dosage
Element IdMedicationKnowledge.indicationGuideline.dosingGuideline.dosage
Definition

Dosage for the medication for the specific guidelines.

Short DisplayDosage for the medication for the specific guidelines
Cardinality0..*
Summaryfalse
MedicationKnowledge.indicationGuideline.dosingGuideline.dosage.type
Element IdMedicationKnowledge.indicationGuideline.dosingGuideline.dosage.type
Definition

The type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).

Short DisplayCategory of dosage for a medication
Cardinality1..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.indicationGuideline.dosingGuideline.dosage.dosage
Element IdMedicationKnowledge.indicationGuideline.dosingGuideline.dosage.dosage
Definition

Dosage for the medication for the specific guidelines.

Short DisplayDosage for the medication for the specific guidelines
Cardinality1..*
TypeDosage
Summaryfalse
MedicationKnowledge.indicationGuideline.dosingGuideline.administrationTreatment
Element IdMedicationKnowledge.indicationGuideline.dosingGuideline.administrationTreatment
Definition

The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etc.

Short DisplayType of treatment the guideline applies to
Cardinality0..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic
Element IdMedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic
Definition

Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).

Short DisplayCharacteristics of the patient that are relevant to the administration guidelines
Cardinality0..*
Summaryfalse
MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic.type
Element IdMedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic.type
Definition

The categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).

Short DisplayCategorization of specific characteristic that is relevant to the administration guideline
Cardinality1..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]
Element IdMedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]
Definition

The specific characteristic (e.g. height, weight, gender, etc.).

Short DisplayThe specific characteristic
Cardinality0..1
TypeCodeableConcept|Quantity|Range
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
MedicationKnowledge.medicineClassification
Element IdMedicationKnowledge.medicineClassification
Definition

Categorization of the medication within a formulary or classification system.

Short DisplayCategorization of the medication within a formulary or classification system
Cardinality0..*
Summaryfalse
MedicationKnowledge.medicineClassification.type
Element IdMedicationKnowledge.medicineClassification.type
Definition

The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).

Short DisplayThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
Cardinality1..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.medicineClassification.source[x]
Element IdMedicationKnowledge.medicineClassification.source[x]
Definition

Either a textual source of the classification or a reference to an online source.

Short DisplayThe source of the classification
Cardinality0..1
Typestring|uri
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
MedicationKnowledge.medicineClassification.classification
Element IdMedicationKnowledge.medicineClassification.classification
Definition

Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).

Short DisplaySpecific category assigned to the medication
Cardinality0..*
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.packaging
Element IdMedicationKnowledge.packaging
Definition

Information that only applies to packages (not products).

Short DisplayDetails about packaged medications
Cardinality0..*
Summaryfalse
MedicationKnowledge.packaging.cost
Element IdMedicationKnowledge.packaging.cost
Definition

The cost of the packaged medication.

Short DisplayCost of the packaged medication
Cardinality0..*
TypeSee MedicationKnowledge.cost
Summaryfalse
MedicationKnowledge.packaging.packagedProduct
Element IdMedicationKnowledge.packaging.packagedProduct
Definition

A reference to a PackagedProductDefinition that provides the details of the product that is in the packaging and is being priced.

Short DisplayThe packaged medication that is being priced
Cardinality0..1
TypeReference(PackagedProductDefinition)
Summaryfalse
MedicationKnowledge.clinicalUseIssue
Element IdMedicationKnowledge.clinicalUseIssue
Definition

Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).

Short DisplayPotential clinical issue with or between medication(s)
Cardinality0..*
TypeReference(ClinicalUseDefinition)
Summaryfalse
MedicationKnowledge.storageGuideline
Element IdMedicationKnowledge.storageGuideline
Definition

Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.

Short DisplayHow the medication should be stored
Cardinality0..*
Summaryfalse
MedicationKnowledge.storageGuideline.reference
Element IdMedicationKnowledge.storageGuideline.reference
Definition

Reference to additional information about the storage guidelines.

Short DisplayReference to additional information
Cardinality0..1
Typeuri
Summaryfalse
MedicationKnowledge.storageGuideline.note
Element IdMedicationKnowledge.storageGuideline.note
Definition

Additional notes about the storage.

Short DisplayAdditional storage notes
Cardinality0..*
TypeAnnotation
Summaryfalse
MedicationKnowledge.storageGuideline.stabilityDuration
Element IdMedicationKnowledge.storageGuideline.stabilityDuration
Definition

Duration that the medication remains stable if the environmentalSetting is respected.

Short DisplayDuration remains stable
Cardinality0..1
TypeDuration
Summaryfalse
MedicationKnowledge.storageGuideline.environmentalSetting
Element IdMedicationKnowledge.storageGuideline.environmentalSetting
Definition

Describes a setting/value on the environment for the adequate storage of the medication and other substances. Environment settings may involve temperature, humidity, or exposure to light.

Short DisplaySetting or value of environment for adequate storage
Cardinality0..*
Summaryfalse
MedicationKnowledge.storageGuideline.environmentalSetting.type
Element IdMedicationKnowledge.storageGuideline.environmentalSetting.type
Definition

Identifies the category or type of setting (e.g., type of location, temperature, humidity).

Short DisplayCategorization of the setting
Cardinality1..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.storageGuideline.environmentalSetting.value[x]
Element IdMedicationKnowledge.storageGuideline.environmentalSetting.value[x]
Definition

Value associated to the setting. E.g., 40° – 50°F for temperature.

Short DisplayValue of the setting
Cardinality1..1
TypeQuantity|Range|CodeableConcept
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
MedicationKnowledge.regulatory
Element IdMedicationKnowledge.regulatory
Definition

Regulatory information about a medication.

Short DisplayRegulatory information about a medication
Cardinality0..*
Summaryfalse
MedicationKnowledge.regulatory.regulatoryAuthority
Element IdMedicationKnowledge.regulatory.regulatoryAuthority
Definition

The authority that is specifying the regulations.

Short DisplaySpecifies the authority of the regulation
Cardinality1..1
TypeReference(Organization)
Summaryfalse
MedicationKnowledge.regulatory.substitution
Element IdMedicationKnowledge.regulatory.substitution
Definition

Specifies if changes are allowed when dispensing a medication from a regulatory perspective.

Short DisplaySpecifies if changes are allowed when dispensing a medication from a regulatory perspective
Cardinality0..*
Summaryfalse
MedicationKnowledge.regulatory.substitution.type
Element IdMedicationKnowledge.regulatory.substitution.type
Definition

Specifies the type of substitution allowed.

Short DisplaySpecifies the type of substitution allowed
Cardinality1..1
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.regulatory.substitution.allowed
Element IdMedicationKnowledge.regulatory.substitution.allowed
Definition

Specifies if regulation allows for changes in the medication when dispensing.

Short DisplaySpecifies if regulation allows for changes in the medication when dispensing
Cardinality1..1
Typeboolean
Summaryfalse
MedicationKnowledge.regulatory.schedule
Element IdMedicationKnowledge.regulatory.schedule
Definition

Specifies the schedule of a medication in jurisdiction.

Short DisplaySpecifies the schedule of a medication in jurisdiction
Cardinality0..*
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.regulatory.maxDispense
Element IdMedicationKnowledge.regulatory.maxDispense
Definition

The maximum number of units of the medication that can be dispensed in a period.

Short DisplayThe maximum number of units of the medication that can be dispensed in a period
Cardinality0..1
Summaryfalse
MedicationKnowledge.regulatory.maxDispense.quantity
Element IdMedicationKnowledge.regulatory.maxDispense.quantity
Definition

The maximum number of units of the medication that can be dispensed.

Short DisplayThe maximum number of units of the medication that can be dispensed
Cardinality1..1
TypeSimpleQuantity
Summaryfalse
MedicationKnowledge.regulatory.maxDispense.period
Element IdMedicationKnowledge.regulatory.maxDispense.period
Definition

The period that applies to the maximum number of units.

Short DisplayThe period that applies to the maximum number of units
Cardinality0..1
TypeDuration
Summaryfalse
MedicationKnowledge.definitional
Element IdMedicationKnowledge.definitional
Definition

Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.

Short DisplayMinimal definition information about the medication
Cardinality0..1
Summaryfalse
MedicationKnowledge.definitional.definition
Element IdMedicationKnowledge.definitional.definition
Definition

Associated definitions for this medication.

Short DisplayDefinitional resources that provide more information about this medication
Cardinality0..*
TypeReference(MedicinalProductDefinition)
Summaryfalse
MedicationKnowledge.definitional.doseForm
Element IdMedicationKnowledge.definitional.doseForm
Definition

Describes the form of the item. Powder; tablets; capsule.

Short Displaypowder | tablets | capsule +
Cardinality0..1
Terminology BindingSNOMED CT Form Codes (Example)
TypeCodeableConcept
Summaryfalse
Comments

When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.

MedicationKnowledge.definitional.intendedRoute
Element IdMedicationKnowledge.definitional.intendedRoute
Definition

The intended or approved route of administration.

Short DisplayThe intended or approved route of administration
Cardinality0..*
Terminology BindingSNOMED CT Route Codes (Example)
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.definitional.ingredient
Element IdMedicationKnowledge.definitional.ingredient
Definition

Identifies a particular constituent of interest in the product.

Short DisplayActive or inactive ingredient
Cardinality0..*
Summarytrue
MedicationKnowledge.definitional.ingredient.item
Element IdMedicationKnowledge.definitional.ingredient.item
Definition

A reference to the resource that provides information about the ingredient.

Short DisplaySubstances contained in the medication
Cardinality1..1
TypeCodeableReference(Substance)
Summarytrue
MedicationKnowledge.definitional.ingredient.type
Element IdMedicationKnowledge.definitional.ingredient.type
Definition

Indication of whether this ingredient affects the therapeutic action of the drug.

Short DisplayA code that defines the type of ingredient, active, base, etc
Cardinality0..1
Terminology BindingRoleClassIngredientEntity icon (Example)
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.definitional.ingredient.strength[x]
Element IdMedicationKnowledge.definitional.ingredient.strength[x]
Definition

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 tablet.

Short DisplayQuantity of ingredient present
Cardinality0..1
Terminology BindingMedication Ingredient Strength Codes (Example)
TypeRatio|CodeableConcept|Quantity
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
MedicationKnowledge.definitional.drugCharacteristic
Element IdMedicationKnowledge.definitional.drugCharacteristic
Definition

Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.

Short DisplaySpecifies descriptive properties of the medicine
Cardinality0..*
Summaryfalse
MedicationKnowledge.definitional.drugCharacteristic.type
Element IdMedicationKnowledge.definitional.drugCharacteristic.type
Definition

A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).

Short DisplayCode specifying the type of characteristic of medication
Cardinality0..1
Terminology BindingmedicationKnowledge Characteristic Codes (Example)
TypeCodeableConcept
Summaryfalse
MedicationKnowledge.definitional.drugCharacteristic.value[x]
Element IdMedicationKnowledge.definitional.drugCharacteristic.value[x]
Definition

Description of the characteristic.

Short DisplayDescription of the characteristic
Cardinality0..1
TypeCodeableConcept|string|SimpleQuantity|base64Binary|Attachment
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Comments

The description should be provided as a CodeableConcept, SimpleQuantity or an image. The description can be a string only when these others are not available.