ca.uhn.fhir.model.dstu2.resource

Class MedicationDispense.DosageInstruction

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu2.resource.MedicationDispense.DosageInstruction

All Implemented Interfaces:

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

Enclosing class:

MedicationDispense

public static class MedicationDispense.DosageInstruction
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: MedicationDispense.dosageInstruction ()

Definition: Indicates how the medication is to be used by the patient

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DosageInstruction()

Method Summary

Modifier and Type	Method and Description
CodeableConceptDt	getAdditionalInstructions() Gets the value(s) for additionalInstructions ().
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
IDatatype	getAsNeeded() Gets the value(s) for asNeeded[x] ().
IDatatype	getDose() Gets the value(s) for dose[x] ().
RatioDt	getMaxDosePerPeriod() Gets the value(s) for maxDosePerPeriod ().
CodeableConceptDt	getMethod() Gets the value(s) for method ().
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 ().
TimingDt	getTiming() Gets the value(s) for timing ().
boolean	isEmpty()
MedicationDispense.DosageInstruction	setAdditionalInstructions(CodeableConceptDt theValue) Sets the value(s) for additionalInstructions ()
MedicationDispense.DosageInstruction	setAsNeeded(IDatatype theValue) Sets the value(s) for asNeeded[x] ()
MedicationDispense.DosageInstruction	setDose(IDatatype theValue) Sets the value(s) for dose[x] ()
MedicationDispense.DosageInstruction	setMaxDosePerPeriod(RatioDt theValue) Sets the value(s) for maxDosePerPeriod ()
MedicationDispense.DosageInstruction	setMethod(CodeableConceptDt theValue) Sets the value(s) for method ()
MedicationDispense.DosageInstruction	setRate(IDatatype theValue) Sets the value(s) for rate[x] ()
MedicationDispense.DosageInstruction	setRoute(CodeableConceptDt theValue) Sets the value(s) for route ()
MedicationDispense.DosageInstruction	setSite(IDatatype theValue) Sets the value(s) for site[x] ()
MedicationDispense.DosageInstruction	setText(String theString) Sets the value for text ()
MedicationDispense.DosageInstruction	setText(StringDt theValue) Sets the value(s) for text ()
MedicationDispense.DosageInstruction	setTiming(TimingDt theValue) Sets the value(s) for timing ()

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, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, 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

Constructor Detail

DosageInstruction

public DosageInstruction()

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

setText

public MedicationDispense.DosageInstruction 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 MedicationDispense.DosageInstruction 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.

getAdditionalInstructions

public CodeableConceptDt getAdditionalInstructions()

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

Definition: Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.

setAdditionalInstructions

public MedicationDispense.DosageInstruction setAdditionalInstructions(CodeableConceptDt theValue)

Sets the value(s) for additionalInstructions ()

Definition: Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.

getTiming

public TimingDt getTiming()

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

Definition: 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\"

setTiming

public MedicationDispense.DosageInstruction setTiming(TimingDt theValue)

Sets the value(s) for timing ()

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

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

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

setAsNeeded

public MedicationDispense.DosageInstruction setAsNeeded(IDatatype theValue)

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

Definition: 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 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 enters the body

setSite

public MedicationDispense.DosageInstruction setSite(IDatatype theValue)

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

Definition: A coded specification of the anatomic site where the medication first enters the body

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 a subject.

setRoute

public MedicationDispense.DosageInstruction 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 a subject.

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.

setMethod

public MedicationDispense.DosageInstruction 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.

getDose

public IDatatype getDose()

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

Definition: The amount of therapeutic or other substance given at one administration event.

setDose

public MedicationDispense.DosageInstruction setDose(IDatatype theValue)

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

Definition: The amount of therapeutic or other substance given at one administration event.

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 MedicationDispense.DosageInstruction 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

getMaxDosePerPeriod

public RatioDt getMaxDosePerPeriod()

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

Definition: The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.

setMaxDosePerPeriod

public MedicationDispense.DosageInstruction setMaxDosePerPeriod(RatioDt theValue)

Sets the value(s) for maxDosePerPeriod ()

Definition: The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.