R6 Ballot (2nd Draft)

Publish-box (todo)

11.6 Resource MedicationKnowledge - Content

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

Information about a medication that is used to support knowledge.

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

Where the Medication resource is intended for the simple identification of a medication for prescribing, dispensing, or administering, the MedicationKnowledge resource is intended to provide more detailed information about the medication. Unlike the MedicinalProductDefinition resource, the MedicationKnowledge resource is not a complete definition of the medication but provides some definitional information along with formulary/catalogue-specific information such as costs, monitoring programs, etc.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge TU DomainResource Definition of Medication Knowledge

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... identifier Σ 0..* Identifier Business identifier for this medication

... code Σ 0..1 CodeableConcept Code that identifies this medication
Binding: SNOMED CT Medication Codes (Example)
... status ?!Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... jurisdiction 0..* CodeableConcept Codes that identify the different jurisdictions for which the information of this resource was created

... name Σ 0..1 string A name associated with the medication being described
... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information

.... type 1..1 CodeableConcept Category of medicationKnowledge
.... reference 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge

... associatedMedication 0..* Reference(Medication) The set of medication resources that are associated with this medication

... productType 0..* CodeableConcept Category of the medication or product

... monograph 0..* BackboneElement Associated documentation about the medication

.... type 0..1 CodeableConcept The category of medication document
.... source 0..1 Reference(DocumentReference) Associated documentation about the medication
... preparationInstruction 0..1 markdown The instructions for preparing the medication
... cost 0..* BackboneElement The pricing of the medication

.... effectiveDate 0..* Period The date range for which the cost is effective

.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: Medication Cost Category Codes (Example)
..... costMoney Money
..... costCodeableConcept CodeableConcept
... monitoringProgram Σ 0..* BackboneElement Program under which a medication is reviewed

.... type 0..1 CodeableConcept Type of program under which the medication is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 0..* BackboneElement Guidelines or protocols for administration of the medication for an indication

.... indication 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline

.... dosingGuideline 0..* BackboneElement Guidelines for dosage of the medication

..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
..... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines

...... type 1..1 CodeableConcept Category of dosage for a medication
...... dosage 1..* Dosage Dosage for the medication for the specific guidelines

..... administrationTreatment 0..1 CodeableConcept Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines

...... type 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline
...... value[x] 0..1 The specific characteristic
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... medicineClassification 0..* BackboneElement 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)
.... source[x] 0..1 The source of the classification
..... sourceString string
..... sourceUri uri
.... classification 0..* CodeableConcept Specific category assigned to the medication

... packaging 0..* BackboneElement Details about packaged medications

.... cost 0..* see cost Cost of the packaged medication

.... packagedProduct 0..1 Reference(PackagedProductDefinition) The packaged medication that is being priced
... clinicalUseIssue 0..* Reference(ClinicalUseDefinition) Potential clinical issue with or between medication(s)

... storageGuideline 0..* BackboneElement How the medication should be stored

.... reference 0..1 uri Reference to additional information
.... note 0..* Annotation Additional storage notes

.... stabilityDuration 0..1 Duration Duration remains stable
.... environmentalSetting 0..* BackboneElement Setting or value of environment for adequate storage

..... type 1..1 CodeableConcept Categorization of the setting
..... value[x] 1..1 Value of the setting
...... valueQuantity Quantity
...... valueRange Range
...... valueCodeableConcept CodeableConcept
... regulatory 0..* BackboneElement Regulatory information about a medication

.... regulatoryAuthority 1..1 Reference(Organization) Specifies the authority of the regulation
.... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective

..... type 1..1 CodeableConcept Specifies the type of substitution allowed
..... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
.... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction

.... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
..... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
..... period 0..1 Duration The period that applies to the maximum number of units
... definitional 0..1 BackboneElement Minimal definition information about the medication
.... definition 0..* Reference(MedicinalProductDefinition) Definitional resources that provide more information about this medication

.... doseForm 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMED CT Form Codes (Example)
.... intendedRoute 0..* CodeableConcept The intended or approved route of administration
Binding: SNOMED CT Route Codes (Example)

.... ingredient Σ 0..* BackboneElement Active or inactive ingredient

..... item Σ 1..1 CodeableReference(Substance) Substances contained in the medication
..... type 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc
Binding: RoleClassIngredientEntity icon (Example)
..... strength[x] 0..1 Quantity of ingredient present
Binding: Medication Ingredient Strength Codes (Example)
...... strengthRatio Ratio
...... strengthCodeableConcept CodeableConcept
...... strengthQuantity Quantity
.... drugCharacteristic 0..* BackboneElement Specifies descriptive properties of the medicine

..... type 0..1 CodeableConcept Code specifying the type of characteristic of medication
Binding: medicationKnowledge Characteristic Codes (Example)
..... value[x] 0..1 Description of the characteristic
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueQuantity SimpleQuantity
...... valueBase64Binary base64Binary
...... valueAttachment Attachment

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

MedicationKnowledge (DomainResource) +MetadataResourceBusiness identifier for this medicationidentifier : Identifier [0..*]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 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 (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)PublicationStatus! »The creator or owner of the knowledge or information about the medicationauthor : ContactDetail [0..1]Lists the jurisdictions that this medication knowledge was written forjurisdiction : CodeableConcept [0..*]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 albuterolname : string [0..1]Links to associated medications that could be prescribed, dispensed or administeredassociatedMedication : 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]Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.)clinicalUseIssue : Reference [0..*] « ClinicalUseDefinition »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 »CostThe date range for which the cost information of the medication is effectiveeffectiveDate : Period [0..*]The 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 or representation of the cost (for example, Band A, Band B or $, $$) of the medicationcost[x] : DataType [1..1] « Money|CodeableConcept; null (Strength=Example) MedicationCostCategoryCodes?? »MonitoringProgramType of program under which the medication is monitoredtype : CodeableConcept [0..1]Name of the reviewing programname : string [0..1]IndicationGuidelineIndication or reason for use of the medication that applies to the specific administration guidelineindication : CodeableReference [0..*] « ClinicalUseDefinition »DosingGuidelineThe overall intention of the treatment, for example, prophylactic, supporative, curative, etctreatmentIntent : CodeableConcept [0..1]The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etcadministrationTreatment : CodeableConcept [0..1]DosageThe type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.)type : CodeableConcept [1..1]Dosage for the medication for the specific guidelinesdosage : Dosage [1..*]PatientCharacteristicThe categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender)type : CodeableConcept [1..1]The specific characteristic (e.g. height, weight, gender, etc.)value[x] : DataType [0..1] « CodeableConcept|Quantity|Range »MedicineClassificationThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)type : CodeableConcept [1..1]Either a textual source of the classification or a reference to an online sourcesource[x] : PrimitiveType [0..1] « string|uri »Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.)classification : CodeableConcept [0..*]PackagingA reference to a PackagedProductDefinition that provides the details of the product that is in the packaging and is being pricedpackagedProduct : Reference [0..1] « PackagedProductDefinition »StorageGuidelineReference to additional information about the storage guidelinesreference : uri [0..1]Additional notes about the storagenote : Annotation [0..*]Duration that the medication remains stable if the environmentalSetting is respectedstabilityDuration : Duration [0..1]EnvironmentalSettingIdentifies the category or type of setting (e.g., type of location, temperature, humidity)type : CodeableConcept [1..1]Value associated to the setting. E.g., 40° – 50°F for temperaturevalue[x] : DataType [1..1] « Quantity|Range|CodeableConcept »RegulatoryThe authority that is specifying the regulationsregulatoryAuthority : Reference [1..1] « Organization »Specifies the schedule of a medication in jurisdictionschedule : CodeableConcept [0..*]SubstitutionSpecifies the type of substitution allowedtype : CodeableConcept [1..1]Specifies if regulation allows for changes in the medication when dispensingallowed : boolean [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]DefinitionalAssociated definitions for this medicationdefinition : Reference [0..*] « MedicinalProductDefinition »Describes the form of the item. Powder; tablets; capsuledoseForm : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTFormCodes?? »The intended or approved route of administrationintendedRoute : CodeableConcept [0..*] « null (Strength=Example)SNOMEDCTRouteCodes?? »IngredientA reference to the resource that provides information about the ingredientitem : CodeableReference [1..1] « Substance »Indication of whether this ingredient affects the therapeutic action of the drugtype : CodeableConcept [0..1] « null (Strength=Example)RoleClassIngredientEntity?? »Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tabletstrength[x] : DataType [0..1] « Ratio|CodeableConcept|Quantity; null (Strength=Example) MedicationIngredientStrengthC...?? »DrugCharacteristicA code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint)type : CodeableConcept [0..1] « null (Strength=Example)MedicationKnowledgeCharacteri...?? »Description of the characteristicvalue[x] : DataType [0..1] « CodeableConcept|string|Quantity(SimpleQuantity)| base64Binary|Attachment »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. CrestorrelatedMedicationKnowledge[0..*]Associated documentation about the medicationmonograph[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.)patientCharacteristic[0..*]The guidelines for the dosage of the medication for the indicationdosingGuideline[0..*]Guidelines or protocols that are applicable for the administration of the medication based on indicationindicationGuideline[0..*]Categorization of the medication within a formulary or classification systemmedicineClassification[0..*]The cost of the packaged medicationcost[0..*]Information that only applies to packages (not products)packaging[0..*]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 lightenvironmentalSetting[0..*]Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperaturestorageGuideline[0..*]Specifies if changes are allowed when dispensing a medication from a regulatory perspectivesubstitution[0..*]The maximum number of units of the medication that can be dispensed in a periodmaxDispense[0..1]Regulatory information about a medicationregulatory[0..*]Identifies a particular constituent of interest in the productingredient[0..*]Specifies descriptive properties of the medicine, such as color, shape, imprints, etcdrugCharacteristic[0..*]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 describeddefinitional[0..1]

