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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static enum
static class
static class
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionLinks to associated medications that could be prescribed, dispensed or administered.protected Reference
The creator or owner of the knowledge or information about the medication.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for classificationstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for classification-typePotential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).protected CodeableConcept
A code that specifies this medication, or a textual description if no code is available.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeThe price of the medication.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.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for doseformprotected List
<Identifier> Business identifier for this medication.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.Guidelines or protocols that are applicable for the administration of the medication based on indication.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for ingredientstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for ingredient-codeprotected List
<CodeableConcept> Lists the jurisdictions that this medication knowledge was written for.Categorization of the medication within a formulary or classification system.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for monitoring-program-namestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for monitoring-program-typeThe program under which the medication is reviewed.Associated documentation about the medication.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for monographstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for monograph-typeprotected List
<StringType> All of the names for a medication, for example, the name(s) given to a medication in different countries.Information that only applies to packages (not products).static final ca.uhn.fhir.rest.gclient.QuantityClientParam
Fluent Client search parameter constant for packaging-coststatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for packaging-cost-conceptprotected MarkdownType
The instructions for preparing the medication.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for product-typeprotected List
<CodeableConcept> Category of the medication or product (e.g.Regulatory information about a medication.Associated or related medications.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for source-coststatic final String
Search parameter: classificationstatic final String
Search parameter: classification-typestatic final String
Search parameter: codestatic final String
Search parameter: doseformstatic final String
Search parameter: identifierstatic final String
Search parameter: ingredientstatic final String
Search parameter: ingredient-codestatic final String
Search parameter: monitoring-program-namestatic final String
Search parameter: monitoring-program-typestatic final String
Search parameter: monographstatic final String
Search parameter: monograph-typestatic final String
Search parameter: packaging-coststatic final String
Search parameter: packaging-cost-conceptstatic final String
Search parameter: product-typestatic final String
Search parameter: source-coststatic final String
Search parameter: statusA code to indicate if the medication referred to by this MedicationKnowledge is in active use within the drug database or inventory system.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusInformation on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddCost()
addRelatedMedicationKnowledge
(MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent t) copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getCost()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
hasCode()
boolean
hasCost()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAssociatedMedication
(List<Reference> theAssociatedMedication) setClinicalUseIssue
(List<Reference> theClinicalUseIssue) setCode
(CodeableConcept value) setIdentifier
(List<Identifier> theIdentifier) setIndicationGuideline
(List<MedicationKnowledge.MedicationKnowledgeIndicationGuidelineComponent> theIndicationGuideline) setIntendedJurisdiction
(List<CodeableConcept> theIntendedJurisdiction) setMedicineClassification
(List<MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent> theMedicineClassification) setMonitoringProgram
(List<MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent> theMonitoringProgram) setName
(List<StringType> theName) setPreparationInstruction
(String value) setProductType
(List<CodeableConcept> theProductType) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRelatedMedicationKnowledge
(List<MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent> theRelatedMedicationKnowledge) setStorageGuideline
(List<MedicationKnowledge.MedicationKnowledgeStorageGuidelineComponent> theStorageGuideline) protected MedicationKnowledge
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Business identifier for this medication. -
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
The creator or owner of the knowledge or information about the medication. -
intendedJurisdiction
Lists the jurisdictions that this medication knowledge was written for. -
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. -
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
protected List<MedicationKnowledge.MedicationKnowledgeIndicationGuidelineComponent> indicationGuidelineGuidelines or protocols that are applicable for the administration of the medication based on indication. -
medicineClassification
protected List<MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent> medicineClassificationCategorization 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
Search parameter: identifierDescription: 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
Fluent Client search parameter constant for identifierDescription: 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
Search parameter: statusDescription: 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
Fluent Client search parameter constant for statusDescription: 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
Search parameter: classification-typeDescription: The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
Type: token
Path: MedicationKnowledge.medicineClassification.type
- See Also:
-
CLASSIFICATION_TYPE
Fluent Client search parameter constant for classification-typeDescription: The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
Type: token
Path: MedicationKnowledge.medicineClassification.type
-
SP_CLASSIFICATION
Search parameter: classificationDescription: Specific category assigned to the medication
Type: token
Path: MedicationKnowledge.medicineClassification.classification
- See Also:
-
CLASSIFICATION
Fluent Client search parameter constant for classificationDescription: Specific category assigned to the medication
Type: token
Path: MedicationKnowledge.medicineClassification.classification
-
SP_CODE
Search parameter: codeDescription: Code that identifies this medication
Type: token
Path: MedicationKnowledge.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Code that identifies this medication
Type: token
Path: MedicationKnowledge.code
-
SP_DOSEFORM
Search parameter: doseformDescription: powder | tablets | capsule +
Type: token
Path: MedicationKnowledge.definitional.doseForm
- See Also:
-
DOSEFORM
Fluent Client search parameter constant for doseformDescription: powder | tablets | capsule +
Type: token
Path: MedicationKnowledge.definitional.doseForm
-
SP_INGREDIENT_CODE
Search parameter: ingredient-codeDescription: Reference to a concept (by class)
Type: token
Path: MedicationKnowledge.definitional.ingredient.item.concept
- See Also:
-
INGREDIENT_CODE
Fluent Client search parameter constant for ingredient-codeDescription: Reference to a concept (by class)
Type: token
Path: MedicationKnowledge.definitional.ingredient.item.concept
-
SP_INGREDIENT
Search parameter: ingredientDescription: Reference to a resource (by instance)
Type: reference
Path: MedicationKnowledge.definitional.ingredient.item.reference
- See Also:
-
INGREDIENT
Fluent Client search parameter constant for ingredientDescription: Reference to a resource (by instance)
Type: reference
Path: MedicationKnowledge.definitional.ingredient.item.reference
-
INCLUDE_INGREDIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationKnowledge:ingredient". -
SP_MONITORING_PROGRAM_NAME
Search parameter: monitoring-program-nameDescription: Name of the reviewing program
Type: token
Path: MedicationKnowledge.monitoringProgram.name
- See Also:
-
MONITORING_PROGRAM_NAME
Fluent Client search parameter constant for monitoring-program-nameDescription: Name of the reviewing program
Type: token
Path: MedicationKnowledge.monitoringProgram.name
-
SP_MONITORING_PROGRAM_TYPE
Search parameter: monitoring-program-typeDescription: Type of program under which the medication is monitored
Type: token
Path: MedicationKnowledge.monitoringProgram.type
- See Also:
-
MONITORING_PROGRAM_TYPE
Fluent Client search parameter constant for monitoring-program-typeDescription: Type of program under which the medication is monitored
Type: token
Path: MedicationKnowledge.monitoringProgram.type
-
SP_MONOGRAPH_TYPE
Search parameter: monograph-typeDescription: The category of medication document
Type: token
Path: MedicationKnowledge.monograph.type
- See Also:
-
MONOGRAPH_TYPE
Fluent Client search parameter constant for monograph-typeDescription: The category of medication document
Type: token
Path: MedicationKnowledge.monograph.type
-
SP_MONOGRAPH
Search parameter: monographDescription: Associated documentation about the medication
Type: reference
Path: MedicationKnowledge.monograph.source
- See Also:
-
MONOGRAPH
Fluent Client search parameter constant for monographDescription: Associated documentation about the medication
Type: reference
Path: MedicationKnowledge.monograph.source
-
INCLUDE_MONOGRAPH
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationKnowledge:monograph". -
SP_PACKAGING_COST_CONCEPT
Search parameter: packaging-cost-conceptDescription: The cost of the packaged medication, if the cost is a CodeableConcept
Type: token
Path: null
- See Also:
-
PACKAGING_COST_CONCEPT
Fluent Client search parameter constant for packaging-cost-conceptDescription: The cost of the packaged medication, if the cost is a CodeableConcept
Type: token
Path: null
-
SP_PACKAGING_COST
Search parameter: packaging-costDescription: The cost of the packaged medication, if the cost is Money
Type: quantity
Path: null
- See Also:
-
PACKAGING_COST
Fluent Client search parameter constant for packaging-costDescription: The cost of the packaged medication, if the cost is Money
Type: quantity
Path: null
-
SP_PRODUCT_TYPE
Search parameter: product-typeDescription: Category of the medication or product
Type: token
Path: MedicationKnowledge.productType
- See Also:
-
PRODUCT_TYPE
Fluent Client search parameter constant for product-typeDescription: Category of the medication or product
Type: token
Path: MedicationKnowledge.productType
-
SP_SOURCE_COST
Search parameter: source-costDescription: The source or owner for the price information
Type: token
Path: MedicationKnowledge.cost.source
- See Also:
-
SOURCE_COST
Fluent Client search parameter constant for source-costDescription: The source or owner for the price information
Type: token
Path: MedicationKnowledge.cost.source
-
-
Constructor Details
-
MedicationKnowledge
public MedicationKnowledge()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Business identifier for this medication.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
getCode
- Returns:
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.)
-
hasCode
-
setCode
- Parameters:
value
-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.)
-
getStatusElement
- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
public MedicationKnowledge setStatusElement(Enumeration<MedicationKnowledge.MedicationKnowledgeStatusCodes> value) - Parameters:
value
-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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- 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.
-
setStatus
- Parameters:
value
- 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.
-
getAuthor
- Returns:
author
(The creator or owner of the knowledge or information about the medication.)
-
hasAuthor
-
setAuthor
- Parameters:
value
-author
(The creator or owner of the knowledge or information about the medication.)
-
getIntendedJurisdiction
- Returns:
intendedJurisdiction
(Lists the jurisdictions that this medication knowledge was written for.)
-
setIntendedJurisdiction
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIntendedJurisdiction
-
addIntendedJurisdiction
-
addIntendedJurisdiction
-
getIntendedJurisdictionFirstRep
- Returns:
- The first repetition of repeating field
intendedJurisdiction
, creating it if it does not already exist {3}
-
getName
- Returns:
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.)
-
setName
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasName
-
addNameElement
- Returns:
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.)
-
addName
- Parameters:
value
-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.)
-
hasName
- Parameters:
value
-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.)
-
getRelatedMedicationKnowledge
public List<MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent> getRelatedMedicationKnowledge()- Returns:
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.)
-
setRelatedMedicationKnowledge
public MedicationKnowledge setRelatedMedicationKnowledge(List<MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent> theRelatedMedicationKnowledge) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelatedMedicationKnowledge
-
addRelatedMedicationKnowledge
-
addRelatedMedicationKnowledge
-
getRelatedMedicationKnowledgeFirstRep
public MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent getRelatedMedicationKnowledgeFirstRep()- Returns:
- The first repetition of repeating field
relatedMedicationKnowledge
, creating it if it does not already exist {3}
-
getAssociatedMedication
- Returns:
associatedMedication
(Links to associated medications that could be prescribed, dispensed or administered.)
-
setAssociatedMedication
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAssociatedMedication
-
addAssociatedMedication
-
addAssociatedMedication
-
getAssociatedMedicationFirstRep
- Returns:
- The first repetition of repeating field
associatedMedication
, creating it if it does not already exist {3}
-
getProductType
- Returns:
productType
(Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).)
-
setProductType
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProductType
-
addProductType
-
addProductType
-
getProductTypeFirstRep
- Returns:
- The first repetition of repeating field
productType
, creating it if it does not already exist {3}
-
getMonograph
- Returns:
monograph
(Associated documentation about the medication.)
-
setMonograph
public MedicationKnowledge setMonograph(List<MedicationKnowledge.MedicationKnowledgeMonographComponent> theMonograph) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasMonograph
-
addMonograph
-
addMonograph
-
getMonographFirstRep
- Returns:
- The first repetition of repeating field
monograph
, creating it if it does not already exist {3}
-
getPreparationInstructionElement
- Returns:
preparationInstruction
(The instructions for preparing the medication.). This is the underlying object with id, value and extensions. The accessor "getPreparationInstruction" gives direct access to the value
-
hasPreparationInstructionElement
-
hasPreparationInstruction
-
setPreparationInstructionElement
- Parameters:
value
-preparationInstruction
(The instructions for preparing the medication.). This is the underlying object with id, value and extensions. The accessor "getPreparationInstruction" gives direct access to the value
-
getPreparationInstruction
- Returns:
- The instructions for preparing the medication.
-
setPreparationInstruction
- Parameters:
value
- The instructions for preparing the medication.
-
getCost
- Returns:
cost
(The price of the medication.)
-
setCost
public MedicationKnowledge setCost(List<MedicationKnowledge.MedicationKnowledgeCostComponent> theCost) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasCost
-
addCost
-
addCost
-
getCostFirstRep
- Returns:
- The first repetition of repeating field
cost
, creating it if it does not already exist {3}
-
getMonitoringProgram
public List<MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent> getMonitoringProgram()- Returns:
monitoringProgram
(The program under which the medication is reviewed.)
-
setMonitoringProgram
public MedicationKnowledge setMonitoringProgram(List<MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent> theMonitoringProgram) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasMonitoringProgram
-
addMonitoringProgram
-
addMonitoringProgram
-
getMonitoringProgramFirstRep
public MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent getMonitoringProgramFirstRep()- Returns:
- The first repetition of repeating field
monitoringProgram
, creating it if it does not already exist {3}
-
getIndicationGuideline
public List<MedicationKnowledge.MedicationKnowledgeIndicationGuidelineComponent> getIndicationGuideline()- Returns:
indicationGuideline
(Guidelines or protocols that are applicable for the administration of the medication based on indication.)
-
setIndicationGuideline
public MedicationKnowledge setIndicationGuideline(List<MedicationKnowledge.MedicationKnowledgeIndicationGuidelineComponent> theIndicationGuideline) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasIndicationGuideline
-
addIndicationGuideline
-
addIndicationGuideline
-
getIndicationGuidelineFirstRep
public MedicationKnowledge.MedicationKnowledgeIndicationGuidelineComponent getIndicationGuidelineFirstRep()- Returns:
- The first repetition of repeating field
indicationGuideline
, creating it if it does not already exist {3}
-
getMedicineClassification
public List<MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent> getMedicineClassification()- Returns:
medicineClassification
(Categorization of the medication within a formulary or classification system.)
-
setMedicineClassification
public MedicationKnowledge setMedicineClassification(List<MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent> theMedicineClassification) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasMedicineClassification
-
addMedicineClassification
-
addMedicineClassification
-
getMedicineClassificationFirstRep
public MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent getMedicineClassificationFirstRep()- Returns:
- The first repetition of repeating field
medicineClassification
, creating it if it does not already exist {3}
-
getPackaging
- Returns:
packaging
(Information that only applies to packages (not products).)
-
setPackaging
public MedicationKnowledge setPackaging(List<MedicationKnowledge.MedicationKnowledgePackagingComponent> thePackaging) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasPackaging
-
addPackaging
-
addPackaging
-
getPackagingFirstRep
- Returns:
- The first repetition of repeating field
packaging
, creating it if it does not already exist {3}
-
getClinicalUseIssue
- Returns:
clinicalUseIssue
(Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).)
-
setClinicalUseIssue
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasClinicalUseIssue
-
addClinicalUseIssue
-
addClinicalUseIssue
-
getClinicalUseIssueFirstRep
- Returns:
- The first repetition of repeating field
clinicalUseIssue
, creating it if it does not already exist {3}
-
getStorageGuideline
- Returns:
storageGuideline
(Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.)
-
setStorageGuideline
public MedicationKnowledge setStorageGuideline(List<MedicationKnowledge.MedicationKnowledgeStorageGuidelineComponent> theStorageGuideline) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasStorageGuideline
-
addStorageGuideline
-
addStorageGuideline
-
getStorageGuidelineFirstRep
public MedicationKnowledge.MedicationKnowledgeStorageGuidelineComponent getStorageGuidelineFirstRep()- Returns:
- The first repetition of repeating field
storageGuideline
, creating it if it does not already exist {3}
-
getRegulatory
- Returns:
regulatory
(Regulatory information about a medication.)
-
setRegulatory
public MedicationKnowledge setRegulatory(List<MedicationKnowledge.MedicationKnowledgeRegulatoryComponent> theRegulatory) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasRegulatory
-
addRegulatory
-
addRegulatory
-
getRegulatoryFirstRep
- Returns:
- The first repetition of repeating field
regulatory
, creating it if it does not already exist {3}
-
getDefinitional
- Returns:
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.)
-
hasDefinitional
-
setDefinitional
public MedicationKnowledge setDefinitional(MedicationKnowledge.MedicationKnowledgeDefinitionalComponent value) - Parameters:
value
-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.)
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-