This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Pharmacy Work Group | Maturity Level: 1 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Information about a medication that is used to support knowledge.
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.
This resource is referenced by CatalogEntry and itself.
This resource does not implement any patterns.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | TU | DomainResource | Definition of Medication Knowledge Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | Business identifier for this medication |
code | Σ | 0..1 | CodeableConcept | Code that identifies this medication SNOMED CT Medication Codes (Example) |
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Medication knowledge status codes (Required) |
author | 0..1 | Reference(Organization) | Creator or owner of the knowledge or information about the medication | |
manufacturer | Σ | 0..1 | Reference(Organization) | Manufacturer of the item |
doseForm | 0..1 | CodeableConcept | powder | tablets | capsule + SNOMED CT Form Codes (Example) | |
amount | Σ | 0..1 | SimpleQuantity | Amount of drug in package |
synonym | Σ | 0..* | string | Additional names for a medication |
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) | A medication resource that is associated with this medication | |
associatedDefinition | 0..1 | Reference(MedicinalProductDefinition) | A definition resource that is 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 | |
ingredient | Σ | 0..* | BackboneElement | Active or inactive ingredient |
item | Σ | 1..1 | CodeableReference(Ingredient) | Medication(s) or MedicinalProductIngredient(s) contained in the medication |
isActive | 0..1 | boolean | Active ingredient indicator | |
strength[x] | 0..1 | Quantity of ingredient present Medication ingredient strength codes (Example) | ||
strengthRatio | Ratio | |||
strengthCodeableConcept | CodeableConcept | |||
strengthQuantity | Quantity | |||
device | 0..* | Reference(Device) | A device associated with the medication (for example, a drug coated catheter or a drug impregnated dressing) | |
preparationInstruction | 0..1 | markdown | The instructions for preparing the medication | |
intendedRoute | 0..* | CodeableConcept | The intended or approved route of administration SNOMED CT Route Codes (Example) | |
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 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 | |
administrationGuideline | 0..* | BackboneElement | Guidelines or protocols for administration of the medication | |
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 | |
indication | 0..1 | CodeableReference(ClinicalUseIssue) | Indication for use that apply to the specific administration guidelines | |
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 | SimpleQuantity | |||
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) | |
classification | 0..* | CodeableConcept | Specific category assigned to the medication | |
packaging | 0..* | BackboneElement | Details about packaged medications | |
identifier | 0..1 | Identifier | Business identifier of the packaged medication | |
cost | 0..1 | see cost | Cost of the packaged medication | |
type | 0..1 | CodeableConcept | A code that defines the specific type of packaging that the medication can be found in SNOMED CT Unit of Presentation Codes (Example) | |
quantity | 0..1 | SimpleQuantity | The number of product units the package would contain if fully loaded | |
device | 0..1 | Reference(Device) | The device used to administer the medication (e.g. scoop, applicator, syringe) | |
material | 0..1 | CodeableConcept | Material type of the package item | |
packaging | 0..* | see packaging | Allows packages within packages | |
drugCharacteristic | 0..* | BackboneElement | Specifies descriptive properties of the medicine | |
type | 0..1 | CodeableConcept | Code specifying the type of characteristic of medication Medication knowledge characteristic codes (Example) | |
value[x] | 0..1 | Description of the characteristic | ||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | SimpleQuantity | |||
valueBase64Binary | base64Binary | |||
valueAttachment | Attachment | |||
clinicalUseIssue | 0..* | Reference(ClinicalUseIssue) | Potential clinical issue with or between medication(s) | |
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 | |
kineticCharacteristic | 0..* | BackboneElement | The time course of drug absorption, distribution, metabolism and excretion of a medication from the body | |
type | 0..1 | CodeableConcept | Code specifying the type of kinetics | |
value[x] | 0..1 | Description of the characteristic | ||
valueQuantity | SimpleQuantity | |||
valueDuration | Duration | |||
Documentation for this format |
UML Diagram (Legend)
XML Template
<MedicationKnowledge xmlns="http://hl7.org/fhir"> <!-- 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 active | inactive | entered-in-error --> <author><!-- 0..1 Reference(Organization) Creator or owner of the knowledge or information about the medication --></author> <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> <associatedDefinition><!-- 0..1 Reference(MedicinalProductDefinition) A definition resource that is associated with this medication --></associatedDefinition> <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> <ingredient> <!-- 0..* Active or inactive ingredient --> <item><!-- 1..1 CodeableReference(Ingredient) Medication(s) or MedicinalProductIngredient(s) contained in the medication --></item> <isActive value="[boolean]"/><!-- 0..1 Active ingredient indicator --> <strength[x]><!-- 0..1 Ratio|CodeableConcept|Quantity Quantity of ingredient present --></strength[x]> </ingredient> <device><!-- 0..* Reference(Device) A device associated with the medication (for example, a drug coated catheter or a drug impregnated dressing) --></device> <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 --> <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> <administrationGuideline> <!-- 0..* Guidelines or protocols for administration of the medication --> <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> <indication><!-- 0..1 CodeableReference(ClinicalUseIssue) Indication for use that apply to the specific administration guidelines --></indication> <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(SimpleQuantity) The specific characteristic --></value[x]> </patientCharacteristic> </administrationGuideline> <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..* Details about packaged medications --> <identifier><!-- 0..1 Identifier Business identifier of the packaged medication --></identifier> <cost><!-- 0..1 Content as for MedicationKnowledge.cost Cost of the packaged medication --></cost> <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> <device><!-- 0..1 Reference(Device) The device used to administer the medication (e.g. scoop, applicator, syringe) --></device> <material><!-- 0..1 CodeableConcept Material type of the package item --></material> <packaging><!-- 0..* Content as for MedicationKnowledge.packaging Allows packages within packages --></packaging> </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|Attachment Description of the characteristic --></value[x]> </drugCharacteristic> <clinicalUseIssue><!-- 0..* Reference(ClinicalUseIssue) Potential clinical issue with or between medication(s) --></clinicalUseIssue> <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> <kineticCharacteristic> <!-- 0..* The time course of drug absorption, distribution, metabolism and excretion of a medication from the body --> <type><!-- 0..1 CodeableConcept Code specifying the type of kinetics --></type> <value[x]><!-- 0..1 Quantity(SimpleQuantity)|Duration Description of the characteristic --></value[x]> </kineticCharacteristic> </MedicationKnowledge>
JSON Template
{ "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>", // active | inactive | entered-in-error "author" : { Reference(Organization) }, // Creator or owner of the knowledge or information about the medication "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 "associatedDefinition" : { Reference(MedicinalProductDefinition) }, // A definition 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) } // Associated documentation about the medication }], "ingredient" : [{ // Active or inactive ingredient "item" : { CodeableReference(Ingredient) }, // R! Medication(s) or MedicinalProductIngredient(s) contained in the medication "isActive" : <boolean>, // Active ingredient indicator // strength[x]: Quantity of ingredient present. One of these 3: "strengthRatio" : { Ratio } "strengthCodeableConcept" : { CodeableConcept } "strengthQuantity" : { Quantity } }], "device" : [{ Reference(Device) }], // A device associated with the medication (for example, a drug coated catheter or a drug impregnated dressing) "preparationInstruction" : "<markdown>", // The instructions for preparing the medication "intendedRoute" : [{ CodeableConcept }], // The intended or approved route of administration "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 }], "administrationGuideline" : [{ // Guidelines or protocols for administration of the medication "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 }], "indication" : { CodeableReference(ClinicalUseIssue) }, // Indication for use that apply to the specific administration guidelines "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 2: "valueCodeableConcept" : { CodeableConcept } "valueQuantity" : { Quantity(SimpleQuantity) } }] }], "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 "identifier" : { Identifier }, // Business identifier of the packaged medication "cost" : { Content as for MedicationKnowledge.cost }, // Cost of the packaged medication "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 "device" : { Reference(Device) }, // The device used to administer the medication (e.g. scoop, applicator, syringe) "material" : { CodeableConcept }, // Material type of the package item "packaging" : [{ Content as for MedicationKnowledge.packaging }] // Allows packages within packages }], "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 } }], "clinicalUseIssue" : [{ Reference(ClinicalUseIssue) }], // 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" : [{ 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 } }], "kineticCharacteristic" : [{ // The time course of drug absorption, distribution, metabolism and excretion of a medication from the body "type" : { CodeableConcept }, // Code specifying the type of kinetics // value[x]: Description of the characteristic. One of these 2: "valueQuantity" : { Quantity(SimpleQuantity) } "valueDuration" : { Duration } }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ 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.identifier [ Identifier ], ... ; # 0..* Business identifier for this medication fhir:MedicationKnowledge.code [ CodeableConcept ]; # 0..1 Code that identifies this medication fhir:MedicationKnowledge.status [ code ]; # 0..1 active | inactive | entered-in-error fhir:MedicationKnowledge.author [ Reference(Organization) ]; # 0..1 Creator or owner of the knowledge or information about the medication 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.associatedDefinition [ Reference(MedicinalProductDefinition) ]; # 0..1 A definition 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) ]; # 0..1 Associated documentation about the medication ], ...; fhir:MedicationKnowledge.ingredient [ # 0..* Active or inactive ingredient fhir:MedicationKnowledge.ingredient.item [ CodeableReference(Ingredient) ]; # 1..1 Medication(s) or MedicinalProductIngredient(s) contained in the medication fhir:MedicationKnowledge.ingredient.isActive [ boolean ]; # 0..1 Active ingredient indicator # MedicationKnowledge.ingredient.strength[x] : 0..1 Quantity of ingredient present. One of these 3 fhir:MedicationKnowledge.ingredient.strengthRatio [ Ratio ] fhir:MedicationKnowledge.ingredient.strengthCodeableConcept [ CodeableConcept ] fhir:MedicationKnowledge.ingredient.strengthQuantity [ Quantity ] ], ...; fhir:MedicationKnowledge.device [ Reference(Device) ], ... ; # 0..* A device associated with the medication (for example, a drug coated catheter or a drug impregnated dressing) 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.effectiveDate [ Period ], ... ; # 0..* The date range for which the cost is effective 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 # MedicationKnowledge.cost.cost[x] : 1..1 The price or category of the cost of the medication. One of these 2 fhir:MedicationKnowledge.cost.costMoney [ Money ] fhir:MedicationKnowledge.cost.costCodeableConcept [ CodeableConcept ] ], ...; 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.administrationGuideline [ # 0..* Guidelines or protocols for administration of the medication fhir:MedicationKnowledge.administrationGuideline.dosage [ # 0..* Dosage for the medication for the specific guidelines fhir:MedicationKnowledge.administrationGuideline.dosage.type [ CodeableConcept ]; # 1..1 Category of dosage for a medication fhir:MedicationKnowledge.administrationGuideline.dosage.dosage [ Dosage ], ... ; # 1..* Dosage for the medication for the specific guidelines ], ...; fhir:MedicationKnowledge.administrationGuideline.indication [ CodeableReference(ClinicalUseIssue) ]; # 0..1 Indication for use that apply to the specific administration guidelines fhir:MedicationKnowledge.administrationGuideline.patientCharacteristic [ # 0..* Characteristics of the patient that are relevant to the administration guidelines fhir:MedicationKnowledge.administrationGuideline.patientCharacteristic.type [ CodeableConcept ]; # 1..1 Categorization of specific characteristic that is relevant to the administration guideline # MedicationKnowledge.administrationGuideline.patientCharacteristic.value[x] : 0..1 The specific characteristic. One of these 2 fhir:MedicationKnowledge.administrationGuideline.patientCharacteristic.valueCodeableConcept [ CodeableConcept ] fhir:MedicationKnowledge.administrationGuideline.patientCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ] ], ...; ], ...; 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..* Details about packaged medications fhir:MedicationKnowledge.packaging.identifier [ Identifier ]; # 0..1 Business identifier of the packaged medication fhir:MedicationKnowledge.packaging.cost [ See MedicationKnowledge.cost ]; # 0..1 Cost of the packaged medication 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.packaging.device [ Reference(Device) ]; # 0..1 The device used to administer the medication (e.g. scoop, applicator, syringe) fhir:MedicationKnowledge.packaging.material [ CodeableConcept ]; # 0..1 Material type of the package item fhir:MedicationKnowledge.packaging.packaging [ See MedicationKnowledge.packaging ], ... ; # 0..* Allows packages within packages ], ...; 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 5 fhir:MedicationKnowledge.drugCharacteristic.valueCodeableConcept [ CodeableConcept ] fhir:MedicationKnowledge.drugCharacteristic.valueString [ string ] fhir:MedicationKnowledge.drugCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ] fhir:MedicationKnowledge.drugCharacteristic.valueBase64Binary [ base64Binary ] fhir:MedicationKnowledge.drugCharacteristic.valueAttachment [ Attachment ] ], ...; fhir:MedicationKnowledge.clinicalUseIssue [ Reference(ClinicalUseIssue) ], ... ; # 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 [ CodeableConcept ], ... ; # 0..* Specifies the schedule of a medication in jurisdiction 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.kineticCharacteristic [ # 0..* The time course of drug absorption, distribution, metabolism and excretion of a medication from the body fhir:MedicationKnowledge.kineticCharacteristic.type [ CodeableConcept ]; # 0..1 Code specifying the type of kinetics # MedicationKnowledge.kineticCharacteristic.value[x] : 0..1 Description of the characteristic. One of these 2 fhir:MedicationKnowledge.kineticCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ] fhir:MedicationKnowledge.kineticCharacteristic.valueDuration [ Duration ] ], ...; ]
Changes since R3
MedicationKnowledge | |
MedicationKnowledge.identifier |
|
MedicationKnowledge.status |
|
MedicationKnowledge.author |
|
MedicationKnowledge.associatedDefinition |
|
MedicationKnowledge.monograph.source |
|
MedicationKnowledge.ingredient.item |
|
MedicationKnowledge.ingredient.strength[x] |
|
MedicationKnowledge.device |
|
MedicationKnowledge.cost.effectiveDate |
|
MedicationKnowledge.cost.cost[x] |
|
MedicationKnowledge.administrationGuideline |
|
MedicationKnowledge.administrationGuideline.dosage |
|
MedicationKnowledge.administrationGuideline.dosage.type |
|
MedicationKnowledge.administrationGuideline.dosage.dosage |
|
MedicationKnowledge.administrationGuideline.indication |
|
MedicationKnowledge.administrationGuideline.patientCharacteristic |
|
MedicationKnowledge.administrationGuideline.patientCharacteristic.type |
|
MedicationKnowledge.administrationGuideline.patientCharacteristic.value[x] |
|
MedicationKnowledge.packaging |
|
MedicationKnowledge.packaging.identifier |
|
MedicationKnowledge.packaging.cost |
|
MedicationKnowledge.packaging.device |
|
MedicationKnowledge.packaging.material |
|
MedicationKnowledge.packaging.packaging |
|
MedicationKnowledge.drugCharacteristic.value[x] |
|
MedicationKnowledge.clinicalUseIssue |
|
MedicationKnowledge.regulatory.schedule |
|
MedicationKnowledge.kineticCharacteristic |
|
MedicationKnowledge.kineticCharacteristic.type |
|
MedicationKnowledge.kineticCharacteristic.value[x] |
|
MedicationKnowledge.ingredient.item[x] |
|
MedicationKnowledge.ingredient.strength |
|
MedicationKnowledge.cost.cost |
|
MedicationKnowledge.administrationGuidelines |
|
MedicationKnowledge.contraindication |
|
MedicationKnowledge.regulatory.schedule.schedule |
|
MedicationKnowledge.kinetics |
|
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | TU | DomainResource | Definition of Medication Knowledge Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | Business identifier for this medication |
code | Σ | 0..1 | CodeableConcept | Code that identifies this medication SNOMED CT Medication Codes (Example) |
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Medication knowledge status codes (Required) |
author | 0..1 | Reference(Organization) | Creator or owner of the knowledge or information about the medication | |
manufacturer | Σ | 0..1 | Reference(Organization) | Manufacturer of the item |
doseForm | 0..1 | CodeableConcept | powder | tablets | capsule + SNOMED CT Form Codes (Example) | |
amount | Σ | 0..1 | SimpleQuantity | Amount of drug in package |
synonym | Σ | 0..* | string | Additional names for a medication |
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) | A medication resource that is associated with this medication | |
associatedDefinition | 0..1 | Reference(MedicinalProductDefinition) | A definition resource that is 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 | |
ingredient | Σ | 0..* | BackboneElement | Active or inactive ingredient |
item | Σ | 1..1 | CodeableReference(Ingredient) | Medication(s) or MedicinalProductIngredient(s) contained in the medication |
isActive | 0..1 | boolean | Active ingredient indicator | |
strength[x] | 0..1 | Quantity of ingredient present Medication ingredient strength codes (Example) | ||
strengthRatio | Ratio | |||
strengthCodeableConcept | CodeableConcept | |||
strengthQuantity | Quantity | |||
device | 0..* | Reference(Device) | A device associated with the medication (for example, a drug coated catheter or a drug impregnated dressing) | |
preparationInstruction | 0..1 | markdown | The instructions for preparing the medication | |
intendedRoute | 0..* | CodeableConcept | The intended or approved route of administration SNOMED CT Route Codes (Example) | |
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 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 | |
administrationGuideline | 0..* | BackboneElement | Guidelines or protocols for administration of the medication | |
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 | |
indication | 0..1 | CodeableReference(ClinicalUseIssue) | Indication for use that apply to the specific administration guidelines | |
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 | SimpleQuantity | |||
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) | |
classification | 0..* | CodeableConcept | Specific category assigned to the medication | |
packaging | 0..* | BackboneElement | Details about packaged medications | |
identifier | 0..1 | Identifier | Business identifier of the packaged medication | |
cost | 0..1 | see cost | Cost of the packaged medication | |
type | 0..1 | CodeableConcept | A code that defines the specific type of packaging that the medication can be found in SNOMED CT Unit of Presentation Codes (Example) | |
quantity | 0..1 | SimpleQuantity | The number of product units the package would contain if fully loaded | |
device | 0..1 | Reference(Device) | The device used to administer the medication (e.g. scoop, applicator, syringe) | |
material | 0..1 | CodeableConcept | Material type of the package item | |
packaging | 0..* | see packaging | Allows packages within packages | |
drugCharacteristic | 0..* | BackboneElement | Specifies descriptive properties of the medicine | |
type | 0..1 | CodeableConcept | Code specifying the type of characteristic of medication Medication knowledge characteristic codes (Example) | |
value[x] | 0..1 | Description of the characteristic | ||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | SimpleQuantity | |||
valueBase64Binary | base64Binary | |||
valueAttachment | Attachment | |||
clinicalUseIssue | 0..* | Reference(ClinicalUseIssue) | Potential clinical issue with or between medication(s) | |
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 | |
kineticCharacteristic | 0..* | BackboneElement | The time course of drug absorption, distribution, metabolism and excretion of a medication from the body | |
type | 0..1 | CodeableConcept | Code specifying the type of kinetics | |
value[x] | 0..1 | Description of the characteristic | ||
valueQuantity | SimpleQuantity | |||
valueDuration | Duration | |||
Documentation for this format |
XML Template
<MedicationKnowledge xmlns="http://hl7.org/fhir"> <!-- 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 active | inactive | entered-in-error --> <author><!-- 0..1 Reference(Organization) Creator or owner of the knowledge or information about the medication --></author> <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> <associatedDefinition><!-- 0..1 Reference(MedicinalProductDefinition) A definition resource that is associated with this medication --></associatedDefinition> <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> <ingredient> <!-- 0..* Active or inactive ingredient --> <item><!-- 1..1 CodeableReference(Ingredient) Medication(s) or MedicinalProductIngredient(s) contained in the medication --></item> <isActive value="[boolean]"/><!-- 0..1 Active ingredient indicator --> <strength[x]><!-- 0..1 Ratio|CodeableConcept|Quantity Quantity of ingredient present --></strength[x]> </ingredient> <device><!-- 0..* Reference(Device) A device associated with the medication (for example, a drug coated catheter or a drug impregnated dressing) --></device> <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 --> <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> <administrationGuideline> <!-- 0..* Guidelines or protocols for administration of the medication --> <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> <indication><!-- 0..1 CodeableReference(ClinicalUseIssue) Indication for use that apply to the specific administration guidelines --></indication> <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(SimpleQuantity) The specific characteristic --></value[x]> </patientCharacteristic> </administrationGuideline> <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..* Details about packaged medications --> <identifier><!-- 0..1 Identifier Business identifier of the packaged medication --></identifier> <cost><!-- 0..1 Content as for MedicationKnowledge.cost Cost of the packaged medication --></cost> <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> <device><!-- 0..1 Reference(Device) The device used to administer the medication (e.g. scoop, applicator, syringe) --></device> <material><!-- 0..1 CodeableConcept Material type of the package item --></material> <packaging><!-- 0..* Content as for MedicationKnowledge.packaging Allows packages within packages --></packaging> </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|Attachment Description of the characteristic --></value[x]> </drugCharacteristic> <clinicalUseIssue><!-- 0..* Reference(ClinicalUseIssue) Potential clinical issue with or between medication(s) --></clinicalUseIssue> <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> <kineticCharacteristic> <!-- 0..* The time course of drug absorption, distribution, metabolism and excretion of a medication from the body --> <type><!-- 0..1 CodeableConcept Code specifying the type of kinetics --></type> <value[x]><!-- 0..1 Quantity(SimpleQuantity)|Duration Description of the characteristic --></value[x]> </kineticCharacteristic> </MedicationKnowledge>
JSON Template
{ "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>", // active | inactive | entered-in-error "author" : { Reference(Organization) }, // Creator or owner of the knowledge or information about the medication "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 "associatedDefinition" : { Reference(MedicinalProductDefinition) }, // A definition 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) } // Associated documentation about the medication }], "ingredient" : [{ // Active or inactive ingredient "item" : { CodeableReference(Ingredient) }, // R! Medication(s) or MedicinalProductIngredient(s) contained in the medication "isActive" : <boolean>, // Active ingredient indicator // strength[x]: Quantity of ingredient present. One of these 3: "strengthRatio" : { Ratio } "strengthCodeableConcept" : { CodeableConcept } "strengthQuantity" : { Quantity } }], "device" : [{ Reference(Device) }], // A device associated with the medication (for example, a drug coated catheter or a drug impregnated dressing) "preparationInstruction" : "<markdown>", // The instructions for preparing the medication "intendedRoute" : [{ CodeableConcept }], // The intended or approved route of administration "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 }], "administrationGuideline" : [{ // Guidelines or protocols for administration of the medication "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 }], "indication" : { CodeableReference(ClinicalUseIssue) }, // Indication for use that apply to the specific administration guidelines "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 2: "valueCodeableConcept" : { CodeableConcept } "valueQuantity" : { Quantity(SimpleQuantity) } }] }], "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 "identifier" : { Identifier }, // Business identifier of the packaged medication "cost" : { Content as for MedicationKnowledge.cost }, // Cost of the packaged medication "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 "device" : { Reference(Device) }, // The device used to administer the medication (e.g. scoop, applicator, syringe) "material" : { CodeableConcept }, // Material type of the package item "packaging" : [{ Content as for MedicationKnowledge.packaging }] // Allows packages within packages }], "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 } }], "clinicalUseIssue" : [{ Reference(ClinicalUseIssue) }], // 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" : [{ 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 } }], "kineticCharacteristic" : [{ // The time course of drug absorption, distribution, metabolism and excretion of a medication from the body "type" : { CodeableConcept }, // Code specifying the type of kinetics // value[x]: Description of the characteristic. One of these 2: "valueQuantity" : { Quantity(SimpleQuantity) } "valueDuration" : { Duration } }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ 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.identifier [ Identifier ], ... ; # 0..* Business identifier for this medication fhir:MedicationKnowledge.code [ CodeableConcept ]; # 0..1 Code that identifies this medication fhir:MedicationKnowledge.status [ code ]; # 0..1 active | inactive | entered-in-error fhir:MedicationKnowledge.author [ Reference(Organization) ]; # 0..1 Creator or owner of the knowledge or information about the medication 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.associatedDefinition [ Reference(MedicinalProductDefinition) ]; # 0..1 A definition 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) ]; # 0..1 Associated documentation about the medication ], ...; fhir:MedicationKnowledge.ingredient [ # 0..* Active or inactive ingredient fhir:MedicationKnowledge.ingredient.item [ CodeableReference(Ingredient) ]; # 1..1 Medication(s) or MedicinalProductIngredient(s) contained in the medication fhir:MedicationKnowledge.ingredient.isActive [ boolean ]; # 0..1 Active ingredient indicator # MedicationKnowledge.ingredient.strength[x] : 0..1 Quantity of ingredient present. One of these 3 fhir:MedicationKnowledge.ingredient.strengthRatio [ Ratio ] fhir:MedicationKnowledge.ingredient.strengthCodeableConcept [ CodeableConcept ] fhir:MedicationKnowledge.ingredient.strengthQuantity [ Quantity ] ], ...; fhir:MedicationKnowledge.device [ Reference(Device) ], ... ; # 0..* A device associated with the medication (for example, a drug coated catheter or a drug impregnated dressing) 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.effectiveDate [ Period ], ... ; # 0..* The date range for which the cost is effective 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 # MedicationKnowledge.cost.cost[x] : 1..1 The price or category of the cost of the medication. One of these 2 fhir:MedicationKnowledge.cost.costMoney [ Money ] fhir:MedicationKnowledge.cost.costCodeableConcept [ CodeableConcept ] ], ...; 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.administrationGuideline [ # 0..* Guidelines or protocols for administration of the medication fhir:MedicationKnowledge.administrationGuideline.dosage [ # 0..* Dosage for the medication for the specific guidelines fhir:MedicationKnowledge.administrationGuideline.dosage.type [ CodeableConcept ]; # 1..1 Category of dosage for a medication fhir:MedicationKnowledge.administrationGuideline.dosage.dosage [ Dosage ], ... ; # 1..* Dosage for the medication for the specific guidelines ], ...; fhir:MedicationKnowledge.administrationGuideline.indication [ CodeableReference(ClinicalUseIssue) ]; # 0..1 Indication for use that apply to the specific administration guidelines fhir:MedicationKnowledge.administrationGuideline.patientCharacteristic [ # 0..* Characteristics of the patient that are relevant to the administration guidelines fhir:MedicationKnowledge.administrationGuideline.patientCharacteristic.type [ CodeableConcept ]; # 1..1 Categorization of specific characteristic that is relevant to the administration guideline # MedicationKnowledge.administrationGuideline.patientCharacteristic.value[x] : 0..1 The specific characteristic. One of these 2 fhir:MedicationKnowledge.administrationGuideline.patientCharacteristic.valueCodeableConcept [ CodeableConcept ] fhir:MedicationKnowledge.administrationGuideline.patientCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ] ], ...; ], ...; 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..* Details about packaged medications fhir:MedicationKnowledge.packaging.identifier [ Identifier ]; # 0..1 Business identifier of the packaged medication fhir:MedicationKnowledge.packaging.cost [ See MedicationKnowledge.cost ]; # 0..1 Cost of the packaged medication 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.packaging.device [ Reference(Device) ]; # 0..1 The device used to administer the medication (e.g. scoop, applicator, syringe) fhir:MedicationKnowledge.packaging.material [ CodeableConcept ]; # 0..1 Material type of the package item fhir:MedicationKnowledge.packaging.packaging [ See MedicationKnowledge.packaging ], ... ; # 0..* Allows packages within packages ], ...; 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 5 fhir:MedicationKnowledge.drugCharacteristic.valueCodeableConcept [ CodeableConcept ] fhir:MedicationKnowledge.drugCharacteristic.valueString [ string ] fhir:MedicationKnowledge.drugCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ] fhir:MedicationKnowledge.drugCharacteristic.valueBase64Binary [ base64Binary ] fhir:MedicationKnowledge.drugCharacteristic.valueAttachment [ Attachment ] ], ...; fhir:MedicationKnowledge.clinicalUseIssue [ Reference(ClinicalUseIssue) ], ... ; # 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 [ CodeableConcept ], ... ; # 0..* Specifies the schedule of a medication in jurisdiction 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.kineticCharacteristic [ # 0..* The time course of drug absorption, distribution, metabolism and excretion of a medication from the body fhir:MedicationKnowledge.kineticCharacteristic.type [ CodeableConcept ]; # 0..1 Code specifying the type of kinetics # MedicationKnowledge.kineticCharacteristic.value[x] : 0..1 Description of the characteristic. One of these 2 fhir:MedicationKnowledge.kineticCharacteristic.valueSimpleQuantity [ Quantity(SimpleQuantity) ] fhir:MedicationKnowledge.kineticCharacteristic.valueDuration [ Duration ] ], ...; ]
Changes since Release 3
MedicationKnowledge | |
MedicationKnowledge.identifier |
|
MedicationKnowledge.status |
|
MedicationKnowledge.author |
|
MedicationKnowledge.associatedDefinition |
|
MedicationKnowledge.monograph.source |
|
MedicationKnowledge.ingredient.item |
|
MedicationKnowledge.ingredient.strength[x] |
|
MedicationKnowledge.device |
|
MedicationKnowledge.cost.effectiveDate |
|
MedicationKnowledge.cost.cost[x] |
|
MedicationKnowledge.administrationGuideline |
|
MedicationKnowledge.administrationGuideline.dosage |
|
MedicationKnowledge.administrationGuideline.dosage.type |
|
MedicationKnowledge.administrationGuideline.dosage.dosage |
|
MedicationKnowledge.administrationGuideline.indication |
|
MedicationKnowledge.administrationGuideline.patientCharacteristic |
|
MedicationKnowledge.administrationGuideline.patientCharacteristic.type |
|
MedicationKnowledge.administrationGuideline.patientCharacteristic.value[x] |
|
MedicationKnowledge.packaging |
|
MedicationKnowledge.packaging.identifier |
|
MedicationKnowledge.packaging.cost |
|
MedicationKnowledge.packaging.device |
|
MedicationKnowledge.packaging.material |
|
MedicationKnowledge.packaging.packaging |
|
MedicationKnowledge.drugCharacteristic.value[x] |
|
MedicationKnowledge.clinicalUseIssue |
|
MedicationKnowledge.regulatory.schedule |
|
MedicationKnowledge.kineticCharacteristic |
|
MedicationKnowledge.kineticCharacteristic.type |
|
MedicationKnowledge.kineticCharacteristic.value[x] |
|
MedicationKnowledge.ingredient.item[x] |
|
MedicationKnowledge.ingredient.strength |
|
MedicationKnowledge.cost.cost |
|
MedicationKnowledge.administrationGuidelines |
|
MedicationKnowledge.contraindication |
|
MedicationKnowledge.regulatory.schedule.schedule |
|
MedicationKnowledge.kinetics |
|
See the Full Difference for further information
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a
Path | Definition | Type | Reference |
---|---|---|---|
MedicationKnowledge.code | A coded concept that defines the type of a medication. | Example | SNOMEDCTMedicationCodes |
MedicationKnowledge.status | A coded concept defining if the medication is in active use. | Required | MedicationKnowledge Status Codes |
MedicationKnowledge.doseForm | A coded concept defining the form of a medication. | Example | SNOMEDCTFormCodes |
MedicationKnowledge.ingredient.strength[x] | A coded concept defining the strength of an ingredient. | Example | Medication Ingredient Strength Codes |
MedicationKnowledge.intendedRoute | A coded concept defining the intended route of administration. | Example | SNOMEDCTRouteCodes |
MedicationKnowledge.cost.cost[x] | A coded concept defining the category of a medication. | Example | Medication Cost Category Codes |
MedicationKnowledge.packaging.type | A coded concept defining the type of packaging of a medication. | Example | SNOMEDCTUnitofPresentationCodes |
MedicationKnowledge.drugCharacteristic.type | A coded concept defining the characteristic types of a medication. | Example | medicationKnowledge Characteristic Codes |
Search parameters for 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.doseForm | |
identifier | token | Business identifier for this medication | MedicationKnowledge.identifier | |
ingredient D | reference | Reference to a resource (by instance) | MedicationKnowledge.ingredient.item.reference | |
ingredient-code D | token | Reference to a concept (by class) | MedicationKnowledge.ingredient.item.concept | |
manufacturer | reference | Manufacturer of the item | MedicationKnowledge.manufacturer (Organization) | |
monitoring-program-name N | 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 N | token | The source or owner for the price information | MedicationKnowledge.cost.source | |
status N | token | active | inactive | entered-in-error | MedicationKnowledge.status |