Class MedicationKnowledge
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.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:
- Serialized Form
-
-
Nested Class Summary
-
Field Summary
Fields Modifier and Type Field Description protected List<MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesComponent>administrationGuidelinesGuidelines for the administration of the medication.protected QuantityamountSpecific amount of the drug in the packaged product.protected List<Reference>associatedMedicationAssociated or related medications.protected List<Medication>associatedMedicationTargetThe actual objects that are the target of the reference (Associated or related medications.static ca.uhn.fhir.rest.gclient.TokenClientParamCLASSIFICATIONFluent Client search parameter constant for classificationstatic ca.uhn.fhir.rest.gclient.TokenClientParamCLASSIFICATION_TYPEFluent Client search parameter constant for classification-typeprotected CodeableConceptcodeA code that specifies this medication, or a textual description if no code is available.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected List<Reference>contraindicationPotential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).protected List<DetectedIssue>contraindicationTargetThe actual objects that are the target of the reference (Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).)protected List<MedicationKnowledge.MedicationKnowledgeCostComponent>costThe price of the medication.protected CodeableConceptdoseFormDescribes the form of the item.static ca.uhn.fhir.rest.gclient.TokenClientParamDOSEFORMFluent Client search parameter constant for doseformprotected List<MedicationKnowledge.MedicationKnowledgeDrugCharacteristicComponent>drugCharacteristicSpecifies descriptive properties of the medicine, such as color, shape, imprints, etc.static ca.uhn.fhir.model.api.IncludeINCLUDE_INGREDIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MANUFACTURERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MONOGRAPHConstant for fluent queries to be used to add include statements.protected List<MedicationKnowledge.MedicationKnowledgeIngredientComponent>ingredientIdentifies a particular constituent of interest in the product.static ca.uhn.fhir.rest.gclient.ReferenceClientParamINGREDIENTFluent Client search parameter constant for ingredientstatic ca.uhn.fhir.rest.gclient.TokenClientParamINGREDIENT_CODEFluent Client search parameter constant for ingredient-codeprotected List<CodeableConcept>intendedRouteThe intended or approved route of administration.protected List<MedicationKnowledge.MedicationKnowledgeKineticsComponent>kineticsThe time course of drug absorption, distribution, metabolism and excretion of a medication from the body.protected ReferencemanufacturerDescribes the details of the manufacturer of the medication product.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMANUFACTURERFluent Client search parameter constant for manufacturerprotected OrganizationmanufacturerTargetThe actual object that is the target of the reference (Describes the details of the manufacturer of the medication product.protected List<MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent>medicineClassificationCategorization of the medication within a formulary or classification system.static ca.uhn.fhir.rest.gclient.TokenClientParamMONITORING_PROGRAM_NAMEFluent Client search parameter constant for monitoring-program-namestatic ca.uhn.fhir.rest.gclient.TokenClientParamMONITORING_PROGRAM_TYPEFluent Client search parameter constant for monitoring-program-typeprotected List<MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent>monitoringProgramThe program under which the medication is reviewed.protected List<MedicationKnowledge.MedicationKnowledgeMonographComponent>monographAssociated documentation about the medication.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMONOGRAPHFluent Client search parameter constant for monographstatic ca.uhn.fhir.rest.gclient.TokenClientParamMONOGRAPH_TYPEFluent Client search parameter constant for monograph-typeprotected MedicationKnowledge.MedicationKnowledgePackagingComponentpackagingInformation that only applies to packages (not products).protected MarkdownTypepreparationInstructionThe instructions for preparing the medication.protected List<CodeableConcept>productTypeCategory of the medication or product (e.g.protected List<MedicationKnowledge.MedicationKnowledgeRegulatoryComponent>regulatoryRegulatory information about a medication.protected List<MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent>relatedMedicationKnowledgeAssociated or related knowledge about a medication.static ca.uhn.fhir.rest.gclient.TokenClientParamSOURCE_COSTFluent Client search parameter constant for source-coststatic StringSP_CLASSIFICATIONSearch parameter: classificationstatic StringSP_CLASSIFICATION_TYPESearch parameter: classification-typestatic StringSP_CODESearch parameter: codestatic StringSP_DOSEFORMSearch parameter: doseformstatic StringSP_INGREDIENTSearch parameter: ingredientstatic StringSP_INGREDIENT_CODESearch parameter: ingredient-codestatic StringSP_MANUFACTURERSearch parameter: manufacturerstatic StringSP_MONITORING_PROGRAM_NAMESearch parameter: monitoring-program-namestatic StringSP_MONITORING_PROGRAM_TYPESearch parameter: monitoring-program-typestatic StringSP_MONOGRAPHSearch parameter: monographstatic StringSP_MONOGRAPH_TYPESearch parameter: monograph-typestatic StringSP_SOURCE_COSTSearch parameter: source-coststatic StringSP_STATUSSearch parameter: statusprotected Enumeration<MedicationKnowledge.MedicationKnowledgeStatus>statusA code to indicate if the medication is in active use.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected List<StringType>synonymAdditional names for a medication, for example, the name(s) given to a medication in different countries.-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MedicationKnowledge()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, 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
-
-
-
-
Field Detail
-
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
protected Enumeration<MedicationKnowledge.MedicationKnowledgeStatus> status
A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.
-
manufacturer
protected Reference manufacturer
Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
-
manufacturerTarget
protected Organization manufacturerTarget
The actual object that is the target of the reference (Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
-
doseForm
protected CodeableConcept doseForm
Describes the form of the item. Powder; tablets; capsule.
-
amount
protected Quantity amount
Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
-
synonym
protected List<StringType> synonym
Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.
-
relatedMedicationKnowledge
protected List<MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent> relatedMedicationKnowledge
Associated or related knowledge about a medication.
-
associatedMedication
protected List<Reference> associatedMedication
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).
-
associatedMedicationTarget
protected List<Medication> associatedMedicationTarget
The actual objects that are the target of the reference (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).)
-
productType
protected List<CodeableConcept> productType
Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
-
monograph
protected List<MedicationKnowledge.MedicationKnowledgeMonographComponent> monograph
Associated documentation about the medication.
-
ingredient
protected List<MedicationKnowledge.MedicationKnowledgeIngredientComponent> ingredient
Identifies a particular constituent of interest in the product.
-
preparationInstruction
protected MarkdownType preparationInstruction
The instructions for preparing the medication.
-
intendedRoute
protected List<CodeableConcept> intendedRoute
The intended or approved route of administration.
-
cost
protected List<MedicationKnowledge.MedicationKnowledgeCostComponent> cost
The price of the medication.
-
monitoringProgram
protected List<MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent> monitoringProgram
The program under which the medication is reviewed.
-
administrationGuidelines
protected List<MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesComponent> administrationGuidelines
Guidelines for the administration of the medication.
-
medicineClassification
protected List<MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent> medicineClassification
Categorization of the medication within a formulary or classification system.
-
packaging
protected MedicationKnowledge.MedicationKnowledgePackagingComponent packaging
Information that only applies to packages (not products).
-
drugCharacteristic
protected List<MedicationKnowledge.MedicationKnowledgeDrugCharacteristicComponent> drugCharacteristic
Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
-
contraindication
protected List<Reference> contraindication
Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
-
contraindicationTarget
protected List<DetectedIssue> contraindicationTarget
The actual objects that are the target of the reference (Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).)
-
regulatory
protected List<MedicationKnowledge.MedicationKnowledgeRegulatoryComponent> regulatory
Regulatory information about a medication.
-
kinetics
protected List<MedicationKnowledge.MedicationKnowledgeKineticsComponent> kinetics
The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: Code that identifies this medication
Type: token
Path: MedicationKnowledge.code
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: Code that identifies this medication
Type: token
Path: MedicationKnowledge.code
-
SP_INGREDIENT
public static final String SP_INGREDIENT
Search parameter: ingredientDescription: Medication(s) or substance(s) contained in the medication
Type: reference
Path: MedicationKnowledge.ingredient.itemReference
- See Also:
- Constant Field Values
-
INGREDIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INGREDIENT
Fluent Client search parameter constant for ingredientDescription: Medication(s) or substance(s) contained in the medication
Type: reference
Path: MedicationKnowledge.ingredient.itemReference
-
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_DOSEFORM
public static final String SP_DOSEFORM
Search parameter: doseformDescription: powder | tablets | capsule +
Type: token
Path: MedicationKnowledge.doseForm
- See Also:
- Constant Field Values
-
DOSEFORM
public static final ca.uhn.fhir.rest.gclient.TokenClientParam DOSEFORM
Fluent Client search parameter constant for doseformDescription: powder | tablets | capsule +
Type: token
Path: MedicationKnowledge.doseForm
-
SP_CLASSIFICATION_TYPE
public static final String 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:
- Constant Field Values
-
CLASSIFICATION_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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_MONOGRAPH_TYPE
public static final String SP_MONOGRAPH_TYPE
Search parameter: monograph-typeDescription: The category of medication document
Type: token
Path: MedicationKnowledge.monograph.type
- See Also:
- Constant Field Values
-
MONOGRAPH_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam MONOGRAPH_TYPE
Fluent Client search parameter constant for monograph-typeDescription: The category of medication document
Type: token
Path: MedicationKnowledge.monograph.type
-
SP_CLASSIFICATION
public static final String SP_CLASSIFICATION
Search parameter: classificationDescription: Specific category assigned to the medication
Type: token
Path: MedicationKnowledge.medicineClassification.classification
- See Also:
- Constant Field Values
-
CLASSIFICATION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CLASSIFICATION
Fluent Client search parameter constant for classificationDescription: Specific category assigned to the medication
Type: token
Path: MedicationKnowledge.medicineClassification.classification
-
SP_MANUFACTURER
public static final String SP_MANUFACTURER
Search parameter: manufacturerDescription: Manufacturer of the item
Type: reference
Path: MedicationKnowledge.manufacturer
- See Also:
- Constant Field Values
-
MANUFACTURER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANUFACTURER
Fluent Client search parameter constant for manufacturerDescription: Manufacturer of the item
Type: reference
Path: MedicationKnowledge.manufacturer
-
INCLUDE_MANUFACTURER
public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationKnowledge:manufacturer".
-
SP_INGREDIENT_CODE
public static final String SP_INGREDIENT_CODE
Search parameter: ingredient-codeDescription: Medication(s) or substance(s) contained in the medication
Type: token
Path: MedicationKnowledge.ingredient.itemCodeableConcept
- See Also:
- Constant Field Values
-
INGREDIENT_CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam INGREDIENT_CODE
Fluent Client search parameter constant for ingredient-codeDescription: Medication(s) or substance(s) contained in the medication
Type: token
Path: MedicationKnowledge.ingredient.itemCodeableConcept
-
SP_SOURCE_COST
public static final String SP_SOURCE_COST
Search parameter: source-costDescription: The source or owner for the price information
Type: token
Path: MedicationKnowledge.cost.source
- See Also:
- Constant Field Values
-
SOURCE_COST
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SOURCE_COST
Fluent Client search parameter constant for source-costDescription: The source or owner for the price information
Type: token
Path: MedicationKnowledge.cost.source
-
SP_MONOGRAPH
public static final String SP_MONOGRAPH
Search parameter: monographDescription: Associated documentation about the medication
Type: reference
Path: MedicationKnowledge.monograph.source
- See Also:
- Constant Field Values
-
MONOGRAPH
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MONOGRAPH
Fluent Client search parameter constant for monographDescription: 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_MONITORING_PROGRAM_NAME
public static final String SP_MONITORING_PROGRAM_NAME
Search parameter: monitoring-program-nameDescription: Name of the reviewing program
Type: token
Path: MedicationKnowledge.monitoringProgram.name
- See Also:
- Constant Field Values
-
MONITORING_PROGRAM_NAME
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String 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:
- Constant Field Values
-
MONITORING_PROGRAM_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: active | inactive | entered-in-error
Type: token
Path: MedicationKnowledge.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: active | inactive | entered-in-error
Type: token
Path: MedicationKnowledge.status
-
-
Constructor Detail
-
MedicationKnowledge
public MedicationKnowledge()
Constructor
-
-
Method Detail
-
getCode
public CodeableConcept 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
public boolean hasCode()
-
setCode
public MedicationKnowledge setCode(CodeableConcept value)
- 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
public Enumeration<MedicationKnowledge.MedicationKnowledgeStatus> getStatusElement()
- Returns:
status(A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public MedicationKnowledge setStatusElement(Enumeration<MedicationKnowledge.MedicationKnowledgeStatus> value)
- Parameters:
value-status(A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public MedicationKnowledge.MedicationKnowledgeStatus getStatus()
- Returns:
- A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.
-
setStatus
public MedicationKnowledge setStatus(MedicationKnowledge.MedicationKnowledgeStatus value)
- Parameters:
value- A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.
-
getManufacturer
public Reference getManufacturer()
- Returns:
manufacturer(Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
-
hasManufacturer
public boolean hasManufacturer()
-
setManufacturer
public MedicationKnowledge setManufacturer(Reference value)
- Parameters:
value-manufacturer(Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
-
getManufacturerTarget
public Organization getManufacturerTarget()
- Returns:
manufacturerThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
-
setManufacturerTarget
public MedicationKnowledge setManufacturerTarget(Organization value)
- Parameters:
value-manufacturerThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
-
getDoseForm
public CodeableConcept getDoseForm()
- Returns:
doseForm(Describes the form of the item. Powder; tablets; capsule.)
-
hasDoseForm
public boolean hasDoseForm()
-
setDoseForm
public MedicationKnowledge setDoseForm(CodeableConcept value)
- Parameters:
value-doseForm(Describes the form of the item. Powder; tablets; capsule.)
-
getAmount
public Quantity getAmount()
- Returns:
amount(Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).)
-
hasAmount
public boolean hasAmount()
-
setAmount
public MedicationKnowledge setAmount(Quantity value)
- Parameters:
value-amount(Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).)
-
getSynonym
public List<StringType> getSynonym()
- Returns:
synonym(Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.)
-
setSynonym
public MedicationKnowledge setSynonym(List<StringType> theSynonym)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSynonym
public boolean hasSynonym()
-
addSynonymElement
public StringType addSynonymElement()
- Returns:
synonym(Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.)
-
addSynonym
public MedicationKnowledge addSynonym(String value)
- Parameters:
value-synonym(Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.)
-
hasSynonym
public boolean hasSynonym(String value)
- Parameters:
value-synonym(Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.)
-
getRelatedMedicationKnowledge
public List<MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent> getRelatedMedicationKnowledge()
- Returns:
relatedMedicationKnowledge(Associated or related knowledge about a medication.)
-
setRelatedMedicationKnowledge
public MedicationKnowledge setRelatedMedicationKnowledge(List<MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent> theRelatedMedicationKnowledge)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelatedMedicationKnowledge
public boolean hasRelatedMedicationKnowledge()
-
addRelatedMedicationKnowledge
public MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent addRelatedMedicationKnowledge()
-
addRelatedMedicationKnowledge
public MedicationKnowledge addRelatedMedicationKnowledge(MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent t)
-
getRelatedMedicationKnowledgeFirstRep
public MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent getRelatedMedicationKnowledgeFirstRep()
- Returns:
- The first repetition of repeating field
relatedMedicationKnowledge, creating it if it does not already exist
-
getAssociatedMedication
public List<Reference> getAssociatedMedication()
- Returns:
associatedMedication(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).)
-
setAssociatedMedication
public MedicationKnowledge setAssociatedMedication(List<Reference> theAssociatedMedication)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAssociatedMedication
public boolean hasAssociatedMedication()
-
addAssociatedMedication
public Reference addAssociatedMedication()
-
addAssociatedMedication
public MedicationKnowledge addAssociatedMedication(Reference t)
-
getAssociatedMedicationFirstRep
public Reference getAssociatedMedicationFirstRep()
- Returns:
- The first repetition of repeating field
associatedMedication, creating it if it does not already exist
-
getAssociatedMedicationTarget
@Deprecated public List<Medication> getAssociatedMedicationTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addAssociatedMedicationTarget
@Deprecated public Medication addAssociatedMedicationTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getProductType
public List<CodeableConcept> getProductType()
- Returns:
productType(Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).)
-
setProductType
public MedicationKnowledge setProductType(List<CodeableConcept> theProductType)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProductType
public boolean hasProductType()
-
addProductType
public CodeableConcept addProductType()
-
addProductType
public MedicationKnowledge addProductType(CodeableConcept t)
-
getProductTypeFirstRep
public CodeableConcept getProductTypeFirstRep()
- Returns:
- The first repetition of repeating field
productType, creating it if it does not already exist
-
getMonograph
public List<MedicationKnowledge.MedicationKnowledgeMonographComponent> getMonograph()
- Returns:
monograph(Associated documentation about the medication.)
-
setMonograph
public MedicationKnowledge setMonograph(List<MedicationKnowledge.MedicationKnowledgeMonographComponent> theMonograph)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasMonograph
public boolean hasMonograph()
-
addMonograph
public MedicationKnowledge.MedicationKnowledgeMonographComponent addMonograph()
-
addMonograph
public MedicationKnowledge addMonograph(MedicationKnowledge.MedicationKnowledgeMonographComponent t)
-
getMonographFirstRep
public MedicationKnowledge.MedicationKnowledgeMonographComponent getMonographFirstRep()
- Returns:
- The first repetition of repeating field
monograph, creating it if it does not already exist
-
getIngredient
public List<MedicationKnowledge.MedicationKnowledgeIngredientComponent> getIngredient()
- Returns:
ingredient(Identifies a particular constituent of interest in the product.)
-
setIngredient
public MedicationKnowledge setIngredient(List<MedicationKnowledge.MedicationKnowledgeIngredientComponent> theIngredient)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIngredient
public boolean hasIngredient()
-
addIngredient
public MedicationKnowledge.MedicationKnowledgeIngredientComponent addIngredient()
-
addIngredient
public MedicationKnowledge addIngredient(MedicationKnowledge.MedicationKnowledgeIngredientComponent t)
-
getIngredientFirstRep
public MedicationKnowledge.MedicationKnowledgeIngredientComponent getIngredientFirstRep()
- Returns:
- The first repetition of repeating field
ingredient, creating it if it does not already exist
-
getPreparationInstructionElement
public MarkdownType 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
public boolean hasPreparationInstructionElement()
-
hasPreparationInstruction
public boolean hasPreparationInstruction()
-
setPreparationInstructionElement
public MedicationKnowledge setPreparationInstructionElement(MarkdownType value)
- 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
public String getPreparationInstruction()
- Returns:
- The instructions for preparing the medication.
-
setPreparationInstruction
public MedicationKnowledge setPreparationInstruction(String value)
- Parameters:
value- The instructions for preparing the medication.
-
getIntendedRoute
public List<CodeableConcept> getIntendedRoute()
- Returns:
intendedRoute(The intended or approved route of administration.)
-
setIntendedRoute
public MedicationKnowledge setIntendedRoute(List<CodeableConcept> theIntendedRoute)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIntendedRoute
public boolean hasIntendedRoute()
-
addIntendedRoute
public CodeableConcept addIntendedRoute()
-
addIntendedRoute
public MedicationKnowledge addIntendedRoute(CodeableConcept t)
-
getIntendedRouteFirstRep
public CodeableConcept getIntendedRouteFirstRep()
- Returns:
- The first repetition of repeating field
intendedRoute, creating it if it does not already exist
-
getCost
public List<MedicationKnowledge.MedicationKnowledgeCostComponent> getCost()
- Returns:
cost(The price of the medication.)
-
setCost
public MedicationKnowledge setCost(List<MedicationKnowledge.MedicationKnowledgeCostComponent> theCost)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCost
public boolean hasCost()
-
addCost
public MedicationKnowledge.MedicationKnowledgeCostComponent addCost()
-
addCost
public MedicationKnowledge addCost(MedicationKnowledge.MedicationKnowledgeCostComponent t)
-
getCostFirstRep
public MedicationKnowledge.MedicationKnowledgeCostComponent getCostFirstRep()
- Returns:
- The first repetition of repeating field
cost, creating it if it does not already exist
-
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
thisfor easy method chaining
-
hasMonitoringProgram
public boolean hasMonitoringProgram()
-
addMonitoringProgram
public MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent addMonitoringProgram()
-
addMonitoringProgram
public MedicationKnowledge addMonitoringProgram(MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent t)
-
getMonitoringProgramFirstRep
public MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent getMonitoringProgramFirstRep()
- Returns:
- The first repetition of repeating field
monitoringProgram, creating it if it does not already exist
-
getAdministrationGuidelines
public List<MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesComponent> getAdministrationGuidelines()
- Returns:
administrationGuidelines(Guidelines for the administration of the medication.)
-
setAdministrationGuidelines
public MedicationKnowledge setAdministrationGuidelines(List<MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesComponent> theAdministrationGuidelines)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAdministrationGuidelines
public boolean hasAdministrationGuidelines()
-
addAdministrationGuidelines
public MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesComponent addAdministrationGuidelines()
-
addAdministrationGuidelines
public MedicationKnowledge addAdministrationGuidelines(MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesComponent t)
-
getAdministrationGuidelinesFirstRep
public MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesComponent getAdministrationGuidelinesFirstRep()
- Returns:
- The first repetition of repeating field
administrationGuidelines, creating it if it does not already exist
-
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
thisfor easy method chaining
-
hasMedicineClassification
public boolean hasMedicineClassification()
-
addMedicineClassification
public MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent addMedicineClassification()
-
addMedicineClassification
public MedicationKnowledge addMedicineClassification(MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent t)
-
getMedicineClassificationFirstRep
public MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent getMedicineClassificationFirstRep()
- Returns:
- The first repetition of repeating field
medicineClassification, creating it if it does not already exist
-
getPackaging
public MedicationKnowledge.MedicationKnowledgePackagingComponent getPackaging()
- Returns:
packaging(Information that only applies to packages (not products).)
-
hasPackaging
public boolean hasPackaging()
-
setPackaging
public MedicationKnowledge setPackaging(MedicationKnowledge.MedicationKnowledgePackagingComponent value)
- Parameters:
value-packaging(Information that only applies to packages (not products).)
-
getDrugCharacteristic
public List<MedicationKnowledge.MedicationKnowledgeDrugCharacteristicComponent> getDrugCharacteristic()
- Returns:
drugCharacteristic(Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.)
-
setDrugCharacteristic
public MedicationKnowledge setDrugCharacteristic(List<MedicationKnowledge.MedicationKnowledgeDrugCharacteristicComponent> theDrugCharacteristic)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDrugCharacteristic
public boolean hasDrugCharacteristic()
-
addDrugCharacteristic
public MedicationKnowledge.MedicationKnowledgeDrugCharacteristicComponent addDrugCharacteristic()
-
addDrugCharacteristic
public MedicationKnowledge addDrugCharacteristic(MedicationKnowledge.MedicationKnowledgeDrugCharacteristicComponent t)
-
getDrugCharacteristicFirstRep
public MedicationKnowledge.MedicationKnowledgeDrugCharacteristicComponent getDrugCharacteristicFirstRep()
- Returns:
- The first repetition of repeating field
drugCharacteristic, creating it if it does not already exist
-
getContraindication
public List<Reference> getContraindication()
- Returns:
contraindication(Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).)
-
setContraindication
public MedicationKnowledge setContraindication(List<Reference> theContraindication)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContraindication
public boolean hasContraindication()
-
addContraindication
public Reference addContraindication()
-
addContraindication
public MedicationKnowledge addContraindication(Reference t)
-
getContraindicationFirstRep
public Reference getContraindicationFirstRep()
- Returns:
- The first repetition of repeating field
contraindication, creating it if it does not already exist
-
getContraindicationTarget
@Deprecated public List<DetectedIssue> getContraindicationTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addContraindicationTarget
@Deprecated public DetectedIssue addContraindicationTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getRegulatory
public List<MedicationKnowledge.MedicationKnowledgeRegulatoryComponent> getRegulatory()
- Returns:
regulatory(Regulatory information about a medication.)
-
setRegulatory
public MedicationKnowledge setRegulatory(List<MedicationKnowledge.MedicationKnowledgeRegulatoryComponent> theRegulatory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRegulatory
public boolean hasRegulatory()
-
addRegulatory
public MedicationKnowledge.MedicationKnowledgeRegulatoryComponent addRegulatory()
-
addRegulatory
public MedicationKnowledge addRegulatory(MedicationKnowledge.MedicationKnowledgeRegulatoryComponent t)
-
getRegulatoryFirstRep
public MedicationKnowledge.MedicationKnowledgeRegulatoryComponent getRegulatoryFirstRep()
- Returns:
- The first repetition of repeating field
regulatory, creating it if it does not already exist
-
getKinetics
public List<MedicationKnowledge.MedicationKnowledgeKineticsComponent> getKinetics()
- Returns:
kinetics(The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.)
-
setKinetics
public MedicationKnowledge setKinetics(List<MedicationKnowledge.MedicationKnowledgeKineticsComponent> theKinetics)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasKinetics
public boolean hasKinetics()
-
addKinetics
public MedicationKnowledge.MedicationKnowledgeKineticsComponent addKinetics()
-
addKinetics
public MedicationKnowledge addKinetics(MedicationKnowledge.MedicationKnowledgeKineticsComponent t)
-
getKineticsFirstRep
public MedicationKnowledge.MedicationKnowledgeKineticsComponent getKineticsFirstRep()
- Returns:
- The first repetition of repeating field
kinetics, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public MedicationKnowledge copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(MedicationKnowledge dst)
-
typedCopy
protected MedicationKnowledge typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-