Class MedicationKnowledge

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class MedicationKnowledge extends DomainResource
Information about a medication that is used to support knowledge.
See Also:
  • Field Details

    • identifier

      Business identifier for this medication.
    • code

      protected CodeableConcept code
      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.
    • status

      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.
    • author

      protected Reference author
      The creator or owner of the knowledge or information about the medication.
    • intendedJurisdiction

      Lists the jurisdictions that this medication knowledge was written for.
    • name

      protected List<StringType> name
      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.
    • relatedMedicationKnowledge

      Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor.
    • associatedMedication

      Links to associated medications that could be prescribed, dispensed or administered.
    • productType

      Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
    • monograph

      Associated documentation about the medication.
    • preparationInstruction

      The instructions for preparing the medication.
    • cost

      The price of the medication.
    • monitoringProgram

      The program under which the medication is reviewed.
    • indicationGuideline

      Guidelines or protocols that are applicable for the administration of the medication based on indication.
    • medicineClassification

      Categorization of the medication within a formulary or classification system.
    • packaging

      Information that only applies to packages (not products).
    • clinicalUseIssue

      Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
    • storageGuideline

      Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.
    • regulatory

      Regulatory information about a medication.
    • definitional

      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.
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): External identifier for the activity definition [ActorDefinition](actordefinition.html): External identifier for the Actor Definition [CapabilityStatement](capabilitystatement.html): External identifier for the capability statement [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition [Citation](citation.html): External identifier for the citation [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition [EventDefinition](eventdefinition.html): External identifier for the event definition [Evidence](evidence.html): External identifier for the evidence [EvidenceReport](evidencereport.html): External identifier for the evidence report [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable [ExampleScenario](examplescenario.html): External identifier for the example scenario [GraphDefinition](graphdefinition.html): External identifier for the graph definition [ImplementationGuide](implementationguide.html): External identifier for the implementation guide [Library](library.html): External identifier for the library [Measure](measure.html): External identifier for the measure [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication [MessageDefinition](messagedefinition.html): External identifier for the message definition [NamingSystem](namingsystem.html): External identifier for the naming system [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition [OperationDefinition](operationdefinition.html): External identifier for the search parameter [PlanDefinition](plandefinition.html): External identifier for the plan definition [Questionnaire](questionnaire.html): External identifier for the questionnaire [Requirements](requirements.html): External identifier for the requirements [SearchParameter](searchparameter.html): External identifier for the search parameter [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities [TestPlan](testplan.html): An identifier for the test plan [TestScript](testscript.html): External identifier for the test script [ValueSet](valueset.html): External identifier for the value set
      Type: token
      Path: ActivityDefinition.identifier | ActorDefinition.identifier | CapabilityStatement.identifier | ChargeItemDefinition.identifier | Citation.identifier | CodeSystem.identifier | ConceptMap.identifier | ConditionDefinition.identifier | EventDefinition.identifier | Evidence.identifier | EvidenceReport.identifier | EvidenceVariable.identifier | ExampleScenario.identifier | GraphDefinition.identifier | ImplementationGuide.identifier | Library.identifier | Measure.identifier | MedicationKnowledge.identifier | MessageDefinition.identifier | NamingSystem.identifier | ObservationDefinition.identifier | OperationDefinition.identifier | PlanDefinition.identifier | Questionnaire.identifier | Requirements.identifier | SearchParameter.identifier | SpecimenDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | SubscriptionTopic.identifier | TerminologyCapabilities.identifier | TestPlan.identifier | TestScript.identifier | ValueSet.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): External identifier for the activity definition [ActorDefinition](actordefinition.html): External identifier for the Actor Definition [CapabilityStatement](capabilitystatement.html): External identifier for the capability statement [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition [Citation](citation.html): External identifier for the citation [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition [EventDefinition](eventdefinition.html): External identifier for the event definition [Evidence](evidence.html): External identifier for the evidence [EvidenceReport](evidencereport.html): External identifier for the evidence report [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable [ExampleScenario](examplescenario.html): External identifier for the example scenario [GraphDefinition](graphdefinition.html): External identifier for the graph definition [ImplementationGuide](implementationguide.html): External identifier for the implementation guide [Library](library.html): External identifier for the library [Measure](measure.html): External identifier for the measure [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication [MessageDefinition](messagedefinition.html): External identifier for the message definition [NamingSystem](namingsystem.html): External identifier for the naming system [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition [OperationDefinition](operationdefinition.html): External identifier for the search parameter [PlanDefinition](plandefinition.html): External identifier for the plan definition [Questionnaire](questionnaire.html): External identifier for the questionnaire [Requirements](requirements.html): External identifier for the requirements [SearchParameter](searchparameter.html): External identifier for the search parameter [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities [TestPlan](testplan.html): An identifier for the test plan [TestScript](testscript.html): External identifier for the test script [ValueSet](valueset.html): External identifier for the value set
      Type: token
      Path: ActivityDefinition.identifier | ActorDefinition.identifier | CapabilityStatement.identifier | ChargeItemDefinition.identifier | Citation.identifier | CodeSystem.identifier | ConceptMap.identifier | ConditionDefinition.identifier | EventDefinition.identifier | Evidence.identifier | EvidenceReport.identifier | EvidenceVariable.identifier | ExampleScenario.identifier | GraphDefinition.identifier | ImplementationGuide.identifier | Library.identifier | Measure.identifier | MedicationKnowledge.identifier | MessageDefinition.identifier | NamingSystem.identifier | ObservationDefinition.identifier | OperationDefinition.identifier | PlanDefinition.identifier | Questionnaire.identifier | Requirements.identifier | SearchParameter.identifier | SpecimenDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | SubscriptionTopic.identifier | TerminologyCapabilities.identifier | TestPlan.identifier | TestScript.identifier | ValueSet.identifier

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The current status of the activity definition [ActorDefinition](actordefinition.html): The current status of the Actor Definition [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition [Citation](citation.html): The current status of the citation [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [ConditionDefinition](conditiondefinition.html): The current status of the condition definition [EventDefinition](eventdefinition.html): The current status of the event definition [Evidence](evidence.html): The current status of the evidence [EvidenceReport](evidencereport.html): The current status of the evidence report [EvidenceVariable](evidencevariable.html): The current status of the evidence variable [ExampleScenario](examplescenario.html): The current status of the example scenario [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [Library](library.html): The current status of the library [Measure](measure.html): The current status of the measure [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown [OperationDefinition](operationdefinition.html): The current status of the operation definition [PlanDefinition](plandefinition.html): The current status of the plan definition [Questionnaire](questionnaire.html): The current status of the questionnaire [Requirements](requirements.html): The current status of the requirements [SearchParameter](searchparameter.html): The current status of the search parameter [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [TestPlan](testplan.html): The current status of the test plan [TestScript](testscript.html): The current status of the test script [ValueSet](valueset.html): The current status of the value set
      Type: token
      Path: ActivityDefinition.status | ActorDefinition.status | CapabilityStatement.status | ChargeItemDefinition.status | Citation.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | ConditionDefinition.status | EventDefinition.status | Evidence.status | EvidenceReport.status | EvidenceVariable.status | ExampleScenario.status | GraphDefinition.status | ImplementationGuide.status | Library.status | Measure.status | MedicationKnowledge.status | MessageDefinition.status | NamingSystem.status | ObservationDefinition.status | OperationDefinition.status | PlanDefinition.status | Questionnaire.status | Requirements.status | SearchParameter.status | SpecimenDefinition.status | StructureDefinition.status | StructureMap.status | SubscriptionTopic.status | TerminologyCapabilities.status | TestPlan.status | TestScript.status | ValueSet.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The current status of the activity definition [ActorDefinition](actordefinition.html): The current status of the Actor Definition [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition [Citation](citation.html): The current status of the citation [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [ConditionDefinition](conditiondefinition.html): The current status of the condition definition [EventDefinition](eventdefinition.html): The current status of the event definition [Evidence](evidence.html): The current status of the evidence [EvidenceReport](evidencereport.html): The current status of the evidence report [EvidenceVariable](evidencevariable.html): The current status of the evidence variable [ExampleScenario](examplescenario.html): The current status of the example scenario [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [Library](library.html): The current status of the library [Measure](measure.html): The current status of the measure [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown [OperationDefinition](operationdefinition.html): The current status of the operation definition [PlanDefinition](plandefinition.html): The current status of the plan definition [Questionnaire](questionnaire.html): The current status of the questionnaire [Requirements](requirements.html): The current status of the requirements [SearchParameter](searchparameter.html): The current status of the search parameter [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [TestPlan](testplan.html): The current status of the test plan [TestScript](testscript.html): The current status of the test script [ValueSet](valueset.html): The current status of the value set
      Type: token
      Path: ActivityDefinition.status | ActorDefinition.status | CapabilityStatement.status | ChargeItemDefinition.status | Citation.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | ConditionDefinition.status | EventDefinition.status | Evidence.status | EvidenceReport.status | EvidenceVariable.status | ExampleScenario.status | GraphDefinition.status | ImplementationGuide.status | Library.status | Measure.status | MedicationKnowledge.status | MessageDefinition.status | NamingSystem.status | ObservationDefinition.status | OperationDefinition.status | PlanDefinition.status | Questionnaire.status | Requirements.status | SearchParameter.status | SpecimenDefinition.status | StructureDefinition.status | StructureMap.status | SubscriptionTopic.status | TerminologyCapabilities.status | TestPlan.status | TestScript.status | ValueSet.status

    • SP_CLASSIFICATION_TYPE

      public static final String SP_CLASSIFICATION_TYPE
      Search parameter: classification-type

      Description: The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
      Type: token
      Path: MedicationKnowledge.medicineClassification.type

      See Also:
    • CLASSIFICATION_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CLASSIFICATION_TYPE
      Fluent Client search parameter constant for classification-type

      Description: The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
      Type: token
      Path: MedicationKnowledge.medicineClassification.type

    • SP_CLASSIFICATION

      public static final String SP_CLASSIFICATION
      Search parameter: classification

      Description: Specific category assigned to the medication
      Type: token
      Path: MedicationKnowledge.medicineClassification.classification

      See Also:
    • CLASSIFICATION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CLASSIFICATION
      Fluent Client search parameter constant for classification

      Description: Specific category assigned to the medication
      Type: token
      Path: MedicationKnowledge.medicineClassification.classification

    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: Code that identifies this medication
      Type: token
      Path: MedicationKnowledge.code

      See Also:
    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: Code that identifies this medication
      Type: token
      Path: MedicationKnowledge.code

    • SP_DOSEFORM

      public static final String SP_DOSEFORM
      Search parameter: doseform

      Description: powder | tablets | capsule +
      Type: token
      Path: MedicationKnowledge.definitional.doseForm

      See Also:
    • DOSEFORM

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam DOSEFORM
      Fluent Client search parameter constant for doseform

      Description: powder | tablets | capsule +
      Type: token
      Path: MedicationKnowledge.definitional.doseForm

    • SP_INGREDIENT_CODE

      public static final String SP_INGREDIENT_CODE
      Search parameter: ingredient-code

      Description: Reference to a concept (by class)
      Type: token
      Path: MedicationKnowledge.definitional.ingredient.item.concept

      See Also:
    • INGREDIENT_CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam INGREDIENT_CODE
      Fluent Client search parameter constant for ingredient-code

      Description: Reference to a concept (by class)
      Type: token
      Path: MedicationKnowledge.definitional.ingredient.item.concept

    • SP_INGREDIENT

      public static final String SP_INGREDIENT
      Search parameter: ingredient

      Description: Reference to a resource (by instance)
      Type: reference
      Path: MedicationKnowledge.definitional.ingredient.item.reference

      See Also:
    • INGREDIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INGREDIENT
      Fluent Client search parameter constant for ingredient

      Description: Reference to a resource (by instance)
      Type: reference
      Path: MedicationKnowledge.definitional.ingredient.item.reference

    • INCLUDE_INGREDIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_INGREDIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationKnowledge:ingredient".
    • SP_MONITORING_PROGRAM_NAME

      public static final String SP_MONITORING_PROGRAM_NAME
      Search parameter: monitoring-program-name

      Description: Name of the reviewing program
      Type: token
      Path: MedicationKnowledge.monitoringProgram.name

      See Also:
    • MONITORING_PROGRAM_NAME

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam MONITORING_PROGRAM_NAME
      Fluent Client search parameter constant for monitoring-program-name

      Description: Name of the reviewing program
      Type: token
      Path: MedicationKnowledge.monitoringProgram.name

    • SP_MONITORING_PROGRAM_TYPE

      public static final String SP_MONITORING_PROGRAM_TYPE
      Search parameter: monitoring-program-type

      Description: Type of program under which the medication is monitored
      Type: token
      Path: MedicationKnowledge.monitoringProgram.type

      See Also:
    • MONITORING_PROGRAM_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam MONITORING_PROGRAM_TYPE
      Fluent Client search parameter constant for monitoring-program-type

      Description: Type of program under which the medication is monitored
      Type: token
      Path: MedicationKnowledge.monitoringProgram.type

    • SP_MONOGRAPH_TYPE

      public static final String SP_MONOGRAPH_TYPE
      Search parameter: monograph-type

      Description: The category of medication document
      Type: token
      Path: MedicationKnowledge.monograph.type

      See Also:
    • MONOGRAPH_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam MONOGRAPH_TYPE
      Fluent Client search parameter constant for monograph-type

      Description: The category of medication document
      Type: token
      Path: MedicationKnowledge.monograph.type

    • SP_MONOGRAPH

      public static final String SP_MONOGRAPH
      Search parameter: monograph

      Description: Associated documentation about the medication
      Type: reference
      Path: MedicationKnowledge.monograph.source

      See Also:
    • MONOGRAPH

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MONOGRAPH
      Fluent Client search parameter constant for monograph

      Description: Associated documentation about the medication
      Type: reference
      Path: MedicationKnowledge.monograph.source

    • INCLUDE_MONOGRAPH

      public static final ca.uhn.fhir.model.api.Include INCLUDE_MONOGRAPH
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationKnowledge:monograph".
    • SP_PACKAGING_COST_CONCEPT

      public static final String SP_PACKAGING_COST_CONCEPT
      Search parameter: packaging-cost-concept

      Description: The cost of the packaged medication, if the cost is a CodeableConcept
      Type: token
      Path: null

      See Also:
    • PACKAGING_COST_CONCEPT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PACKAGING_COST_CONCEPT
      Fluent Client search parameter constant for packaging-cost-concept

      Description: The cost of the packaged medication, if the cost is a CodeableConcept
      Type: token
      Path: null

    • SP_PACKAGING_COST

      public static final String SP_PACKAGING_COST
      Search parameter: packaging-cost

      Description: The cost of the packaged medication, if the cost is Money
      Type: quantity
      Path: null

      See Also:
    • PACKAGING_COST

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam PACKAGING_COST
      Fluent Client search parameter constant for packaging-cost

      Description: The cost of the packaged medication, if the cost is Money
      Type: quantity
      Path: null

    • SP_PRODUCT_TYPE

      public static final String SP_PRODUCT_TYPE
      Search parameter: product-type

      Description: Category of the medication or product
      Type: token
      Path: MedicationKnowledge.productType

      See Also:
    • PRODUCT_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PRODUCT_TYPE
      Fluent Client search parameter constant for product-type

      Description: Category of the medication or product
      Type: token
      Path: MedicationKnowledge.productType

    • SP_SOURCE_COST

      public static final String SP_SOURCE_COST
      Search parameter: source-cost

      Description: The source or owner for the price information
      Type: token
      Path: MedicationKnowledge.cost.source

      See Also:
    • SOURCE_COST

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SOURCE_COST
      Fluent Client search parameter constant for source-cost

      Description: The source or owner for the price information
      Type: token
      Path: MedicationKnowledge.cost.source

  • Constructor Details

  • Method Details