Package org.hl7.fhir.dstu2.model

Class MedicationAdministration.MedicationAdministrationDosageComponent

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.MedicationAdministration.MedicationAdministrationDosageComponent
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:
MedicationAdministration
public static class MedicationAdministration.MedicationAdministrationDosageComponent 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.

    • site

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

    • quantity

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

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

    • getSite

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

    • getSiteCodeableConcept

      public CodeableConcept getSiteCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      site (A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".)
      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 entered the body. For example, "left arm".)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasSiteReference

      public boolean hasSiteReference()

    • hasSite

      public boolean hasSite()

    • setSite

      public MedicationAdministration.MedicationAdministrationDosageComponent setSite(Type value)
      Parameters:
      value - site (A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".)

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

    • hasRoute

      public boolean hasRoute()

    • setRoute

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

    • hasMethod

      public boolean hasMethod()

    • setMethod

      public MedicationAdministration.MedicationAdministrationDosageComponent 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. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.)

    • getQuantity

      public SimpleQuantity getQuantity()
      Returns:
      quantity (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.)

    • hasQuantity

      public boolean hasQuantity()

    • setQuantity

      public MedicationAdministration.MedicationAdministrationDosageComponent setQuantity(SimpleQuantity value)
      Parameters:
      value - quantity (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.)

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

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