Class MedicationStatement.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:
    MedicationStatement

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

    Definition: Indicates how the medication is/was used by the patient

    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 information as reported about a patient's medication use. When coded dosage information is present, the free text may still be present for display to humans.

      • 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 information as reported about a patient's medication use. When coded dosage information is present, the free text may still be present for display to humans.

      • setText

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

        Definition: Free text dosage information as reported about a patient's medication use. When coded dosage information is present, the free text may still be present for display to humans.

      • setText

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

        Definition: Free text dosage information as reported about a patient's medication use. When coded dosage information is present, the free text may still be present for display to humans.

      • getTiming

        public TimingDt getTiming()
        Gets the value(s) for timing (). creating it if it does not exist. Will not return null.

        Definition: The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\"

      • setTiming

        public MedicationStatement.Dosage setTiming​(TimingDt theValue)
        Sets the value(s) for timing ()

        Definition: The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\"

      • getAsNeeded

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

        Definition: 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). Specifically if 'boolean' datatype is selected, then the following logic applies: If set to True, this indicates that the medication is only taken when needed, within the specified schedule.

      • setAsNeeded

        public MedicationStatement.Dosage setAsNeeded​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for asNeeded[x] ()

        Definition: 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). Specifically if 'boolean' datatype is selected, then the following logic applies: If set to True, this indicates that the medication is only taken when needed, within the specified schedule.

      • 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 or a reference to the anatomic site where the medication first enters the body

      • setSite

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

        Definition: A coded specification of or a reference to the anatomic site where the medication first enters the body

      • 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 a subject.

      • 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 MedicationStatement.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 ca.uhn.fhir.model.api.IDatatype getQuantity()
        Gets the value(s) for quantity[x] (). creating it if it does not exist. Will not return null.

        Definition: The amount of therapeutic or other substance given at one administration event.

      • setQuantity

        public MedicationStatement.Dosage setQuantity​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for quantity[x] ()

        Definition: The amount of therapeutic or other substance given at one administration event.

      • 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 MedicationStatement.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

      • getMaxDosePerPeriod

        public RatioDt getMaxDosePerPeriod()
        Gets the value(s) for maxDosePerPeriod (). creating it if it does not exist. Will not return null.

        Definition: The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.

      • setMaxDosePerPeriod

        public MedicationStatement.Dosage setMaxDosePerPeriod​(RatioDt theValue)
        Sets the value(s) for maxDosePerPeriod ()

        Definition: The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.