Package org.hl7.fhir.dstu2.model

Class Period

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.Period

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 Period
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType

A time period defined by a start and end date and optionally time.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DateTimeType	end	The end of the period.
protected DateTimeType	start	The start of the period.

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

extension, id

Constructor Summary

Constructors

Constructor	Description
Period()

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Period	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Date	getEnd()
DateTimeType	getEndElement()
Date	getStart()
DateTimeType	getStartElement()
boolean	hasEnd()
boolean	hasEndElement()
boolean	hasStart()
boolean	hasStartElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Period	setEnd(Date value)
Period	setEndElement(DateTimeType value)
void	setProperty(String name, Base value)
Period	setStart(Date value)
Period	setStartElement(DateTimeType value)
protected Period	typedCopy()

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, 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 Details

start

protected DateTimeType start

The start of the period. The boundary is inclusive.

end

protected DateTimeType end

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Constructor Details

Period

public Period()

Method Details

getStartElement

public DateTimeType getStartElement()

Returns:

start (The start of the period. The boundary is inclusive.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

hasStartElement

public boolean hasStartElement()

hasStart

public boolean hasStart()

setStartElement

public Period setStartElement(DateTimeType value)

Parameters:

value - start (The start of the period. The boundary is inclusive.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

getStart

public Date getStart()

Returns:

The start of the period. The boundary is inclusive.

setStart

public Period setStart(Date value)

Parameters:

value - The start of the period. The boundary is inclusive.

getEndElement

public DateTimeType getEndElement()

Returns:

end (The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

hasEndElement

public boolean hasEndElement()

hasEnd

public boolean hasEnd()

setEndElement

public Period setEndElement(DateTimeType value)

Parameters:

value - end (The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

getEnd

public Date getEnd()

Returns:

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

setEnd

public Period setEnd(Date value)

Parameters:

value - The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

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 Period copy()

Overrides:

copy in class Type

typedCopy

protected Period 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