Package org.hl7.fhir.dstu3.model

Class MedicationAdministration.MedicationAdministrationDosageComponent

    • Field Detail

      • text

        protected StringType text
        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.

      • site

        protected CodeableConcept site
        A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".

      • route

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

      • method

        protected CodeableConcept method
        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.

      • dose

        protected SimpleQuantity dose
        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.

      • rate

        protected Type rate
        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.

    • Method Detail

      • getTextElement

        public StringType getTextElement()
        Returns:
        text (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.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

      • hasText

        public boolean hasText()

      • setTextElement

        public MedicationAdministration.MedicationAdministrationDosageComponent setTextElement​(StringType value)
        Parameters:
        value - text (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.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

      • getText

        public String getText()
        Returns:
        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.

      • setText

        public MedicationAdministration.MedicationAdministrationDosageComponent setText​(String value)
        Parameters:
        value - 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.

      • getSite

        public CodeableConcept getSite()
        Returns:
        site (A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".)

      • hasSite

        public boolean hasSite()

      • getRoute

        public CodeableConcept getRoute()
        Returns:
        route (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 CodeableConcept getMethod()
        Returns:
        method (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.)

      • getDose

        public SimpleQuantity getDose()
        Returns:
        dose (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.)

      • hasDose

        public boolean hasDose()

      • getRate

        public Type getRate()
        Returns:
        rate (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.)

      • getRateRatio

        public Ratio getRateRatio()
                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        rate (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getRateSimpleQuantity

        public SimpleQuantity getRateSimpleQuantity()
                                     throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        rate (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • hasRate

        public boolean hasRate()

      • setRate

        public MedicationAdministration.MedicationAdministrationDosageComponent setRate​(Type value)
                                                                         throws org.hl7.fhir.exceptions.FHIRFormatError
        Parameters:
        value - rate (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRFormatError

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class BackboneElement