Dosage (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.Element
  - - org.hl7.fhir.dstu3.model.Type
    - - org.hl7.fhir.dstu3.model.Dosage

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseDatatype, IBaseElement, IBaseHasExtensions, ICompositeType
```
public class Dosage
extends Type
implements ICompositeType
```
Indicates how the medication is/was taken or should be taken by the patient.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<CodeableConcept>`	`additionalInstruction` Supplemental instruction - e.g.
`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 Type`	`dose` Amount of medication per dose.
`protected SimpleQuantity`	`maxDosePerAdministration` Upper limit on medication per administration.
`protected SimpleQuantity`	`maxDosePerLifetime` Upper limit on medication per lifetime of the patient.
`protected Ratio`	`maxDosePerPeriod` Upper limit on medication per unit of time.
`protected CodeableConcept`	`method` Technique for administering medication.
`protected StringType`	`patientInstruction` Instructions in terms that are understood by the patient or consumer.
`protected Type`	`rate` Amount of medication per unit of time.
`protected CodeableConcept`	`route` How drug should enter body.
`protected IntegerType`	`sequence` Indicates the order in which the dosage instructions should be applied or interpreted.
`protected CodeableConcept`	`site` Body site to administer to.
`protected StringType`	`text` Free text dosage instructions e.g.
`protected Timing`	`timing` When medication should be administered.

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

Constructor Summary

Constructors
Constructor and Description

Dosage()
Constructor

Constructors
Constructor and Description
`Dosage()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodeableConcept`	`addAdditionalInstruction()`
`Dosage`	`addAdditionalInstruction(CodeableConcept t)`
`Base`	`addChild(String name)`
`Dosage`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<CodeableConcept>`	`getAdditionalInstruction()`
`CodeableConcept`	`getAdditionalInstructionFirstRep()`
`Type`	`getAsNeeded()`
`BooleanType`	`getAsNeededBooleanType()`
`CodeableConcept`	`getAsNeededCodeableConcept()`
`Type`	`getDose()`
`Range`	`getDoseRange()`
`SimpleQuantity`	`getDoseSimpleQuantity()`
`SimpleQuantity`	`getMaxDosePerAdministration()`
`SimpleQuantity`	`getMaxDosePerLifetime()`
`Ratio`	`getMaxDosePerPeriod()`
`CodeableConcept`	`getMethod()`
`String`	`getPatientInstruction()`
`StringType`	`getPatientInstructionElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`Type`	`getRate()`
`Range`	`getRateRange()`
`Ratio`	`getRateRatio()`
`SimpleQuantity`	`getRateSimpleQuantity()`
`CodeableConcept`	`getRoute()`
`int`	`getSequence()`
`IntegerType`	`getSequenceElement()`
`CodeableConcept`	`getSite()`
`String`	`getText()`
`StringType`	`getTextElement()`
`Timing`	`getTiming()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAdditionalInstruction()`
`boolean`	`hasAsNeeded()`
`boolean`	`hasAsNeededBooleanType()`
`boolean`	`hasAsNeededCodeableConcept()`
`boolean`	`hasDose()`
`boolean`	`hasDoseRange()`
`boolean`	`hasDoseSimpleQuantity()`
`boolean`	`hasMaxDosePerAdministration()`
`boolean`	`hasMaxDosePerLifetime()`
`boolean`	`hasMaxDosePerPeriod()`
`boolean`	`hasMethod()`
`boolean`	`hasPatientInstruction()`
`boolean`	`hasPatientInstructionElement()`
`boolean`	`hasRate()`
`boolean`	`hasRateRange()`
`boolean`	`hasRateRatio()`
`boolean`	`hasRateSimpleQuantity()`
`boolean`	`hasRoute()`
`boolean`	`hasSequence()`
`boolean`	`hasSequenceElement()`
`boolean`	`hasSite()`
`boolean`	`hasText()`
`boolean`	`hasTextElement()`
`boolean`	`hasTiming()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Dosage`	`setAdditionalInstruction(List<CodeableConcept> theAdditionalInstruction)`
`Dosage`	`setAsNeeded(Type value)`
`Dosage`	`setDose(Type value)`
`Dosage`	`setMaxDosePerAdministration(SimpleQuantity value)`
`Dosage`	`setMaxDosePerLifetime(SimpleQuantity value)`
`Dosage`	`setMaxDosePerPeriod(Ratio value)`
`Dosage`	`setMethod(CodeableConcept value)`
`Dosage`	`setPatientInstruction(String value)`
`Dosage`	`setPatientInstructionElement(StringType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Dosage`	`setRate(Type value)`
`Dosage`	`setRoute(CodeableConcept value)`
`Dosage`	`setSequence(int value)`
`Dosage`	`setSequenceElement(IntegerType value)`
`Dosage`	`setSite(CodeableConcept value)`
`Dosage`	`setText(String value)`
`Dosage`	`setTextElement(StringType value)`
`Dosage`	`setTiming(Timing value)`
`protected Dosage`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, isResource, 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

- Field Detail
  - sequence
```
protected IntegerType sequence
```
    Indicates the order in which the dosage instructions should be applied or interpreted.
  - text
```
protected StringType text
```
    Free text dosage instructions e.g. SIG.
  - additionalInstruction
```
protected List<CodeableConcept> additionalInstruction
```
    Supplemental instruction - e.g. "with meals".
  - patientInstruction
```
protected StringType patientInstruction
```
    Instructions in terms that are understood by the patient or consumer.
  - timing
```
protected Timing timing
```
    When medication should be administered.
  - 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).
  - site
```
protected CodeableConcept site
```
    Body site to administer to.
  - route
```
protected CodeableConcept route
```
    How drug should enter body.
  - method
```
protected CodeableConcept method
```
    Technique for administering medication.
  - dose
```
protected Type dose
```
    Amount of medication per dose.
  - maxDosePerPeriod
```
protected Ratio maxDosePerPeriod
```
    Upper limit on medication per unit of time.
  - maxDosePerAdministration
```
protected SimpleQuantity maxDosePerAdministration
```
    Upper limit on medication per administration.
  - maxDosePerLifetime
```
protected SimpleQuantity maxDosePerLifetime
```
    Upper limit on medication per lifetime of the patient.
  - rate
```
protected Type rate
```
    Amount of medication per unit of time.
- Constructor Detail
  - Dosage
```
public Dosage()
```
    Constructor
- Method Detail
  - getSequenceElement
```
public IntegerType getSequenceElement()
```
    Returns:
    
    sequence (Indicates the order in which the dosage instructions should be applied or interpreted.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value
  - hasSequenceElement
```
public boolean hasSequenceElement()
```
  - hasSequence
```
public boolean hasSequence()
```
  - setSequenceElement
```
public Dosage setSequenceElement(IntegerType value)
```
    Parameters:
    
    value - sequence (Indicates the order in which the dosage instructions should be applied or interpreted.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value
  - getSequence
```
public int getSequence()
```
    Returns:
    
    Indicates the order in which the dosage instructions should be applied or interpreted.
  - setSequence
```
public Dosage setSequence(int value)
```
    Parameters:
    
    value - Indicates the order in which the dosage instructions should be applied or interpreted.
  - getTextElement
```
public StringType getTextElement()
```
    Returns:
    
    text (Free text dosage instructions e.g. SIG.). 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 Dosage setTextElement(StringType value)
```
    Parameters:
    
    value - text (Free text dosage instructions e.g. SIG.). 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 e.g. SIG.
  - setText
```
public Dosage setText(String value)
```
    Parameters:
    
    value - Free text dosage instructions e.g. SIG.
  - getAdditionalInstruction
```
public List<CodeableConcept> getAdditionalInstruction()
```
    Returns:
    
    additionalInstruction (Supplemental instruction - e.g. "with meals".)
  - setAdditionalInstruction
```
public Dosage setAdditionalInstruction(List<CodeableConcept> theAdditionalInstruction)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAdditionalInstruction
```
public boolean hasAdditionalInstruction()
```
  - addAdditionalInstruction
```
public CodeableConcept addAdditionalInstruction()
```
  - addAdditionalInstruction
```
public Dosage addAdditionalInstruction(CodeableConcept t)
```
  - getAdditionalInstructionFirstRep
```
public CodeableConcept getAdditionalInstructionFirstRep()
```
    Returns:
    
    The first repetition of repeating field additionalInstruction, creating it if it does not already exist
  - getPatientInstructionElement
```
public StringType getPatientInstructionElement()
```
    Returns:
    
    patientInstruction (Instructions in terms that are understood by the patient or consumer.). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
  - hasPatientInstructionElement
```
public boolean hasPatientInstructionElement()
```
  - hasPatientInstruction
```
public boolean hasPatientInstruction()
```
  - setPatientInstructionElement
```
public Dosage setPatientInstructionElement(StringType value)
```
    Parameters:
    
    value - patientInstruction (Instructions in terms that are understood by the patient or consumer.). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
  - getPatientInstruction
```
public String getPatientInstruction()
```
    Returns:
    
    Instructions in terms that are understood by the patient or consumer.
  - setPatientInstruction
```
public Dosage setPatientInstruction(String value)
```
    Parameters:
    
    value - Instructions in terms that are understood by the patient or consumer.
  - getTiming
```
public Timing getTiming()
```
    Returns:
    
    timing (When medication should be administered.)
  - hasTiming
```
public boolean hasTiming()
```
  - setTiming
```
public Dosage setTiming(Timing value)
```
    Parameters:
    
    value - timing (When medication should be administered.)
  - 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).)
  - getAsNeededBooleanType
```
public BooleanType getAsNeededBooleanType()
                                   throws 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).)
    
    Throws:
    
    FHIRException
  - hasAsNeededBooleanType
