ca.uhn.fhir.model.dstu2.resource

Class MedicationAdministration.Dosage

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu2.resource.MedicationAdministration.Dosage

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions, Serializable, IBase

Enclosing class:

MedicationAdministration

public static class MedicationAdministration.Dosage
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: MedicationAdministration.dosage ()

Definition: Describes the medication dosage information details e.g. dose, rate, site, route, etc.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Dosage()

Method Summary

Modifier and Type	Method and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
CodeableConceptDt	getMethod() Gets the value(s) for method ().
SimpleQuantityDt	getQuantity() Gets the value(s) for quantity ().
IDatatype	getRate() Gets the value(s) for rate[x] ().
CodeableConceptDt	getRoute() Gets the value(s) for route ().
IDatatype	getSite() Gets the value(s) for site[x] ().
String	getText() Gets the value(s) for text ().
StringDt	getTextElement() Gets the value(s) for text ().
boolean	isEmpty()
MedicationAdministration.Dosage	setMethod(CodeableConceptDt theValue) Sets the value(s) for method ()
MedicationAdministration.Dosage	setQuantity(SimpleQuantityDt theValue) Sets the value(s) for quantity ()
MedicationAdministration.Dosage	setRate(IDatatype theValue) Sets the value(s) for rate[x] ()
MedicationAdministration.Dosage	setRoute(CodeableConceptDt theValue) Sets the value(s) for route ()
MedicationAdministration.Dosage	setSite(IDatatype theValue) Sets the value(s) for site[x] ()
MedicationAdministration.Dosage	setText(String theString) Sets the value for text ()
MedicationAdministration.Dosage	setText(StringDt theValue) Sets the value(s) for text ()

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Constructor Detail

Dosage

public Dosage()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

getTextElement

public StringDt getTextElement()

Gets the value(s) for text (). creating it if it does not exist. Will not return null.

Definition: 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.

getText

public String getText()

Gets the value(s) for text (). creating it if it does not exist. This method may return null.

Definition: 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.Dosage setText(StringDt theValue)

Sets the value(s) for text ()

Definition: 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.Dosage setText(String theString)

Sets the value for text ()

Definition: 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 IDatatype getSite()

Gets the value(s) for site[x] (). creating it if it does not exist. Will not return null.

Definition: A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\"

setSite

public MedicationAdministration.Dosage setSite(IDatatype theValue)

Sets the value(s) for site[x] ()

Definition: A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\"

getRoute

public CodeableConceptDt getRoute()

Gets the value(s) for route (). creating it if it does not exist. Will not return null.

Definition: A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.

setRoute

public MedicationAdministration.Dosage setRoute(CodeableConceptDt theValue)

Sets the value(s) for route ()

Definition: 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 CodeableConceptDt getMethod()

Gets the value(s) for method (). creating it if it does not exist. Will not return null.

Definition: 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.

setMethod

public MedicationAdministration.Dosage setMethod(CodeableConceptDt theValue)

Sets the value(s) for method ()

Definition: 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 SimpleQuantityDt getQuantity()

Gets the value(s) for quantity (). creating it if it does not exist. Will not return null.

Definition: 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.

setQuantity

public MedicationAdministration.Dosage setQuantity(SimpleQuantityDt theValue)

Sets the value(s) for quantity ()

Definition: 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 IDatatype getRate()

Gets the value(s) for rate[x] (). creating it if it does not exist. Will not return null.

Definition: 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.

setRate

public MedicationAdministration.Dosage setRate(IDatatype theValue)

Sets the value(s) for rate[x] ()

Definition: 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.