Class Timing.TimingRepeatComponent

  • All Implemented Interfaces:
    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 IntegerType count
        A total count of the desired number of repetitions.
      • durationMax

        protected DecimalType durationMax
        The upper limit of how long this thing happens for when it happens.
      • frequency

        protected IntegerType frequency
        The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).
      • frequencyMax

        protected IntegerType frequencyMax
        If present, indicates that the frequency is a range - so 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.
      • 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.
    • 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 IntegerType getCountElement()
        Returns:
        count (A total count of the desired number of repetitions.). 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.
      • getDurationElement

        public DecimalType getDurationElement()
        Returns:
        duration (How long this thing happens for when it happens.). 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.
      • getDurationMaxElement

        public DecimalType getDurationMaxElement()
        Returns:
        durationMax (The upper limit of how long this thing happens for when it happens.). This is the underlying object with id, value and extensions. The accessor "getDurationMax" gives direct access to the value
      • getDurationMax

        public BigDecimal getDurationMax()
        Returns:
        The upper limit of how long this thing happens for when it happens.
      • getFrequencyElement

        public IntegerType getFrequencyElement()
        Returns:
        frequency (The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).). This is the underlying object with id, value and extensions. The accessor "getFrequency" gives direct access to the value
      • setFrequencyElement

        public Timing.TimingRepeatComponent setFrequencyElement​(IntegerType value)
        Parameters:
        value - frequency (The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).). 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 / period range (i.e. both period and periodMax provided).
      • setFrequency

        public Timing.TimingRepeatComponent setFrequency​(int value)
        Parameters:
        value - The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).
      • getFrequencyMaxElement

        public IntegerType getFrequencyMaxElement()
        Returns:
        frequencyMax (If present, indicates that the frequency is a range - so 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​(IntegerType value)
        Parameters:
        value - frequencyMax (If present, indicates that the frequency is a range - so 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 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 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.). 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.). 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.
      • 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.
      • 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.
      • getWhenElement

        public Enumeration<Timing.EventTiminggetWhenElement()
        Returns:
        when (A real world event that the occurrence of the event should be tied to.). This is the underlying object with id, value and extensions. The accessor "getWhen" gives direct access to the value
      • hasWhen

        public boolean hasWhen()
      • getWhen

        public Timing.EventTiming getWhen()
        Returns:
        A real world event that the occurrence of the event should be tied to.
      • setProperty

        public void setProperty​(String name,
                                Base value)
                         throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        setProperty 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