ca.uhn.fhir.model.dstu.resource

Class MedicationAdministration.Dosage

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

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

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

MedicationAdministration

public static class MedicationAdministration.Dosage
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: MedicationAdministration.dosage (Medicine administration instructions to the patient/carer)

Definition: Provides details of how much of the medication was administered

Constructor Summary

Constructors

Constructor and Description
MedicationAdministration.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 (Total dose that was consumed per unit of time).
CodeableConceptDt	getMethod() Gets the value(s) for method (How drug was administered).
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 (Path of substance into body).
CodeableConceptDt	getSite() Gets the value(s) for site (Body site administered to).
IDatatype	getTiming() Gets the value(s) for timing[x] (When dose(s) were given).
boolean	isEmpty()
MedicationAdministration.Dosage	setAsNeeded(IDatatype theValue) Sets the value(s) for asNeeded[x] (Take \"as needed\" f(or x))
MedicationAdministration.Dosage	setMaxDosePerPeriod(RatioDt theValue) Sets the value(s) for maxDosePerPeriod (Total dose that was consumed per unit of time)
MedicationAdministration.Dosage	setMethod(CodeableConceptDt theValue) Sets the value(s) for method (How drug was administered)
MedicationAdministration.Dosage	setQuantity(double theValue) Sets the value for quantity (Amount administered in one dose)
MedicationAdministration.Dosage	setQuantity(long theValue) Sets the value for quantity (Amount administered in one dose)
MedicationAdministration.Dosage	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theUnits) Sets the value for quantity (Amount administered in one dose)
MedicationAdministration.Dosage	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Sets the value for quantity (Amount administered in one dose)
MedicationAdministration.Dosage	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theUnits) Sets the value for quantity (Amount administered in one dose)
MedicationAdministration.Dosage	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Sets the value for quantity (Amount administered in one dose)
MedicationAdministration.Dosage	setQuantity(QuantityDt theValue) Sets the value(s) for quantity (Amount administered in one dose)
MedicationAdministration.Dosage	setRate(RatioDt theValue) Sets the value(s) for rate (Dose quantity per unit of time)
MedicationAdministration.Dosage	setRoute(CodeableConceptDt theValue) Sets the value(s) for route (Path of substance into body)
MedicationAdministration.Dosage	setSite(CodeableConceptDt theValue) Sets the value(s) for site (Body site administered to)
MedicationAdministration.Dosage	setTiming(IDatatype theValue) Sets the value(s) for timing[x] (When dose(s) were given)

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

MedicationAdministration.Dosage

public MedicationAdministration.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 IDatatype getTiming()

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

Definition: The timing schedule for giving the medication to the patient. This may be a single time point (using dateTime) or it may be a start and end dateTime (Period)

setTiming

public MedicationAdministration.Dosage setTiming(IDatatype theValue)

Sets the value(s) for timing[x] (When dose(s) were given)

Definition: The timing schedule for giving the medication to the patient. This may be a single time point (using dateTime) or it may be a start and end dateTime (Period)

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 MedicationAdministration.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 (Body site administered to). 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. E.g. \"left arm\"

setSite

public MedicationAdministration.Dosage setSite(CodeableConceptDt theValue)

Sets the value(s) for site (Body site administered to)

Definition: A coded specification of the anatomic site where the medication first entered the body. E.g. \"left arm\"

getRoute

public CodeableConceptDt getRoute()

Gets the value(s) for route (Path of substance into 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 the patient. E.g. topical, intravenous, etc.

setRoute

public MedicationAdministration.Dosage setRoute(CodeableConceptDt theValue)

Sets the value(s) for route (Path of substance into body)

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

getMethod

public CodeableConceptDt getMethod()

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

Definition: A coded value indicating the method by which the medication was 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 MedicationAdministration.Dosage setMethod(CodeableConceptDt theValue)

Sets the value(s) for method (How drug was administered)

Definition: A coded value indicating the method by which the medication was 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 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(QuantityDt theValue)

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

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(QuantityCompararatorEnum theComparator,
                                          double theValue,
                                          String theUnits)

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

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(QuantityCompararatorEnum theComparator,
                                          long theValue,
                                          String theUnits)

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

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(QuantityCompararatorEnum theComparator,
                                          double theValue,
                                          String theSystem,
                                          String theUnits)

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

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(QuantityCompararatorEnum theComparator,
                                          long theValue,
                                          String theSystem,
                                          String theUnits)

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

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(double theValue)

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

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(long theValue)

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

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 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 medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity.

setRate

public MedicationAdministration.Dosage setRate(RatioDt theValue)

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

Definition: Identifies the speed with which the medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity.

getMaxDosePerPeriod

public RatioDt getMaxDosePerPeriod()

Gets the value(s) for maxDosePerPeriod (Total 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 was administered to the patient over the specified period of time. E.g. 1000mg in 24 hours.

setMaxDosePerPeriod

public MedicationAdministration.Dosage setMaxDosePerPeriod(RatioDt theValue)

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

Definition: The maximum total quantity of a therapeutic substance that was administered to the patient over the specified period of time. E.g. 1000mg in 24 hours.