Package org.hl7.fhir.r5.model

Class Dosage

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.BackboneType

org.hl7.fhir.r5.model.Dosage

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.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class Dosage
extends BackboneType
implements org.hl7.fhir.instance.model.api.ICompositeType

Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dosage.DosageDoseAndRateComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	additionalInstruction	Supplemental instructions to the patient on how to take the medication (e.g.
protected BooleanType	asNeeded	Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).
protected List<CodeableConcept>	asNeededFor	Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).
protected List<Dosage.DosageDoseAndRateComponent>	doseAndRate	Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.
protected Quantity	maxDosePerAdministration	Upper limit on medication per administration.
protected Quantity	maxDosePerLifetime	Upper limit on medication per lifetime of the patient.
protected List<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 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.r5.model.BackboneType

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
Dosage()	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addAdditionalInstruction()
Dosage	addAdditionalInstruction(CodeableConcept t)
CodeableConcept	addAsNeededFor()
Dosage	addAsNeededFor(CodeableConcept t)
Base	addChild(String name)
Dosage.DosageDoseAndRateComponent	addDoseAndRate()
Dosage	addDoseAndRate(Dosage.DosageDoseAndRateComponent t)
Ratio	addMaxDosePerPeriod()
Dosage	addMaxDosePerPeriod(Ratio t)
Dosage	copy()
void	copyValues(Dosage dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getAdditionalInstruction()
CodeableConcept	getAdditionalInstructionFirstRep()
boolean	getAsNeeded()
BooleanType	getAsNeededElement()
List<CodeableConcept>	getAsNeededFor()
CodeableConcept	getAsNeededForFirstRep()
List<Dosage.DosageDoseAndRateComponent>	getDoseAndRate()
Dosage.DosageDoseAndRateComponent	getDoseAndRateFirstRep()
Quantity	getMaxDosePerAdministration()
Quantity	getMaxDosePerLifetime()
List<Ratio>	getMaxDosePerPeriod()
Ratio	getMaxDosePerPeriodFirstRep()
CodeableConcept	getMethod()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
String	getPatientInstruction()
StringType	getPatientInstructionElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
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	hasAsNeededElement()
boolean	hasAsNeededFor()
boolean	hasDoseAndRate()
boolean	hasMaxDosePerAdministration()
boolean	hasMaxDosePerLifetime()
boolean	hasMaxDosePerPeriod()
boolean	hasMethod()
boolean	hasPatientInstruction()
boolean	hasPatientInstructionElement()
boolean	hasRoute()
boolean	hasSequence()
boolean	hasSequenceElement()
boolean	hasSite()
boolean	hasText()
boolean	hasTextElement()
boolean	hasTiming()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Dosage	setAdditionalInstruction(List<CodeableConcept> theAdditionalInstruction)
Dosage	setAsNeeded(boolean value)
Dosage	setAsNeededElement(BooleanType value)
Dosage	setAsNeededFor(List<CodeableConcept> theAsNeededFor)
Dosage	setDoseAndRate(List<Dosage.DosageDoseAndRateComponent> theDoseAndRate)
Dosage	setMaxDosePerAdministration(Quantity value)
Dosage	setMaxDosePerLifetime(Quantity value)
Dosage	setMaxDosePerPeriod(List<Ratio> theMaxDosePerPeriod)
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	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.r5.model.BackboneType

addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

Field Details

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 instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").

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 BooleanType asNeeded

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).

asNeededFor

protected List<CodeableConcept> asNeededFor

Indicates whether the Medication is only taken based on a 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.

doseAndRate

protected List<Dosage.DosageDoseAndRateComponent> doseAndRate

Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.

maxDosePerPeriod

protected List<Ratio> maxDosePerPeriod

Upper limit on medication per unit of time.

maxDosePerAdministration

protected Quantity maxDosePerAdministration

Upper limit on medication per administration.

maxDosePerLifetime

protected Quantity maxDosePerLifetime

Upper limit on medication per lifetime of the patient.

Constructor Details

Dosage

public Dosage()

Constructor

Method Details

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 instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").)

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 {3}

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

getAsNeededElement

public BooleanType getAsNeededElement()

Returns:

asNeeded (Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).). This is the underlying object with id, value and extensions. The accessor "getAsNeeded" gives direct access to the value

hasAsNeededElement

public boolean hasAsNeededElement()

hasAsNeeded

public boolean hasAsNeeded()

setAsNeededElement

public Dosage setAsNeededElement(BooleanType value)

Parameters:

value - asNeeded (Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).). This is the underlying object with id, value and extensions. The accessor "getAsNeeded" gives direct access to the value

getAsNeeded

public boolean getAsNeeded()

Returns:

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).

setAsNeeded

public Dosage setAsNeeded(boolean value)

Parameters:

value - Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).

getAsNeededFor

public List<CodeableConcept> getAsNeededFor()

Returns:

asNeededFor (Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).)

setAsNeededFor

public Dosage setAsNeededFor(List<CodeableConcept> theAsNeededFor)

Returns:

Returns a reference to this for easy method chaining

hasAsNeededFor

public boolean hasAsNeededFor()

addAsNeededFor

public CodeableConcept addAsNeededFor()

addAsNeededFor

public Dosage addAsNeededFor(CodeableConcept t)

getAsNeededForFirstRep

public CodeableConcept getAsNeededForFirstRep()

Returns:

The first repetition of repeating field asNeededFor, creating it if it does not already exist {3}

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

getDoseAndRate

public List<Dosage.DosageDoseAndRateComponent> getDoseAndRate()

Returns:

doseAndRate (Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.)

setDoseAndRate

public Dosage setDoseAndRate(List<Dosage.DosageDoseAndRateComponent> theDoseAndRate)

Returns:

Returns a reference to this for easy method chaining

hasDoseAndRate

public boolean hasDoseAndRate()

addDoseAndRate

public Dosage.DosageDoseAndRateComponent addDoseAndRate()

addDoseAndRate

public Dosage addDoseAndRate(Dosage.DosageDoseAndRateComponent t)

getDoseAndRateFirstRep

public Dosage.DosageDoseAndRateComponent getDoseAndRateFirstRep()

Returns:

The first repetition of repeating field doseAndRate, creating it if it does not already exist {3}

getMaxDosePerPeriod

public List<Ratio> getMaxDosePerPeriod()

Returns:

maxDosePerPeriod (Upper limit on medication per unit of time.)

setMaxDosePerPeriod

public Dosage setMaxDosePerPeriod(List<Ratio> theMaxDosePerPeriod)

Returns:

Returns a reference to this for easy method chaining

hasMaxDosePerPeriod

public boolean hasMaxDosePerPeriod()

addMaxDosePerPeriod

public Ratio addMaxDosePerPeriod()

addMaxDosePerPeriod

public Dosage addMaxDosePerPeriod(Ratio t)

getMaxDosePerPeriodFirstRep

public Ratio getMaxDosePerPeriodFirstRep()

Returns:

The first repetition of repeating field maxDosePerPeriod, creating it if it does not already exist {3}

getMaxDosePerAdministration

public Quantity getMaxDosePerAdministration()

Returns:

maxDosePerAdministration (Upper limit on medication per administration.)

hasMaxDosePerAdministration

public boolean hasMaxDosePerAdministration()

setMaxDosePerAdministration

public Dosage setMaxDosePerAdministration(Quantity value)

Parameters:

value - maxDosePerAdministration (Upper limit on medication per administration.)

getMaxDosePerLifetime

public Quantity getMaxDosePerLifetime()

Returns:

maxDosePerLifetime (Upper limit on medication per lifetime of the patient.)

hasMaxDosePerLifetime

public boolean hasMaxDosePerLifetime()

setMaxDosePerLifetime

public Dosage setMaxDosePerLifetime(Quantity value)

Parameters:

value - maxDosePerLifetime (Upper limit on medication per lifetime of the patient.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneType

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneType

Returns:

the FHIR type name of the instance (not the java class name)

copy

public Dosage copy()

Specified by:

copy in class BackboneType

copyValues

public void copyValues(Dosage dst)

typedCopy

protected Dosage typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneType

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneType

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneType