Package com.ibm.fhir.model.type

Class Dosage

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Dosage
extends BackboneElement
    Indicates how the medication is/was taken or should be taken by the patient.

    • Method Detail

      • getSequence

        public Integer getSequence()
        Indicates the order in which the dosage instructions should be applied or interpreted.
        Returns:
        An immutable object of type Integer that may be null.

      • getText

        public String getText()
        Free text dosage instructions e.g. SIG.
        Returns:
        An immutable object of type String that may be null.

      • getAdditionalInstruction

        public List<CodeableConcept> getAdditionalInstruction()
        Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPatientInstruction

        public String getPatientInstruction()
        Instructions in terms that are understood by the patient or consumer.
        Returns:
        An immutable object of type String that may be null.

      • getTiming

        public Timing getTiming()
        When medication should be administered.
        Returns:
        An immutable object of type Timing that may be null.

      • getAsNeeded

        public Element getAsNeeded()
        Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
        Returns:
        An immutable object of type Element that may be null.

      • getMethod

        public CodeableConcept getMethod()
        Technique for administering medication.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getDoseAndRate

        public List<Dosage.DoseAndRate> getDoseAndRate()
        The amount of medication administered.
        Returns:
        An unmodifiable list containing immutable objects of type Dosage.DoseAndRate that may be empty.

      • getMaxDosePerPeriod

        public Ratio getMaxDosePerPeriod()
        Upper limit on medication per unit of time.
        Returns:
        An immutable object of type Ratio that may be null.

      • getMaxDosePerAdministration

        public SimpleQuantity getMaxDosePerAdministration()
        Upper limit on medication per administration.
        Returns:
        An immutable object of type SimpleQuantity that may be null.

      • getMaxDosePerLifetime

        public SimpleQuantity getMaxDosePerLifetime()
        Upper limit on medication per lifetime of the patient.
        Returns:
        An immutable object of type SimpleQuantity that may be null.

      • accept

        public void accept​(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 interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object