```
public boolean hasAsNeededBooleanType()
```
  - getAsNeededCodeableConcept
```
public CodeableConcept getAsNeededCodeableConcept()
                                           throws 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).)
    
    Throws:
    
    FHIRException
  - hasAsNeededCodeableConcept
```
public boolean hasAsNeededCodeableConcept()
```
  - hasAsNeeded
```
public boolean hasAsNeeded()
```
  - setAsNeeded
```
public Dosage 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).)
  - getSite
```
public CodeableConcept getSite()
```
    Returns:
    
    site (Body site to administer to.)
  - hasSite
```
public boolean hasSite()
```
  - setSite
```
public Dosage setSite(CodeableConcept value)
```
    Parameters:
    
    value - site (Body site to administer to.)
  - getRoute
```
public CodeableConcept getRoute()
```
    Returns:
    
    route (How drug should enter body.)
  - hasRoute
```
public boolean hasRoute()
```
  - setRoute
```
public Dosage setRoute(CodeableConcept value)
```
    Parameters:
    
    value - route (How drug should enter body.)
  - getMethod
```
public CodeableConcept getMethod()
```
    Returns:
    
    method (Technique for administering medication.)
  - hasMethod
```
public boolean hasMethod()
```
  - setMethod
```
public Dosage setMethod(CodeableConcept value)
```
    Parameters:
    
    value - method (Technique for administering medication.)
  - getDose
```
public Type getDose()
```
    Returns:
    
    dose (Amount of medication per dose.)
  - getDoseRange
```
public Range getDoseRange()
                   throws FHIRException
```
    Returns:
    
    dose (Amount of medication per dose.)
    
    Throws:
    
    FHIRException
  - hasDoseRange
```
public boolean hasDoseRange()
```
  - getDoseSimpleQuantity
```
public SimpleQuantity getDoseSimpleQuantity()
                                     throws FHIRException
```
    Returns:
    
    dose (Amount of medication per dose.)
    
    Throws:
    
    FHIRException
  - hasDoseSimpleQuantity
```
public boolean hasDoseSimpleQuantity()
```
  - hasDose
```
public boolean hasDose()
```
  - setDose
```
public Dosage setDose(Type value)
```
    Parameters:
    
    value - dose (Amount of medication per dose.)
  - getMaxDosePerPeriod
```
public Ratio getMaxDosePerPeriod()
```
    Returns:
    
    maxDosePerPeriod (Upper limit on medication per unit of time.)
  - hasMaxDosePerPeriod
```
public boolean hasMaxDosePerPeriod()
```
  - setMaxDosePerPeriod
```
public Dosage setMaxDosePerPeriod(Ratio value)
```
    Parameters:
    
    value - maxDosePerPeriod (Upper limit on medication per unit of time.)
  - getMaxDosePerAdministration
```
public SimpleQuantity getMaxDosePerAdministration()
```
    Returns:
    
    maxDosePerAdministration (Upper limit on medication per administration.)
  - hasMaxDosePerAdministration
```
public boolean hasMaxDosePerAdministration()
```
  - setMaxDosePerAdministration
```
public Dosage setMaxDosePerAdministration(SimpleQuantity value)
```
    Parameters:
    
    value - maxDosePerAdministration (Upper limit on medication per administration.)
  - getMaxDosePerLifetime
```
public SimpleQuantity getMaxDosePerLifetime()
```
    Returns:
    
    maxDosePerLifetime (Upper limit on medication per lifetime of the patient.)
  - hasMaxDosePerLifetime
```
public boolean hasMaxDosePerLifetime()
```
  - setMaxDosePerLifetime
```
public Dosage setMaxDosePerLifetime(SimpleQuantity value)
```
    Parameters:
    
    value - maxDosePerLifetime (Upper limit on medication per lifetime of the patient.)
  - getRate
```
public Type getRate()
```
    Returns:
    
    rate (Amount of medication per unit of time.)
  - getRateRatio
```
public Ratio getRateRatio()
                   throws FHIRException
```
    Returns:
    
    rate (Amount of medication per unit of time.)
    
    Throws:
    
    FHIRException
  - hasRateRatio
```
public boolean hasRateRatio()
```
  - getRateRange
```
public Range getRateRange()
                   throws FHIRException
```
    Returns:
    
    rate (Amount of medication per unit of time.)
    
    Throws:
    
    FHIRException
  - hasRateRange
```
public boolean hasRateRange()
```
  - getRateSimpleQuantity
```
public SimpleQuantity getRateSimpleQuantity()
                                     throws FHIRException
```
    Returns:
    
    rate (Amount of medication per unit of time.)
    
    Throws:
    
    FHIRException
  - hasRateSimpleQuantity
```
public boolean hasRateSimpleQuantity()
```
  - hasRate
```
public boolean hasRate()
```
  - setRate
```
public Dosage setRate(Type value)
```
    Parameters:
    
    value - rate (Amount of medication per unit of time.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class Element
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class Element
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class Element
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class Element
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class Element
    
    Throws:
    
    FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class Element
  - copy
```
public Dosage copy()
```
    Overrides:
    
    copy in class Type
  - typedCopy
```
protected Dosage typedCopy()
```
    Specified by:
    
    typedCopy in class Type
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class Element
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class Element
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class Element

Class Dosage

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

sequence

text

additionalInstruction

patientInstruction

timing

asNeeded

site

route

method

dose

maxDosePerPeriod

maxDosePerAdministration

maxDosePerLifetime

rate

Constructor Detail

Dosage

Method Detail

getSequenceElement

hasSequenceElement

hasSequence

setSequenceElement

getSequence

setSequence

getTextElement

hasTextElement

hasText

setTextElement

getText

setText

getAdditionalInstruction

setAdditionalInstruction

hasAdditionalInstruction

addAdditionalInstruction

addAdditionalInstruction

getAdditionalInstructionFirstRep

getPatientInstructionElement

hasPatientInstructionElement

hasPatientInstruction

setPatientInstructionElement

getPatientInstruction

setPatientInstruction

getTiming

hasTiming

setTiming

getAsNeeded

getAsNeededBooleanType

hasAsNeededBooleanType

getAsNeededCodeableConcept

hasAsNeededCodeableConcept

hasAsNeeded

setAsNeeded

getSite

hasSite

setSite

getRoute

hasRoute

setRoute

getMethod

hasMethod

setMethod

getDose

getDoseRange

hasDoseRange

getDoseSimpleQuantity

hasDoseSimpleQuantity

hasDose

setDose

getMaxDosePerPeriod

hasMaxDosePerPeriod

setMaxDosePerPeriod