Class MedicationAdministration.Dosage
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.MedicationAdministration.Dosage
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- MedicationAdministration
public static class MedicationAdministration.Dosage extends BackboneElement
Describes the medication dosage information details e.g. dose, rate, site, route, etc.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MedicationAdministration.Dosage.Builder
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
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 MedicationAdministration.Dosage.Builder
builder()
boolean
equals(java.lang.Object obj)
SimpleQuantity
getDose()
The amount of the medication given at one administration event.CodeableConcept
getMethod()
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body.Element
getRate()
Identifies the speed with which the medication was or will be introduced into the patient.CodeableConcept
getRoute()
A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient.CodeableConcept
getSite()
A coded specification of the anatomic site where the medication first entered the body.String
getText()
Free text dosage can be used for cases where the dosage administered is too complex to code.boolean
hasChildren()
int
hashCode()
MedicationAdministration.Dosage.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getText
public String getText()
Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.- Returns:
- An immutable object of type
String
that may be null.
-
getSite
public CodeableConcept getSite()
A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getRoute
public CodeableConcept getRoute()
A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getMethod
public CodeableConcept getMethod()
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getDose
public SimpleQuantity getDose()
The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.- Returns:
- An immutable object of type
SimpleQuantity
that may be null.
-
getRate
public Element getRate()
Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.- Returns:
- An immutable object of type
Ratio
orSimpleQuantity
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
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 MedicationAdministration.Dosage.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static MedicationAdministration.Dosage.Builder builder()
-
-