Release 4B Snapshot #1

This page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

11.6 Resource MedicationKnowledge - Content

Pharmacy Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Information about a medication that is used to support knowledge.

11.6.1 Scope and Usage

Note that this content is preliminary has not undergone proper review by the appropriate Workgroups.

This resource supports use cases for creation of and querying for drug information including attributes such as drug classifications, images of medications, drug costs and/or coverages, etc. This resource can be used to return drug information as part of a formulary or a catalogue.

11.6.2 References

This resource is referenced by itself.

This resource does not implement any patterns.

11.6.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge TUDomainResourceDefinition of Medication Knowledge
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... code Σ0..1CodeableConceptCode that identifies this medication
SNOMED CT Medication Codes (Example)
... status ?!Σ0..1codeactive | inactive | entered-in-error
MedicationKnowledge Status Codes (Required)
... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... amount Σ0..1SimpleQuantityAmount of drug in package
... synonym Σ0..*stringAdditional names for a medication
... relatedMedicationKnowledge 0..*BackboneElementAssociated or related medication information
.... type 1..1CodeableConceptCategory of medicationKnowledge
.... reference 1..*Reference(MedicationKnowledge)Associated documentation about the associated medication knowledge
... associatedMedication 0..*Reference(Medication)A medication resource that is associated with this medication
... productType 0..*CodeableConceptCategory of the medication or product
... monograph 0..*BackboneElementAssociated documentation about the medication
.... type 0..1CodeableConceptThe category of medication document
.... source 0..1Reference(DocumentReference | Media)Associated documentation about the medication
... ingredient 0..*BackboneElementActive or inactive ingredient
.... item[x] 1..1Medication(s) or substance(s) contained in the medication
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... preparationInstruction 0..1markdownThe instructions for preparing the medication
... intendedRoute 0..*CodeableConceptThe intended or approved route of administration
SNOMED CT Route Codes (Example)
... cost 0..*BackboneElementThe pricing of the medication
.... type 1..1CodeableConceptThe category of the cost information
.... source 0..1stringThe source or owner for the price information
.... cost 1..1MoneyThe price of the medication
... monitoringProgram 0..*BackboneElementProgram under which a medication is reviewed
.... type 0..1CodeableConceptType of program under which the medication is monitored
.... name 0..1stringName of the reviewing program
... administrationGuidelines 0..*BackboneElementGuidelines for administration of the medication
.... dosage 0..*BackboneElementDosage for the medication for the specific guidelines
..... type 1..1CodeableConceptType of dosage
..... dosage 1..*DosageDosage for the medication for the specific guidelines
.... indication[x] 0..1Indication for use that apply to the specific administration guidelines
..... indicationCodeableConceptCodeableConcept
..... indicationReferenceReference(ObservationDefinition)
.... patientCharacteristics 0..*BackboneElementCharacteristics of the patient that are relevant to the administration guidelines
..... characteristic[x] 1..1Specific characteristic that is relevant to the administration guideline
...... characteristicCodeableConceptCodeableConcept
...... characteristicQuantitySimpleQuantity
..... value 0..*stringThe specific characteristic
... medicineClassification 0..*BackboneElementCategorization of the medication within a formulary or classification system
.... type 1..1CodeableConceptThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... classification 0..*CodeableConceptSpecific category assigned to the medication
... packaging 0..1BackboneElementDetails about packaged medications
.... type 0..1CodeableConceptA code that defines the specific type of packaging that the medication can be found in
medicationKnowledge Package Type Codes (Example)
.... quantity 0..1SimpleQuantityThe number of product units the package would contain if fully loaded
... drugCharacteristic 0..*BackboneElementSpecifies descriptive properties of the medicine
.... type 0..1CodeableConceptCode specifying the type of characteristic of medication
medicationKnowledge Characteristic Codes (Example)
.... value[x] 0..1Description of the characteristic
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueQuantitySimpleQuantity
..... valueBase64Binarybase64Binary
... contraindication 0..*Reference(DetectedIssue)Potential clinical issue with or between medication(s)
... regulatory 0..*BackboneElementRegulatory information about a medication
.... regulatoryAuthority 1..1Reference(Organization)Specifies the authority of the regulation
.... substitution 0..*BackboneElementSpecifies if changes are allowed when dispensing a medication from a regulatory perspective
..... type 1..1CodeableConceptSpecifies the type of substitution allowed
..... allowed 1..1booleanSpecifies if regulation allows for changes in the medication when dispensing
.... schedule 0..*BackboneElementSpecifies the schedule of a medication in jurisdiction
..... schedule 1..1CodeableConceptSpecifies the specific drug schedule
.... maxDispense 0..1BackboneElementThe maximum number of units of the medication that can be dispensed in a period
..... quantity 1..1SimpleQuantityThe maximum number of units of the medication that can be dispensed
..... period 0..1DurationThe period that applies to the maximum number of units
... kinetics 0..*BackboneElementThe time course of drug absorption, distribution, metabolism and excretion of a medication from the body
.... areaUnderCurve 0..*SimpleQuantityThe drug concentration measured at certain discrete points in time
.... lethalDose50 0..*SimpleQuantityThe median lethal dose of a drug
.... halfLifePeriod 0..1DurationTime required for concentration in the body to decrease by half

doco Documentation for this format

UML Diagram (Legend)

MedicationKnowledge (DomainResource)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 systemscode : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTMedicationCodes?? »A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)MedicationKnowledge Status ! »Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication productmanufacturer : Reference [0..1] « Organization »Describes the form of the item. Powder; tablets; capsuledoseForm : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTFormCodes?? »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.)amount : Quantity(SimpleQuantity) [0..1]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 albuterolsynonym : string [0..*]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)associatedMedication : Reference [0..*] « Medication »Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.)productType : CodeableConcept [0..*]The instructions for preparing the medicationpreparationInstruction : markdown [0..1]The intended or approved route of administrationintendedRoute : CodeableConcept [0..*] « null (Strength=Example)SNOMEDCTRouteCodes?? »Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.)contraindication : Reference [0..*] « DetectedIssue »RelatedMedicationKnowledgeThe category of the associated medication knowledge referencetype : CodeableConcept [1..1]Associated documentation about the associated medication knowledgereference : Reference [1..*] « MedicationKnowledge »MonographThe category of documentation about the medication. (e.g. professional monograph, patient education monograph)type : CodeableConcept [0..1]Associated documentation about the medicationsource : Reference [0..1] « DocumentReference|Media »IngredientThe actual ingredient - either a substance (simple ingredient) or another medicationitem[x] : Element [1..1] « CodeableConcept|Reference(Substance) »Indication of whether this ingredient affects the therapeutic action of the drugisActive : boolean [0..1]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 tabletstrength : Ratio [0..1]CostThe category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition costtype : CodeableConcept [1..1]The source or owner that assigns the price to the medicationsource : string [0..1]The price of the medicationcost : Money [1..1]MonitoringProgramType of program under which the medication is monitoredtype : CodeableConcept [0..1]Name of the reviewing programname : string [0..1]AdministrationGuidelinesIndication for use that apply to the specific administration guidelinesindication[x] : Element [0..1] « CodeableConcept|Reference( ObservationDefinition) »DosageThe type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.)type : CodeableConcept [1..1]Dosage for the medication for the specific guidelinesdosage : Dosage [1..*]PatientCharacteristicsSpecific characteristic that is relevant to the administration guideline (e.g. height, weight, gender)characteristic[x] : Element [1..1] « CodeableConcept|Quantity(SimpleQuantity) »The specific characteristic (e.g. height, weight, gender, etc.)value : string [0..*]MedicineClassificationThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)type : CodeableConcept [1..1]Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.)classification : CodeableConcept [0..*]PackagingA code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle)type : CodeableConcept [0..1] « null (Strength=Example)medicationKnowledge Package T...?? »The number of product units the package would contain if fully loadedquantity : Quantity(SimpleQuantity) [0..1]DrugCharacteristicA code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint)type : CodeableConcept [0..1] « null (Strength=Example)medicationKnowledge Character...?? »Description of the characteristicvalue[x] : Element [0..1] « CodeableConcept|string|Quantity(SimpleQuantity)| base64Binary »RegulatoryThe authority that is specifying the regulationsregulatoryAuthority : Reference [1..1] « Organization »SubstitutionSpecifies the type of substitution allowedtype : CodeableConcept [1..1]Specifies if regulation allows for changes in the medication when dispensingallowed : boolean [1..1]ScheduleSpecifies the specific drug scheduleschedule : CodeableConcept [1..1]MaxDispenseThe maximum number of units of the medication that can be dispensedquantity : Quantity(SimpleQuantity) [1..1]The period that applies to the maximum number of unitsperiod : Duration [0..1]KineticsThe drug concentration measured at certain discrete points in timeareaUnderCurve : Quantity(SimpleQuantity) [0..*]The median lethal dose of a druglethalDose50 : Quantity(SimpleQuantity) [0..*]The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by halfhalfLifePeriod : Duration [0..1]Associated or related knowledge about a medicationrelatedMedicationKnowledge[0..*]Associated documentation about the medicationmonograph[0..*]Identifies a particular constituent of interest in the productingredient[0..*]The price of the medicationcost[0..*]The program under which the medication is reviewedmonitoringProgram[0..*]Dosage for the medication for the specific guidelinesdosage[0..*]Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.)patientCharacteristics[0..*]Guidelines for the administration of the medicationadministrationGuidelines[0..*]Categorization of the medication within a formulary or classification systemmedicineClassification[0..*]Information that only applies to packages (not products)packaging[0..1]Specifies descriptive properties of the medicine, such as color, shape, imprints, etcdrugCharacteristic[0..*]Specifies if changes are allowed when dispensing a medication from a regulatory perspectivesubstitution[0..*]Specifies the schedule of a medication in jurisdictionschedule[0..*]The maximum number of units of the medication that can be dispensed in a periodmaxDispense[0..1]Regulatory information about a medicationregulatory[0..*]The time course of drug absorption, distribution, metabolism and excretion of a medication from the bodykinetics[0..*]

