Package com.ibm.fhir.model.type

Class Timing.Repeat.Builder

    • Method Detail

      • id

        public Timing.Repeat.Builder id​(String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public Timing.Repeat.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Timing.Repeat.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Timing.Repeat.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Timing.Repeat.Builder modifierExtension​(Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • bounds

        public Timing.Repeat.Builder bounds​(Element 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.

        This is a choice element with the following allowed types:

        Parameters:
        bounds - Length/Range of lengths, or (Start and/or end) limits
        Returns:
        A reference to this Builder instance

      • count

        public Timing.Repeat.Builder count​(PositiveInt 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.
        Parameters:
        count - Number of times to repeat
        Returns:
        A reference to this Builder instance

      • countMax

        public Timing.Repeat.Builder countMax​(PositiveInt countMax)
        If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
        Parameters:
        countMax - Maximum number of times to repeat
        Returns:
        A reference to this Builder instance

      • duration

        public Timing.Repeat.Builder duration​(Decimal 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.
        Parameters:
        duration - How long when it happens
        Returns:
        A reference to this Builder instance

      • durationMax

        public Timing.Repeat.Builder durationMax​(Decimal durationMax)
        If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
        Parameters:
        durationMax - How long when it happens (Max)
        Returns:
        A reference to this Builder instance

      • durationUnit

        public Timing.Repeat.Builder durationUnit​(UnitsOfTime durationUnit)
        The units of time for the duration, in UCUM units.
        Parameters:
        durationUnit - s | min | h | d | wk | mo | a - unit of time (UCUM)
        Returns:
        A reference to this Builder instance

      • frequency

        public Timing.Repeat.Builder frequency​(PositiveInt 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.
        Parameters:
        frequency - Event occurs frequency times per period
        Returns:
        A reference to this Builder instance

      • frequencyMax

        public Timing.Repeat.Builder frequencyMax​(PositiveInt frequencyMax)
        If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
        Parameters:
        frequencyMax - Event occurs up to frequencyMax times per period
        Returns:
        A reference to this Builder instance

      • period

        public Timing.Repeat.Builder period​(Decimal 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.
        Parameters:
        period - Event occurs frequency times per period
        Returns:
        A reference to this Builder instance

      • periodMax

        public Timing.Repeat.Builder periodMax​(Decimal 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.
        Parameters:
        periodMax - Upper limit of period (3-4 hours)
        Returns:
        A reference to this Builder instance

      • periodUnit

        public Timing.Repeat.Builder periodUnit​(UnitsOfTime periodUnit)
        The units of time for the period in UCUM units.
        Parameters:
        periodUnit - s | min | h | d | wk | mo | a - unit of time (UCUM)
        Returns:
        A reference to this Builder instance

      • dayOfWeek

        public Timing.Repeat.Builder dayOfWeek​(DayOfWeek... dayOfWeek)
        If one or more days of week is provided, then the action happens only on the specified day(s).

        Adds new element(s) to the existing list

        Parameters:
        dayOfWeek - mon | tue | wed | thu | fri | sat | sun
        Returns:
        A reference to this Builder instance

      • dayOfWeek

        public Timing.Repeat.Builder dayOfWeek​(Collection<DayOfWeek> dayOfWeek)
        If one or more days of week is provided, then the action happens only on the specified day(s).

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        dayOfWeek - mon | tue | wed | thu | fri | sat | sun
        Returns:
        A reference to this Builder instance

      • timeOfDay

        public Timing.Repeat.Builder timeOfDay​(Time... timeOfDay)
        Specified time of day for action to take place.

        Adds new element(s) to the existing list

        Parameters:
        timeOfDay - Time of day for action
        Returns:
        A reference to this Builder instance

      • timeOfDay

        public Timing.Repeat.Builder timeOfDay​(Collection<Time> timeOfDay)
        Specified time of day for action to take place.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        timeOfDay - Time of day for action
        Returns:
        A reference to this Builder instance

      • when

        public Timing.Repeat.Builder when​(EventTiming... when)
        An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

        Adds new element(s) to the existing list

        Parameters:
        when - Code for time period of occurrence
        Returns:
        A reference to this Builder instance

      • when

        public Timing.Repeat.Builder when​(Collection<EventTiming> when)
        An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        when - Code for time period of occurrence
        Returns:
        A reference to this Builder instance

      • offset

        public Timing.Repeat.Builder offset​(UnsignedInt 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.
        Parameters:
        offset - Minutes from event (before or after)
        Returns:
        A reference to this Builder instance