Package org.hl7.fhir.r5.model

Class DateTimeType

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

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 DateTimeType
extends BaseDateTimeType

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

• TemporalPrecisionEnum.YEAR
• TemporalPrecisionEnum.MONTH
• TemporalPrecisionEnum.DAY
• 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
DateTimeType()	Constructor
DateTimeType(String theValue)	Create a new instance using a string date/time
DateTimeType(Calendar theCalendar)	Constructor
DateTimeType(Date theDate)	Create a new DateTimeDt with seconds precision and the local time zone
DateTimeType(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)	Constructor which accepts a date value and a precision value.
DateTimeType(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision, TimeZone theTimezone)	Constructor which accepts a date value, precision value, and time zone.

Method Summary

Modifier and Type	Method	Description
DateTimeType	copy()
String	fhirType()
String	getAsV3()
protected ca.uhn.fhir.model.api.TemporalPrecisionEnum	getDefaultPrecisionForDatatype()	Returns the default precision for this datatype
int	getTzHour()
int	getTzMin()
boolean	getTzSign()
boolean	isDateTime()
static DateTimeType	now()	Returns a new instance of DateTimeType with the current system time and SECOND precision and the system local time zone
static DateTimeType	parseV3(String theV3String)	Creates a new instance by parsing an HL7 v3 format date time string
static DateTimeType	today()

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, 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, 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

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

DateTimeType

public DateTimeType()

Constructor

DateTimeType

public DateTimeType(Date theDate)

Create a new DateTimeDt with seconds precision and the local time zone

DateTimeType

public DateTimeType(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.YEAR
• TemporalPrecisionEnum.MONTH
• TemporalPrecisionEnum.DAY
• TemporalPrecisionEnum.SECOND
• TemporalPrecisionEnum.MILLI

Throws:

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

DateTimeType

public DateTimeType(String theValue)

Create a new instance using a string date/time

Throws:

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

DateTimeType

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

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

• TemporalPrecisionEnum.YEAR
• TemporalPrecisionEnum.MONTH
• TemporalPrecisionEnum.DAY
• TemporalPrecisionEnum.SECOND
• TemporalPrecisionEnum.MILLI

DateTimeType

public DateTimeType(Calendar theCalendar)

Constructor

Method Details

now

public static DateTimeType now()

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

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

Specified by:

copy in class PrimitiveType<Date>

parseV3

public static DateTimeType parseV3(String theV3String)

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

today

public static DateTimeType today()

getTzSign

public boolean getTzSign()

getTzHour

public int getTzHour()

getTzMin

public int getTzMin()

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)

getAsV3

public String getAsV3()

isDateTime

public boolean isDateTime()

Overrides:

isDateTime in class BaseDateTimeType

Returns:

true if the type is date|dateTime|instant, and the primitive value is a date/time of some precision