Package org.hl7.fhir.r4.model

Class Timing

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.Type

org.hl7.fhir.r4.model.BackboneType

org.hl7.fhir.r4.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.IBaseBackboneElement, 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.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class Timing
extends BackboneType
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 planned, 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, and may be used for reporting the schedule to which past regular activities were carried out.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	code	A code for the timing schedule (or just text in code.text).
protected List<DateTimeType>	event	Identifies specific times when the event occurs.
protected Timing.TimingRepeatComponent	repeat	A set of rules that describe when the event is scheduled.

Fields inherited from class org.hl7.fhir.r4.model.BackboneType

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
Timing()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Timing	addEvent(Date value)
DateTimeType	addEventElement()
Timing	copy()
void	copyValues(Timing dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getCode()
List<DateTimeType>	getEvent()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
Timing.TimingRepeatComponent	getRepeat()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCode()
boolean	hasEvent()
boolean	hasEvent(Date value)
boolean	hasRepeat()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Timing	setCode(CodeableConcept value)
Timing	setEvent(List<DateTimeType> theEvent)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Timing	setRepeat(Timing.TimingRepeatComponent value)
protected Timing	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.BackboneType

addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, 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

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

addExtension, getExtension, hasExtension

Field Details

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 is scheduled.

code

protected CodeableConcept code

A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).

Constructor Details

Timing

public Timing()

Constructor

Method Details

getEvent

public List<DateTimeType> getEvent()

Returns:

event (Identifies specific times when the event occurs.)

setEvent

public Timing setEvent(List<DateTimeType> theEvent)

Returns:

Returns a reference to this for easy method chaining

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 is scheduled.)

hasRepeat

public boolean hasRepeat()

setRepeat

public Timing setRepeat(Timing.TimingRepeatComponent value)

Parameters:

value - repeat (A set of rules that describe when the event is scheduled.)

getCode

public CodeableConcept getCode()

Returns:

code (A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).)

hasCode

public boolean hasCode()

setCode

public Timing setCode(CodeableConcept value)

Parameters:

value - code (A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneType

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class BackboneType

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 BackboneType

copy

public Timing copy()

Specified by:

copy in class BackboneType

copyValues

public void copyValues(Timing dst)

typedCopy

protected Timing typedCopy()

Specified by:

typedCopy in class Type

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneType

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneType

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneType