Data Model Libraries
    Preparing search index...

    Class MedicationKnowledge

    MedicationKnowledge Class

    Information about a medication that is used to support knowledge.

    FHIR Specification

    • Short: Definition of Medication Knowledge
    • Definition: Information about a medication that is used to support knowledge.
    • FHIR Version: 4.0.1

    FHIR MedicationKnowledge

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    code? medicationknowledgeStatusEnum status? manufacturer? doseForm? amount? synonym? relatedMedicationKnowledge? associatedMedication? productType? monograph? ingredient? preparationInstruction? intendedRoute? cost? monitoringProgram? administrationGuidelines? medicineClassification? packaging? drugCharacteristic? contraindication? regulatory? kinetics?

    Methods

    parse getCode setCode hasCode getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getManufacturer setManufacturer hasManufacturer getDoseForm setDoseForm hasDoseForm getAmount setAmount hasAmount getSynonymElement setSynonymElement addSynonymElement hasSynonymElement getSynonym setSynonym addSynonym hasSynonym getRelatedMedicationKnowledge setRelatedMedicationKnowledge addRelatedMedicationKnowledge hasRelatedMedicationKnowledge getAssociatedMedication setAssociatedMedication addAssociatedMedication hasAssociatedMedication getProductType setProductType addProductType hasProductType getMonograph setMonograph addMonograph hasMonograph getIngredient setIngredient addIngredient hasIngredient getPreparationInstructionElement setPreparationInstructionElement hasPreparationInstructionElement getPreparationInstruction setPreparationInstruction hasPreparationInstruction getIntendedRoute setIntendedRoute addIntendedRoute hasIntendedRoute getCost setCost addCost hasCost getMonitoringProgram setMonitoringProgram addMonitoringProgram hasMonitoringProgram getAdministrationGuidelines setAdministrationGuidelines addAdministrationGuidelines hasAdministrationGuidelines getMedicineClassification setMedicineClassification addMedicineClassification hasMedicineClassification getPackaging setPackaging hasPackaging getDrugCharacteristic setDrugCharacteristic addDrugCharacteristic hasDrugCharacteristic getContraindication setContraindication addContraindication hasContraindication getRegulatory setRegulatory addRegulatory hasRegulatory getKinetics setKinetics addKinetics hasKinetics fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initSynonym initRelatedMedicationKnowledge initAssociatedMedication initProductType initMonograph initIngredient initIntendedRoute initCost initMonitoringProgram initAdministrationGuidelines initMedicineClassification initDrugCharacteristic initContraindication initRegulatory initKinetics

    Constructors

    Properties

    code?: CodeableConcept

    MedicationKnowledge.code Element

    FHIR Specification

    • Short: Code that identifies this medication
    • Definition: A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
    • Comment: Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    medicationknowledgeStatusEnum: MedicationknowledgeStatusEnum

    FHIR CodeSystem: MedicationknowledgeStatus

    MedicationknowledgeStatusEnum

    status?: EnumCodeType

    MedicationKnowledge.status Element

    FHIR Specification

    • Short: active | inactive | entered-in-error
    • Definition: A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.
    • Comment: This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element changes the interpretation of all descriptive attributes.
    • isSummary: true

    CodeSystem Enumeration: MedicationknowledgeStatusEnum

    manufacturer?: Reference

    MedicationKnowledge.manufacturer Element

    FHIR Specification

    • Short: Manufacturer of the item
    • Definition: Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    doseForm?: CodeableConcept

    MedicationKnowledge.doseForm Element

    FHIR Specification

    • Short: powder | tablets | capsule +
    • Definition: Describes the form of the item. Powder; tablets; capsule.
    • Comment: When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    amount?: Quantity

    MedicationKnowledge.amount Element

    FHIR Specification

    • Short: Amount of drug in package
    • Definition: Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
    • Comment: This is the quantity of medication in a package. To specify the strength of the medication, the Ingredient.strength attribute is used.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    synonym?: StringType[]

    MedicationKnowledge.synonym Element

    FHIR Specification

    • Short: Additional names for a medication
    • Definition: Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    relatedMedicationKnowledge?: MedicationKnowledgeRelatedMedicationKnowledgeComponent[]

    MedicationKnowledge.relatedMedicationKnowledge Element

    FHIR Specification

    • Short: Associated or related medication information
    • Definition: Associated or related knowledge about a medication.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    associatedMedication?: Reference[]

    MedicationKnowledge.associatedMedication Element

    FHIR Specification

    • Short: A medication resource that is associated with this medication
    • Definition: Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    productType?: CodeableConcept[]

    MedicationKnowledge.productType Element

    FHIR Specification

    • Short: Category of the medication or product
    • Definition: Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    monograph?: MedicationKnowledgeMonographComponent[]

    MedicationKnowledge.monograph Element

    FHIR Specification

    • Short: Associated documentation about the medication
    • Definition: Associated documentation about the medication.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    ingredient?: MedicationKnowledgeIngredientComponent[]

    MedicationKnowledge.ingredient Element

    FHIR Specification

    • Short: Active or inactive ingredient
    • Definition: Identifies a particular constituent of interest in the product.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    preparationInstruction?: MarkdownType

    MedicationKnowledge.preparationInstruction Element

    FHIR Specification

    • Short: The instructions for preparing the medication
    • Definition: The instructions for preparing the medication.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    intendedRoute?: CodeableConcept[]

    MedicationKnowledge.intendedRoute Element

    FHIR Specification

    • Short: The intended or approved route of administration
    • Definition: The intended or approved route of administration.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    cost?: MedicationKnowledgeCostComponent[]

    MedicationKnowledge.cost Element

    FHIR Specification

    • Short: The pricing of the medication
    • Definition: The price of the medication.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    monitoringProgram?: MedicationKnowledgeMonitoringProgramComponent[]

    MedicationKnowledge.monitoringProgram Element

    FHIR Specification

    • Short: Program under which a medication is reviewed
    • Definition: The program under which the medication is reviewed.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    administrationGuidelines?: MedicationKnowledgeAdministrationGuidelinesComponent[]

    MedicationKnowledge.administrationGuidelines Element

    FHIR Specification

    • Short: Guidelines for administration of the medication
    • Definition: Guidelines for the administration of the medication.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    medicineClassification?: MedicationKnowledgeMedicineClassificationComponent[]

    MedicationKnowledge.medicineClassification Element

    FHIR Specification

    • Short: Categorization of the medication within a formulary or classification system
    • Definition: Categorization of the medication within a formulary or classification system.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    packaging?: MedicationKnowledgePackagingComponent

    MedicationKnowledge.packaging Element

    FHIR Specification

    • Short: Details about packaged medications
    • Definition: Information that only applies to packages (not products).
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    drugCharacteristic?: MedicationKnowledgeDrugCharacteristicComponent[]

    MedicationKnowledge.drugCharacteristic Element

    FHIR Specification

    • Short: Specifies descriptive properties of the medicine
    • Definition: Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    contraindication?: Reference[]

    MedicationKnowledge.contraindication Element

    FHIR Specification

    • Short: Potential clinical issue with or between medication(s)
    • Definition: Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    regulatory?: MedicationKnowledgeRegulatoryComponent[]

    MedicationKnowledge.regulatory Element

    FHIR Specification

    • Short: Regulatory information about a medication
    • Definition: Regulatory information about a medication.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    kinetics?: MedicationKnowledgeKineticsComponent[]

    MedicationKnowledge.kinetics Element

    FHIR Specification

    • Short: The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
    • Definition: The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided MedicationKnowledge JSON to instantiate the MedicationKnowledge data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationKnowledge

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MedicationKnowledge

      Returns undefined | MedicationKnowledge

      MedicationKnowledge data model or undefined for MedicationKnowledge

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetCodesetCodehasCodegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetManufacturersetManufacturerhasManufacturergetDoseFormsetDoseFormhasDoseFormgetAmountsetAmounthasAmountgetSynonymElementsetSynonymElementaddSynonymElementhasSynonymElementgetSynonymsetSynonymaddSynonymhasSynonymgetRelatedMedicationKnowledgesetRelatedMedicationKnowledgeaddRelatedMedicationKnowledgehasRelatedMedicationKnowledgegetAssociatedMedicationsetAssociatedMedicationaddAssociatedMedicationhasAssociatedMedicationgetProductTypesetProductTypeaddProductTypehasProductTypegetMonographsetMonographaddMonographhasMonographgetIngredientsetIngredientaddIngredienthasIngredientgetPreparationInstructionElementsetPreparationInstructionElementhasPreparationInstructionElementgetPreparationInstructionsetPreparationInstructionhasPreparationInstructiongetIntendedRoutesetIntendedRouteaddIntendedRoutehasIntendedRoutegetCostsetCostaddCosthasCostgetMonitoringProgramsetMonitoringProgramaddMonitoringProgramhasMonitoringProgramgetAdministrationGuidelinessetAdministrationGuidelinesaddAdministrationGuidelineshasAdministrationGuidelinesgetMedicineClassificationsetMedicineClassificationaddMedicineClassificationhasMedicineClassificationgetPackagingsetPackaginghasPackaginggetDrugCharacteristicsetDrugCharacteristicaddDrugCharacteristichasDrugCharacteristicgetContraindicationsetContraindicationaddContraindicationhasContraindicationgetRegulatorysetRegulatoryaddRegulatoryhasRegulatorygetKineticssetKineticsaddKineticshasKineticsfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitSynonyminitRelatedMedicationKnowledgeinitAssociatedMedicationinitProductTypeinitMonographinitIngredientinitIntendedRouteinitCostinitMonitoringPrograminitAdministrationGuidelinesinitMedicineClassificationinitDrugCharacteristicinitContraindicationinitRegulatoryinitKinetics