Package org.hl7.fhir.r5.model
Class Timing.TimingRepeatComponent
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.Timing.TimingRepeatComponent
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseDatatypeElement
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
- Enclosing class:
Timing
public static class Timing.TimingRepeatComponent
extends Element
implements org.hl7.fhir.instance.model.api.IBaseDatatypeElement
- See Also:
-
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
Modifier and TypeFieldDescriptionprotected DataType
Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.protected PositiveIntType
A total count of the desired number of repetitions across the duration of the entire timing specification.protected PositiveIntType
If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.protected List
<Enumeration<Enumerations.DaysOfWeek>> If one or more days of week is provided, then the action happens only on the specified day(s).protected DecimalType
How long this thing happens for when it happens.protected DecimalType
If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.protected Enumeration
<Timing.UnitsOfTime> The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.protected PositiveIntType
The number of times to repeat the action within the specified period.protected PositiveIntType
If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.protected UnsignedIntType
The number of minutes from the event.protected DecimalType
Indicates the duration of time over which repetitions are to occur; e.g.protected DecimalType
If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.protected Enumeration
<Timing.UnitsOfTime> The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.Specified time of day for action to take place.protected List
<Enumeration<Timing.EventTiming>> An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddTimeOfDay
(String value) addWhen
(Timing.EventTiming value) copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
int
getCount()
int
int
int
getNamedProperty
(int _hash, String _name, boolean _checkValid) int
Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) getWhen()
boolean
boolean
boolean
boolean
boolean
hasCount()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTimeOfDay
(String value) boolean
hasWhen()
boolean
hasWhen
(Timing.EventTiming value) boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCount
(int value) setCountElement
(PositiveIntType value) setCountMax
(int value) setDayOfWeek
(List<Enumeration<Enumerations.DaysOfWeek>> theDayOfWeek) setDuration
(double value) setDuration
(long value) setDuration
(BigDecimal value) setDurationElement
(DecimalType value) setDurationMax
(double value) setDurationMax
(long value) setDurationMax
(BigDecimal value) setDurationMaxElement
(DecimalType value) setFrequency
(int value) setFrequencyMax
(int value) setOffset
(int value) setOffsetElement
(UnsignedIntType value) setPeriod
(double value) setPeriod
(long value) setPeriod
(BigDecimal value) setPeriodElement
(DecimalType value) setPeriodMax
(double value) setPeriodMax
(long value) setPeriodMax
(BigDecimal value) setPeriodMaxElement
(DecimalType value) setPeriodUnit
(Timing.UnitsOfTime value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setTimeOfDay
(List<TimeType> theTimeOfDay) setWhen
(List<Enumeration<Timing.EventTiming>> theWhen) Methods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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
-
Field Details
-
bounds
Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. -
count
A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. -
countMax
If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. -
duration
How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. -
durationMax
If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. -
durationUnit
The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. -
frequency
The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. -
frequencyMax
If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. -
period
Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. -
periodMax
If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. -
periodUnit
The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. -
dayOfWeek
If one or more days of week is provided, then the action happens only on the specified day(s). -
timeOfDay
Specified time of day for action to take place. -
when
An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. -
offset
The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
-
-
Constructor Details
-
TimingRepeatComponent
public TimingRepeatComponent()Constructor
-
-
Method Details
-
getBounds
- Returns:
bounds
(Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.)
-
getBoundsDuration
- Returns:
bounds
(Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasBoundsDuration
-
getBoundsRange
- Returns:
bounds
(Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasBoundsRange
-
getBoundsPeriod
- Returns:
bounds
(Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasBoundsPeriod
-
hasBounds
-
setBounds
- Parameters:
value
-bounds
(Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.)
-
getCountElement
- Returns:
count
(A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.). This is the underlying object with id, value and extensions. The accessor "getCount" gives direct access to the value
-
hasCountElement
-
hasCount
-
setCountElement
- Parameters:
value
-count
(A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.). This is the underlying object with id, value and extensions. The accessor "getCount" gives direct access to the value
-
getCount
- Returns:
- A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
-
setCount
- Parameters:
value
- A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
-
getCountMaxElement
- Returns:
countMax
(If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.). This is the underlying object with id, value and extensions. The accessor "getCountMax" gives direct access to the value
-
hasCountMaxElement
-
hasCountMax
-
setCountMaxElement
- Parameters:
value
-countMax
(If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.). This is the underlying object with id, value and extensions. The accessor "getCountMax" gives direct access to the value
-
getCountMax
- Returns:
- If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
-
setCountMax
- Parameters:
value
- If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
-
getDurationElement
- Returns:
duration
(How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.). This is the underlying object with id, value and extensions. The accessor "getDuration" gives direct access to the value
-
hasDurationElement
-
hasDuration
-
setDurationElement
- Parameters:
value
-duration
(How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.). This is the underlying object with id, value and extensions. The accessor "getDuration" gives direct access to the value
-
getDuration
- Returns:
- How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
-
setDuration
- Parameters:
value
- How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
-
setDuration
- Parameters:
value
- How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
-
setDuration
- Parameters:
value
- How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
-
getDurationMaxElement
- Returns:
durationMax
(If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.). This is the underlying object with id, value and extensions. The accessor "getDurationMax" gives direct access to the value
-
hasDurationMaxElement
-
hasDurationMax
-
setDurationMaxElement
- Parameters:
value
-durationMax
(If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.). This is the underlying object with id, value and extensions. The accessor "getDurationMax" gives direct access to the value
-
getDurationMax
- Returns:
- If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
-
setDurationMax
- Parameters:
value
- If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
-
setDurationMax
- Parameters:
value
- If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
-
setDurationMax
- Parameters:
value
- If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
-
getDurationUnitElement
- Returns:
durationUnit
(The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.). This is the underlying object with id, value and extensions. The accessor "getDurationUnit" gives direct access to the value
-
hasDurationUnitElement
-
hasDurationUnit
-
setDurationUnitElement
- Parameters:
value
-durationUnit
(The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.). This is the underlying object with id, value and extensions. The accessor "getDurationUnit" gives direct access to the value
-
getDurationUnit
- Returns:
- The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
-
setDurationUnit
- Parameters:
value
- The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
-
getFrequencyElement
- Returns:
frequency
(The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.). This is the underlying object with id, value and extensions. The accessor "getFrequency" gives direct access to the value
-
hasFrequencyElement
-
hasFrequency
-
setFrequencyElement
- Parameters:
value
-frequency
(The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.). This is the underlying object with id, value and extensions. The accessor "getFrequency" gives direct access to the value
-
getFrequency
- Returns:
- The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
-
setFrequency
- Parameters:
value
- The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
-
getFrequencyMaxElement
- Returns:
frequencyMax
(If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.). This is the underlying object with id, value and extensions. The accessor "getFrequencyMax" gives direct access to the value
-
hasFrequencyMaxElement
-
hasFrequencyMax
-
setFrequencyMaxElement
- Parameters:
value
-frequencyMax
(If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.). This is the underlying object with id, value and extensions. The accessor "getFrequencyMax" gives direct access to the value
-
getFrequencyMax
- Returns:
- If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
-
setFrequencyMax
- Parameters:
value
- If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
-
getPeriodElement
- Returns:
period
(Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.). This is the underlying object with id, value and extensions. The accessor "getPeriod" gives direct access to the value
-
hasPeriodElement
-
hasPeriod
-
setPeriodElement
- Parameters:
value
-period
(Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.). This is the underlying object with id, value and extensions. The accessor "getPeriod" gives direct access to the value
-
getPeriod
- Returns:
- Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
-
setPeriod
- Parameters:
value
- Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
-
setPeriod
- Parameters:
value
- Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
-
setPeriod
- Parameters:
value
- Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
-
getPeriodMaxElement
- Returns:
periodMax
(If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.). This is the underlying object with id, value and extensions. The accessor "getPeriodMax" gives direct access to the value
-
hasPeriodMaxElement
-
hasPeriodMax
-
setPeriodMaxElement
- Parameters:
value
-periodMax
(If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.). This is the underlying object with id, value and extensions. The accessor "getPeriodMax" gives direct access to the value
-
getPeriodMax
- Returns:
- If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
-
setPeriodMax
- Parameters:
value
- If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
-
setPeriodMax
- Parameters:
value
- If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
-
setPeriodMax
- Parameters:
value
- If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
-
getPeriodUnitElement
- Returns:
periodUnit
(The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.). This is the underlying object with id, value and extensions. The accessor "getPeriodUnit" gives direct access to the value
-
hasPeriodUnitElement
-
hasPeriodUnit
-
setPeriodUnitElement
- Parameters:
value
-periodUnit
(The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.). This is the underlying object with id, value and extensions. The accessor "getPeriodUnit" gives direct access to the value
-
getPeriodUnit
- Returns:
- The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
-
setPeriodUnit
- Parameters:
value
- The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
-
getDayOfWeek
- Returns:
dayOfWeek
(If one or more days of week is provided, then the action happens only on the specified day(s).)
-
setDayOfWeek
public Timing.TimingRepeatComponent setDayOfWeek(List<Enumeration<Enumerations.DaysOfWeek>> theDayOfWeek) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasDayOfWeek
-
addDayOfWeekElement
- Returns:
dayOfWeek
(If one or more days of week is provided, then the action happens only on the specified day(s).)
-
addDayOfWeek
- Parameters:
value
-dayOfWeek
(If one or more days of week is provided, then the action happens only on the specified day(s).)
-
hasDayOfWeek
- Parameters:
value
-dayOfWeek
(If one or more days of week is provided, then the action happens only on the specified day(s).)
-
getTimeOfDay
- Returns:
timeOfDay
(Specified time of day for action to take place.)
-
setTimeOfDay
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTimeOfDay
-
addTimeOfDayElement
- Returns:
timeOfDay
(Specified time of day for action to take place.)
-
addTimeOfDay
- Parameters:
value
-timeOfDay
(Specified time of day for action to take place.)
-
hasTimeOfDay
- Parameters:
value
-timeOfDay
(Specified time of day for action to take place.)
-
getWhen
- Returns:
when
(An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.)
-
setWhen
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasWhen
-
addWhenElement
- Returns:
when
(An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.)
-
addWhen
- Parameters:
value
-when
(An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.)
-
hasWhen
- Parameters:
value
-when
(An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.)
-
getOffsetElement
- Returns:
offset
(The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.). This is the underlying object with id, value and extensions. The accessor "getOffset" gives direct access to the value
-
hasOffsetElement
-
hasOffset
-
setOffsetElement
- Parameters:
value
-offset
(The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.). This is the underlying object with id, value and extensions. The accessor "getOffset" gives direct access to the value
-
getOffset
- Returns:
- The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
-
setOffset
- Parameters:
value
- The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
-
listChildren
- Overrides:
listChildren
in classElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
-
copy
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classElement
-
equalsShallow
- Overrides:
equalsShallow
in classElement
-
isEmpty
-
fhirType
-