XML Template

<MedicationKnowledge xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for this medication --></identifier>
 <code><!-- 0..1 CodeableConcept Code that identifies this medication --></code>
 <status value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <author><!-- 0..1 ContactDetail Creator or owner of the knowledge or information about the medication --></author>
 <jurisdiction><!-- 0..* CodeableConcept Codes that identify the different jurisdictions for which the information of this resource was created --></jurisdiction>
 <name value="[string]"/><!-- 0..1 A name associated with the medication being described -->
 <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) The set of medication resources that are 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) Associated documentation about the medication --></source>
 </monograph>
 <preparationInstruction value="[markdown]"/><!-- 0..1 The instructions for preparing the medication -->
 <cost>  <!-- 0..* The pricing of the medication -->
  <effectiveDate><!-- 0..* Period The date range for which the cost is effective --></effectiveDate>
  <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[x]><!-- 1..1 Money|CodeableConcept The price or category of the cost of the medication --></cost[x]>
 </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>
 <indicationGuideline>  <!-- 0..* Guidelines or protocols for administration of the medication for an indication -->
  <indication><!-- 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline --></indication>
  <dosingGuideline>  <!-- 0..* Guidelines for dosage of the medication -->
   <treatmentIntent><!-- 0..1 CodeableConcept Intention of the treatment --></treatmentIntent>
   <dosage>  <!-- 0..* Dosage for the medication for the specific guidelines -->
    <type><!-- 1..1 CodeableConcept Category of dosage for a medication --></type>
    <dosage><!-- 1..* Dosage Dosage for the medication for the specific guidelines --></dosage>
   </dosage>
   <administrationTreatment><!-- 0..1 CodeableConcept Type of treatment the guideline applies to --></administrationTreatment>
   <patientCharacteristic>  <!-- 0..* Characteristics of the patient that are relevant to the administration guidelines -->
    <type><!-- 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline --></type>
    <value[x]><!-- 0..1 CodeableConcept|Quantity|Range The specific characteristic --></value[x]>
   </patientCharacteristic>
  </dosingGuideline>
 </indicationGuideline>
 <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>
  <source[x]><!-- 0..1 string|uri The source of the classification --></source[x]>
  <classification><!-- 0..* CodeableConcept Specific category assigned to the medication --></classification>
 </medicineClassification>
 <packaging>  <!-- 0..* Details about packaged medications -->
  <cost><!-- 0..* Content as for MedicationKnowledge.cost Cost of the packaged medication --></cost>
  <packagedProduct><!-- 0..1 Reference(PackagedProductDefinition) The packaged medication that is being priced --></packagedProduct>
 </packaging>
 <clinicalUseIssue><!-- 0..* Reference(ClinicalUseDefinition) Potential clinical issue with or between medication(s) --></clinicalUseIssue>
 <storageGuideline>  <!-- 0..* How the medication should be stored -->
  <reference value="[uri]"/><!-- 0..1 Reference to additional information -->
  <note><!-- 0..* Annotation Additional storage notes --></note>
  <stabilityDuration><!-- 0..1 Duration Duration remains stable --></stabilityDuration>
  <environmentalSetting>  <!-- 0..* Setting or value of environment for adequate storage -->
   <type><!-- 1..1 CodeableConcept Categorization of the setting --></type>
   <value[x]><!-- 1..1 Quantity|Range|CodeableConcept Value of the setting --></value[x]>
  </environmentalSetting>
 </storageGuideline>
 <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..* CodeableConcept Specifies the schedule of a medication in jurisdiction --></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>
 <definitional>  <!-- 0..1 Minimal definition information about the medication -->
  <definition><!-- 0..* Reference(MedicinalProductDefinition) Definitional resources that provide more information about this medication --></definition>
  <doseForm><!-- 0..1 CodeableConcept powder | tablets | capsule + --></doseForm>
  <intendedRoute><!-- 0..* CodeableConcept The intended or approved route of administration --></intendedRoute>
  <ingredient>  <!-- 0..* Active or inactive ingredient -->
   <item><!-- 1..1 CodeableReference(Substance) Substances contained in the medication --></item>
   <type><!-- 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc icon --></type>
   <strength[x]><!-- 0..1 Ratio|CodeableConcept|Quantity Quantity of ingredient present --></strength[x]>
  </ingredient>
  <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|Attachment Description of the characteristic --></value[x]>
  </drugCharacteristic>
 </definitional>
</MedicationKnowledge>

JSON Template

{doco
  "resourceType" : "MedicationKnowledge",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier for this medication
  "code" : { CodeableConcept }, // Code that identifies this medication
  "status" : "<code>", // draft | active | retired | unknown
  "author" : { ContactDetail }, // Creator or owner of the knowledge or information about the medication
  "jurisdiction" : [{ CodeableConcept }], // Codes that identify the different jurisdictions for which the information of this resource was created
  "name" : "<string>", // A name associated with the medication being described
  "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) }], // The set of medication resources that are 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) } // Associated documentation about the medication
  }],
  "preparationInstruction" : "<markdown>", // The instructions for preparing the medication
  "cost" : [{ // The pricing of the medication
    "effectiveDate" : [{ Period }], // The date range for which the cost is effective
    "type" : { CodeableConcept }, // R!  The category of the cost information
    "source" : "<string>", // The source or owner for the price information
    // cost[x]: The price or category of the cost of the medication. One of these 2:
    "costMoney" : { Money },
    "costCodeableConcept" : { CodeableConcept }
  }],
  "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
  }],
  "indicationGuideline" : [{ // Guidelines or protocols for administration of the medication for an indication
    "indication" : [{ CodeableReference(ClinicalUseDefinition) }], // Indication for use that applies to the specific administration guideline
    "dosingGuideline" : [{ // Guidelines for dosage of the medication
      "treatmentIntent" : { CodeableConcept }, // Intention of the treatment
      "dosage" : [{ // Dosage for the medication for the specific guidelines
        "type" : { CodeableConcept }, // R!  Category of dosage for a medication
        "dosage" : [{ Dosage }] // R!  Dosage for the medication for the specific guidelines
      }],
      "administrationTreatment" : { CodeableConcept }, // Type of treatment the guideline applies to
      "patientCharacteristic" : [{ // Characteristics of the patient that are relevant to the administration guidelines
        "type" : { CodeableConcept }, // R!  Categorization of specific characteristic that is relevant to the administration guideline
        // value[x]: The specific characteristic. One of these 3:
        "valueCodeableConcept" : { CodeableConcept },
        "valueQuantity" : { Quantity },
        "valueRange" : { Range }
      }]
    }]
  }],
  "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)
    // source[x]: The source of the classification. One of these 2:
    "sourceString" : "<string>",
    "sourceUri" : "<uri>",
    "classification" : [{ CodeableConcept }] // Specific category assigned to the medication
  }],
  "packaging" : [{ // Details about packaged medications
    "cost" : [{ Content as for MedicationKnowledge.cost }], // Cost of the packaged medication
    "packagedProduct" : { Reference(PackagedProductDefinition) } // The packaged medication that is being priced
  }],
  "clinicalUseIssue" : [{ Reference(ClinicalUseDefinition) }], // Potential clinical issue with or between medication(s)
  "storageGuideline" : [{ // How the medication should be stored
    "reference" : "<uri>", // Reference to additional information
    "note" : [{ Annotation }], // Additional storage notes
    "stabilityDuration" : { Duration }, // Duration remains stable
    "environmentalSetting" : [{ // Setting or value of environment for adequate storage
      "type" : { CodeableConcept }, // R!  Categorization of the setting
      // value[x]: Value of the setting. One of these 3:
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "valueCodeableConcept" : { CodeableConcept }
    }]
  }],
  "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" : [{ CodeableConcept }], // Specifies the schedule of a medication in jurisdiction
    "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
    }
  }],
  "definitional" : { // Minimal definition information about the medication
    "definition" : [{ Reference(MedicinalProductDefinition) }], // Definitional resources that provide more information about this medication
    "doseForm" : { CodeableConcept }, // powder | tablets | capsule +
    "intendedRoute" : [{ CodeableConcept }], // The intended or approved route of administration
    "ingredient" : [{ // Active or inactive ingredient
      "item" : { CodeableReference(Substance) }, // R!  Substances contained in the medication
      "type" : { CodeableConcept }, // A code that defines the type of ingredient, active, base, etc icon
      // strength[x]: Quantity of ingredient present. One of these 3:
      "strengthRatio" : { Ratio },
      "strengthCodeableConcept" : { CodeableConcept },
      "strengthQuantity" : { Quantity }
    }],
    "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 5:
      "valueCodeableConcept" : { CodeableConcept },
      "valueString" : "<string>",
      "valueQuantity" : { Quantity(SimpleQuantity) },
      "valueBase64Binary" : "<base64Binary>",
      "valueAttachment" : { Attachment }
    }]
  }
}

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:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for this medication
  fhir:code [ CodeableConcept ] ; # 0..1 Code that identifies this medication
  fhir:status [ code ] ; # 0..1 draft | active | retired | unknown
  fhir:author [ ContactDetail ] ; # 0..1 Creator or owner of the knowledge or information about the medication
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Codes that identify the different jurisdictions for which the information of this resource was created
  fhir:name [ string ] ; # 0..1 A name associated with the medication being described
  fhir:relatedMedicationKnowledge ( [ # 0..* Associated or related medication information
    fhir:type [ CodeableConcept ] ; # 1..1 Category of medicationKnowledge
    fhir:reference  ( [ Reference(MedicationKnowledge) ] ... ) ; # 1..* Associated documentation about the associated medication knowledge
  ] ... ) ;
  fhir:associatedMedication  ( [ Reference(Medication) ] ... ) ; # 0..* The set of medication resources that are associated with this medication
  fhir:productType  ( [ CodeableConcept ] ... ) ; # 0..* Category of the medication or product
  fhir:monograph ( [ # 0..* Associated documentation about the medication
    fhir:type [ CodeableConcept ] ; # 0..1 The category of medication document
    fhir:source [ Reference(DocumentReference) ] ; # 0..1 Associated documentation about the medication
  ] ... ) ;
  fhir:preparationInstruction [ markdown ] ; # 0..1 The instructions for preparing the medication
  fhir:cost ( [ # 0..* The pricing of the medication
    fhir:effectiveDate  ( [ Period ] ... ) ; # 0..* The date range for which the cost is effective
    fhir:type [ CodeableConcept ] ; # 1..1 The category of the cost information
    fhir:source [ string ] ; # 0..1 The source or owner for the price information
    # cost[x] : 1..1 The price or category of the cost of the medication. One of these 2
      fhir:cost [  a fhir:Money ; Money ]
      fhir:cost [  a fhir:CodeableConcept ; CodeableConcept ]
  ] ... ) ;
  fhir:monitoringProgram ( [ # 0..* Program under which a medication is reviewed
    fhir:type [ CodeableConcept ] ; # 0..1 Type of program under which the medication is monitored
    fhir:name [ string ] ; # 0..1 Name of the reviewing program
  ] ... ) ;
  fhir:indicationGuideline ( [ # 0..* Guidelines or protocols for administration of the medication for an indication
    fhir:indication  ( [ CodeableReference(ClinicalUseDefinition) ] ... ) ; # 0..* Indication for use that applies to the specific administration guideline
    fhir:dosingGuideline ( [ # 0..* Guidelines for dosage of the medication
      fhir:treatmentIntent [ CodeableConcept ] ; # 0..1 Intention of the treatment
      fhir:dosage ( [ # 0..* Dosage for the medication for the specific guidelines
        fhir:type [ CodeableConcept ] ; # 1..1 Category of dosage for a medication
        fhir:dosage  ( [ Dosage ] ... ) ; # 1..* Dosage for the medication for the specific guidelines
      ] ... ) ;
      fhir:administrationTreatment [ CodeableConcept ] ; # 0..1 Type of treatment the guideline applies to
      fhir:patientCharacteristic ( [ # 0..* Characteristics of the patient that are relevant to the administration guidelines
        fhir:type [ CodeableConcept ] ; # 1..1 Categorization of specific characteristic that is relevant to the administration guideline
        # value[x] : 0..1 The specific characteristic. One of these 3
          fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
          fhir:value [  a fhir:Quantity ; Quantity ]
          fhir:value [  a fhir:Range ; Range ]
      ] ... ) ;
    ] ... ) ;
  ] ... ) ;
  fhir:medicineClassification ( [ # 0..* Categorization of the medication within a formulary or classification system
    fhir:type [ CodeableConcept ] ; # 1..1 The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
    # source[x] : 0..1 The source of the classification. One of these 2
      fhir:source [  a fhir:string ; string ]
      fhir:source [  a fhir:uri ; uri ]
    fhir:classification  ( [ CodeableConcept ] ... ) ; # 0..* Specific category assigned to the medication
  ] ... ) ;
  fhir:packaging ( [ # 0..* Details about packaged medications
    fhir:cost  ( [ See MedicationKnowledge.cost ] ... ) ; # 0..* Cost of the packaged medication
    fhir:packagedProduct [ Reference(PackagedProductDefinition) ] ; # 0..1 The packaged medication that is being priced
  ] ... ) ;
  fhir:clinicalUseIssue  ( [ Reference(ClinicalUseDefinition) ] ... ) ; # 0..* Potential clinical issue with or between medication(s)
  fhir:storageGuideline ( [ # 0..* How the medication should be stored
    fhir:reference [ uri ] ; # 0..1 Reference to additional information
    fhir:note  ( [ Annotation ] ... ) ; # 0..* Additional storage notes
    fhir:stabilityDuration [ Duration ] ; # 0..1 Duration remains stable
    fhir:environmentalSetting ( [ # 0..* Setting or value of environment for adequate storage
      fhir:type [ CodeableConcept ] ; # 1..1 Categorization of the setting
      # value[x] : 1..1 Value of the setting. One of these 3
        fhir:value [  a fhir:Quantity ; Quantity ]
        fhir:value [  a fhir:Range ; Range ]
        fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
    ] ... ) ;
  ] ... ) ;
  fhir:regulatory ( [ # 0..* Regulatory information about a medication
    fhir:regulatoryAuthority [ Reference(Organization) ] ; # 1..1 Specifies the authority of the regulation
    fhir:substitution ( [ # 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective
      fhir:type [ CodeableConcept ] ; # 1..1 Specifies the type of substitution allowed
      fhir:allowed [ boolean ] ; # 1..1 Specifies if regulation allows for changes in the medication when dispensing
    ] ... ) ;
    fhir:schedule  ( [ CodeableConcept ] ... ) ; # 0..* Specifies the schedule of a medication in jurisdiction
    fhir:maxDispense [ # 0..1 The maximum number of units of the medication that can be dispensed in a period
      fhir:quantity [ Quantity(SimpleQuantity) ] ; # 1..1 The maximum number of units of the medication that can be dispensed
      fhir:period [ Duration ] ; # 0..1 The period that applies to the maximum number of units
    ] ;
  ] ... ) ;
  fhir:definitional [ # 0..1 Minimal definition information about the medication
    fhir:definition  ( [ Reference(MedicinalProductDefinition) ] ... ) ; # 0..* Definitional resources that provide more information about this medication
    fhir:doseForm [ CodeableConcept ] ; # 0..1 powder | tablets | capsule +
    fhir:intendedRoute  ( [ CodeableConcept ] ... ) ; # 0..* The intended or approved route of administration
    fhir:ingredient ( [ # 0..* Active or inactive ingredient
      fhir:item [ CodeableReference(Substance) ] ; # 1..1 Substances contained in the medication
      fhir:type [ CodeableConcept ] ; # 0..1 A code that defines the type of ingredient, active, base, etc
      # strength[x] : 0..1 Quantity of ingredient present. One of these 3
        fhir:strength [  a fhir:Ratio ; Ratio ]
        fhir:strength [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:strength [  a fhir:Quantity ; Quantity ]
    ] ... ) ;
    fhir:drugCharacteristic ( [ # 0..* Specifies descriptive properties of the medicine
      fhir:type [ CodeableConcept ] ; # 0..1 Code specifying the type of characteristic of medication
      # value[x] : 0..1 Description of the characteristic. One of these 5
        fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:value [  a fhir:string ; string ]
        fhir:value [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
        fhir:value [  a fhir:base64Binary ; base64Binary ]
        fhir:value [  a fhir:Attachment ; Attachment ]
    ] ... ) ;
  ] ;
]

Changes from both R4 and R4B

MedicationKnowledge
MedicationKnowledge.identifier
  • Added Element
MedicationKnowledge.status
  • Change value set from http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.0 to PublicationStatus
  • Remove codes inactive, entered-in-error
  • Add codes draft, retired, unknown
MedicationKnowledge.author
  • Added Element
MedicationKnowledge.jurisdiction
  • Added Element
MedicationKnowledge.name
  • Added Element
MedicationKnowledge.monograph.source
  • Type Reference: Removed Target Type Media
MedicationKnowledge.cost.effectiveDate
  • Added Element
MedicationKnowledge.cost.cost[x]
  • Renamed from cost to cost[x]
  • Add Type CodeableConcept
MedicationKnowledge.indicationGuideline
  • Added Element
MedicationKnowledge.indicationGuideline.indication
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.treatmentIntent
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.dosage
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.dosage.type
  • Added Mandatory Element
MedicationKnowledge.indicationGuideline.dosingGuideline.dosage.dosage
  • Added Mandatory Element
MedicationKnowledge.indicationGuideline.dosingGuideline.administrationTreatment
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic.type
  • Added Mandatory Element
MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]
  • Added Element
MedicationKnowledge.medicineClassification.source[x]
  • Added Element
MedicationKnowledge.packaging
  • Max Cardinality changed from 1 to *
MedicationKnowledge.packaging.cost
  • Added Element
MedicationKnowledge.packaging.packagedProduct
  • Added Element
MedicationKnowledge.clinicalUseIssue
  • Added Element
MedicationKnowledge.storageGuideline
  • Added Element
MedicationKnowledge.storageGuideline.reference
  • Added Element
MedicationKnowledge.storageGuideline.note
  • Added Element
MedicationKnowledge.storageGuideline.stabilityDuration
  • Added Element
MedicationKnowledge.storageGuideline.environmentalSetting
  • Added Element
MedicationKnowledge.storageGuideline.environmentalSetting.type
  • Added Mandatory Element
MedicationKnowledge.storageGuideline.environmentalSetting.value[x]
  • Added Mandatory Element
MedicationKnowledge.regulatory.schedule
  • Type changed from BackboneElement to CodeableConcept
MedicationKnowledge.definitional
  • Added Element
MedicationKnowledge.definitional.definition
  • Added Element
MedicationKnowledge.definitional.doseForm
  • Added Element
MedicationKnowledge.definitional.intendedRoute
  • Added Element
MedicationKnowledge.definitional.ingredient
  • Added Element
MedicationKnowledge.definitional.ingredient.item
  • Added Mandatory Element
MedicationKnowledge.definitional.ingredient.type
  • Added Element
MedicationKnowledge.definitional.ingredient.strength[x]
  • Added Element
MedicationKnowledge.definitional.drugCharacteristic
  • Added Element
MedicationKnowledge.definitional.drugCharacteristic.type
  • Added Element
MedicationKnowledge.definitional.drugCharacteristic.value[x]
  • Added Element
MedicationKnowledge.manufacturer
  • Deleted
MedicationKnowledge.doseForm
  • Deleted
MedicationKnowledge.amount
  • Deleted
MedicationKnowledge.synonym
  • Deleted
MedicationKnowledge.ingredient
  • Deleted
MedicationKnowledge.intendedRoute
  • Deleted
MedicationKnowledge.administrationGuidelines
  • Deleted
MedicationKnowledge.packaging.type
  • Deleted
MedicationKnowledge.packaging.quantity
  • Deleted
MedicationKnowledge.drugCharacteristic
  • Deleted
MedicationKnowledge.contraindication
  • Deleted
MedicationKnowledge.regulatory.schedule.schedule
  • Deleted
MedicationKnowledge.kinetics
  • Deleted

See the Full Difference for further information

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

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge TU DomainResource Definition of Medication Knowledge

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... identifier Σ 0..* Identifier Business identifier for this medication

... code Σ 0..1 CodeableConcept Code that identifies this medication
Binding: SNOMED CT Medication Codes (Example)
... status ?!Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... jurisdiction 0..* CodeableConcept Codes that identify the different jurisdictions for which the information of this resource was created

... name Σ 0..1 string A name associated with the medication being described
... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information

.... type 1..1 CodeableConcept Category of medicationKnowledge
.... reference 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge

... associatedMedication 0..* Reference(Medication) The set of medication resources that are associated with this medication

... productType 0..* CodeableConcept Category of the medication or product

... monograph 0..* BackboneElement Associated documentation about the medication

.... type 0..1 CodeableConcept The category of medication document
.... source 0..1 Reference(DocumentReference) Associated documentation about the medication
... preparationInstruction 0..1 markdown The instructions for preparing the medication
... cost 0..* BackboneElement The pricing of the medication

.... effectiveDate 0..* Period The date range for which the cost is effective

.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: Medication Cost Category Codes (Example)
..... costMoney Money
..... costCodeableConcept CodeableConcept
... monitoringProgram Σ 0..* BackboneElement Program under which a medication is reviewed

.... type 0..1 CodeableConcept Type of program under which the medication is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 0..* BackboneElement Guidelines or protocols for administration of the medication for an indication

.... indication 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline

.... dosingGuideline 0..* BackboneElement Guidelines for dosage of the medication

..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
..... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines

...... type 1..1 CodeableConcept Category of dosage for a medication
...... dosage 1..* Dosage Dosage for the medication for the specific guidelines

..... administrationTreatment 0..1 CodeableConcept Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines

...... type 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline
...... value[x] 0..1 The specific characteristic
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... medicineClassification 0..* BackboneElement 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)
.... source[x] 0..1 The source of the classification
..... sourceString string
..... sourceUri uri
.... classification 0..* CodeableConcept Specific category assigned to the medication

... packaging 0..* BackboneElement Details about packaged medications

.... cost 0..* see cost Cost of the packaged medication

.... packagedProduct 0..1 Reference(PackagedProductDefinition) The packaged medication that is being priced
... clinicalUseIssue 0..* Reference(ClinicalUseDefinition) Potential clinical issue with or between medication(s)

... storageGuideline 0..* BackboneElement How the medication should be stored

.... reference 0..1 uri Reference to additional information
.... note 0..* Annotation Additional storage notes

.... stabilityDuration 0..1 Duration Duration remains stable
.... environmentalSetting 0..* BackboneElement Setting or value of environment for adequate storage

..... type 1..1 CodeableConcept Categorization of the setting
..... value[x] 1..1 Value of the setting
...... valueQuantity Quantity
...... valueRange Range
...... valueCodeableConcept CodeableConcept
... regulatory 0..* BackboneElement Regulatory information about a medication

.... regulatoryAuthority 1..1 Reference(Organization) Specifies the authority of the regulation
.... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective

..... type 1..1 CodeableConcept Specifies the type of substitution allowed
..... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
.... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction

.... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
..... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
..... period 0..1 Duration The period that applies to the maximum number of units
... definitional 0..1 BackboneElement Minimal definition information about the medication
.... definition 0..* Reference(MedicinalProductDefinition) Definitional resources that provide more information about this medication

.... doseForm 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMED CT Form Codes (Example)
.... intendedRoute 0..* CodeableConcept The intended or approved route of administration
Binding: SNOMED CT Route Codes (Example)

.... ingredient Σ 0..* BackboneElement Active or inactive ingredient

..... item Σ 1..1 CodeableReference(Substance) Substances contained in the medication
..... type 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc
Binding: RoleClassIngredientEntity icon (Example)
..... strength[x] 0..1 Quantity of ingredient present
Binding: Medication Ingredient Strength Codes (Example)
...... strengthRatio Ratio
...... strengthCodeableConcept CodeableConcept
...... strengthQuantity Quantity
.... drugCharacteristic 0..* BackboneElement Specifies descriptive properties of the medicine

..... type 0..1 CodeableConcept Code specifying the type of characteristic of medication
Binding: medicationKnowledge Characteristic Codes (Example)
..... value[x] 0..1 Description of the characteristic
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueQuantity SimpleQuantity
...... valueBase64Binary base64Binary
...... valueAttachment Attachment

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

MedicationKnowledge (DomainResource) +MetadataResourceBusiness identifier for this medicationidentifier : Identifier [0..*]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 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 (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)PublicationStatus! »The creator or owner of the knowledge or information about the medicationauthor : ContactDetail [0..1]Lists the jurisdictions that this medication knowledge was written forjurisdiction : CodeableConcept [0..*]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 albuterolname : string [0..1]Links to associated medications that could be prescribed, dispensed or administeredassociatedMedication : 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]Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.)clinicalUseIssue : Reference [0..*] « ClinicalUseDefinition »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 »CostThe date range for which the cost information of the medication is effectiveeffectiveDate : Period [0..*]The 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 or representation of the cost (for example, Band A, Band B or $, $$) of the medicationcost[x] : DataType [1..1] « Money|CodeableConcept; null (Strength=Example) MedicationCostCategoryCodes?? »MonitoringProgramType of program under which the medication is monitoredtype : CodeableConcept [0..1]Name of the reviewing programname : string [0..1]IndicationGuidelineIndication or reason for use of the medication that applies to the specific administration guidelineindication : CodeableReference [0..*] « ClinicalUseDefinition »DosingGuidelineThe overall intention of the treatment, for example, prophylactic, supporative, curative, etctreatmentIntent : CodeableConcept [0..1]The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etcadministrationTreatment : CodeableConcept [0..1]DosageThe type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.)type : CodeableConcept [1..1]Dosage for the medication for the specific guidelinesdosage : Dosage [1..*]PatientCharacteristicThe categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender)type : CodeableConcept [1..1]The specific characteristic (e.g. height, weight, gender, etc.)value[x] : DataType [0..1] « CodeableConcept|Quantity|Range »MedicineClassificationThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)type : CodeableConcept [1..1]Either a textual source of the classification or a reference to an online sourcesource[x] : PrimitiveType [0..1] « string|uri »Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.)classification : CodeableConcept [0..*]PackagingA reference to a PackagedProductDefinition that provides the details of the product that is in the packaging and is being pricedpackagedProduct : Reference [0..1] « PackagedProductDefinition »StorageGuidelineReference to additional information about the storage guidelinesreference : uri [0..1]Additional notes about the storagenote : Annotation [0..*]Duration that the medication remains stable if the environmentalSetting is respectedstabilityDuration : Duration [0..1]EnvironmentalSettingIdentifies the category or type of setting (e.g., type of location, temperature, humidity)type : CodeableConcept [1..1]Value associated to the setting. E.g., 40° – 50°F for temperaturevalue[x] : DataType [1..1] « Quantity|Range|CodeableConcept »RegulatoryThe authority that is specifying the regulationsregulatoryAuthority : Reference [1..1] « Organization »Specifies the schedule of a medication in jurisdictionschedule : CodeableConcept [0..*]SubstitutionSpecifies the type of substitution allowedtype : CodeableConcept [1..1]Specifies if regulation allows for changes in the medication when dispensingallowed : boolean [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]DefinitionalAssociated definitions for this medicationdefinition : Reference [0..*] « MedicinalProductDefinition »Describes the form of the item. Powder; tablets; capsuledoseForm : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTFormCodes?? »The intended or approved route of administrationintendedRoute : CodeableConcept [0..*] « null (Strength=Example)SNOMEDCTRouteCodes?? »IngredientA reference to the resource that provides information about the ingredientitem : CodeableReference [1..1] « Substance »Indication of whether this ingredient affects the therapeutic action of the drugtype : CodeableConcept [0..1] « null (Strength=Example)RoleClassIngredientEntity?? »Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tabletstrength[x] : DataType [0..1] « Ratio|CodeableConcept|Quantity; null (Strength=Example) MedicationIngredientStrengthC...?? »DrugCharacteristicA code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint)type : CodeableConcept [0..1] « null (Strength=Example)MedicationKnowledgeCharacteri...?? »Description of the characteristicvalue[x] : DataType [0..1] « CodeableConcept|string|Quantity(SimpleQuantity)| base64Binary|Attachment »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. CrestorrelatedMedicationKnowledge[0..*]Associated documentation about the medicationmonograph[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.)patientCharacteristic[0..*]The guidelines for the dosage of the medication for the indicationdosingGuideline[0..*]Guidelines or protocols that are applicable for the administration of the medication based on indicationindicationGuideline[0..*]Categorization of the medication within a formulary or classification systemmedicineClassification[0..*]The cost of the packaged medicationcost[0..*]Information that only applies to packages (not products)packaging[0..*]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 lightenvironmentalSetting[0..*]Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperaturestorageGuideline[0..*]Specifies if changes are allowed when dispensing a medication from a regulatory perspectivesubstitution[0..*]The maximum number of units of the medication that can be dispensed in a periodmaxDispense[0..1]Regulatory information about a medicationregulatory[0..*]Identifies a particular constituent of interest in the productingredient[0..*]Specifies descriptive properties of the medicine, such as color, shape, imprints, etcdrugCharacteristic[0..*]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 describeddefinitional[0..1]

