MedicationStatement.MedicationStatementDosageComponent (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.Element
  - - org.hl7.fhir.dstu2016may.model.BackboneElement
    - - org.hl7.fhir.dstu2016may.model.MedicationStatement.MedicationStatementDosageComponent

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:

MedicationStatement
```
public static class MedicationStatement.MedicationStatementDosageComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`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).
`protected Ratio`	`maxDosePerPeriod` The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time.
`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.
`protected Type`	`quantity` The amount of therapeutic or other substance given at one administration event.
`protected Type`	`rate` Identifies the speed with which the medication was or will be introduced into the patient.
`protected CodeableConcept`	`route` A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.
`protected Type`	`site` A coded specification of or a reference to the anatomic site where the medication first enters the body.
`protected StringType`	`text` Free text dosage information as reported about a patient's medication use.
`protected Timing`	`timing` The timing schedule for giving the medication to the patient.

Fields inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.dstu2016may.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

MedicationStatementDosageComponent()
Constructor

Constructors
Constructor and Description
`MedicationStatementDosageComponent()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`MedicationStatement.MedicationStatementDosageComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Type`	`getAsNeeded()`
`BooleanType`	`getAsNeededBooleanType()`
`CodeableConcept`	`getAsNeededCodeableConcept()`
`Ratio`	`getMaxDosePerPeriod()`
`CodeableConcept`	`getMethod()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`Type`	`getQuantity()`
`Range`	`getQuantityRange()`
`SimpleQuantity`	`getQuantitySimpleQuantity()`
`Type`	`getRate()`
`Range`	`getRateRange()`
`Ratio`	`getRateRatio()`
`CodeableConcept`	`getRoute()`
`Type`	`getSite()`
`CodeableConcept`	`getSiteCodeableConcept()`
`Reference`	`getSiteReference()`
`String`	`getText()`
`StringType`	`getTextElement()`
`Timing`	`getTiming()`
`boolean`	`hasAsNeeded()`
`boolean`	`hasAsNeededBooleanType()`
`boolean`	`hasAsNeededCodeableConcept()`
`boolean`	`hasMaxDosePerPeriod()`
`boolean`	`hasMethod()`
`boolean`	`hasQuantity()`
`boolean`	`hasQuantityRange()`
`boolean`	`hasQuantitySimpleQuantity()`
`boolean`	`hasRate()`
`boolean`	`hasRateRange()`
`boolean`	`hasRateRatio()`
`boolean`	`hasRoute()`
`boolean`	`hasSite()`
`boolean`	`hasSiteCodeableConcept()`
`boolean`	`hasSiteReference()`
`boolean`	`hasText()`
`boolean`	`hasTextElement()`
`boolean`	`hasTiming()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`MedicationStatement.MedicationStatementDosageComponent`	`setAsNeeded(Type value)`
`MedicationStatement.MedicationStatementDosageComponent`	`setMaxDosePerPeriod(Ratio value)`
`MedicationStatement.MedicationStatementDosageComponent`	`setMethod(CodeableConcept value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`MedicationStatement.MedicationStatementDosageComponent`	`setQuantity(Type value)`
`MedicationStatement.MedicationStatementDosageComponent`	`setRate(Type value)`
`MedicationStatement.MedicationStatementDosageComponent`	`setRoute(CodeableConcept value)`
`MedicationStatement.MedicationStatementDosageComponent`	`setSite(Type value)`
`MedicationStatement.MedicationStatementDosageComponent`	`setText(String value)`
`MedicationStatement.MedicationStatementDosageComponent`	`setTextElement(StringType value)`
`MedicationStatement.MedicationStatementDosageComponent`	`setTiming(Timing value)`

Methods inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.dstu2016may.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

- Field Detail
  - text
```
protected StringType text
```
    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.
  - 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 or a reference to 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. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.
  - quantity
```
protected Type quantity
```
    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. For example, 1000mg in 24 hours.
- Constructor Detail
  - MedicationStatementDosageComponent
```
public MedicationStatementDosageComponent()
```
    Constructor
- Method Detail
  - getTextElement
```
public StringType getTextElement()
```
    Returns:
    
    text (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.). 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 MedicationStatement.MedicationStatementDosageComponent setTextElement(StringType value)
```
    Parameters:
    
    value - text (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.). 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 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.MedicationStatementDosageComponent setText(String value)
```
    Parameters:
    
    value - 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 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 MedicationStatement.MedicationStatementDosageComponent 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 MedicationStatement.MedicationStatementDosageComponent 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 or a reference to 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 or a reference to 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 or a reference to 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 MedicationStatement.MedicationStatementDosageComponent setSite(Type value)
```
    Parameters:
    
    value - site (A coded specification of or a reference to 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 MedicationStatement.MedicationStatementDosageComponent 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. 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 MedicationStatement.MedicationStatementDosageComponent 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 Type getQuantity()
```
    Returns:
    
    quantity (The amount of therapeutic or other substance given at one administration event.)
  - getQuantitySimpleQuantity
```
public SimpleQuantity getQuantitySimpleQuantity()
                                         throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    quantity (The amount of therapeutic or other substance given at one administration event.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasQuantitySimpleQuantity
```
public boolean hasQuantitySimpleQuantity()
```
  - getQuantityRange
```
public Range getQuantityRange()
                       throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    quantity (The amount of therapeutic or other substance given at one administration event.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasQuantityRange
```
public boolean hasQuantityRange()
```
  - hasQuantity
```
public boolean hasQuantity()
```
  - setQuantity
```
public MedicationStatement.MedicationStatementDosageComponent setQuantity(Type value)
```
    Parameters:
    
    value - quantity (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 MedicationStatement.MedicationStatementDosageComponent 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. For example, 1000mg in 24 hours.)
  - hasMaxDosePerPeriod
```
public boolean hasMaxDosePerPeriod()
```
  - setMaxDosePerPeriod
```
public MedicationStatement.MedicationStatementDosageComponent 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. For example, 1000mg in 24 hours.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - 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
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty 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 MedicationStatement.MedicationStatementDosageComponent 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()
```
    Overrides:
    
    fhirType in class BackboneElement

Class MedicationStatement.MedicationStatementDosageComponent

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement

Fields inherited from class org.hl7.fhir.dstu2016may.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement

Methods inherited from class org.hl7.fhir.dstu2016may.model.Element

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Field Detail

text

timing

asNeeded

site

route

method

quantity

rate

maxDosePerPeriod

Constructor Detail

MedicationStatementDosageComponent

Method Detail

getTextElement

hasTextElement

hasText

setTextElement

getText

setText

getTiming

hasTiming

setTiming

getAsNeeded

getAsNeededBooleanType

hasAsNeededBooleanType

getAsNeededCodeableConcept

hasAsNeededCodeableConcept

hasAsNeeded

setAsNeeded

getSite

getSiteCodeableConcept

hasSiteCodeableConcept

getSiteReference

hasSiteReference

hasSite

setSite

getRoute

hasRoute

setRoute

getMethod

hasMethod

setMethod

getQuantity

getQuantitySimpleQuantity

hasQuantitySimpleQuantity

getQuantityRange

hasQuantityRange

hasQuantity

setQuantity

getRate

getRateRatio

hasRateRatio

getRateRange

hasRateRange

hasRate

setRate

getMaxDosePerPeriod

hasMaxDosePerPeriod

setMaxDosePerPeriod

listChildren

getProperty

setProperty

setProperty

makeProperty

addChild

copy

equalsDeep