Package ca.uhn.fhir.model.dstu2.resource

Class MedicationDispense.DosageInstruction

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.dstu2.resource.MedicationDispense.DosageInstruction
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:
MedicationDispense
public static class MedicationDispense.DosageInstruction extends ca.uhn.fhir.model.api.BaseIdentifiableElement implements ca.uhn.fhir.model.api.IResourceBlock
Block class for child element: MedicationDispense.dosageInstruction ()

Definition: Indicates how the medication is to be used by the patient

See Also:

  • Constructor Details

  • Method Details

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

    • getAdditionalInstructions

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

      Definition: Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.

    • setAdditionalInstructions

      public MedicationDispense.DosageInstruction setAdditionalInstructions(CodeableConceptDt theValue)
      Sets the value(s) for additionalInstructions ()

      Definition: Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.

    • 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 MedicationDispense.DosageInstruction 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 MedicationDispense.DosageInstruction 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 the anatomic site where the medication first enters the body

    • setSite

      public MedicationDispense.DosageInstruction 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 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.

    • setRoute

      public MedicationDispense.DosageInstruction 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 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.

    • setMethod

      public MedicationDispense.DosageInstruction 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.

    • getDose

      public ca.uhn.fhir.model.api.IDatatype getDose()
      Gets the value(s) for dose[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.

    • setDose

      public MedicationDispense.DosageInstruction setDose(ca.uhn.fhir.model.api.IDatatype theValue)
      Sets the value(s) for dose[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 MedicationDispense.DosageInstruction 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, e.g. 1000mg in 24 hours.

    • setMaxDosePerPeriod

      public MedicationDispense.DosageInstruction 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, e.g. 1000mg in 24 hours.