XML Template

<MedicationKnowledge xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <code><!-- 0..1 CodeableConcept Code that identifies this medication --></code>
 <status value="[code]"/><!-- 0..1 active | inactive | entered-in-error -->
 <manufacturer><!-- 0..1 Reference(Organization) Manufacturer of the item --></manufacturer>
 <doseForm><!-- 0..1 CodeableConcept powder | tablets | capsule + --></doseForm>
 <amount><!-- 0..1 Quantity(SimpleQuantity) Amount of drug in package --></amount>
 <synonym value="[string]"/><!-- 0..* Additional names for a medication -->
 <relatedMedicationKnowledge>  <!-- 0..* Associated or related medication information -->
  <type><!-- 1..1 CodeableConcept Category of medicationKnowledge --></type>
  <reference><!-- 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge --></reference>
 </relatedMedicationKnowledge>
 <associatedMedication><!-- 0..* Reference(Medication) A medication resource that is associated with this medication --></associatedMedication>
 <productType><!-- 0..* CodeableConcept Category of the medication or product --></productType>
 <monograph>  <!-- 0..* Associated documentation about the medication -->
  <type><!-- 0..1 CodeableConcept The category of medication document --></type>
  <source><!-- 0..1 Reference(DocumentReference|Media) Associated documentation about the medication --></source>
 </monograph>
 <ingredient>  <!-- 0..* Active or inactive ingredient -->
  <item[x]><!-- 1..1 CodeableConcept|Reference(Substance) Medication(s) or substance(s) contained in the medication --></item[x]>
  <isActive value="[boolean]"/><!-- 0..1 Active ingredient indicator -->
  <strength><!-- 0..1 Ratio Quantity of ingredient present --></strength>
 </ingredient>
 <preparationInstruction value="[markdown]"/><!-- 0..1 The instructions for preparing the medication -->
 <intendedRoute><!-- 0..* CodeableConcept The intended or approved route of administration --></intendedRoute>
 <cost>  <!-- 0..* The pricing of the medication -->
  <type><!-- 1..1 CodeableConcept The category of the cost information --></type>
  <source value="[string]"/><!-- 0..1 The source or owner for the price information -->
  <cost><!-- 1..1 Money The price of the medication --></cost>
 </cost>
 <monitoringProgram>  <!-- 0..* Program under which a medication is reviewed -->
  <type><!-- 0..1 CodeableConcept Type of program under which the medication is monitored --></type>
  <name value="[string]"/><!-- 0..1 Name of the reviewing program -->
 </monitoringProgram>
 <administrationGuidelines>  <!-- 0..* Guidelines for administration of the medication -->
  <dosage>  <!-- 0..* Dosage for the medication for the specific guidelines -->
   <type><!-- 1..1 CodeableConcept Type of dosage --></type>
   <dosage><!-- 1..* Dosage Dosage for the medication for the specific guidelines --></dosage>
  </dosage>
  <indication[x]><!-- 0..1 CodeableConcept|Reference(ObservationDefinition) Indication for use that apply to the specific administration guidelines --></indication[x]>
  <patientCharacteristics>  <!-- 0..* Characteristics of the patient that are relevant to the administration guidelines -->
   <characteristic[x]><!-- 1..1 CodeableConcept|Quantity(SimpleQuantity) Specific characteristic that is relevant to the administration guideline --></characteristic[x]>
   <value value="[string]"/><!-- 0..* The specific characteristic -->
  </patientCharacteristics>
 </administrationGuidelines>
 <medicineClassification>  <!-- 0..* Categorization of the medication within a formulary or classification system -->
  <type><!-- 1..1 CodeableConcept The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) --></type>
  <classification><!-- 0..* CodeableConcept Specific category assigned to the medication --></classification>
 </medicineClassification>
 <packaging>  <!-- 0..1 Details about packaged medications -->
  <type><!-- 0..1 CodeableConcept A code that defines the specific type of packaging that the medication can be found in --></type>
  <quantity><!-- 0..1 Quantity(SimpleQuantity) The number of product units the package would contain if fully loaded --></quantity>
 </packaging>
 <drugCharacteristic>  <!-- 0..* Specifies descriptive properties of the medicine -->
  <type><!-- 0..1 CodeableConcept Code specifying the type of characteristic of medication --></type>
  <value[x]><!-- 0..1 CodeableConcept|string|Quantity(SimpleQuantity)|
    base64Binary Description of the characteristic --></value[x]>
 </drugCharacteristic>
 <contraindication><!-- 0..* Reference(DetectedIssue) Potential clinical issue with or between medication(s) --></contraindication>
 <regulatory>  <!-- 0..* Regulatory information about a medication -->
  <regulatoryAuthority><!-- 1..1 Reference(Organization) Specifies the authority of the regulation --></regulatoryAuthority>
  <substitution>  <!-- 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective -->
   <type><!-- 1..1 CodeableConcept Specifies the type of substitution allowed --></type>
   <allowed value="[boolean]"/><!-- 1..1 Specifies if regulation allows for changes in the medication when dispensing -->
  </substitution>
  <schedule>  <!-- 0..* Specifies the schedule of a medication in jurisdiction -->
   <schedule><!-- 1..1 CodeableConcept Specifies the specific drug schedule --></schedule>
  </schedule>
  <maxDispense>  <!-- 0..1 The maximum number of units of the medication that can be dispensed in a period -->
   <quantity><!-- 1..1 Quantity(SimpleQuantity) The maximum number of units of the medication that can be dispensed --></quantity>
   <period><!-- 0..1 Duration The period that applies to the maximum number of units --></period>
  </maxDispense>
 </regulatory>
 <kinetics>  <!-- 0..* The time course of drug absorption, distribution, metabolism and excretion of a medication from the body -->
  <areaUnderCurve><!-- 0..* Quantity(SimpleQuantity) The drug concentration measured at certain discrete points in time --></areaUnderCurve>
  <lethalDose50><!-- 0..* Quantity(SimpleQuantity) The median lethal dose of a drug --></lethalDose50>
  <halfLifePeriod><!-- 0..1 Duration Time required for concentration in the body to decrease by half --></halfLifePeriod>
 </kinetics>
