Package org.hl7.fhir.dstu2.model

Class MedicationDispense.MedicationDispenseDosageInstructionComponent

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.Element
org.hl7.fhir.dstu2.model.BackboneElement
org.hl7.fhir.dstu2.model.MedicationDispense.MedicationDispenseDosageInstructionComponent
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
Enclosing class:
MedicationDispense
public static class MedicationDispense.MedicationDispenseDosageInstructionComponent extends BackboneElement implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
See Also:

  • Field Details

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

    • additionalInstructions

      protected CodeableConcept additionalInstructions
      Additional instructions such as "Swallow with plenty of water" which may or may not be coded.

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

  • Constructor Details

  • Method Details

    • 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

    • hasTextElement

      public boolean hasTextElement()

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

    • setText

      public MedicationDispense.MedicationDispenseDosageInstructionComponent setText(String value)
      Parameters:
      value - 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 CodeableConcept getAdditionalInstructions()
      Returns:
      additionalInstructions (Additional instructions such as "Swallow with plenty of water" which may or may not be coded.)

    • hasAdditionalInstructions

      public boolean hasAdditionalInstructions()

    • setAdditionalInstructions

      public MedicationDispense.MedicationDispenseDosageInstructionComponent setAdditionalInstructions(CodeableConcept value)
      Parameters:
      value - additionalInstructions (Additional instructions such as "Swallow with plenty of water" which may or may not be coded.)

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

    • hasTiming

      public boolean hasTiming()

    • setTiming

      public MedicationDispense.MedicationDispenseDosageInstructionComponent setTiming(Timing value)
      Parameters:
      value - 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

    • hasAsNeededBooleanType

      public boolean hasAsNeededBooleanType()

    • 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

    • hasAsNeededCodeableConcept

      public boolean hasAsNeededCodeableConcept()

    • hasAsNeeded

      public boolean hasAsNeeded()

    • 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

    • hasSiteCodeableConcept

      public boolean hasSiteCodeableConcept()

    • 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

    • hasSiteReference

      public boolean hasSiteReference()

    • hasSite

      public boolean hasSite()

    • setSite

      public MedicationDispense.MedicationDispenseDosageInstructionComponent setSite(Type value)
      Parameters:
      value - site (A coded specification of the anatomic site where the medication first enters the body.)

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

    • hasRoute

      public boolean hasRoute()

    • setRoute

      public MedicationDispense.MedicationDispenseDosageInstructionComponent setRoute(CodeableConcept value)
      Parameters:
      value - 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.)

    • hasMethod

      public boolean hasMethod()

    • setMethod

      public MedicationDispense.MedicationDispenseDosageInstructionComponent setMethod(CodeableConcept value)
      Parameters:
      value - 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

    • hasDoseRange

      public boolean hasDoseRange()

    • 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

    • hasDoseSimpleQuantity

      public boolean hasDoseSimpleQuantity()

    • hasDose

      public boolean hasDose()

    • setDose

      public MedicationDispense.MedicationDispenseDosageInstructionComponent setDose(Type value)
      Parameters:
      value - dose (The amount of therapeutic or other substance given at one administration event.)

    • 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

    • hasRateRatio

      public boolean hasRateRatio()

    • 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

    • hasRateRange

      public boolean hasRateRange()

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

    • hasMaxDosePerPeriod

      public boolean hasMaxDosePerPeriod()

    • setMaxDosePerPeriod

      public MedicationDispense.MedicationDispenseDosageInstructionComponent setMaxDosePerPeriod(Ratio value)
      Parameters:
      value - 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.)

    • listChildren

      protected void listChildren(List<Property> childrenList)
      Overrides:
      listChildren in class BackboneElement

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class BackboneElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class BackboneElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • copy

      public MedicationDispense.MedicationDispenseDosageInstructionComponent copy()
      Specified by:
      copy in class BackboneElement

    • equalsDeep

      public boolean equalsDeep(Base other)
      Overrides:
      equalsDeep in class BackboneElement

    • equalsShallow

      public boolean equalsShallow(Base other)
      Overrides:
      equalsShallow in class BackboneElement

    • isEmpty

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

    • fhirType

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