au.gov.nehta.model.cda.common.time

Class PeriodicIntervalTime

java.lang.Object

au.gov.nehta.model.cda.common.time.CDATimeStamp

au.gov.nehta.model.cda.common.time.SetComponentTime

au.gov.nehta.model.cda.common.time.PeriodicIntervalTime

public class PeriodicIntervalTime
extends SetComponentTime

PeriodicTimeInterval
A Class that models time intervals in the PIVL_TS CDA HL7 datatype

Definition: An interval of time that recurs periodically. Periodic intervals have two properties, phase and period. The phase specifies the "interval prototype" that is repeated every period.

Note 3 - Alignment
Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from "the 5th of every month".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar.

Note 5 - phase
A prototype of the repeating interval specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time.

Note 6 - period
A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.

Note 7 - frequency
The inverse of period, but allows to specify a number of repeats in a time unit using a ratio.

Author:

NeHTA

See Also:

CalendarCycleCode, (IVL_TS), (SXCM_TS)

Field Summary

Fields inherited from class au.gov.nehta.model.cda.common.time.SetComponentTime

operator

Fields inherited from class au.gov.nehta.model.cda.common.time.CDATimeStamp

value

Constructor Summary

Constructors

Constructor and Description
PeriodicIntervalTime(double period, CalendarCycleCode cycleAlignment)
PeriodicIntervalTime(double period, CalendarCycleCode cycleAlignment, RestrictedTimeInterval phase)
PeriodicIntervalTime(RestrictedTimeInterval phase)
PeriodicIntervalTime(TimeQuantity frequency) Set a time interval using the frequency method.
PeriodicIntervalTime(TimeQuantity frequency, int denominator) Set a time interval using the frequency method.

Method Summary

Modifier and Type	Method and Description
CalendarCycleCode	getCycleAlignment()
Integer	getDenominator()
TimeQuantity	getFrequency()
Double	getPeriod()
RestrictedTimeInterval	getPhase()
void	setCycleAlignment(CalendarCycleCode cycleAlignment)
void	setDenominator(int denominator)
void	setFrequency(TimeQuantity frequency)
void	setPeriod(Double period)
void	setPhase(RestrictedTimeInterval phase)

Methods inherited from class au.gov.nehta.model.cda.common.time.SetComponentTime

getNarrative, getOperator, setNarrative, setOperator

Methods inherited from class au.gov.nehta.model.cda.common.time.CDATimeStamp

getValue, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeriodicIntervalTime

public PeriodicIntervalTime(TimeQuantity frequency)

Set a time interval using the frequency method.

Parameters:

frequency - A time quantity with a unit and width, optionally with a narrative. NOTE: a frequency narrative will override the periodic time interval narrative

PeriodicIntervalTime

public PeriodicIntervalTime(TimeQuantity frequency,
                            int denominator)

Set a time interval using the frequency method.

Parameters:

frequency - A time quantity with a unit and width, optionally with a narrative. NOTE: a frequency narrative will override the periodic time interval narrative

PeriodicIntervalTime

public PeriodicIntervalTime(RestrictedTimeInterval phase)

PeriodicIntervalTime

public PeriodicIntervalTime(double period,
                            CalendarCycleCode cycleAlignment)

PeriodicIntervalTime

public PeriodicIntervalTime(double period,
                            CalendarCycleCode cycleAlignment,
                            RestrictedTimeInterval phase)

Method Detail

getCycleAlignment

public CalendarCycleCode getCycleAlignment()

getPhase

public RestrictedTimeInterval getPhase()

setPhase

public void setPhase(RestrictedTimeInterval phase)

setCycleAlignment

public void setCycleAlignment(CalendarCycleCode cycleAlignment)

getPeriod

public Double getPeriod()

setPeriod

public void setPeriod(Double period)

getFrequency

public TimeQuantity getFrequency()

setFrequency

public void setFrequency(TimeQuantity frequency)

setDenominator

public void setDenominator(int denominator)

getDenominator

public Integer getDenominator()