ca.uhn.fhir.model.dstu.resource

Class MedicationPrescription.DosageInstruction

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.resource.MedicationPrescription.DosageInstruction

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

MedicationPrescription

public static class MedicationPrescription.DosageInstruction
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: MedicationPrescription.dosageInstruction (How medication should be taken)

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

Constructor Summary

Constructors

Constructor and Description
MedicationPrescription.DosageInstruction()

Method Summary

Methods

Modifier and Type	Method and Description
CodeableConceptDt	getAdditionalInstructions() Gets the value(s) for additionalInstructions (Supplemental instructions - e.g.
<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)).
QuantityDt	getDoseQuantity() Gets the value(s) for doseQuantity (Amount of medication per dose).
RatioDt	getMaxDosePerPeriod() Gets the value(s) for maxDosePerPeriod (Upper limit on medication per unit of time).
CodeableConceptDt	getMethod() Gets the value(s) for method (Technique for administering medication).
RatioDt	getRate() Gets the value(s) for rate (Amount of medication per unit of time).
CodeableConceptDt	getRoute() Gets the value(s) for route (How drug should enter body).
CodeableConceptDt	getSite() Gets the value(s) for site (Body site to administer to).
StringDt	getText() Gets the value(s) for text (Dosage instructions expressed as text).
IDatatype	getTiming() Gets the value(s) for timing[x] (When medication should be administered).
boolean	isEmpty()
MedicationPrescription.DosageInstruction	setAdditionalInstructions(CodeableConceptDt theValue) Sets the value(s) for additionalInstructions (Supplemental instructions - e.g.
MedicationPrescription.DosageInstruction	setAsNeeded(IDatatype theValue) Sets the value(s) for asNeeded[x] (Take \"as needed\" f(or x))
MedicationPrescription.DosageInstruction	setDoseQuantity(double theValue) Sets the value for doseQuantity (Amount of medication per dose)
MedicationPrescription.DosageInstruction	setDoseQuantity(long theValue) Sets the value for doseQuantity (Amount of medication per dose)
MedicationPrescription.DosageInstruction	setDoseQuantity(QuantityCompararatorEnum theComparator, double theValue, String theUnits) Sets the value for doseQuantity (Amount of medication per dose)
MedicationPrescription.DosageInstruction	setDoseQuantity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Sets the value for doseQuantity (Amount of medication per dose)
MedicationPrescription.DosageInstruction	setDoseQuantity(QuantityCompararatorEnum theComparator, long theValue, String theUnits) Sets the value for doseQuantity (Amount of medication per dose)
MedicationPrescription.DosageInstruction	setDoseQuantity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Sets the value for doseQuantity (Amount of medication per dose)
MedicationPrescription.DosageInstruction	setDoseQuantity(QuantityDt theValue) Sets the value(s) for doseQuantity (Amount of medication per dose)
MedicationPrescription.DosageInstruction	setMaxDosePerPeriod(RatioDt theValue) Sets the value(s) for maxDosePerPeriod (Upper limit on medication per unit of time)
MedicationPrescription.DosageInstruction	setMethod(CodeableConceptDt theValue) Sets the value(s) for method (Technique for administering medication)
MedicationPrescription.DosageInstruction	setRate(RatioDt theValue) Sets the value(s) for rate (Amount of medication per unit of time)
MedicationPrescription.DosageInstruction	setRoute(CodeableConceptDt theValue) Sets the value(s) for route (How drug should enter body)
MedicationPrescription.DosageInstruction	setSite(CodeableConceptDt theValue) Sets the value(s) for site (Body site to administer to)
MedicationPrescription.DosageInstruction	setText(String theString) Sets the value for text (Dosage instructions expressed as text)
MedicationPrescription.DosageInstruction	setText(StringDt theValue) Sets the value(s) for text (Dosage instructions expressed as text)
MedicationPrescription.DosageInstruction	setTiming(IDatatype theValue) Sets the value(s) for timing[x] (When medication should be administered)

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

MedicationPrescription.DosageInstruction

public MedicationPrescription.DosageInstruction()

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

getText

public StringDt getText()

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

Definition: Free text dosage instructions for cases where the instructions are too complex to code.

setText

public MedicationPrescription.DosageInstruction setText(StringDt theValue)

Sets the value(s) for text (Dosage instructions expressed as text)

Definition: Free text dosage instructions for cases where the instructions are too complex to code.

setText

public MedicationPrescription.DosageInstruction setText(String theString)

Sets the value for text (Dosage instructions expressed as text)

Definition: Free text dosage instructions for cases where the instructions are too complex to code.

getAdditionalInstructions

public CodeableConceptDt getAdditionalInstructions()

Gets the value(s) for additionalInstructions (Supplemental instructions - e.g. \"with meals\"). 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 MedicationPrescription.DosageInstruction setAdditionalInstructions(CodeableConceptDt theValue)

Sets the value(s) for additionalInstructions (Supplemental instructions - e.g. \"with meals\")

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

getTiming

public IDatatype getTiming()

Gets the value(s) for timing[x] (When medication should be administered). 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 MedicationPrescription.DosageInstruction setTiming(IDatatype theValue)

Sets the value(s) for timing[x] (When medication should be administered)

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 MedicationPrescription.DosageInstruction 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 to administer to). 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 MedicationPrescription.DosageInstruction setSite(CodeableConceptDt theValue)

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

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 drug should enter 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 patient.

setRoute

public MedicationPrescription.DosageInstruction setRoute(CodeableConceptDt theValue)

Sets the value(s) for route (How drug should enter body)

Definition: A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient.

getMethod

public CodeableConceptDt getMethod()

Gets the value(s) for method (Technique for administering 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 MedicationPrescription.DosageInstruction setMethod(CodeableConceptDt theValue)

Sets the value(s) for method (Technique for administering 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.

getDoseQuantity

public QuantityDt getDoseQuantity()

Gets the value(s) for doseQuantity (Amount of medication per 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.

setDoseQuantity

public MedicationPrescription.DosageInstruction setDoseQuantity(QuantityDt theValue)

Sets the value(s) for doseQuantity (Amount of medication per dose)

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

setDoseQuantity

public MedicationPrescription.DosageInstruction setDoseQuantity(QuantityCompararatorEnum theComparator,
                                                       double theValue,
                                                       String theUnits)

Sets the value for doseQuantity (Amount of medication per dose)

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

setDoseQuantity

public MedicationPrescription.DosageInstruction setDoseQuantity(QuantityCompararatorEnum theComparator,
                                                       long theValue,
                                                       String theUnits)

Sets the value for doseQuantity (Amount of medication per dose)

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

setDoseQuantity

public MedicationPrescription.DosageInstruction setDoseQuantity(QuantityCompararatorEnum theComparator,
                                                       double theValue,
                                                       String theSystem,
                                                       String theUnits)

Sets the value for doseQuantity (Amount of medication per dose)

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

setDoseQuantity

public MedicationPrescription.DosageInstruction setDoseQuantity(QuantityCompararatorEnum theComparator,
                                                       long theValue,
                                                       String theSystem,
                                                       String theUnits)

Sets the value for doseQuantity (Amount of medication per dose)

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

setDoseQuantity

public MedicationPrescription.DosageInstruction setDoseQuantity(double theValue)

Sets the value for doseQuantity (Amount of medication per dose)

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

setDoseQuantity

public MedicationPrescription.DosageInstruction setDoseQuantity(long theValue)

Sets the value for doseQuantity (Amount of medication per dose)

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

getRate

public RatioDt getRate()

Gets the value(s) for rate (Amount of medication 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 MedicationPrescription.DosageInstruction setRate(RatioDt theValue)

Sets the value(s) for rate (Amount of medication 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 (Upper limit on medication 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 MedicationPrescription.DosageInstruction setMaxDosePerPeriod(RatioDt theValue)

Sets the value(s) for maxDosePerPeriod (Upper limit on medication 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.