R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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

Pharmacy Work GroupMaturity Level: 0 Trial Use Compartments: Not linked to any 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.

Control1..1
TypeDomainResource
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.

Control0..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 is in active use.

Control0..1
Terminology BindingMedicationKnowledgeStatus (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.manufacturer
Element IdMedicationKnowledge.manufacturer
Definition

Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.

Control0..1
TypeReference(Organization)
Summarytrue
MedicationKnowledge.doseForm
Element IdMedicationKnowledge.doseForm
Definition

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

Control0..1
Terminology BindingSNOMED CT Form Codes (Example)
TypeCodeableConcept
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.amount
Element IdMedicationKnowledge.amount
Definition

Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc).

Control0..1
TypeSimpleQuantity
Summarytrue
Comments

This is the quantity of medication in a package. To specify the strength of the medication, the Ingredient.strength attribute is used.

MedicationKnowledge.synonym
Element IdMedicationKnowledge.synonym
Definition

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

Control0..*
Typestring
Summarytrue
MedicationKnowledge.relatedMedicationKnowledge
Element IdMedicationKnowledge.relatedMedicationKnowledge
Definition

Associated or related knowledge about a medication.

Control0..*
MedicationKnowledge.relatedMedicationKnowledge.type
Element IdMedicationKnowledge.relatedMedicationKnowledge.type
Definition

The category of the associated medication knowledge reference.

Control1..1
TypeCodeableConcept
MedicationKnowledge.relatedMedicationKnowledge.reference
Element IdMedicationKnowledge.relatedMedicationKnowledge.reference
Definition

Associated documentation about the associated medication knowledge.

Control1..*
TypeReference(MedicationKnowledge)
MedicationKnowledge.associatedMedication
Element IdMedicationKnowledge.associatedMedication
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).

Control0..*
TypeReference(Medication)
MedicationKnowledge.productType
Element IdMedicationKnowledge.productType
Definition

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

Control0..*
TypeCodeableConcept
MedicationKnowledge.monograph
Element IdMedicationKnowledge.monograph
Definition

Associated documentation about the medication.

Control0..*
MedicationKnowledge.monograph.type
Element IdMedicationKnowledge.monograph.type
Definition

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

Control0..1
TypeCodeableConcept
MedicationKnowledge.monograph.source
Element IdMedicationKnowledge.monograph.source
Definition

Associated documentation about the medication.

Control0..1
TypeReference(DocumentReference | Media)
MedicationKnowledge.ingredient
Element IdMedicationKnowledge.ingredient
Definition

Identifies a particular constituent of interest in the product.

Control0..*
MedicationKnowledge.ingredient.item[x]
Element IdMedicationKnowledge.ingredient.item[x]
Definition

The actual ingredient - either a substance (simple ingredient) or another medication.

Control1..1
TypeCodeableConcept|Reference(Substance)
[x] NoteSee Choice of Data Types for further information about how to use [x]
MedicationKnowledge.ingredient.isActive
Element IdMedicationKnowledge.ingredient.isActive
Definition

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

Control0..1
Typeboolean
Requirements

True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).

MedicationKnowledge.ingredient.strength
Element IdMedicationKnowledge.ingredient.strength
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.

Control0..1
TypeRatio
MedicationKnowledge.preparationInstruction
Element IdMedicationKnowledge.preparationInstruction
Definition

The instructions for preparing the medication.

Control0..1
Typemarkdown
MedicationKnowledge.intendedRoute
Element IdMedicationKnowledge.intendedRoute
Definition

The intended or approved route of administration.

Control0..*
Terminology BindingSNOMED CT Route Codes (Example)
TypeCodeableConcept
MedicationKnowledge.cost
Element IdMedicationKnowledge.cost
Definition

The price of the medication.

Control0..*
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.

Control1..1
TypeCodeableConcept
MedicationKnowledge.cost.source
Element IdMedicationKnowledge.cost.source
Definition

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

Control0..1
Typestring
MedicationKnowledge.cost.cost
Element IdMedicationKnowledge.cost.cost
Definition

The price of the medication.

Control1..1
TypeMoney
MedicationKnowledge.monitoringProgram
Element IdMedicationKnowledge.monitoringProgram
Definition

The program under which the medication is reviewed.

Control0..*
MedicationKnowledge.monitoringProgram.type
Element IdMedicationKnowledge.monitoringProgram.type
Definition

Type of program under which the medication is monitored.

Control0..1
TypeCodeableConcept
MedicationKnowledge.monitoringProgram.name
Element IdMedicationKnowledge.monitoringProgram.name
Definition

Name of the reviewing program.

Control0..1
Typestring
MedicationKnowledge.administrationGuidelines
Element IdMedicationKnowledge.administrationGuidelines
Definition

Guidelines for the administration of the medication.

Control0..*
MedicationKnowledge.administrationGuidelines.dosage
Element IdMedicationKnowledge.administrationGuidelines.dosage
Definition

Dosage for the medication for the specific guidelines.

Control0..*
MedicationKnowledge.administrationGuidelines.dosage.type
Element IdMedicationKnowledge.administrationGuidelines.dosage.type
Definition

The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc).

Control1..1
TypeCodeableConcept
MedicationKnowledge.administrationGuidelines.dosage.dosage
Element IdMedicationKnowledge.administrationGuidelines.dosage.dosage
Definition

