Class MedicationKnowledge
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.MedicationKnowledge
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class MedicationKnowledge extends DomainResource
Information about a medication that is used to support knowledge.Maturity level: FMM0 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MedicationKnowledge.AdministrationGuidelines
Guidelines for the administration of the medication.static class
MedicationKnowledge.Builder
static class
MedicationKnowledge.Cost
The price of the medication.static class
MedicationKnowledge.DrugCharacteristic
Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.static class
MedicationKnowledge.Ingredient
Identifies a particular constituent of interest in the product.static class
MedicationKnowledge.Kinetics
The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.static class
MedicationKnowledge.MedicineClassification
Categorization of the medication within a formulary or classification system.static class
MedicationKnowledge.MonitoringProgram
The program under which the medication is reviewed.static class
MedicationKnowledge.Monograph
Associated documentation about the medication.static class
MedicationKnowledge.Packaging
Information that only applies to packages (not products).static class
MedicationKnowledge.Regulatory
Regulatory information about a medication.static class
MedicationKnowledge.RelatedMedicationKnowledge
Associated or related knowledge about a medication.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static MedicationKnowledge.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<MedicationKnowledge.AdministrationGuidelines>
getAdministrationGuidelines()
Guidelines for the administration of the medication.SimpleQuantity
getAmount()
Specific amount of the drug in the packaged product.java.util.List<Reference>
getAssociatedMedication()
Associated or related medications.CodeableConcept
getCode()
A code that specifies this medication, or a textual description if no code is available.java.util.List<Reference>
getContraindication()
Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).java.util.List<MedicationKnowledge.Cost>
getCost()
The price of the medication.CodeableConcept
getDoseForm()
Describes the form of the item.java.util.List<MedicationKnowledge.DrugCharacteristic>
getDrugCharacteristic()
Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.java.util.List<MedicationKnowledge.Ingredient>
getIngredient()
Identifies a particular constituent of interest in the product.java.util.List<CodeableConcept>
getIntendedRoute()
The intended or approved route of administration.java.util.List<MedicationKnowledge.Kinetics>
getKinetics()
The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.Reference
getManufacturer()
Describes the details of the manufacturer of the medication product.java.util.List<MedicationKnowledge.MedicineClassification>
getMedicineClassification()
Categorization of the medication within a formulary or classification system.java.util.List<MedicationKnowledge.MonitoringProgram>
getMonitoringProgram()
The program under which the medication is reviewed.java.util.List<MedicationKnowledge.Monograph>
getMonograph()
Associated documentation about the medication.MedicationKnowledge.Packaging
getPackaging()
Information that only applies to packages (not products).Markdown
getPreparationInstruction()
The instructions for preparing the medication.java.util.List<CodeableConcept>
getProductType()
Category of the medication or product (e.g.java.util.List<MedicationKnowledge.Regulatory>
getRegulatory()
Regulatory information about a medication.java.util.List<MedicationKnowledge.RelatedMedicationKnowledge>
getRelatedMedicationKnowledge()
Associated or related knowledge about a medication.MedicationKnowledgeStatus
getStatus()
A code to indicate if the medication is in active use.java.util.List<String>
getSynonym()
Additional names for a medication, for example, the name(s) given to a medication in different countries.boolean
hasChildren()
int
hashCode()
MedicationKnowledge.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getCode
public CodeableConcept getCode()
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.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getStatus
public MedicationKnowledgeStatus getStatus()
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.- Returns:
- An immutable object of type
MedicationKnowledgeStatus
that may be null.
-
getManufacturer
public Reference getManufacturer()
Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.- Returns:
- An immutable object of type
Reference
that may be null.
-
getDoseForm
public CodeableConcept getDoseForm()
Describes the form of the item. Powder; tablets; capsule.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getAmount
public SimpleQuantity getAmount()
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.).- Returns:
- An immutable object of type
SimpleQuantity
that may be null.
-
getSynonym
public java.util.List<String> getSynonym()
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.- Returns:
- An unmodifiable list containing immutable objects of type
String
that may be empty.
-
getRelatedMedicationKnowledge
public java.util.List<MedicationKnowledge.RelatedMedicationKnowledge> getRelatedMedicationKnowledge()
Associated or related knowledge about a medication.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.RelatedMedicationKnowledge
that may be empty.
-
getAssociatedMedication
public java.util.List<Reference> getAssociatedMedication()
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).- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getProductType
public java.util.List<CodeableConcept> getProductType()
Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getMonograph
public java.util.List<MedicationKnowledge.Monograph> getMonograph()
Associated documentation about the medication.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.Monograph
that may be empty.
-
getIngredient
public java.util.List<MedicationKnowledge.Ingredient> getIngredient()
Identifies a particular constituent of interest in the product.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.Ingredient
that may be empty.
-
getPreparationInstruction
public Markdown getPreparationInstruction()
The instructions for preparing the medication.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getIntendedRoute
public java.util.List<CodeableConcept> getIntendedRoute()
The intended or approved route of administration.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getCost
public java.util.List<MedicationKnowledge.Cost> getCost()
The price of the medication.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.Cost
that may be empty.
-
getMonitoringProgram
public java.util.List<MedicationKnowledge.MonitoringProgram> getMonitoringProgram()
The program under which the medication is reviewed.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.MonitoringProgram
that may be empty.
-
getAdministrationGuidelines
public java.util.List<MedicationKnowledge.AdministrationGuidelines> getAdministrationGuidelines()
Guidelines for the administration of the medication.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.AdministrationGuidelines
that may be empty.
-
getMedicineClassification
public java.util.List<MedicationKnowledge.MedicineClassification> getMedicineClassification()
Categorization of the medication within a formulary or classification system.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.MedicineClassification
that may be empty.
-
getPackaging
public MedicationKnowledge.Packaging getPackaging()
Information that only applies to packages (not products).- Returns:
- An immutable object of type
MedicationKnowledge.Packaging
that may be null.
-
getDrugCharacteristic
public java.util.List<MedicationKnowledge.DrugCharacteristic> getDrugCharacteristic()
Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.DrugCharacteristic
that may be empty.
-
getContraindication
public java.util.List<Reference> getContraindication()
Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getRegulatory
public java.util.List<MedicationKnowledge.Regulatory> getRegulatory()
Regulatory information about a medication.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.Regulatory
that may be empty.
-
getKinetics
public java.util.List<MedicationKnowledge.Kinetics> getKinetics()
The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationKnowledge.Kinetics
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public MedicationKnowledge.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static MedicationKnowledge.Builder builder()
-
-