ca.uhn.fhir.model.dstu.resource

Class MedicationStatement.Dosage

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.resource.MedicationStatement.Dosage

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

MedicationStatement

public static class MedicationStatement.Dosage
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: MedicationStatement.dosage (Details of how medication was taken)

Definition: Indicates how the medication is/was used by the patient

Constructor Summary

Constructors

Constructor and Description
MedicationStatement.Dosage()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
IDatatype	getAsNeeded() Gets the value(s) for asNeeded[x] (Take \"as needed\" f(or x)).
RatioDt	getMaxDosePerPeriod() Gets the value(s) for maxDosePerPeriod (Maximum dose that was consumed per unit of time).
CodeableConceptDt	getMethod() Gets the value(s) for method (Technique used to administer medication).
QuantityDt	getQuantity() Gets the value(s) for quantity (Amount administered in one dose).
RatioDt	getRate() Gets the value(s) for rate (Dose quantity per unit of time).
CodeableConceptDt	getRoute() Gets the value(s) for route (How did the medication enter the body?).
CodeableConceptDt	getSite() Gets the value(s) for site (Where on body was medication administered?).
ScheduleDt	getTiming() Gets the value(s) for timing (When/how often was medication taken?).
boolean	isEmpty()
MedicationStatement.Dosage	setAsNeeded(IDatatype theValue) Sets the value(s) for asNeeded[x] (Take \"as needed\" f(or x))
MedicationStatement.Dosage	setMaxDosePerPeriod(RatioDt theValue) Sets the value(s) for maxDosePerPeriod (Maximum dose that was consumed per unit of time)
MedicationStatement.Dosage	setMethod(CodeableConceptDt theValue) Sets the value(s) for method (Technique used to administer medication)
MedicationStatement.Dosage	setQuantity(double theValue) Sets the value for quantity (Amount administered in one dose)
MedicationStatement.Dosage	setQuantity(long theValue) Sets the value for quantity (Amount administered in one dose)
MedicationStatement.Dosage	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theUnits) Sets the value for quantity (Amount administered in one dose)
MedicationStatement.Dosage	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Sets the value for quantity (Amount administered in one dose)
MedicationStatement.Dosage	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theUnits) Sets the value for quantity (Amount administered in one dose)
MedicationStatement.Dosage	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Sets the value for quantity (Amount administered in one dose)
MedicationStatement.Dosage	setQuantity(QuantityDt theValue) Sets the value(s) for quantity (Amount administered in one dose)
MedicationStatement.Dosage	setRate(RatioDt theValue) Sets the value(s) for rate (Dose quantity per unit of time)
MedicationStatement.Dosage	setRoute(CodeableConceptDt theValue) Sets the value(s) for route (How did the medication enter the body?)
MedicationStatement.Dosage	setSite(CodeableConceptDt theValue) Sets the value(s) for site (Where on body was medication administered?)
MedicationStatement.Dosage	setTiming(ScheduleDt theValue) Sets the value(s) for timing (When/how often was medication taken?)

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

MedicationStatement.Dosage

public MedicationStatement.Dosage()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

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

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getTiming

public ScheduleDt getTiming()

Gets the value(s) for timing (When/how often was medication taken?). 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 MedicationStatement.Dosage setTiming(ScheduleDt theValue)

Sets the value(s) for timing (When/how often was medication taken?)

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] (Take \"as needed\" f(or x)). creating it if it does not exist. Will not return null.

Definition: If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication

setAsNeeded

public MedicationStatement.Dosage setAsNeeded(IDatatype theValue)

Sets the value(s) for asNeeded[x] (Take \"as needed\" f(or x))

Definition: If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication

getSite

public CodeableConceptDt getSite()

Gets the value(s) for site (Where on body was medication administered?). 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 MedicationStatement.Dosage setSite(CodeableConceptDt theValue)

Sets the value(s) for site (Where on body was medication administered?)

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 (How did the medication enter the body?). 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 MedicationStatement.Dosage setRoute(CodeableConceptDt theValue)

Sets the value(s) for route (How did the medication enter the body?)

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 (Technique used to administer medication). creating it if it does not exist. Will not return null.

Definition: A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.Terminologies used often pre-coordinate this term with the route and or form of administration.

setMethod

public MedicationStatement.Dosage setMethod(CodeableConceptDt theValue)

Sets the value(s) for method (Technique used to administer medication)

Definition: A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.Terminologies used often pre-coordinate this term with the route and or form of administration.

getQuantity

public QuantityDt getQuantity()

Gets the value(s) for quantity (Amount administered in one dose). creating it if it does not exist. Will not return null.

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

setQuantity

public MedicationStatement.Dosage setQuantity(QuantityDt theValue)

Sets the value(s) for quantity (Amount administered in one dose)

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

setQuantity

public MedicationStatement.Dosage setQuantity(QuantityCompararatorEnum theComparator,
                                     double theValue,
                                     String theUnits)

Sets the value for quantity (Amount administered in one dose)

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

setQuantity

public MedicationStatement.Dosage setQuantity(QuantityCompararatorEnum theComparator,
                                     long theValue,
                                     String theUnits)

Sets the value for quantity (Amount administered in one dose)

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

setQuantity

public MedicationStatement.Dosage setQuantity(QuantityCompararatorEnum theComparator,
                                     double theValue,
                                     String theSystem,
                                     String theUnits)

Sets the value for quantity (Amount administered in one dose)

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

setQuantity

public MedicationStatement.Dosage setQuantity(QuantityCompararatorEnum theComparator,
                                     long theValue,
                                     String theSystem,
                                     String theUnits)

Sets the value for quantity (Amount administered in one dose)

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

setQuantity

public MedicationStatement.Dosage setQuantity(double theValue)

Sets the value for quantity (Amount administered in one dose)

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

setQuantity

public MedicationStatement.Dosage setQuantity(long theValue)

Sets the value for quantity (Amount administered in one dose)

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

getRate

public RatioDt getRate()

Gets the value(s) for rate (Dose quantity per unit of time). creating it if it does not exist. Will not return null.

Definition: Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.

setRate

public MedicationStatement.Dosage setRate(RatioDt theValue)

Sets the value(s) for rate (Dose quantity per unit of time)

Definition: Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.

getMaxDosePerPeriod

public RatioDt getMaxDosePerPeriod()

Gets the value(s) for maxDosePerPeriod (Maximum dose that was consumed per unit of time). 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 MedicationStatement.Dosage setMaxDosePerPeriod(RatioDt theValue)

Sets the value(s) for maxDosePerPeriod (Maximum dose that was consumed per unit of time)

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.