Package org.dcm4che.typeddicom.valuerepresentations

Interface DateTimeWrapper

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.DateDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

All Known Implementing Classes:

AcquisitionDateTime, AlarmDecisionTime, ApprovalStatusDateTime, AssertionDateTime, AssertionExpirationDateTime, AttributeModificationDateTime, BeamHoldTransitionDateTime, CalibrationDateTime, ContextGroupLocalVersion, ContextGroupVersion, ContributionDateTime, DateTime, DateTimeOfLastCalibration, DecayCorrectionDateTime, DigitalSignatureDateTime, EffectiveDateTime, EndAcquisitionDateTime, ExclusionStartDateTime, ExpectedCompletionDateTime, ExpirationDateTime, FrameAcquisitionDateTime, FrameReferenceDateTime, FunctionalSyncPulse, GPSDateStamp, GPSTimeStamp, HangingProtocolCreationDateTime, HL7DocumentEffectiveTime, ImpedanceMeasurementDateTime, InformationIssueDateTime, InstanceCoercionDateTime, InstructionPerformedDateTime, InterlockDateTime, ItemInventoryDateTime, ObservationDateTime, ObservationStartDateTime, OOIOwnerCreationTime, OverrideDateTime, ParticipationDateTime, PerformedProcedureStepEndDateTime, PerformedProcedureStepStartDateTime, ProcedureStepCancellationDateTime, ProductExpirationDateTime, RadiopharmaceuticalStartDateTime, RadiopharmaceuticalStopDateTime, RecordedRTControlPointDateTime, RouteSegmentEndTime, RouteSegmentStartTime, ScheduledProcedureStepExpirationDateTime, ScheduledProcedureStepModificationDateTime, ScheduledProcedureStepStartDateTime, SOPAuthorizationDateTime, SourceEndDateTime, SourceStartDateTime, StartAcquisitionDateTime, StudyUpdateDateTime, SubstanceAdministrationDateTime, TemplateLocalVersion, TemplateVersion, TreatmentToleranceViolationDateTime, VerificationDateTime

public interface DateTimeWrapper
extends org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.DateDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

Name: Date Time
Tag: DT
Definition:

A concatenated date-time character string in the format:

YYYYMMDDHHMMSS.FFFFFF&ZZXX

The components of this string, from left to right, are YYYY = Year, MM = Month, DD = Day, HH = Hour (range "00" - "23"), MM = Minute (range "00" - "59"), SS = Second (range "00" - "60").

FFFFFF = Fractional Second contains a fractional part of a second as small as 1 millionth of a second (range "000000" - "999999").

&ZZXX is an optional suffix for offset from Coordinated Universal Time (UTC), where & = "+" or "-", and ZZ = Hours and XX = Minutes of offset.

The year, month, and day shall be interpreted as a date of the Gregorian calendar system.

A 24-hour clock is used. Midnight shall be represented by only "0000" since "2400" would violate the hour range.

The Fractional Second component, if present, shall contain 1 to 6 digits. If Fractional Second is unspecified the preceding "." shall not be included. The offset suffix, if present, shall contain 4 digits. The string may be padded with trailing SPACE characters. Leading and embedded spaces are not allowed.

A component that is omitted from the string is termed a null component. Trailing null components of Date Time indicate that the Value is not precise to the precision of those components. The YYYY component shall not be null. Non-trailing null components are prohibited. The optional suffix is not considered as a component.

A Date Time Value without the optional suffix is interpreted to be in the local time zone of the application creating the Data Element, unless explicitly specified by the Timezone Offset From UTC (0008,0201).

UTC offsets are calculated as "local time minus UTC". The offset for a Date Time Value in UTC shall be +0000.

Alternatively, in the context of a Query with Empty Value Matching (see PS3.4 PS3.4), a string of two QUOTATION MARK characters, representing an empty key Value.

Note

1. The range of the offset is -1200 to +1400. The offset for United States Eastern Standard Time is -0500. The offset for Japan Standard Time is +0900.

2. The RFC 2822 use of -0000 as an offset to indicate local time is not allowed.

3. A Date Time Value of 195308 means August 1953, not specific to particular day. A Date Time Value of 19530827111300.0 means August 27, 1953, 11;13 a.m. accurate to 1/10th second.

4. The Second component may have a Value of 60 only for a leap second.

5. The offset may be included regardless of null components; e.g., 2007-0500 is a legal Value.

Character Repertoire:

"0"-"9", "+", "-", "." and the SPACE character of Default Character Repertoire

In the context of a Query with Empty Value Matching (see PS3.4 PS3.4), the QUOTATION MARK character is allowed.

Length of Value:

26 bytes maximum

In the context of a Query with Range Matching (see PS3.4 PS3.4), the length is 54 bytes maximum.

In the context of a Query with Empty Value Matching (see PS3.4 PS3.4), the length is 2 bytes fixed.

See Also:

DICOM Standard Part 5 - Date Time

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DateTimeWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends DateTimeWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this interface.

Method Summary

Modifier and Type	Method	Description
default org.dcm4che3.data.VR	getValueRepresentation()

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getPrivateCreator, getTag, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.DateDataElementWrapper

getDate, getDate, getDate, setDate, setDate

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Detail

VALUE_REPRESENTATION

static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this interface.

Method Detail

getValueRepresentation

default org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface org.dcm4che.typeddicom.DataElementWrapper