Class MedicationAdministration.Dosage

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
    Enclosing class:
    MedicationAdministration

    public static class MedicationAdministration.Dosage
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.IResourceBlock
    Block class for child element: MedicationAdministration.dosage ()

    Definition: Describes the medication dosage information details e.g. dose, rate, site, route, etc.

    See Also:
    Serialized Form
    • Constructor Detail

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getTextElement

        public ca.uhn.fhir.model.primitive.StringDt getTextElement()
        Gets the value(s) for text (). creating it if it does not exist. Will not return null.

        Definition: Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.

      • getText

        public String getText()
        Gets the value(s) for text (). creating it if it does not exist. This method may return null.

        Definition: Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.

      • setText

        public MedicationAdministration.Dosage setText​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for text ()

        Definition: Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.

      • setText

        public MedicationAdministration.Dosage setText​(String theString)
        Sets the value for text ()

        Definition: Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.

      • getSite

        public ca.uhn.fhir.model.api.IDatatype getSite()
        Gets the value(s) for site[x] (). creating it if it does not exist. Will not return null.

        Definition: A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\"

      • setSite

        public MedicationAdministration.Dosage setSite​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for site[x] ()

        Definition: A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\"

      • getRoute

        public CodeableConceptDt getRoute()
        Gets the value(s) for route (). creating it if it does not exist. Will not return null.

        Definition: A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.

      • setRoute

        public MedicationAdministration.Dosage setRoute​(CodeableConceptDt theValue)
        Sets the value(s) for route ()

        Definition: A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.

      • getMethod

        public CodeableConceptDt getMethod()
        Gets the value(s) for method (). creating it if it does not exist. Will not return null.

        Definition: 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.

      • setMethod

        public MedicationAdministration.Dosage setMethod​(CodeableConceptDt theValue)
        Sets the value(s) for method ()

        Definition: 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.

      • getQuantity

        public SimpleQuantityDt getQuantity()
        Gets the value(s) for quantity (). creating it if it does not exist. Will not return null.

        Definition: 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.

      • setQuantity

        public MedicationAdministration.Dosage setQuantity​(SimpleQuantityDt theValue)
        Sets the value(s) for quantity ()

        Definition: 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.

      • getRate

        public ca.uhn.fhir.model.api.IDatatype getRate()
        Gets the value(s) for rate[x] (). creating it if it does not exist. Will not return null.

        Definition: 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. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.

      • setRate

        public MedicationAdministration.Dosage setRate​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for rate[x] ()

        Definition: 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. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.