org.hl7.fhir.r4.model

Class DateType

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.PrimitiveType<Date>

org.hl7.fhir.r4.model.BaseDateTimeType

org.hl7.fhir.r4.model.DateType

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

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

• TemporalPrecisionEnum.YEAR
• TemporalPrecisionEnum.MONTH
• TemporalPrecisionEnum.DAY

See Also:

Serialized Form

Field Summary

Fields

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

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

extension, id

Constructor Summary

Constructors

Constructor and Description
DateType() Constructor
DateType(Calendar theCalendar) Constructor which accepts a date value and uses the DEFAULT_PRECISION for this type.
DateType(Date theDate) Constructor which accepts a date value and uses the DEFAULT_PRECISION for this type
DateType(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision) Constructor which accepts a date value and a precision value.
DateType(int theYear, int theMonth, int theDay) Constructor which accepts a date value and uses the DEFAULT_PRECISION for this type.
DateType(String theDate) Constructor which accepts a date as a string in FHIR format

Method Summary

Modifier and Type	Method and Description
DateType	copy()
String	fhirType()
protected ca.uhn.fhir.model.api.TemporalPrecisionEnum	getDefaultPrecisionForDatatype() Returns the default precision for this datatype
boolean	isDateTime()
static DateType	parseV3(String theV3String) Creates a new instance by parsing an HL7 v3 format date time string
static InstantType	today()

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

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

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

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

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

addChild, addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, getNamedProperty, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, listChildren, 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, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isResource, listChildrenByName, listChildrenByName, 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.IPrimitiveType

toValueOrNull

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

addExtension, getExtension, hasExtension

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

getUserData, setUserData

Field Detail

DEFAULT_PRECISION

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

The default precision for this type

Constructor Detail

DateType

public DateType()

Constructor

DateType

public DateType(Date theDate)

Constructor which accepts a date value and uses the DEFAULT_PRECISION for this type

DateType

public DateType(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

Throws:

ca.uhn.fhir.parser.DataFormatException - If the specified precision is not allowed for this type

DateType

public DateType(String theDate)

Constructor which accepts a date as a string in FHIR format

Throws:

ca.uhn.fhir.parser.DataFormatException - If the precision in the date string is not allowed for this type

DateType

public DateType(Calendar theCalendar)

Constructor which accepts a date value and uses the DEFAULT_PRECISION for this type.

DateType

public DateType(int theYear,
                int theMonth,
                int theDay)

Constructor which accepts a date value and uses the DEFAULT_PRECISION for this type.

Use caution when using this constructor: The month is 0-indexed but the day is 1-indexed in order to match the bahaviour of the Java Calendar type.

Parameters:

theYear - The year, e.g. 2015

theMonth - The month, e.g. 0 for January

theDay - The day (1 indexed) e.g. 1 for the first day of the month

Method Detail

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

Specified by:

copy in class PrimitiveType<Date>

today

public static InstantType today()

parseV3

public static DateType 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 Element

isDateTime

public boolean isDateTime()

Overrides:

isDateTime in class BaseDateTimeType