ca.uhn.fhir.model.dstu2.composite

Class TimingDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu2.composite.TimingDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseDatatype, ICompositeType

public class TimingDt
extends BaseIdentifiableElement
implements ICompositeDatatype

HAPI/FHIR TimingDt Datatype ()

Definition: Specifies an event that may occur multiple times. Timing schedules are used to record when things are expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds

Requirements: Need to able to track proposed timing schedules. There are several different ways to do this: one or more specified times, a simple rules like three times a day, or before/after meals

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimingDt.Repeat Block class for child element: Timing.repeat ()

Constructor Summary

Constructors

Constructor and Description
TimingDt() Constructor

Method Summary

Modifier and Type	Method and Description
DateTimeDt	addEvent() Adds and returns a new value for event ()
TimingDt	addEvent(Date theDate) Adds a new value for event ()
TimingDt	addEvent(Date theDate, TemporalPrecisionEnum thePrecision) Adds a new value for event ()
TimingDt	addEvent(DateTimeDt theValue) Adds a given new value for event ()
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
BoundCodeableConceptDt<TimingAbbreviationEnum>	getCode() Gets the value(s) for code ().
List<DateTimeDt>	getEvent() Gets the value(s) for event ().
DateTimeDt	getEventFirstRep() Gets the first repetition for event (), creating it if it does not already exist.
TimingDt.Repeat	getRepeat() Gets the value(s) for repeat ().
boolean	isEmpty()
TimingDt	setCode(BoundCodeableConceptDt<TimingAbbreviationEnum> theValue) Sets the value(s) for code ()
TimingDt	setCode(TimingAbbreviationEnum theValue) Sets the value(s) for code ()
TimingDt	setEvent(List<DateTimeDt> theValue) Sets the value(s) for event ()
TimingDt	setRepeat(TimingDt.Repeat theValue) Sets the value(s) for repeat ()

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

Constructor Detail

TimingDt

public TimingDt()

Constructor

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

getEvent

public List<DateTimeDt> getEvent()

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

Definition: Identifies specific times when the event occurs

setEvent

public TimingDt setEvent(List<DateTimeDt> theValue)

Sets the value(s) for event ()

Definition: Identifies specific times when the event occurs

addEvent

public DateTimeDt addEvent()

Adds and returns a new value for event ()

Definition: Identifies specific times when the event occurs

addEvent

public TimingDt addEvent(DateTimeDt theValue)

Adds a given new value for event ()

Definition: Identifies specific times when the event occurs

Parameters:

theValue - The event to add (must not be null)

getEventFirstRep

public DateTimeDt getEventFirstRep()

Gets the first repetition for event (), creating it if it does not already exist.

Definition: Identifies specific times when the event occurs

addEvent

public TimingDt addEvent(Date theDate,
                         TemporalPrecisionEnum thePrecision)

Adds a new value for event ()

Definition: Identifies specific times when the event occurs

Returns:

Returns a reference to this object, to allow for simple chaining.

addEvent

public TimingDt addEvent(Date theDate)

Adds a new value for event ()

Definition: Identifies specific times when the event occurs

Returns:

Returns a reference to this object, to allow for simple chaining.

getRepeat

public TimingDt.Repeat getRepeat()

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

Definition: A set of rules that describe when the event should occur

setRepeat

public TimingDt setRepeat(TimingDt.Repeat theValue)

Sets the value(s) for repeat ()

Definition: A set of rules that describe when the event should occur

getCode

public BoundCodeableConceptDt<TimingAbbreviationEnum> getCode()

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

Definition: A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes

setCode

public TimingDt setCode(BoundCodeableConceptDt<TimingAbbreviationEnum> theValue)

Sets the value(s) for code ()

Definition: A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes

setCode

public TimingDt setCode(TimingAbbreviationEnum theValue)

Sets the value(s) for code ()

Definition: A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes