Package org.hl7.fhir.dstu2.model

Class MedicationDispense.MedicationDispenseDosageInstructionComponent

    • Field Detail

      • text

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

      • timing

        protected Timing timing
        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".

      • asNeeded

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

      • site

        protected Type site
        A coded specification of the anatomic site where the medication first enters the body.

      • route

        protected CodeableConcept route
        A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.

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

      • dose

        protected Type dose
        The amount of therapeutic or other substance given at one administration event.

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

      • maxDosePerPeriod

        protected Ratio maxDosePerPeriod
        The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.

    • Method Detail

      • getTextElement

        public StringType getTextElement()
        Returns:
        text (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.). 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 MedicationDispense.MedicationDispenseDosageInstructionComponent setTextElement​(StringType value)
        Parameters:
        value - text (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.). 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 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.

      • getTiming

        public Timing getTiming()
        Returns:
        timing (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 Type getAsNeeded()
        Returns:
        asNeeded (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.)

      • getAsNeededBooleanType

        public BooleanType getAsNeededBooleanType()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        asNeeded (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getAsNeededCodeableConcept

        public CodeableConcept getAsNeededCodeableConcept()
                                           throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        asNeeded (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • setAsNeeded

        public MedicationDispense.MedicationDispenseDosageInstructionComponent setAsNeeded​(Type value)
        Parameters:
        value - asNeeded (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 Type getSite()
        Returns:
        site (A coded specification of the anatomic site where the medication first enters the body.)

      • getSiteCodeableConcept

        public CodeableConcept getSiteCodeableConcept()
                                       throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        site (A coded specification of the anatomic site where the medication first enters the body.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getSiteReference

        public Reference getSiteReference()
                           throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        site (A coded specification of the anatomic site where the medication first enters the body.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

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

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

      • getDose

        public Type getDose()
        Returns:
        dose (The amount of therapeutic or other substance given at one administration event.)

      • getDoseRange

        public Range getDoseRange()
                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        dose (The amount of therapeutic or other substance given at one administration event.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getDoseSimpleQuantity

        public SimpleQuantity getDoseSimpleQuantity()
                                     throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        dose (The amount of therapeutic or other substance given at one administration event.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

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

      • 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. 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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getRateRange

        public Range getRateRange()
                   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. 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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • hasRate

        public boolean hasRate()

      • setRate

        public MedicationDispense.MedicationDispenseDosageInstructionComponent setRate​(Type value)
        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. 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 Ratio getMaxDosePerPeriod()
        Returns:
        maxDosePerPeriod (The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.)

      • isEmpty

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