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: 5.0.0

    FHIR MedicationKnowledge

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? code? medicationknowledgeStatusEnum status? author? intendedJurisdiction? name? relatedMedicationKnowledge? associatedMedication? productType? monograph? preparationInstruction? cost? monitoringProgram? indicationGuideline? medicineClassification? packaging? clinicalUseIssue? storageGuideline? regulatory? definitional?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getCode setCode hasCode getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getAuthor setAuthor hasAuthor getIntendedJurisdiction setIntendedJurisdiction addIntendedJurisdiction hasIntendedJurisdiction getNameElement setNameElement addNameElement hasNameElement getName setName addName hasName getRelatedMedicationKnowledge setRelatedMedicationKnowledge addRelatedMedicationKnowledge hasRelatedMedicationKnowledge getAssociatedMedication setAssociatedMedication addAssociatedMedication hasAssociatedMedication getProductType setProductType addProductType hasProductType getMonograph setMonograph addMonograph hasMonograph getPreparationInstructionElement setPreparationInstructionElement hasPreparationInstructionElement getPreparationInstruction setPreparationInstruction hasPreparationInstruction getCost setCost addCost hasCost getMonitoringProgram setMonitoringProgram addMonitoringProgram hasMonitoringProgram getIndicationGuideline setIndicationGuideline addIndicationGuideline hasIndicationGuideline getMedicineClassification setMedicineClassification addMedicineClassification hasMedicineClassification getPackaging setPackaging addPackaging hasPackaging getClinicalUseIssue setClinicalUseIssue addClinicalUseIssue hasClinicalUseIssue getStorageGuideline setStorageGuideline addStorageGuideline hasStorageGuideline getRegulatory setRegulatory addRegulatory hasRegulatory getDefinitional setDefinitional hasDefinitional 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 initIdentifier initIntendedJurisdiction initName initRelatedMedicationKnowledge initAssociatedMedication initProductType initMonograph initCost initMonitoringProgram initIndicationGuideline initMedicineClassification initPackaging initClinicalUseIssue initStorageGuideline initRegulatory

    Constructors

    Properties

    identifier?: Identifier[]

    MedicationKnowledge.identifier Element

    FHIR Specification

    • Short: Business identifier for this medication
    • Definition: Business identifier for this medication.
    • Comment: This is a business identifier, not a resource identifier (see discussion).
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    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 | entered-in-error | inactive
    • Definition: A code to indicate if the medication referred to by this MedicationKnowledge is in active use within the drug database or inventory system. The status refers to the validity about the information of the medication and not to its medicinal properties.
    • 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

    author?: Reference

    MedicationKnowledge.author Element

    FHIR Specification

    • Short: Creator or owner of the knowledge or information about the medication
    • Definition: The creator or owner of the knowledge or information about the medication.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    intendedJurisdiction?: CodeableConcept[]

    MedicationKnowledge.intendedJurisdiction Element

    FHIR Specification

    • Short: Codes that identify the different jurisdictions for which the information of this resource was created
    • Definition: Lists the jurisdictions that this medication knowledge was written for.
    • Comment: The codes could have varying granularity from a country or group of countries down to a specific district.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    name?: StringType[]

    MedicationKnowledge.name Element

    FHIR Specification

    • Short: A name associated with the medication being described
    • Definition: All of the names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and 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 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: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    associatedMedication?: Reference[]

    MedicationKnowledge.associatedMedication Element

    FHIR Specification

    • Short: The set of medication resources that are associated with this medication
    • Definition: Links to associated medications that could be prescribed, dispensed or administered.
    • 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
    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
    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: true
    indicationGuideline?: MedicationKnowledgeIndicationGuidelineComponent[]

    MedicationKnowledge.indicationGuideline Element

    FHIR Specification

    • Short: Guidelines or protocols for administration of the medication for an indication
    • Definition: Guidelines or protocols that are applicable for the administration of the medication based on indication.
    • 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..*
    • isModifier: false
    • isSummary: false
    clinicalUseIssue?: Reference[]

    MedicationKnowledge.clinicalUseIssue 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
    storageGuideline?: MedicationKnowledgeStorageGuidelineComponent[]

    MedicationKnowledge.storageGuideline Element

    FHIR Specification

    • Short: How the medication should be stored
    • Definition: Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.
    • FHIR Type: BackboneElement
    • 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
    definitional?: MedicationKnowledgeDefinitionalComponent

    MedicationKnowledge.definitional Element

    FHIR Specification

    • Short: Minimal definition information about the medication
    • Definition: Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetCodesetCodehasCodegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetAuthorsetAuthorhasAuthorgetIntendedJurisdictionsetIntendedJurisdictionaddIntendedJurisdictionhasIntendedJurisdictiongetNameElementsetNameElementaddNameElementhasNameElementgetNamesetNameaddNamehasNamegetRelatedMedicationKnowledgesetRelatedMedicationKnowledgeaddRelatedMedicationKnowledgehasRelatedMedicationKnowledgegetAssociatedMedicationsetAssociatedMedicationaddAssociatedMedicationhasAssociatedMedicationgetProductTypesetProductTypeaddProductTypehasProductTypegetMonographsetMonographaddMonographhasMonographgetPreparationInstructionElementsetPreparationInstructionElementhasPreparationInstructionElementgetPreparationInstructionsetPreparationInstructionhasPreparationInstructiongetCostsetCostaddCosthasCostgetMonitoringProgramsetMonitoringProgramaddMonitoringProgramhasMonitoringProgramgetIndicationGuidelinesetIndicationGuidelineaddIndicationGuidelinehasIndicationGuidelinegetMedicineClassificationsetMedicineClassificationaddMedicineClassificationhasMedicineClassificationgetPackagingsetPackagingaddPackaginghasPackaginggetClinicalUseIssuesetClinicalUseIssueaddClinicalUseIssuehasClinicalUseIssuegetStorageGuidelinesetStorageGuidelineaddStorageGuidelinehasStorageGuidelinegetRegulatorysetRegulatoryaddRegulatoryhasRegulatorygetDefinitionalsetDefinitionalhasDefinitionalfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitIntendedJurisdictioninitNameinitRelatedMedicationKnowledgeinitAssociatedMedicationinitProductTypeinitMonographinitCostinitMonitoringPrograminitIndicationGuidelineinitMedicineClassificationinitPackaginginitClinicalUseIssueinitStorageGuidelineinitRegulatory