</MedicationKnowledge>

JSON Template

{doco
  "resourceType" : "MedicationKnowledge",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "code" : { CodeableConcept }, // Code that identifies this medication
  "status" : "<code>", // active | inactive | entered-in-error
  "manufacturer" : { Reference(Organization) }, // Manufacturer of the item
  "doseForm" : { CodeableConcept }, // powder | tablets | capsule +
  "amount" : { Quantity(SimpleQuantity) }, // Amount of drug in package
  "synonym" : ["<string>"], // Additional names for a medication
  "relatedMedicationKnowledge" : [{ // Associated or related medication information
    "type" : { CodeableConcept }, // R!  Category of medicationKnowledge
    "reference" : [{ Reference(MedicationKnowledge) }] // R!  Associated documentation about the associated medication knowledge
  }],
  "associatedMedication" : [{ Reference(Medication) }], // A medication resource that is associated with this medication
  "productType" : [{ CodeableConcept }], // Category of the medication or product
  "monograph" : [{ // Associated documentation about the medication
    "type" : { CodeableConcept }, // The category of medication document
    "source" : { Reference(DocumentReference|Media) } // Associated documentation about the medication
  }],
  "ingredient" : [{ // Active or inactive ingredient
    // item[x]: Medication(s) or substance(s) contained in the medication. One of these 2:
    "itemCodeableConcept" : { CodeableConcept },
    "itemReference" : { Reference(Substance) },
    "isActive" : <boolean>, // Active ingredient indicator
    "strength" : { Ratio } // Quantity of ingredient present
  }],
  "preparationInstruction" : "<markdown>", // The instructions for preparing the medication
  "intendedRoute" : [{ CodeableConcept }], // The intended or approved route of administration
  "cost" : [{ // The pricing of the medication
    "type" : { CodeableConcept }, // R!  The category of the cost information
    "source" : "<string>", // The source or owner for the price information
    "cost" : { Money } // R!  The price of the medication
  }],
  "monitoringProgram" : [{ // Program under which a medication is reviewed
    "type" : { CodeableConcept }, // Type of program under which the medication is monitored
    "name" : "<string>" // Name of the reviewing program
  }],
  "administrationGuidelines" : [{ // Guidelines for administration of the medication
    "dosage" : [{ // Dosage for the medication for the specific guidelines
      "type" : { CodeableConcept }, // R!  Type of dosage
      "dosage" : [{ Dosage }] // R!  Dosage for the medication for the specific guidelines
    }],
    // indication[x]: Indication for use that apply to the specific administration guidelines. One of these 2:
    "indicationCodeableConcept" : { CodeableConcept },
    "indicationReference" : { Reference(ObservationDefinition) },
    "patientCharacteristics" : [{ // Characteristics of the patient that are relevant to the administration guidelines
      // characteristic[x]: Specific characteristic that is relevant to the administration guideline. One of these 2:
      "characteristicCodeableConcept" : { CodeableConcept },
      "characteristicQuantity" : { Quantity(SimpleQuantity) },
      "value" : ["<string>"] // The specific characteristic
    }]
  }],
  "medicineClassification" : [{ // Categorization of the medication within a formulary or classification system
    "type" : { CodeableConcept }, // R!  The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
    "classification" : [{ CodeableConcept }] // Specific category assigned to the medication
  }],
  "packaging" : { // Details about packaged medications
    "type" : { CodeableConcept }, // A code that defines the specific type of packaging that the medication can be found in
    "quantity" : { Quantity(SimpleQuantity) } // The number of product units the package would contain if fully loaded
  },
  "drugCharacteristic" : [{ // Specifies descriptive properties of the medicine
    "type" : { CodeableConcept }, // Code specifying the type of characteristic of medication
    // value[x]: Description of the characteristic. One of these 4:
    "valueCodeableConcept" : { CodeableConcept }
    "valueString" : "<string>"
    "valueQuantity" : { Quantity(SimpleQuantity) }
    "valueBase64Binary" : "<base64Binary>"
  }],
  "contraindication" : [{ Reference(DetectedIssue) }], // Potential clinical issue with or between medication(s)
  "regulatory" : [{ // Regulatory information about a medication
    "regulatoryAuthority" : { Reference(Organization) }, // R!  Specifies the authority of the regulation
    "substitution" : [{ // Specifies if changes are allowed when dispensing a medication from a regulatory perspective
      "type" : { CodeableConcept }, // R!  Specifies the type of substitution allowed
      "allowed" : <boolean> // R!  Specifies if regulation allows for changes in the medication when dispensing
    }],
    "schedule" : [{ // Specifies the schedule of a medication in jurisdiction
      "schedule" : { CodeableConcept } // R!  Specifies the specific drug schedule
    }],
    "maxDispense" : { // The maximum number of units of the medication that can be dispensed in a period
      "quantity" : { Quantity(SimpleQuantity) }, // R!  The maximum number of units of the medication that can be dispensed
      "period" : { Duration } // The period that applies to the maximum number of units
    }
  }],
  "kinetics" : [{ // The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
    "areaUnderCurve" : [{ Quantity(SimpleQuantity) }], // The drug concentration measured at certain discrete points in time
    "lethalDose50" : [{ Quantity(SimpleQuantity) }], // The median lethal dose of a drug
    "halfLifePeriod" : { Duration } // Time required for concentration in the body to decrease by half
  }]
}

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:MedicationKnowledge.code [ CodeableConcept ]; # 0..1 Code that identifies this medication
  fhir:MedicationKnowledge.status [ code ]; # 0..1 active | inactive | entered-in-error
  fhir:MedicationKnowledge.manufacturer [ Reference(Organization) ]; # 0..1 Manufacturer of the item
  fhir:MedicationKnowledge.doseForm [ CodeableConcept ]; # 0..1 powder | tablets | capsule +
  fhir:MedicationKnowledge.amount [ Quantity(SimpleQuantity) ]; # 0..1 Amount of drug in package
  fhir:MedicationKnowledge.synonym [ string ], ... ; # 0..* Additional names for a medication
  fhir:MedicationKnowledge.relatedMedicationKnowledge [ # 0..* Associated or related medication information
    fhir:MedicationKnowledge.relatedMedicationKnowledge.type [ CodeableConcept ]; # 1..1 Category of medicationKnowledge
    fhir:MedicationKnowledge.relatedMedicationKnowledge.reference [ Reference(MedicationKnowledge) ], ... ; # 1..* Associated documentation about the associated medication knowledge
  ], ...;
  fhir:MedicationKnowledge.associatedMedication [ Reference(Medication) ], ... ; # 0..* A medication resource that is associated with this medication
  fhir:MedicationKnowledge.productType [ CodeableConcept ], ... ; # 0..* Category of the medication or product
  fhir:MedicationKnowledge.monograph [ # 0..* Associated documentation about the medication
    fhir:MedicationKnowledge.monograph.type [ CodeableConcept ]; # 0..1 The category of medication document
    fhir:MedicationKnowledge.monograph.source [ Reference(DocumentReference|Media) ]; # 0..1 Associated documentation about the medication
  ], ...;
  fhir:MedicationKnowledge.ingredient [ # 0..* Active or inactive ingredient
    # MedicationKnowledge.ingredient.item[x] : 1..1 Medication(s) or substance(s) contained in the medication. One of these 2
      fhir:MedicationKnowledge.ingredient.itemCodeableConcept [ CodeableConcept ]
      fhir:MedicationKnowledge.ingredient.itemReference [ Reference(Substance) ]
    fhir:MedicationKnowledge.ingredient.isActive [ boolean ]; # 0..1 Active ingredient indicator
    fhir:MedicationKnowledge.ingredient.strength [ Ratio ]; # 0..1 Quantity of ingredient present
  ], ...;
  fhir:MedicationKnowledge.preparationInstruction [ markdown ]; # 0..1 The instructions for preparing the medication
  fhir:MedicationKnowledge.intendedRoute [ CodeableConcept ], ... ; # 0..* The intended or approved route of administration
  fhir:MedicationKnowledge.cost [ # 0..* The pricing of the medication
    fhir:MedicationKnowledge.cost.type [ CodeableConcept ]; # 1..1 The category of the cost information
    fhir:MedicationKnowledge.cost.source [ string ]; # 0..1 The source or owner for the price information
    fhir:MedicationKnowledge.cost.cost [ Money ]; # 1..1 The price of the medication
  ], ...;
  fhir:MedicationKnowledge.monitoringProgram [ # 0..* Program under which a medication is reviewed
    fhir:MedicationKnowledge.monitoringProgram.type [ CodeableConcept ]; # 0..1 Type of program under which the medication is monitored
    fhir:MedicationKnowledge.monitoringProgram.name [ string ]; # 0..1 Name of the reviewing program
  ], ...;
  fhir:MedicationKnowledge.administrationGuidelines [ # 0..* Guidelines for administration of the medication
    fhir:MedicationKnowledge.administrationGuidelines.dosage [ # 0..* Dosage for the medication for the specific guidelines
      fhir:MedicationKnowledge.administrationGuidelines.dosage.type [ CodeableConcept ]; # 1..1 Type of dosage
      fhir:MedicationKnowledge.administrationGuidelines.dosage.dosage [ Dosage ], ... ; # 1..* Dosage for the medication for the specific guidelines
    ], ...;
    # MedicationKnowledge.administrationGuidelines.indication[x] : 0..1 Indication for use that apply to the specific administration guidelines. One of these 2
      fhir:MedicationKnowledge.administrationGuidelines.indicationCodeableConcept [ CodeableConcept ]
      fhir:MedicationKnowledge.administrationGuidelines.indicationReference [ Reference(ObservationDefinition) ]
    fhir:MedicationKnowledge.administrationGuidelines.patientCharacteristics [ # 0..* Characteristics of the patient that are relevant to the administration guidelines
      # MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x] : 1..1 Specific characteristic that is relevant to the administration guideline. One of these 2
        fhir:MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristicCodeableConcept [ CodeableConcept ]
        fhir:MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristicSimpleQuantity [ Quantity(SimpleQuantity) ]
      fhir:MedicationKnowledge.administrationGuidelines.patientCharacteristics.value [ string ], ... ; # 0..* The specific characteristic
    ], ...;
  ], ...;
  fhir:MedicationKnowledge.medicineClassification [ # 0..* Categorization of the medication within a formulary or classification system
    fhir:MedicationKnowledge.medicineClassification.type [ CodeableConcept ]; # 1..1 The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
    fhir:MedicationKnowledge.medicineClassification.classification [ CodeableConcept ], ... ; # 0..* Specific category assigned to the medication
  ], ...;
  fhir:MedicationKnowledge.packaging [ # 0..1 Details about packaged medications
    fhir:MedicationKnowledge.packaging.type [ CodeableConcept ]; # 0..1 A code that defines the specific type of packaging that the medication can be found in
    fhir:MedicationKnowledge.packaging.quantity [ Quantity(SimpleQuantity) ]; # 0..1 The number of product units the package would contain if fully loaded
  ];
  fhir:MedicationKnowledge.drugCharacteristic [ # 0..* Specifies descriptive properties of the medicine
    fhir:MedicationKnowledge.drugCharacteristic.type [ CodeableConcept ]; # 0..1 Code specifying the type of characteristic of medication
    # MedicationKnowledge.drugCharacteristic.value[x] : 0..1 Description of the characteristic. One of these 4
      fhir:MedicationKnowledge.drugCharacteristic.valueCodeableConcept [ CodeableConcept ]
      fhir:MedicationKnowledge.drugCharacteristic.valueString [ string ]
      fhir:MedicationKnowledge.drugCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ]
      fhir:MedicationKnowledge.drugCharacteristic.valueBase64Binary [ base64Binary ]
  ], ...;
  fhir:MedicationKnowledge.contraindication [ Reference(DetectedIssue) ], ... ; # 0..* Potential clinical issue with or between medication(s)
  fhir:MedicationKnowledge.regulatory [ # 0..* Regulatory information about a medication
    fhir:MedicationKnowledge.regulatory.regulatoryAuthority [ Reference(Organization) ]; # 1..1 Specifies the authority of the regulation
    fhir:MedicationKnowledge.regulatory.substitution [ # 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective
      fhir:MedicationKnowledge.regulatory.substitution.type [ CodeableConcept ]; # 1..1 Specifies the type of substitution allowed
      fhir:MedicationKnowledge.regulatory.substitution.allowed [ boolean ]; # 1..1 Specifies if regulation allows for changes in the medication when dispensing
    ], ...;
    fhir:MedicationKnowledge.regulatory.schedule [ # 0..* Specifies the schedule of a medication in jurisdiction
      fhir:MedicationKnowledge.regulatory.schedule.schedule [ CodeableConcept ]; # 1..1 Specifies the specific drug schedule
    ], ...;
    fhir:MedicationKnowledge.regulatory.maxDispense [ # 0..1 The maximum number of units of the medication that can be dispensed in a period
      fhir:MedicationKnowledge.regulatory.maxDispense.quantity [ Quantity(SimpleQuantity) ]; # 1..1 The maximum number of units of the medication that can be dispensed
      fhir:MedicationKnowledge.regulatory.maxDispense.period [ Duration ]; # 0..1 The period that applies to the maximum number of units
    ];
  ], ...;
  fhir:MedicationKnowledge.kinetics [ # 0..* The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
    fhir:MedicationKnowledge.kinetics.areaUnderCurve [ Quantity(SimpleQuantity) ], ... ; # 0..* The drug concentration measured at certain discrete points in time
    fhir:MedicationKnowledge.kinetics.lethalDose50 [ Quantity(SimpleQuantity) ], ... ; # 0..* The median lethal dose of a drug
    fhir:MedicationKnowledge.kinetics.halfLifePeriod [ Duration ]; # 0..1 Time required for concentration in the body to decrease by half
  ], ...;
]

