Package org.hl7.fhir.dstu2.model

Class Timing

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.Element

org.hl7.fhir.dstu2.model.Type

org.hl7.fhir.dstu2.model.Timing

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class Timing
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Timing.EventTiming
static class	Timing.EventTimingEnumFactory
static class	Timing.TimingRepeatComponent
static class	Timing.UnitsOfTime
static class	Timing.UnitsOfTimeEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	code	A code for the timing pattern.
protected List<DateTimeType>	event	Identifies specific times when the event occurs.
protected Timing.TimingRepeatComponent	repeat	A set of rules that describe when the event should occur.

Fields inherited from class org.hl7.fhir.dstu2.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
Timing()

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Timing	addEvent(Date value)
DateTimeType	addEventElement()
Timing	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
CodeableConcept	getCode()
List<DateTimeType>	getEvent()
Timing.TimingRepeatComponent	getRepeat()
boolean	hasCode()
boolean	hasEvent()
boolean	hasEvent(Date value)
boolean	hasRepeat()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Timing	setCode(CodeableConcept value)
void	setProperty(String name, Base value)
Timing	setRepeat(Timing.TimingRepeatComponent value)
protected Timing	typedCopy()

Methods inherited from class org.hl7.fhir.dstu2.model.Element

addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.dstu2.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Field Detail

event

protected List<DateTimeType> event

Identifies specific times when the event occurs.

repeat

protected Timing.TimingRepeatComponent repeat

A set of rules that describe when the event should occur.

code

protected CodeableConcept code

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

Constructor Detail

Timing

public Timing()

Method Detail

getEvent

public List<DateTimeType> getEvent()

Returns:

event (Identifies specific times when the event occurs.)

hasEvent

public boolean hasEvent()

addEventElement

public DateTimeType addEventElement()

Returns:

event (Identifies specific times when the event occurs.)

addEvent

public Timing addEvent(Date value)

Parameters:

value - event (Identifies specific times when the event occurs.)

hasEvent

public boolean hasEvent(Date value)

Parameters:

value - event (Identifies specific times when the event occurs.)

getRepeat

public Timing.TimingRepeatComponent getRepeat()

Returns:

repeat (A set of rules that describe when the event should occur.)

hasRepeat

public boolean hasRepeat()

setRepeat

public Timing setRepeat(Timing.TimingRepeatComponent value)

Parameters:

value - repeat (A set of rules that describe when the event should occur.)

getCode

public CodeableConcept getCode()

Returns:

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

hasCode

public boolean hasCode()

setCode

public Timing setCode(CodeableConcept value)

Parameters:

value - code (A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class Element

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class Element

copy

public Timing copy()

Overrides:

copy in class Type

typedCopy

protected Timing typedCopy()

Specified by:

typedCopy in class Type

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Element