XML Template

<MedicationKnowledge xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for this medication --></identifier>
 <code><!-- 0..1 CodeableConcept Code that identifies this medication --></code>
 <status value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <author><!-- 0..1 ContactDetail Creator or owner of the knowledge or information about the medication --></author>
 <jurisdiction><!-- 0..* CodeableConcept Codes that identify the different jurisdictions for which the information of this resource was created --></jurisdiction>
 <name value="[string]"/><!-- 0..1 A name associated with the medication being described -->
 <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) The set of medication resources that are 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) Associated documentation about the medication --></source>
 </monograph>
 <preparationInstruction value="[markdown]"/><!-- 0..1 The instructions for preparing the medication -->
 <cost>  <!-- 0..* The pricing of the medication -->
  <effectiveDate><!-- 0..* Period The date range for which the cost is effective --></effectiveDate>
  <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[x]><!-- 1..1 Money|CodeableConcept The price or category of the cost of the medication --></cost[x]>
 </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>
 <indicationGuideline>  <!-- 0..* Guidelines or protocols for administration of the medication for an indication -->
  <indication><!-- 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline --></indication>
  <dosingGuideline>  <!-- 0..* Guidelines for dosage of the medication -->
   <treatmentIntent><!-- 0..1 CodeableConcept Intention of the treatment --></treatmentIntent>
   <dosage>  <!-- 0..* Dosage for the medication for the specific guidelines -->
    <type><!-- 1..1 CodeableConcept Category of dosage for a medication --></type>
    <dosage><!-- 1..* Dosage Dosage for the medication for the specific guidelines --></dosage>
   </dosage>
   <administrationTreatment><!-- 0..1 CodeableConcept Type of treatment the guideline applies to --></administrationTreatment>
   <patientCharacteristic>  <!-- 0..* Characteristics of the patient that are relevant to the administration guidelines -->
    <type><!-- 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline --></type>
    <value[x]><!-- 0..1 CodeableConcept|Quantity|Range The specific characteristic --></value[x]>
   </patientCharacteristic>
  </dosingGuideline>
 </indicationGuideline>
 <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>
  <source[x]><!-- 0..1 string|uri The source of the classification --></source[x]>
  <classification><!-- 0..* CodeableConcept Specific category assigned to the medication --></classification>
 </medicineClassification>
 <packaging>  <!-- 0..* Details about packaged medications -->
  <cost><!-- 0..* Content as for MedicationKnowledge.cost Cost of the packaged medication --></cost>
  <packagedProduct><!-- 0..1 Reference(PackagedProductDefinition) The packaged medication that is being priced --></packagedProduct>
 </packaging>
 <clinicalUseIssue><!-- 0..* Reference(ClinicalUseDefinition) Potential clinical issue with or between medication(s) --></clinicalUseIssue>
 <storageGuideline>  <!-- 0..* How the medication should be stored -->
  <reference value="[uri]"/><!-- 0..1 Reference to additional information -->
  <note><!-- 0..* Annotation Additional storage notes --></note>
  <stabilityDuration><!-- 0..1 Duration Duration remains stable --></stabilityDuration>
  <environmentalSetting>  <!-- 0..* Setting or value of environment for adequate storage -->
   <type><!-- 1..1 CodeableConcept Categorization of the setting --></type>
   <value[x]><!-- 1..1 Quantity|Range|CodeableConcept Value of the setting --></value[x]>
  </environmentalSetting>
 </storageGuideline>
 <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..* CodeableConcept Specifies the schedule of a medication in jurisdiction --></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>
 <definitional>  <!-- 0..1 Minimal definition information about the medication -->
  <definition><!-- 0..* Reference(MedicinalProductDefinition) Definitional resources that provide more information about this medication --></definition>
  <doseForm><!-- 0..1 CodeableConcept powder | tablets | capsule + --></doseForm>
  <intendedRoute><!-- 0..* CodeableConcept The intended or approved route of administration --></intendedRoute>
  <ingredient>  <!-- 0..* Active or inactive ingredient -->
   <item><!-- 1..1 CodeableReference(Substance) Substances contained in the medication --></item>
   <type><!-- 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc icon --></type>
   <strength[x]><!-- 0..1 Ratio|CodeableConcept|Quantity Quantity of ingredient present --></strength[x]>
  </ingredient>
  <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|Attachment Description of the characteristic --></value[x]>
  </drugCharacteristic>
 </definitional>
</MedicationKnowledge>

JSON Template

{doco
  "resourceType" : "MedicationKnowledge",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier for this medication
  "code" : { CodeableConcept }, // Code that identifies this medication
  "status" : "<code>", // draft | active | retired | unknown
  "author" : { ContactDetail }, // Creator or owner of the knowledge or information about the medication
  "jurisdiction" : [{ CodeableConcept }], // Codes that identify the different jurisdictions for which the information of this resource was created
  "name" : "<string>", // A name associated with the medication being described
  "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) }], // The set of medication resources that are 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) } // Associated documentation about the medication
  }],
  "preparationInstruction" : "<markdown>", // The instructions for preparing the medication
  "cost" : [{ // The pricing of the medication
    "effectiveDate" : [{ Period }], // The date range for which the cost is effective
    "type" : { CodeableConcept }, // R!  The category of the cost information
    "source" : "<string>", // The source or owner for the price information
    // cost[x]: The price or category of the cost of the medication. One of these 2:
    "costMoney" : { Money },
    "costCodeableConcept" : { CodeableConcept }
  }],
  "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
  }],
  "indicationGuideline" : [{ // Guidelines or protocols for administration of the medication for an indication
    "indication" : [{ CodeableReference(ClinicalUseDefinition) }], // Indication for use that applies to the specific administration guideline
    "dosingGuideline" : [{ // Guidelines for dosage of the medication
      "treatmentIntent" : { CodeableConcept }, // Intention of the treatment
      "dosage" : [{ // Dosage for the medication for the specific guidelines
        "type" : { CodeableConcept }, // R!  Category of dosage for a medication
        "dosage" : [{ Dosage }] // R!  Dosage for the medication for the specific guidelines
      }],
      "administrationTreatment" : { CodeableConcept }, // Type of treatment the guideline applies to
      "patientCharacteristic" : [{ // Characteristics of the patient that are relevant to the administration guidelines
        "type" : { CodeableConcept }, // R!  Categorization of specific characteristic that is relevant to the administration guideline
        // value[x]: The specific characteristic. One of these 3:
        "valueCodeableConcept" : { CodeableConcept },
        "valueQuantity" : { Quantity },
        "valueRange" : { Range }
      }]
    }]
  }],
  "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)
    // source[x]: The source of the classification. One of these 2:
    "sourceString" : "<string>",
    "sourceUri" : "<uri>",
    "classification" : [{ CodeableConcept }] // Specific category assigned to the medication
  }],
  "packaging" : [{ // Details about packaged medications
    "cost" : [{ Content as for MedicationKnowledge.cost }], // Cost of the packaged medication
    "packagedProduct" : { Reference(PackagedProductDefinition) } // The packaged medication that is being priced
  }],
  "clinicalUseIssue" : [{ Reference(ClinicalUseDefinition) }], // Potential clinical issue with or between medication(s)
  "storageGuideline" : [{ // How the medication should be stored
    "reference" : "<uri>", // Reference to additional information
    "note" : [{ Annotation }], // Additional storage notes
    "stabilityDuration" : { Duration }, // Duration remains stable
    "environmentalSetting" : [{ // Setting or value of environment for adequate storage
      "type" : { CodeableConcept }, // R!  Categorization of the setting
      // value[x]: Value of the setting. One of these 3:
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "valueCodeableConcept" : { CodeableConcept }
    }]
  }],
  "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" : [{ CodeableConcept }], // Specifies the schedule of a medication in jurisdiction
    "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
    }
  }],
  "definitional" : { // Minimal definition information about the medication
    "definition" : [{ Reference(MedicinalProductDefinition) }], // Definitional resources that provide more information about this medication
    "doseForm" : { CodeableConcept }, // powder | tablets | capsule +
    "intendedRoute" : [{ CodeableConcept }], // The intended or approved route of administration
    "ingredient" : [{ // Active or inactive ingredient
      "item" : { CodeableReference(Substance) }, // R!  Substances contained in the medication
      "type" : { CodeableConcept }, // A code that defines the type of ingredient, active, base, etc icon
      // strength[x]: Quantity of ingredient present. One of these 3:
      "strengthRatio" : { Ratio },
      "strengthCodeableConcept" : { CodeableConcept },
      "strengthQuantity" : { Quantity }
    }],
    "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 5:
      "valueCodeableConcept" : { CodeableConcept },
      "valueString" : "<string>",
      "valueQuantity" : { Quantity(SimpleQuantity) },
      "valueBase64Binary" : "<base64Binary>",
      "valueAttachment" : { Attachment }
    }]
  }
}

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:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for this medication
  fhir:code [ CodeableConcept ] ; # 0..1 Code that identifies this medication
  fhir:status [ code ] ; # 0..1 draft | active | retired | unknown
  fhir:author [ ContactDetail ] ; # 0..1 Creator or owner of the knowledge or information about the medication
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Codes that identify the different jurisdictions for which the information of this resource was created
  fhir:name [ string ] ; # 0..1 A name associated with the medication being described
  fhir:relatedMedicationKnowledge ( [ # 0..* Associated or related medication information
    fhir:type [ CodeableConcept ] ; # 1..1 Category of medicationKnowledge
    fhir:reference  ( [ Reference(MedicationKnowledge) ] ... ) ; # 1..* Associated documentation about the associated medication knowledge
  ] ... ) ;
  fhir:associatedMedication  ( [ Reference(Medication) ] ... ) ; # 0..* The set of medication resources that are associated with this medication
  fhir:productType  ( [ CodeableConcept ] ... ) ; # 0..* Category of the medication or product
  fhir:monograph ( [ # 0..* Associated documentation about the medication
    fhir:type [ CodeableConcept ] ; # 0..1 The category of medication document
    fhir:source [ Reference(DocumentReference) ] ; # 0..1 Associated documentation about the medication
  ] ... ) ;
  fhir:preparationInstruction [ markdown ] ; # 0..1 The instructions for preparing the medication
  fhir:cost ( [ # 0..* The pricing of the medication
    fhir:effectiveDate  ( [ Period ] ... ) ; # 0..* The date range for which the cost is effective
    fhir:type [ CodeableConcept ] ; # 1..1 The category of the cost information
    fhir:source [ string ] ; # 0..1 The source or owner for the price information
    # cost[x] : 1..1 The price or category of the cost of the medication. One of these 2
      fhir:cost [  a fhir:Money ; Money ]
      fhir:cost [  a fhir:CodeableConcept ; CodeableConcept ]
  ] ... ) ;
  fhir:monitoringProgram ( [ # 0..* Program under which a medication is reviewed
    fhir:type [ CodeableConcept ] ; # 0..1 Type of program under which the medication is monitored
    fhir:name [ string ] ; # 0..1 Name of the reviewing program
  ] ... ) ;
  fhir:indicationGuideline ( [ # 0..* Guidelines or protocols for administration of the medication for an indication
    fhir:indication  ( [ CodeableReference(ClinicalUseDefinition) ] ... ) ; # 0..* Indication for use that applies to the specific administration guideline
    fhir:dosingGuideline ( [ # 0..* Guidelines for dosage of the medication
      fhir:treatmentIntent [ CodeableConcept ] ; # 0..1 Intention of the treatment
      fhir:dosage ( [ # 0..* Dosage for the medication for the specific guidelines
        fhir:type [ CodeableConcept ] ; # 1..1 Category of dosage for a medication
        fhir:dosage  ( [ Dosage ] ... ) ; # 1..* Dosage for the medication for the specific guidelines
      ] ... ) ;
      fhir:administrationTreatment [ CodeableConcept ] ; # 0..1 Type of treatment the guideline applies to
      fhir:patientCharacteristic ( [ # 0..* Characteristics of the patient that are relevant to the administration guidelines
        fhir:type [ CodeableConcept ] ; # 1..1 Categorization of specific characteristic that is relevant to the administration guideline
        # value[x] : 0..1 The specific characteristic. One of these 3
          fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
          fhir:value [  a fhir:Quantity ; Quantity ]
          fhir:value [  a fhir:Range ; Range ]
      ] ... ) ;
    ] ... ) ;
  ] ... ) ;
  fhir:medicineClassification ( [ # 0..* Categorization of the medication within a formulary or classification system
    fhir:type [ CodeableConcept ] ; # 1..1 The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
    # source[x] : 0..1 The source of the classification. One of these 2
      fhir:source [  a fhir:string ; string ]
      fhir:source [  a fhir:uri ; uri ]
    fhir:classification  ( [ CodeableConcept ] ... ) ; # 0..* Specific category assigned to the medication
  ] ... ) ;
  fhir:packaging ( [ # 0..* Details about packaged medications
    fhir:cost  ( [ See MedicationKnowledge.cost ] ... ) ; # 0..* Cost of the packaged medication
    fhir:packagedProduct [ Reference(PackagedProductDefinition) ] ; # 0..1 The packaged medication that is being priced
  ] ... ) ;
  fhir:clinicalUseIssue  ( [ Reference(ClinicalUseDefinition) ] ... ) ; # 0..* Potential clinical issue with or between medication(s)
  fhir:storageGuideline ( [ # 0..* How the medication should be stored
    fhir:reference [ uri ] ; # 0..1 Reference to additional information
    fhir:note  ( [ Annotation ] ... ) ; # 0..* Additional storage notes
    fhir:stabilityDuration [ Duration ] ; # 0..1 Duration remains stable
    fhir:environmentalSetting ( [ # 0..* Setting or value of environment for adequate storage
      fhir:type [ CodeableConcept ] ; # 1..1 Categorization of the setting
      # value[x] : 1..1 Value of the setting. One of these 3
        fhir:value [  a fhir:Quantity ; Quantity ]
        fhir:value [  a fhir:Range ; Range ]
        fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
    ] ... ) ;
  ] ... ) ;
  fhir:regulatory ( [ # 0..* Regulatory information about a medication
    fhir:regulatoryAuthority [ Reference(Organization) ] ; # 1..1 Specifies the authority of the regulation
    fhir:substitution ( [ # 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective
      fhir:type [ CodeableConcept ] ; # 1..1 Specifies the type of substitution allowed
      fhir:allowed [ boolean ] ; # 1..1 Specifies if regulation allows for changes in the medication when dispensing
    ] ... ) ;
    fhir:schedule  ( [ CodeableConcept ] ... ) ; # 0..* Specifies the schedule of a medication in jurisdiction
    fhir:maxDispense [ # 0..1 The maximum number of units of the medication that can be dispensed in a period
      fhir:quantity [ Quantity(SimpleQuantity) ] ; # 1..1 The maximum number of units of the medication that can be dispensed
      fhir:period [ Duration ] ; # 0..1 The period that applies to the maximum number of units
    ] ;
  ] ... ) ;
  fhir:definitional [ # 0..1 Minimal definition information about the medication
    fhir:definition  ( [ Reference(MedicinalProductDefinition) ] ... ) ; # 0..* Definitional resources that provide more information about this medication
    fhir:doseForm [ CodeableConcept ] ; # 0..1 powder | tablets | capsule +
    fhir:intendedRoute  ( [ CodeableConcept ] ... ) ; # 0..* The intended or approved route of administration
    fhir:ingredient ( [ # 0..* Active or inactive ingredient
      fhir:item [ CodeableReference(Substance) ] ; # 1..1 Substances contained in the medication
      fhir:type [ CodeableConcept ] ; # 0..1 A code that defines the type of ingredient, active, base, etc
      # strength[x] : 0..1 Quantity of ingredient present. One of these 3
        fhir:strength [  a fhir:Ratio ; Ratio ]
        fhir:strength [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:strength [  a fhir:Quantity ; Quantity ]
    ] ... ) ;
    fhir:drugCharacteristic ( [ # 0..* Specifies descriptive properties of the medicine
      fhir:type [ CodeableConcept ] ; # 0..1 Code specifying the type of characteristic of medication
      # value[x] : 0..1 Description of the characteristic. One of these 5
        fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:value [  a fhir:string ; string ]
        fhir:value [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
        fhir:value [  a fhir:base64Binary ; base64Binary ]
        fhir:value [  a fhir:Attachment ; Attachment ]
    ] ... ) ;
  ] ;
]

Changes from both R4 and R4B

MedicationKnowledge
MedicationKnowledge.identifier
  • Added Element
MedicationKnowledge.status
  • Change value set from http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.0 to PublicationStatus
  • Remove codes inactive, entered-in-error
  • Add codes draft, retired, unknown
MedicationKnowledge.author
  • Added Element
MedicationKnowledge.jurisdiction
  • Added Element
MedicationKnowledge.name
  • Added Element
MedicationKnowledge.monograph.source
  • Type Reference: Removed Target Type Media
MedicationKnowledge.cost.effectiveDate
  • Added Element
MedicationKnowledge.cost.cost[x]
  • Renamed from cost to cost[x]
  • Add Type CodeableConcept
MedicationKnowledge.indicationGuideline
  • Added Element
MedicationKnowledge.indicationGuideline.indication
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.treatmentIntent
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.dosage
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.dosage.type
  • Added Mandatory Element
MedicationKnowledge.indicationGuideline.dosingGuideline.dosage.dosage
  • Added Mandatory Element
MedicationKnowledge.indicationGuideline.dosingGuideline.administrationTreatment
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic
  • Added Element
MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic.type
  • Added Mandatory Element
MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]
  • Added Element
MedicationKnowledge.medicineClassification.source[x]
  • Added Element
MedicationKnowledge.packaging
  • Max Cardinality changed from 1 to *
MedicationKnowledge.packaging.cost
  • Added Element
MedicationKnowledge.packaging.packagedProduct
  • Added Element
MedicationKnowledge.clinicalUseIssue
  • Added Element
MedicationKnowledge.storageGuideline
  • Added Element
MedicationKnowledge.storageGuideline.reference
  • Added Element
MedicationKnowledge.storageGuideline.note
  • Added Element
MedicationKnowledge.storageGuideline.stabilityDuration
  • Added Element
MedicationKnowledge.storageGuideline.environmentalSetting
  • Added Element
MedicationKnowledge.storageGuideline.environmentalSetting.type
  • Added Mandatory Element
MedicationKnowledge.storageGuideline.environmentalSetting.value[x]
  • Added Mandatory Element
MedicationKnowledge.regulatory.schedule
  • Type changed from BackboneElement to CodeableConcept
MedicationKnowledge.definitional
  • Added Element
MedicationKnowledge.definitional.definition
  • Added Element
MedicationKnowledge.definitional.doseForm
  • Added Element
MedicationKnowledge.definitional.intendedRoute
  • Added Element
MedicationKnowledge.definitional.ingredient
  • Added Element
MedicationKnowledge.definitional.ingredient.item
  • Added Mandatory Element
MedicationKnowledge.definitional.ingredient.type
  • Added Element
MedicationKnowledge.definitional.ingredient.strength[x]
  • Added Element
MedicationKnowledge.definitional.drugCharacteristic
  • Added Element
MedicationKnowledge.definitional.drugCharacteristic.type
  • Added Element
MedicationKnowledge.definitional.drugCharacteristic.value[x]
  • Added Element
MedicationKnowledge.manufacturer
  • Deleted
MedicationKnowledge.doseForm
  • Deleted
MedicationKnowledge.amount
  • Deleted
MedicationKnowledge.synonym
  • Deleted
MedicationKnowledge.ingredient
  • Deleted
MedicationKnowledge.intendedRoute
  • Deleted
MedicationKnowledge.administrationGuidelines
  • Deleted
MedicationKnowledge.packaging.type
  • Deleted
MedicationKnowledge.packaging.quantity
  • Deleted
MedicationKnowledge.drugCharacteristic
  • Deleted
MedicationKnowledge.contraindication
  • Deleted
MedicationKnowledge.regulatory.schedule.schedule
  • Deleted
MedicationKnowledge.kinetics
  • Deleted

See the Full Difference for further information

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

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

Path ValueSet Type Documentation
MedicationKnowledge.code SNOMEDCTMedicationCodes Example

This value set includes all drug or medicament substance codes and all pharmaceutical/biologic products from SNOMED CT - provided as an exemplar value set.

MedicationKnowledge.status PublicationStatus Required

The lifecycle status of an artifact.

MedicationKnowledge.cost.cost[x] MedicationCostCategoryCodes Example

Medication Cost Category Codes

MedicationKnowledge.definitional.doseForm SNOMEDCTFormCodes Example

This value set includes all dose form codes from SNOMED CT - provided as an exemplar.

MedicationKnowledge.definitional.intendedRoute SNOMEDCTRouteCodes Example

This value set includes all Route codes from SNOMED CT - provided as an exemplar.

MedicationKnowledge.definitional.ingredient.type RoleClassIngredientEntity icon Example

Relates a component (player) to a mixture (scoper). E.g., Glucose and Water are ingredients of D5W, latex may be an ingredient in a tracheal tube.

MedicationKnowledge.definitional.ingredient.strength[x] MedicationIngredientStrengthCodes Example

Medication Ingredient Strength Codes

MedicationKnowledge.definitional.drugCharacteristic.type MedicationKnowledgeCharacteristicCodes Example

MedicationKnowledge Characteristic Codes

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
classification token Specific category assigned to the medication MedicationKnowledge.medicineClassification.classification
classification-type token The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) MedicationKnowledge.medicineClassification.type
code token Code that identifies this medication MedicationKnowledge.code
doseform token powder | tablets | capsule + MedicationKnowledge.definitional.doseForm
identifier token Business identifier for this medication MedicationKnowledge.identifier 36 Resources
ingredient reference Reference to a resource (by instance) MedicationKnowledge.definitional.ingredient.item.reference
ingredient-code token Reference to a concept (by class) MedicationKnowledge.definitional.ingredient.item.concept
monitoring-program-name token Name of the reviewing program MedicationKnowledge.monitoringProgram.name
monitoring-program-type token Type of program under which the medication is monitored MedicationKnowledge.monitoringProgram.type
monograph reference Associated documentation about the medication MedicationKnowledge.monograph.source
(DocumentReference)
monograph-type token The category of medication document MedicationKnowledge.monograph.type
packaging-cost quantity The cost of the packaged medication, if the cost is Money
packaging-cost-concept token The cost of the packaged medication, if the cost is a CodeableConcept
product-type token Category of the medication or product MedicationKnowledge.productType
source-cost token The source or owner for the price information MedicationKnowledge.cost.source
status token active | inactive | entered-in-error MedicationKnowledge.status 36 Resources