Dosage for the medication for the specific guidelines.

Control1..*
TypeDosage
MedicationKnowledge.administrationGuidelines.indication[x]
Element IdMedicationKnowledge.administrationGuidelines.indication[x]
Definition

Indication for use that apply to the specific administration guidelines.

Control0..1
TypeCodeableConcept|Reference(ObservationDefinition)
[x] NoteSee Choice of Data Types for further information about how to use [x]
MedicationKnowledge.administrationGuidelines.patientCharacteristics
Element IdMedicationKnowledge.administrationGuidelines.patientCharacteristics
Definition

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

Control0..*
MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x]
Element IdMedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x]
Definition

Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).

Control1..1
TypeCodeableConcept|SimpleQuantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
MedicationKnowledge.administrationGuidelines.patientCharacteristics.value
Element IdMedicationKnowledge.administrationGuidelines.patientCharacteristics.value
Definition

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

Control0..*
Typestring
MedicationKnowledge.medicineClassification
Element IdMedicationKnowledge.medicineClassification
Definition

Categorization of the medication within a formulary or classification system.

Control0..*
MedicationKnowledge.medicineClassification.type
Element IdMedicationKnowledge.medicineClassification.type
Definition

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

Control1..1
TypeCodeableConcept
MedicationKnowledge.medicineClassification.classification
Element IdMedicationKnowledge.medicineClassification.classification
Definition

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

Control0..*
TypeCodeableConcept
MedicationKnowledge.packaging
Element IdMedicationKnowledge.packaging
Definition

Information that only applies to packages (not products).

Control0..1
MedicationKnowledge.packaging.type
Element IdMedicationKnowledge.packaging.type
Definition

A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle).

Control0..1
Terminology BindingMedicationPackageType (Example)
TypeCodeableConcept
MedicationKnowledge.packaging.quantity
Element IdMedicationKnowledge.packaging.quantity
Definition

The number of product units the package would contain if fully loaded.

Control0..1
TypeSimpleQuantity
MedicationKnowledge.drugCharacteristic
Element IdMedicationKnowledge.drugCharacteristic
Definition

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

Control0..*
MedicationKnowledge.drugCharacteristic.type
Element IdMedicationKnowledge.drugCharacteristic.type
Definition

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

Control0..1
TypeCodeableConcept
MedicationKnowledge.drugCharacteristic.value[x]
Element IdMedicationKnowledge.drugCharacteristic.value[x]
Definition

Description of the characteristic.

Control0..1
TypeCodeableConcept|string|SimpleQuantity|base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
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.

MedicationKnowledge.contraindication
Element IdMedicationKnowledge.contraindication
Definition

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

Control0..*
TypeReference(DetectedIssue)
MedicationKnowledge.regulatory
Element IdMedicationKnowledge.regulatory
Definition

Regulatory information about a medication.

Control0..*
MedicationKnowledge.regulatory.regulatoryAuthority
Element IdMedicationKnowledge.regulatory.regulatoryAuthority
Definition

The authority that is specifying the regulations.

Control1..1
TypeReference(Organization)
MedicationKnowledge.regulatory.substitution
Element IdMedicationKnowledge.regulatory.substitution
Definition

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

Control0..*
MedicationKnowledge.regulatory.substitution.type
Element IdMedicationKnowledge.regulatory.substitution.type
Definition

Specifies the type of substitution allowed.

Control1..1
TypeCodeableConcept
MedicationKnowledge.regulatory.substitution.allowed
Element IdMedicationKnowledge.regulatory.substitution.allowed
Definition

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

Control1..1
Typeboolean
MedicationKnowledge.regulatory.schedule
Element IdMedicationKnowledge.regulatory.schedule
Definition

Specifies the schedule of a medication in jurisdiction.

Control0..*
MedicationKnowledge.regulatory.schedule.schedule
Element IdMedicationKnowledge.regulatory.schedule.schedule
Definition

Specifies the specific drug schedule.

Control1..1
TypeCodeableConcept
MedicationKnowledge.regulatory.maxDispense
Element IdMedicationKnowledge.regulatory.maxDispense
Definition

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

Control0..1
MedicationKnowledge.regulatory.maxDispense.quantity
Element IdMedicationKnowledge.regulatory.maxDispense.quantity
Definition

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

Control1..1
TypeSimpleQuantity
MedicationKnowledge.regulatory.maxDispense.period
Element IdMedicationKnowledge.regulatory.maxDispense.period
Definition

The period that applies to the maximum number of units.

Control0..1
TypeDuration
MedicationKnowledge.kinetics
Element IdMedicationKnowledge.kinetics
Definition

The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

Control0..*
MedicationKnowledge.kinetics.areaUnderCurve
Element IdMedicationKnowledge.kinetics.areaUnderCurve
Definition

The drug concentration measured at certain discrete points in time.

Control0..*
TypeSimpleQuantity
MedicationKnowledge.kinetics.lethalDose50
Element IdMedicationKnowledge.kinetics.lethalDose50
Definition

The median lethal dose of a drug.

Control0..*
TypeSimpleQuantity
MedicationKnowledge.kinetics.halfLifePeriod
Element IdMedicationKnowledge.kinetics.halfLifePeriod
Definition

The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half.

Control0..1
TypeDuration