Changes since R3

MedicationKnowledge
MedicationKnowledge.status
  • Change value set from http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.0 to http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.3.0-snapshot1
MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x]
  • Add Type Quantity()
  • Remove Type Quantity()
MedicationKnowledge.drugCharacteristic.value[x]
  • Add Type Quantity()
  • Remove Type Quantity()

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge TUDomainResourceDefinition of Medication Knowledge
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... code Σ0..1CodeableConceptCode that identifies this medication
SNOMED CT Medication Codes (Example)
... status ?!Σ0..1codeactive | inactive | entered-in-error
MedicationKnowledge Status Codes (Required)
... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... amount Σ0..1SimpleQuantityAmount of drug in package
... synonym Σ0..*stringAdditional names for a medication
... relatedMedicationKnowledge 0..*BackboneElementAssociated or related medication information
.... type 1..1CodeableConceptCategory of medicationKnowledge
.... reference 1..*Reference(MedicationKnowledge)Associated documentation about the associated medication knowledge
... associatedMedication 0..*Reference(Medication)A medication resource that is associated with this medication
... productType 0..*CodeableConceptCategory of the medication or product
... monograph 0..*BackboneElementAssociated documentation about the medication
.... type 0..1CodeableConceptThe category of medication document
.... source 0..1Reference(DocumentReference | Media)Associated documentation about the medication
... ingredient 0..*BackboneElementActive or inactive ingredient
.... item[x] 1..1Medication(s) or substance(s) contained in the medication
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... preparationInstruction 0..1markdownThe instructions for preparing the medication
... intendedRoute 0..*CodeableConceptThe intended or approved route of administration
SNOMED CT Route Codes (Example)
... cost 0..*BackboneElementThe pricing of the medication
.... type 1..1CodeableConceptThe category of the cost information
.... source 0..1stringThe source or owner for the price information
.... cost 1..1MoneyThe price of the medication
... monitoringProgram 0..*BackboneElementProgram under which a medication is reviewed
.... type 0..1CodeableConceptType of program under which the medication is monitored
.... name 0..1stringName of the reviewing program
... administrationGuidelines 0..*BackboneElementGuidelines for administration of the medication
.... dosage 0..*BackboneElementDosage for the medication for the specific guidelines
..... type 1..1CodeableConceptType of dosage
..... dosage 1..*DosageDosage for the medication for the specific guidelines
.... indication[x] 0..1Indication for use that apply to the specific administration guidelines
..... indicationCodeableConceptCodeableConcept
..... indicationReferenceReference(ObservationDefinition)
.... patientCharacteristics 0..*BackboneElementCharacteristics of the patient that are relevant to the administration guidelines
..... characteristic[x] 1..1Specific characteristic that is relevant to the administration guideline
...... characteristicCodeableConceptCodeableConcept
...... characteristicQuantitySimpleQuantity
..... value 0..*stringThe specific characteristic
... medicineClassification 0..*BackboneElementCategorization of the medication within a formulary or classification system
.... type 1..1CodeableConceptThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... classification 0..*CodeableConceptSpecific category assigned to the medication
... packaging 0..1BackboneElementDetails about packaged medications
.... type 0..1CodeableConceptA code that defines the specific type of packaging that the medication can be found in
medicationKnowledge Package Type Codes (Example)
.... quantity 0..1SimpleQuantityThe number of product units the package would contain if fully loaded
... drugCharacteristic 0..*BackboneElementSpecifies descriptive properties of the medicine
.... type 0..1CodeableConceptCode specifying the type of characteristic of medication
medicationKnowledge Characteristic Codes (Example)
.... value[x] 0..1Description of the characteristic
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueQuantitySimpleQuantity
..... valueBase64Binarybase64Binary
... contraindication 0..*Reference(DetectedIssue)Potential clinical issue with or between medication(s)
... regulatory 0..*BackboneElementRegulatory information about a medication
.... regulatoryAuthority 1..1Reference(Organization)Specifies the authority of the regulation
.... substitution 0..*BackboneElementSpecifies if changes are allowed when dispensing a medication from a regulatory perspective
..... type 1..1CodeableConceptSpecifies the type of substitution allowed
..... allowed 1..1booleanSpecifies if regulation allows for changes in the medication when dispensing
.... schedule 0..*BackboneElementSpecifies the schedule of a medication in jurisdiction
..... schedule 1..1CodeableConceptSpecifies the specific drug schedule
.... maxDispense 0..1BackboneElementThe maximum number of units of the medication that can be dispensed in a period
..... quantity 1..1SimpleQuantityThe maximum number of units of the medication that can be dispensed
..... period 0..1DurationThe period that applies to the maximum number of units
... kinetics 0..*BackboneElementThe time course of drug absorption, distribution, metabolism and excretion of a medication from the body
.... areaUnderCurve 0..*SimpleQuantityThe drug concentration measured at certain discrete points in time
.... lethalDose50 0..*SimpleQuantityThe median lethal dose of a drug
.... halfLifePeriod 0..1DurationTime required for concentration in the body to decrease by half

