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:
Serialized Form
  • Field Details

    • bounds

      protected DataType 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

      protected DecimalType 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

      protected DecimalType 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

      protected List<TimeType> 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

  • Method Details

    • getBounds

      public DataType 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

      public Duration getBoundsDuration() throws org.hl7.fhir.exceptions.FHIRException
      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

      public boolean hasBoundsDuration()
    • getBoundsRange

      public Range getBoundsRange() throws org.hl7.fhir.exceptions.FHIRException
      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

      public boolean hasBoundsRange()
    • getBoundsPeriod

      public Period getBoundsPeriod() throws org.hl7.fhir.exceptions.FHIRException
      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

      public boolean hasBoundsPeriod()
    • hasBounds

      public boolean 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

      public boolean hasCountElement()
    • hasCount

      public boolean 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

      public int 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

      public Timing.TimingRepeatComponent setCount(int value)
      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

      public boolean hasCountMaxElement()
    • hasCountMax

      public boolean 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

      public int 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

      public boolean hasDurationElement()
    • hasDuration

      public boolean 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

      public Timing.TimingRepeatComponent setDuration(long value)
      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

      public Timing.TimingRepeatComponent setDuration(double value)
      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

      public boolean hasDurationMaxElement()
    • hasDurationMax

      public boolean 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

      public Timing.TimingRepeatComponent setDurationMax(double value)
      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

      public boolean hasDurationUnitElement()
    • hasDurationUnit

      public boolean 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

      public boolean hasFrequencyElement()
    • hasFrequency

      public boolean 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

      public int 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

      public boolean hasFrequencyMaxElement()
    • hasFrequencyMax

      public boolean 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

      public int 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

      public boolean hasPeriodElement()
    • hasPeriod

      public boolean 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

      public Timing.TimingRepeatComponent setPeriod(long value)
      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

      public Timing.TimingRepeatComponent setPeriod(double value)
      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

      public boolean hasPeriodMaxElement()
    • hasPeriodMax

      public boolean 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

      public Timing.TimingRepeatComponent setPeriodMax(double value)
      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

      public boolean hasPeriodUnitElement()
    • hasPeriodUnit

      public boolean 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

      Returns:
      Returns a reference to this for easy method chaining
    • hasDayOfWeek

      public boolean 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

      public boolean hasDayOfWeek(Enumerations.DaysOfWeek value)
      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

      public boolean 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

      public boolean hasTimeOfDay(String value)
      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

      public boolean 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

      public boolean hasWhen(Timing.EventTiming value)
      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

      public boolean hasOffsetElement()
    • hasOffset

      public boolean 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

      public int 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

      public Timing.TimingRepeatComponent setOffset(int value)
      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

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Element
    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      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 class Element
      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 class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • copy

      Specified by:
      copy in class Element
    • copyValues

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Element
    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Element
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Element
    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class Element