Class 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 Detail

      • bounds

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

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

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

        protected DecimalType durationMax
        If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
      • frequency

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

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

        protected DecimalType 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.
      • when

        protected List<Enumeration<Timing.EventTiming>> when
        An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
      • offset

        protected UnsignedIntType 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.
    • Method Detail

      • getBounds

        public Type 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
      • 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
      • 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
      • setBounds

        public Timing.TimingRepeatComponent setBounds​(Type value)
        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

        public PositiveIntType 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
      • setCountElement

        public Timing.TimingRepeatComponent setCountElement​(PositiveIntType value)
        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

        public PositiveIntType 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
      • setCountMaxElement

        public Timing.TimingRepeatComponent setCountMaxElement​(PositiveIntType value)
        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

        public Timing.TimingRepeatComponent setCountMax​(int value)
        Parameters:
        value - If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
      • getDurationElement

        public DecimalType 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
      • setDurationElement

        public Timing.TimingRepeatComponent setDurationElement​(DecimalType value)
        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

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

        public Timing.TimingRepeatComponent setDuration​(BigDecimal 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​(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

        public DecimalType 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
      • setDurationMaxElement

        public Timing.TimingRepeatComponent setDurationMaxElement​(DecimalType value)
        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

        public BigDecimal getDurationMax()
        Returns:
        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​(long value)
        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.
      • getFrequencyElement

        public PositiveIntType 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
      • setFrequencyElement

        public Timing.TimingRepeatComponent setFrequencyElement​(PositiveIntType value)
        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

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

        public PositiveIntType 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
      • setFrequencyMaxElement

        public Timing.TimingRepeatComponent setFrequencyMaxElement​(PositiveIntType value)
        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

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

        public DecimalType 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
      • setPeriodElement

        public Timing.TimingRepeatComponent setPeriodElement​(DecimalType value)
        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

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

        public Timing.TimingRepeatComponent setPeriod​(BigDecimal 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​(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

        public DecimalType 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
      • setPeriodMaxElement

        public Timing.TimingRepeatComponent setPeriodMaxElement​(DecimalType value)
        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

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

        public Timing.TimingRepeatComponent setPeriodMax​(BigDecimal 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.
      • setPeriodMax

        public Timing.TimingRepeatComponent setPeriodMax​(long 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.
      • 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.
      • hasDayOfWeek

        public boolean hasDayOfWeek​(Timing.DayOfWeek value)
        Parameters:
        value - dayOfWeek (If one or more days of week is provided, then the action happens only on the specified day(s).)
      • hasTimeOfDay

        public boolean hasTimeOfDay​(String value)
        Parameters:
        value - timeOfDay (Specified time of day for action to take place.)
      • hasWhen

        public boolean hasWhen()
      • 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

        public UnsignedIntType 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
      • setOffsetElement

        public Timing.TimingRepeatComponent setOffsetElement​(UnsignedIntType value)
        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.
      • 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
      • addChild

        public Base addChild​(String name)
                      throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        addChild in class Element
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • 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