doco Documentation for this format

UML Diagram (Legend)

MedicationKnowledge (DomainResource)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 systemscode : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTMedicationCodes?? »A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)MedicationKnowledge Status ! »Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication productmanufacturer : Reference [0..1] « Organization »Describes the form of the item. Powder; tablets; capsuledoseForm : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTFormCodes?? »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.)amount : Quantity(SimpleQuantity) [0..1]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 albuterolsynonym : string [0..*]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)associatedMedication : Reference [0..*] « Medication »Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.)productType : CodeableConcept [0..*]The instructions for preparing the medicationpreparationInstruction : markdown [0..1]The intended or approved route of administrationintendedRoute : CodeableConcept [0..*] « null (Strength=Example)SNOMEDCTRouteCodes?? »Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.)contraindication : Reference [0..*] « DetectedIssue »RelatedMedicationKnowledgeThe category of the associated medication knowledge referencetype : CodeableConcept [1..1]Associated documentation about the associated medication knowledgereference : Reference [1..*] « MedicationKnowledge »MonographThe category of documentation about the medication. (e.g. professional monograph, patient education monograph)type : CodeableConcept [0..1]Associated documentation about the medicationsource : Reference [0..1] « DocumentReference|Media »IngredientThe actual ingredient - either a substance (simple ingredient) or another medicationitem[x] : Element [1..1] « CodeableConcept|Reference(Substance) »Indication of whether this ingredient affects the therapeutic action of the drugisActive : boolean [0..1]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 tabletstrength : Ratio [0..1]CostThe category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition costtype : CodeableConcept [1..1]The source or owner that assigns the price to the medicationsource : string [0..1]The price of the medicationcost : Money [1..1]MonitoringProgramType of program under which the medication is monitoredtype : CodeableConcept [0..1]Name of the reviewing programname : string [0..1]AdministrationGuidelinesIndication for use that apply to the specific administration guidelinesindication[x] : Element [0..1] « CodeableConcept|Reference( ObservationDefinition) »DosageThe type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.)type : CodeableConcept [1..1]Dosage for the medication for the specific guidelinesdosage : Dosage [1..*]PatientCharacteristicsSpecific characteristic that is relevant to the administration guideline (e.g. height, weight, gender)characteristic[x] : Element [1..1] « CodeableConcept|Quantity(SimpleQuantity) »The specific characteristic (e.g. height, weight, gender, etc.)value : string [0..*]MedicineClassificationThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)type : CodeableConcept [1..1]Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.)classification : CodeableConcept [0..*]PackagingA code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle)type : CodeableConcept [0..1] « null (Strength=Example)medicationKnowledge Package T...?? »The number of product units the package would contain if fully loadedquantity : Quantity(SimpleQuantity) [0..1]DrugCharacteristicA code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint)type : CodeableConcept [0..1] « null (Strength=Example)medicationKnowledge Character...?? »Description of the characteristicvalue[x] : Element [0..1] « CodeableConcept|string|Quantity(SimpleQuantity)| base64Binary »RegulatoryThe authority that is specifying the regulationsregulatoryAuthority : Reference [1..1] « Organization »SubstitutionSpecifies the type of substitution allowedtype : CodeableConcept [1..1]Specifies if regulation allows for changes in the medication when dispensingallowed : boolean [1..1]ScheduleSpecifies the specific drug scheduleschedule : CodeableConcept [1..1]MaxDispenseThe maximum number of units of the medication that can be dispensedquantity : Quantity(SimpleQuantity) [1..1]The period that applies to the maximum number of unitsperiod : Duration [0..1]KineticsThe drug concentration measured at certain discrete points in timeareaUnderCurve : Quantity(SimpleQuantity) [0..*]The median lethal dose of a druglethalDose50 : Quantity(SimpleQuantity) [0..*]The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by halfhalfLifePeriod : Duration [0..1]Associated or related knowledge about a medicationrelatedMedicationKnowledge[0..*]Associated documentation about the medicationmonograph[0..*]Identifies a particular constituent of interest in the productingredient[0..*]The price of the medicationcost[0..*]The program under which the medication is reviewedmonitoringProgram[0..*]Dosage for the medication for the specific guidelinesdosage[0..*]Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.)patientCharacteristics[0..*]Guidelines for the administration of the medicationadministrationGuidelines[0..*]Categorization of the medication within a formulary or classification systemmedicineClassification[0..*]Information that only applies to packages (not products)packaging[0..1]Specifies descriptive properties of the medicine, such as color, shape, imprints, etcdrugCharacteristic[0..*]Specifies if changes are allowed when dispensing a medication from a regulatory perspectivesubstitution[0..*]Specifies the schedule of a medication in jurisdictionschedule[0..*]The maximum number of units of the medication that can be dispensed in a periodmaxDispense[0..1]Regulatory information about a medicationregulatory[0..*]The time course of drug absorption, distribution, metabolism and excretion of a medication from the bodykinetics[0..*]

XML Template

<MedicationKnowledge xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <code><!-- 0..1 CodeableConcept Code that identifies this medication --></code>
 <status value="[code]"/><!-- 0..1 active | inactive | entered-in-error -->
 <manufacturer><!-- 0..1 Reference(Organization) Manufacturer of the item --></manufacturer>
 <doseForm><!-- 0..1 CodeableConcept powder | tablets | capsule + --></doseForm>
 <amount><!-- 0..1 Quantity(SimpleQuantity) Amount of drug in package --></amount>
 <synonym value="[string]"/><!-- 0..* Additional names for a medication -->
 <relatedMedicationKnowledge>  <!-- 0..* Associated or related medication information -->
  <type><!-- 1..1 CodeableConcept Category of medicationKnowledge --></type>
  <reference><!-- 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge --></reference>
 </relatedMedicationKnowledge>
 <associatedMedication><!-- 0..* Reference(Medication) A medication resource that is associated with this medication --></associatedMedication>
 <productType><!-- 0..* CodeableConcept Category of the medication or product --></productType>
 <monograph>  <!-- 0..* Associated documentation about the medication -->
  <type><!-- 0..1 CodeableConcept The category of medication document --></type>
  <source><!-- 0..1 Reference(DocumentReference|Media) Associated documentation about the medication --></source>
 </monograph>
 <ingredient>  <!-- 0..* Active or inactive ingredient -->
  <item[x]><!-- 1..1 CodeableConcept|Reference(Substance) Medication(s) or substance(s) contained in the medication --></item[x]>
  <isActive value="[boolean]"/><!-- 0..1 Active ingredient indicator -->
  <strength><!-- 0..1 Ratio Quantity of ingredient present --></strength>
 </ingredient>
 <preparationInstruction value="[markdown]"/><!-- 0..1 The instructions for preparing the medication -->
 <intendedRoute><!-- 0..* CodeableConcept The intended or approved route of administration --></intendedRoute>
 <cost>  <!-- 0..* The pricing of the medication -->
  <type><!-- 1..1 CodeableConcept The category of the cost information --></type>
  <source value="[string]"/><!-- 0..1 The source or owner for the price information -->
  <cost><!-- 1..1 Money The price of the medication --></cost>
 </cost>
 <monitoringProgram>  <!-- 0..* Program under which a medication is reviewed -->
  <type><!-- 0..1 CodeableConcept Type of program under which the medication is monitored --></type>
  <name value="[string]"/><!-- 0..1 Name of the reviewing program -->
 </monitoringProgram>
 <administrationGuidelines>  <!-- 0..* Guidelines for administration of the medication -->
  <dosage>  <!-- 0..* Dosage for the medication for the specific guidelines -->
   <type><!-- 1..1 CodeableConcept Type of dosage --></type>
   <dosage><!-- 1..* Dosage Dosage for the medication for the specific guidelines --></dosage>
  </dosage>
  <indication[x]><!-- 0..1 CodeableConcept|Reference(ObservationDefinition) Indication for use that apply to the specific administration guidelines --></indication[x]>
  <patientCharacteristics>  <!-- 0..* Characteristics of the patient that are relevant to the administration guidelines -->
   <characteristic[x]><!-- 1..1 CodeableConcept|Quantity(SimpleQuantity) Specific characteristic that is relevant to the administration guideline --></characteristic[x]>
   <value value="[string]"/><!-- 0..* The specific characteristic -->
  </patientCharacteristics>
 </administrationGuidelines>
 <medicineClassification>  <!-- 0..* Categorization of the medication within a formulary or classification system -->
  <type><!-- 1..1 CodeableConcept The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) --></type>
  <classification><!-- 0..* CodeableConcept Specific category assigned to the medication --></classification>
 </medicineClassification>
 <packaging>  <!-- 0..1 Details about packaged medications -->
  <type><!-- 0..1 CodeableConcept A code that defines the specific type of packaging that the medication can be found in --></type>
  <quantity><!-- 0..1 Quantity(SimpleQuantity) The number of product units the package would contain if fully loaded --></quantity>
 </packaging>
 <drugCharacteristic>  <!-- 0..* Specifies descriptive properties of the medicine -->
  <type><!-- 0..1 CodeableConcept Code specifying the type of characteristic of medication --></type>
  <value[x]><!-- 0..1 CodeableConcept|string|Quantity(SimpleQuantity)|
    base64Binary Description of the characteristic --></value[x]>
 </drugCharacteristic>
 <contraindication><!-- 0..* Reference(DetectedIssue) Potential clinical issue with or between medication(s) --></contraindication>
 <regulatory>  <!-- 0..* Regulatory information about a medication -->
  <regulatoryAuthority><!-- 1..1 Reference(Organization) Specifies the authority of the regulation --></regulatoryAuthority>
  <substitution>  <!-- 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective -->
   <type><!-- 1..1 CodeableConcept Specifies the type of substitution allowed --></type>
   <allowed value="[boolean]"/><!-- 1..1 Specifies if regulation allows for changes in the medication when dispensing -->
  </substitution>
  <schedule>  <!-- 0..* Specifies the schedule of a medication in jurisdiction -->
   <schedule><!-- 1..1 CodeableConcept Specifies the specific drug schedule --></schedule>
  </schedule>
  <maxDispense>  <!-- 0..1 The maximum number of units of the medication that can be dispensed in a period -->
   <quantity><!-- 1..1 Quantity(SimpleQuantity) The maximum number of units of the medication that can be dispensed --></quantity>
   <period><!-- 0..1 Duration The period that applies to the maximum number of units --></period>
  </maxDispense>
 </regulatory>
 <kinetics>  <!-- 0..* The time course of drug absorption, distribution, metabolism and excretion of a medication from the body -->
  <areaUnderCurve><!-- 0..* Quantity(SimpleQuantity) The drug concentration measured at certain discrete points in time --></areaUnderCurve>
  <lethalDose50><!-- 0..* Quantity(SimpleQuantity) The median lethal dose of a drug --></lethalDose50>
  <halfLifePeriod><!-- 0..1 Duration Time required for concentration in the body to decrease by half --></halfLifePeriod>
 </kinetics>
</MedicationKnowledge>

JSON Template

{doco
  "resourceType" : "MedicationKnowledge",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "code" : { CodeableConcept }, // Code that identifies this medication
  "status" : "<code>", // active | inactive | entered-in-error
  "manufacturer" : { Reference(Organization) }, // Manufacturer of the item
  "doseForm" : { CodeableConcept }, // powder | tablets | capsule +
  "amount" : { Quantity(SimpleQuantity) }, // Amount of drug in package
  "synonym" : ["<string>"], // Additional names for a medication
  "relatedMedicationKnowledge" : [{ // Associated or related medication information
    "type" : { CodeableConcept }, // R!  Category of medicationKnowledge
    "reference" : [{ Reference(MedicationKnowledge) }] // R!  Associated documentation about the associated medication knowledge
  }],
  "associatedMedication" : [{ Reference(Medication) }], // A medication resource that is associated with this medication
  "productType" : [{ CodeableConcept }], // Category of the medication or product
  "monograph" : [{ // Associated documentation about the medication
    "type" : { CodeableConcept }, // The category of medication document
    "source" : { Reference(DocumentReference|Media) } // Associated documentation about the medication
  }],
  "ingredient" : [{ // Active or inactive ingredient
    // item[x]: Medication(s) or substance(s) contained in the medication. One of these 2:
    "itemCodeableConcept" : { CodeableConcept },
    "itemReference" : { Reference(Substance) },
    "isActive" : <boolean>, // Active ingredient indicator
    "strength" : { Ratio } // Quantity of ingredient present
  }],
  "preparationInstruction" : "<markdown>", // The instructions for preparing the medication
  "intendedRoute" : [{ CodeableConcept }], // The intended or approved route of administration
  "cost" : [{ // The pricing of the medication
    "type" : { CodeableConcept }, // R!  The category of the cost information
    "source" : "<string>", // The source or owner for the price information
    "cost" : { Money } // R!  The price of the medication
  }],
  "monitoringProgram" : [{ // Program under which a medication is reviewed
    "type" : { CodeableConcept }, // Type of program under which the medication is monitored
    "name" : "<string>" // Name of the reviewing program
  }],
  "administrationGuidelines" : [{ // Guidelines for administration of the medication
    "dosage" : [{ // Dosage for the medication for the specific guidelines
      "type" : { CodeableConcept }, // R!  Type of dosage
      "dosage" : [{ Dosage }] // R!  Dosage for the medication for the specific guidelines
    }],
    // indication[x]: Indication for use that apply to the specific administration guidelines. One of these 2:
    "indicationCodeableConcept" : { CodeableConcept },
    "indicationReference" : { Reference(ObservationDefinition) },
    "patientCharacteristics" : [{ // Characteristics of the patient that are relevant to the administration guidelines
      // characteristic[x]: Specific characteristic that is relevant to the administration guideline. One of these 2:
      "characteristicCodeableConcept" : { CodeableConcept },
      "characteristicQuantity" : { Quantity(SimpleQuantity) },
      "value" : ["<string>"] // The specific characteristic
    }]
  }],
  "medicineClassification" : [{ // Categorization of the medication within a formulary or classification system
    "type" : { CodeableConcept }, // R!  The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
    "classification" : [{ CodeableConcept }] // Specific category assigned to the medication
  }],
  "packaging" : { // Details about packaged medications
    "type" : { CodeableConcept }, // A code that defines the specific type of packaging that the medication can be found in
    "quantity" : { Quantity(SimpleQuantity) } // The number of product units the package would contain if fully loaded
  },
  "drugCharacteristic" : [{ // Specifies descriptive properties of the medicine
    "type" : { CodeableConcept }, // Code specifying the type of characteristic of medication
    // value[x]: Description of the characteristic. One of these 4:
    "valueCodeableConcept" : { CodeableConcept }
    "valueString" : "<string>"
    "valueQuantity" : { Quantity(SimpleQuantity) }
    "valueBase64Binary" : "<base64Binary>"
  }],
  "contraindication" : [{ Reference(DetectedIssue) }], // Potential clinical issue with or between medication(s)
  "regulatory" : [{ // Regulatory information about a medication
    "regulatoryAuthority" : { Reference(Organization) }, // R!  Specifies the authority of the regulation
    "substitution" : [{ // Specifies if changes are allowed when dispensing a medication from a regulatory perspective
      "type" : { CodeableConcept }, // R!  Specifies the type of substitution allowed
      "allowed" : <boolean> // R!  Specifies if regulation allows for changes in the medication when dispensing
    }],
    "schedule" : [{ // Specifies the schedule of a medication in jurisdiction
      "schedule" : { CodeableConcept } // R!  Specifies the specific drug schedule
    }],
    "maxDispense" : { // The maximum number of units of the medication that can be dispensed in a period
      "quantity" : { Quantity(SimpleQuantity) }, // R!  The maximum number of units of the medication that can be dispensed
      "period" : { Duration } // The period that applies to the maximum number of units
    }
  }],
  "kinetics" : [{ // The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
    "areaUnderCurve" : [{ Quantity(SimpleQuantity) }], // The drug concentration measured at certain discrete points in time
    "lethalDose50" : [{ Quantity(SimpleQuantity) }], // The median lethal dose of a drug
    "halfLifePeriod" : { Duration } // Time required for concentration in the body to decrease by half
  }]
}

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:MedicationKnowledge.code [ CodeableConcept ]; # 0..1 Code that identifies this medication
  fhir:MedicationKnowledge.status [ code ]; # 0..1 active | inactive | entered-in-error
  fhir:MedicationKnowledge.manufacturer [ Reference(Organization) ]; # 0..1 Manufacturer of the item
  fhir:MedicationKnowledge.doseForm [ CodeableConcept ]; # 0..1 powder | tablets | capsule +
  fhir:MedicationKnowledge.amount [ Quantity(SimpleQuantity) ]; # 0..1 Amount of drug in package
  fhir:MedicationKnowledge.synonym [ string ], ... ; # 0..* Additional names for a medication
  fhir:MedicationKnowledge.relatedMedicationKnowledge [ # 0..* Associated or related medication information
    fhir:MedicationKnowledge.relatedMedicationKnowledge.type [ CodeableConcept ]; # 1..1 Category of medicationKnowledge
    fhir:MedicationKnowledge.relatedMedicationKnowledge.reference [ Reference(MedicationKnowledge) ], ... ; # 1..* Associated documentation about the associated medication knowledge
  ], ...;
  fhir:MedicationKnowledge.associatedMedication [ Reference(Medication) ], ... ; # 0..* A medication resource that is associated with this medication
  fhir:MedicationKnowledge.productType [ CodeableConcept ], ... ; # 0..* Category of the medication or product
  fhir:MedicationKnowledge.monograph [ # 0..* Associated documentation about the medication
    fhir:MedicationKnowledge.monograph.type [ CodeableConcept ]; # 0..1 The category of medication document
    fhir:MedicationKnowledge.monograph.source [ Reference(DocumentReference|Media) ]; # 0..1 Associated documentation about the medication
  ], ...;
  fhir:MedicationKnowledge.ingredient [ # 0..* Active or inactive ingredient
    # MedicationKnowledge.ingredient.item[x] : 1..1 Medication(s) or substance(s) contained in the medication. One of these 2
      fhir:MedicationKnowledge.ingredient.itemCodeableConcept [ CodeableConcept ]
      fhir:MedicationKnowledge.ingredient.itemReference [ Reference(Substance) ]
    fhir:MedicationKnowledge.ingredient.isActive [ boolean ]; # 0..1 Active ingredient indicator
    fhir:MedicationKnowledge.ingredient.strength [ Ratio ]; # 0..1 Quantity of ingredient present
  ], ...;
  fhir:MedicationKnowledge.preparationInstruction [ markdown ]; # 0..1 The instructions for preparing the medication
  fhir:MedicationKnowledge.intendedRoute [ CodeableConcept ], ... ; # 0..* The intended or approved route of administration
  fhir:MedicationKnowledge.cost [ # 0..* The pricing of the medication
    fhir:MedicationKnowledge.cost.type [ CodeableConcept ]; # 1..1 The category of the cost information
    fhir:MedicationKnowledge.cost.source [ string ]; # 0..1 The source or owner for the price information
    fhir:MedicationKnowledge.cost.cost [ Money ]; # 1..1 The price of the medication
  ], ...;
  fhir:MedicationKnowledge.monitoringProgram [ # 0..* Program under which a medication is reviewed
    fhir:MedicationKnowledge.monitoringProgram.type [ CodeableConcept ]; # 0..1 Type of program under which the medication is monitored
    fhir:MedicationKnowledge.monitoringProgram.name [ string ]; # 0..1 Name of the reviewing program
  ], ...;
  fhir:MedicationKnowledge.administrationGuidelines [ # 0..* Guidelines for administration of the medication
    fhir:MedicationKnowledge.administrationGuidelines.dosage [ # 0..* Dosage for the medication for the specific guidelines
      fhir:MedicationKnowledge.administrationGuidelines.dosage.type [ CodeableConcept ]; # 1..1 Type of dosage
      fhir:MedicationKnowledge.administrationGuidelines.dosage.dosage [ Dosage ], ... ; # 1..* Dosage for the medication for the specific guidelines
    ], ...;
    # MedicationKnowledge.administrationGuidelines.indication[x] : 0..1 Indication for use that apply to the specific administration guidelines. One of these 2
      fhir:MedicationKnowledge.administrationGuidelines.indicationCodeableConcept [ CodeableConcept ]
      fhir:MedicationKnowledge.administrationGuidelines.indicationReference [ Reference(ObservationDefinition) ]
    fhir:MedicationKnowledge.administrationGuidelines.patientCharacteristics [ # 0..* Characteristics of the patient that are relevant to the administration guidelines
      # MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x] : 1..1 Specific characteristic that is relevant to the administration guideline. One of these 2
        fhir:MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristicCodeableConcept [ CodeableConcept ]
        fhir:MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristicSimpleQuantity [ Quantity(SimpleQuantity) ]
      fhir:MedicationKnowledge.administrationGuidelines.patientCharacteristics.value [ string ], ... ; # 0..* The specific characteristic
    ], ...;
  ], ...;
  fhir:MedicationKnowledge.medicineClassification [ # 0..* Categorization of the medication within a formulary or classification system
    fhir:MedicationKnowledge.medicineClassification.type [ CodeableConcept ]; # 1..1 The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
    fhir:MedicationKnowledge.medicineClassification.classification [ CodeableConcept ], ... ; # 0..* Specific category assigned to the medication
  ], ...;
  fhir:MedicationKnowledge.packaging [ # 0..1 Details about packaged medications
    fhir:MedicationKnowledge.packaging.type [ CodeableConcept ]; # 0..1 A code that defines the specific type of packaging that the medication can be found in
    fhir:MedicationKnowledge.packaging.quantity [ Quantity(SimpleQuantity) ]; # 0..1 The number of product units the package would contain if fully loaded
  ];
  fhir:MedicationKnowledge.drugCharacteristic [ # 0..* Specifies descriptive properties of the medicine
    fhir:MedicationKnowledge.drugCharacteristic.type [ CodeableConcept ]; # 0..1 Code specifying the type of characteristic of medication
    # MedicationKnowledge.drugCharacteristic.value[x] : 0..1 Description of the characteristic. One of these 4
      fhir:MedicationKnowledge.drugCharacteristic.valueCodeableConcept [ CodeableConcept ]
      fhir:MedicationKnowledge.drugCharacteristic.valueString [ string ]
      fhir:MedicationKnowledge.drugCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ]
      fhir:MedicationKnowledge.drugCharacteristic.valueBase64Binary [ base64Binary ]
  ], ...;
  fhir:MedicationKnowledge.contraindication [ Reference(DetectedIssue) ], ... ; # 0..* Potential clinical issue with or between medication(s)
  fhir:MedicationKnowledge.regulatory [ # 0..* Regulatory information about a medication
    fhir:MedicationKnowledge.regulatory.regulatoryAuthority [ Reference(Organization) ]; # 1..1 Specifies the authority of the regulation
    fhir:MedicationKnowledge.regulatory.substitution [ # 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective
      fhir:MedicationKnowledge.regulatory.substitution.type [ CodeableConcept ]; # 1..1 Specifies the type of substitution allowed
      fhir:MedicationKnowledge.regulatory.substitution.allowed [ boolean ]; # 1..1 Specifies if regulation allows for changes in the medication when dispensing
    ], ...;
    fhir:MedicationKnowledge.regulatory.schedule [ # 0..* Specifies the schedule of a medication in jurisdiction
      fhir:MedicationKnowledge.regulatory.schedule.schedule [ CodeableConcept ]; # 1..1 Specifies the specific drug schedule
    ], ...;
    fhir:MedicationKnowledge.regulatory.maxDispense [ # 0..1 The maximum number of units of the medication that can be dispensed in a period
      fhir:MedicationKnowledge.regulatory.maxDispense.quantity [ Quantity(SimpleQuantity) ]; # 1..1 The maximum number of units of the medication that can be dispensed
      fhir:MedicationKnowledge.regulatory.maxDispense.period [ Duration ]; # 0..1 The period that applies to the maximum number of units
    ];
  ], ...;
  fhir:MedicationKnowledge.kinetics [ # 0..* The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
    fhir:MedicationKnowledge.kinetics.areaUnderCurve [ Quantity(SimpleQuantity) ], ... ; # 0..* The drug concentration measured at certain discrete points in time
    fhir:MedicationKnowledge.kinetics.lethalDose50 [ Quantity(SimpleQuantity) ], ... ; # 0..* The median lethal dose of a drug
    fhir:MedicationKnowledge.kinetics.halfLifePeriod [ Duration ]; # 0..1 Time required for concentration in the body to decrease by half
  ], ...;
]

Changes since Release 3

MedicationKnowledge
MedicationKnowledge.status
  • Change value set from http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.0 to http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.3.0-snapshot1
MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x]
  • Add Type Quantity()
  • Remove Type Quantity()
MedicationKnowledge.drugCharacteristic.value[x]
  • Add Type Quantity()
  • Remove Type Quantity()

See the Full Difference for further information

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

11.6.3.1 Terminology Bindings

PathDefinitionTypeReference
MedicationKnowledge.code ExampleSNOMEDCTMedicationCodes
MedicationKnowledge.status RequiredMedicationKnowledge Status Codes
MedicationKnowledge.doseForm ExampleSNOMEDCTFormCodes
MedicationKnowledge.intendedRoute ExampleSNOMEDCTRouteCodes
MedicationKnowledge.packaging.type ExamplemedicationKnowledge Package Type Codes
MedicationKnowledge.drugCharacteristic.type ExamplemedicationKnowledge Characteristic Codes

11.6.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
classificationtokenSpecific category assigned to the medicationMedicationKnowledge.medicineClassification.classification
classification-typetokenThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)MedicationKnowledge.medicineClassification.type
codetokenCode that identifies this medicationMedicationKnowledge.code
doseformtokenpowder | tablets | capsule +MedicationKnowledge.doseForm
ingredientreferenceMedication(s) or substance(s) contained in the medication(MedicationKnowledge.ingredient.item as Reference)
(Substance)
ingredient-codetokenMedication(s) or substance(s) contained in the medication(MedicationKnowledge.ingredient.item as CodeableConcept)
manufacturerreferenceManufacturer of the itemMedicationKnowledge.manufacturer
(Organization)
monitoring-program-nametokenName of the reviewing programMedicationKnowledge.monitoringProgram.name
monitoring-program-typetokenType of program under which the medication is monitoredMedicationKnowledge.monitoringProgram.type
monographreferenceAssociated documentation about the medicationMedicationKnowledge.monograph.source
(Media, DocumentReference)
monograph-typetokenThe category of medication documentMedicationKnowledge.monograph.type
source-costtokenThe source or owner for the price informationMedicationKnowledge.cost.source
statustokenactive | inactive | entered-in-errorMedicationKnowledge.status