Package org.hl7.fhir.r5.model

Class InstantType

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.PrimitiveType<Date>

org.hl7.fhir.r5.model.BaseDateTimeType

org.hl7.fhir.r5.model.InstantType

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Externalizable, 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.IPrimitiveType<Date>

public class InstantType
extends BaseDateTimeType

Represents a FHIR instant datatype. Valid precisions values for this type are:

• TemporalPrecisionEnum.SECOND
• TemporalPrecisionEnum.MILLI

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.model.api.TemporalPrecisionEnum	DEFAULT_PRECISION	The default precision for this type

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

extension, id

Constructor Summary

Constructors

Constructor	Description
InstantType()	Constructor which creates an InstantDt with no timne value.
InstantType(String theString)	Create a new InstantDt from a string value
InstantType(Calendar theCalendar)	Create a new DateTimeDt
InstantType(Date theDate)	Create a new DateTimeDt with the given date/time and TemporalPrecisionEnum.MILLI precision
InstantType(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)	Constructor which accepts a date value and a precision value.
InstantType(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision, TimeZone theTimezone)	Create a new instance using the given date, precision level, and time zone
InstantType(BaseDateTimeType theDateTime)	Create a new DateTimeDt using an existing value.

Method Summary

Modifier and Type	Method	Description
boolean	after(Date theDate)	Invokes Date.after(Date) on the contained Date against the given date
boolean	before(Date theDate)	Invokes Date.before(Date) on the contained Date against the given date
InstantType	copy()
String	fhirType()
protected ca.uhn.fhir.model.api.TemporalPrecisionEnum	getDefaultPrecisionForDatatype()	Returns the default precision for this datatype
static InstantType	now()	Returns a new instance of DateTimeType with the current system time and MILLI precision and the system local time zone
static InstantType	parseV3(String theV3String)	Creates a new instance by parsing an HL7 v3 format date time string
void	setToCurrentTimeInLocalTimeZone()	Sets the value of this instant to the current time (from the system clock) and the local/default timezone (as retrieved using TimeZone.getDefault().
static InstantType	withCurrentTime()	Factory method which creates a new InstantDt with millisecond precision and initializes it with the current time and the system local timezone.

Methods inherited from class org.hl7.fhir.r5.model.BaseDateTimeType

add, after, before, compareTimes, dateTimeValue, encode, equalsUsingFhirPathRules, fpValue, getDay, getHour, getMillis, getMinute, getMonth, getNanos, getPrecision, getSecond, getSecondsMilli, getTimeZone, getValueAsCalendar, getValueAsString, getYear, hasTime, isDateTime, isTimeZoneZulu, isToday, parse, setDay, setHour, setMillis, setMinute, setMonth, setNanos, setPrecision, setSecond, setTimeZone, setTimeZoneZulu, setValue, setValue, setValueAsString, setValueAsV3String, setYear, toCalendar, toHumanDisplay, toHumanDisplay, toHumanDisplayLocalTimezone

Methods inherited from class org.hl7.fhir.r5.model.PrimitiveType

asStringValue, canHavePrimitiveValue, equalsDeep, equalsShallow, forceStringValue, fromStringValue, getProperty, getTypesForProperty, getValue, getValueAsString, hashCode, hasPrimitiveValue, hasValue, isEmpty, isPrimitive, makeProperty, matches, primitiveValue, readExternal, removeChild, setProperty, setProperty, toString, typedCopy, updateStringValue, writeExternal

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

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

addChild, addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getExtensionValue, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getNamedProperty, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, listChildren, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isMetadataBased, isResource, listChildrenByName, listChildrenByName, setCopyUserData, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, 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

DEFAULT_PRECISION

public static final ca.uhn.fhir.model.api.TemporalPrecisionEnum DEFAULT_PRECISION

The default precision for this type

Constructor Details

InstantType

public InstantType()

Constructor which creates an InstantDt with no timne value. Note that unlike the default constructor for the Java Date or Calendar objects, this constructor does not initialize the object with the current time.

See Also:

• to create a new object that has been initialized with the current time.

InstantType

public InstantType(Calendar theCalendar)

Create a new DateTimeDt

InstantType

public InstantType(Date theDate,
 ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision,
 TimeZone theTimezone)

Create a new instance using the given date, precision level, and time zone

Throws:

DataFormatException - If the specified precision is not allowed for this type

InstantType

public InstantType(BaseDateTimeType theDateTime)

Create a new DateTimeDt using an existing value. Use this constructor with caution, as it may create more precision than warranted (since for example it is possible to pass in a DateTime with only a year, and this constructor will convert to an InstantDt with milliseconds precision).

InstantType

public InstantType(Date theDate)

Create a new DateTimeDt with the given date/time and TemporalPrecisionEnum.MILLI precision

InstantType

public InstantType(Date theDate,
 ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)

Constructor which accepts a date value and a precision value. Valid precisions values for this type are:

• TemporalPrecisionEnum.SECOND
• TemporalPrecisionEnum.MILLI

InstantType

public InstantType(String theString)

Create a new InstantDt from a string value

Parameters:

theString - The string representation of the string. Must be in a valid format according to the FHIR specification

Throws:

DataFormatException

Method Details

after

public boolean after(Date theDate)

Invokes Date.after(Date) on the contained Date against the given date

Throws:

NullPointerException - If the contained Date is null

before

public boolean before(Date theDate)

Invokes Date.before(Date) on the contained Date against the given date

Throws:

NullPointerException - If the contained Date is null

setToCurrentTimeInLocalTimeZone

public void setToCurrentTimeInLocalTimeZone()

Sets the value of this instant to the current time (from the system clock) and the local/default timezone (as retrieved using TimeZone.getDefault(). This TimeZone is generally obtained from the underlying OS.

withCurrentTime

public static InstantType withCurrentTime()

Factory method which creates a new InstantDt with millisecond precision and initializes it with the current time and the system local timezone.

getDefaultPrecisionForDatatype

protected ca.uhn.fhir.model.api.TemporalPrecisionEnum getDefaultPrecisionForDatatype()

Returns the default precision for this datatype

Specified by:

getDefaultPrecisionForDatatype in class BaseDateTimeType

See Also:

• DEFAULT_PRECISION

copy

public InstantType copy()

Specified by:

copy in class PrimitiveType<Date>

now

public static InstantType now()

Returns a new instance of DateTimeType with the current system time and MILLI precision and the system local time zone

parseV3

public static InstantType parseV3(String theV3String)

Creates a new instance by parsing an HL7 v3 format date time string

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class DataType

Returns:

the FHIR type name of the instance (not the java class name)