TimingRepeat constructor

const TimingRepeat({ @JsonKey(name: 'id') String? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirDuration? boundsDuration, Range? boundsRange, Period? boundsPeriod, FhirPositiveInt? count, @JsonKey(name: '_count') Element? countElement, FhirPositiveInt? countMax, @JsonKey(name: '_countMax') Element? countMaxElement, FhirDecimal? duration, @JsonKey(name: '_duration') Element? durationElement, FhirDecimal? durationMax, @JsonKey(name: '_durationMax') Element? durationMaxElement, @JsonKey(unknownEnumValue: TimingRepeatDurationUnit.unknown) TimingRepeatDurationUnit? durationUnit, @JsonKey(name: '_durationUnit') Element? durationUnitElement, FhirPositiveInt? frequency, @JsonKey(name: '_frequency') Element? frequencyElement, FhirPositiveInt? frequencyMax, @JsonKey(name: '_frequencyMax') Element? frequencyMaxElement, FhirDecimal? period, @JsonKey(name: '_period') Element? periodElement, FhirDecimal? periodMax, @JsonKey(name: '_periodMax') Element? periodMaxElement, @JsonKey(unknownEnumValue: TimingRepeatPeriodUnit.unknown) TimingRepeatPeriodUnit? periodUnit, @JsonKey(name: '_periodUnit') Element? periodUnitElement, List<FhirCode>? dayOfWeek, @JsonKey(name: '_dayOfWeek') List<Element?>? dayOfWeekElement, List<FhirTime>? timeOfDay, @JsonKey(name: '_timeOfDay') List<Element?>? timeOfDayElement, List<TimingRepeatWhen>? when, @JsonKey(name: '_when') List<Element?>? whenElement, FhirUnsignedInt? offset, @JsonKey(name: '_offset') Element? offsetElement, })

TimingRepeat Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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.

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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

boundsDuration 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.

boundsRange 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.

boundsPeriod 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.

countElement Extensions for count

countMax If present, indicates that the count is a range - so to perform the action between count and countMax times.

countMaxElement Extensions for countMax

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.

durationElement Extensions for duration

durationMax If present, indicates that the duration is a range - so to perform the action between duration and durationMax time length.

durationMaxElement Extensions for durationMax

durationUnit The units of time for the duration, in UCUM units.

durationUnitElement Extensions for durationUnit

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.

frequencyElement Extensions for 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.

frequencyMaxElement Extensions for frequencyMax

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.

periodElement Extensions for period

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.

periodMaxElement Extensions for periodMax

periodUnit The units of time for the period in UCUM units.

periodUnitElement Extensions for periodUnit

dayOfWeek If one or more days of week is provided, then the action happens only on the specified day(s).

dayOfWeekElement Extensions for dayOfWeek

timeOfDay Specified time of day for action to take place.

timeOfDayElement Extensions for timeOfDay

when An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

whenElement Extensions for when

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.

offsetElement Extensions for offset

Implementation

const factory TimingRepeat({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') String? fhirId,

  /// [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.
  @JsonKey(name: 'extension') List<FhirExtension>? 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.
  /// Modifier extensions SHALL NOT change the meaning of any elements on
  /// Resource or DomainResource (including cannot change the meaning of
  ///  modifierExtension itself).
  List<FhirExtension>? modifierExtension,

  /// [boundsDuration] 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.
  FhirDuration? boundsDuration,

  /// [boundsRange] 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.
  Range? boundsRange,

  /// [boundsPeriod] 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.
  Period? boundsPeriod,

  /// [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.
  FhirPositiveInt? count,

  /// [countElement] Extensions for count
  @JsonKey(name: '_count') Element? countElement,

  /// [countMax] If present, indicates that the count is a range - so to
  ///  perform the action between [count] and [countMax] times.
  FhirPositiveInt? countMax,

  /// [countMaxElement] Extensions for countMax
  @JsonKey(name: '_countMax') Element? countMaxElement,

  /// [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.
  FhirDecimal? duration,

  /// [durationElement] Extensions for duration
  @JsonKey(name: '_duration') Element? durationElement,

  /// [durationMax] If present, indicates that the duration is a range - so to
  ///  perform the action between [duration] and [durationMax] time length.
  FhirDecimal? durationMax,

  /// [durationMaxElement] Extensions for durationMax
  @JsonKey(name: '_durationMax') Element? durationMaxElement,
  @JsonKey(unknownEnumValue: TimingRepeatDurationUnit.unknown)

  /// [durationUnit] The units of time for the duration, in UCUM units.
  TimingRepeatDurationUnit? durationUnit,

  /// [durationUnitElement] Extensions for durationUnit
  @JsonKey(name: '_durationUnit') Element? durationUnitElement,

  /// [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.
  FhirPositiveInt? frequency,

  /// [frequencyElement] Extensions for frequency
  @JsonKey(name: '_frequency') Element? frequencyElement,

  /// [frequencyMax] If present, indicates that the frequency is a range - so
  /// to repeat between [frequency] and [frequencyMax] times within the period
  ///  or period range.
  FhirPositiveInt? frequencyMax,

  /// [frequencyMaxElement] Extensions for frequencyMax
  @JsonKey(name: '_frequencyMax') Element? frequencyMaxElement,

  /// [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.
  FhirDecimal? period,

  /// [periodElement] Extensions for period
  @JsonKey(name: '_period') Element? periodElement,

  /// [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.
  FhirDecimal? periodMax,

  /// [periodMaxElement] Extensions for periodMax
  @JsonKey(name: '_periodMax') Element? periodMaxElement,
  @JsonKey(unknownEnumValue: TimingRepeatPeriodUnit.unknown)

  /// [periodUnit] The units of time for the period in UCUM units.
  TimingRepeatPeriodUnit? periodUnit,

  /// [periodUnitElement] Extensions for periodUnit
  @JsonKey(name: '_periodUnit') Element? periodUnitElement,

  /// [dayOfWeek] If one or more days of week is provided, then the action
  ///  happens only on the specified day(s).
  List<FhirCode>? dayOfWeek,

  /// [dayOfWeekElement] Extensions for dayOfWeek
  @JsonKey(name: '_dayOfWeek') List<Element?>? dayOfWeekElement,

  /// [timeOfDay] Specified time of day for action to take place.
  List<FhirTime>? timeOfDay,

  /// [timeOfDayElement] Extensions for timeOfDay
  @JsonKey(name: '_timeOfDay') List<Element?>? timeOfDayElement,

  /// [when] An approximate time period during the day, potentially linked to
  ///  an event of daily living that indicates when the action should occur.
  List<TimingRepeatWhen>? when,

  /// [whenElement] Extensions for when
  @JsonKey(name: '_when') List<Element?>? whenElement,

  /// [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.
  FhirUnsignedInt? offset,

  /// [offsetElement] Extensions for offset
  @JsonKey(name: '_offset') Element? offsetElement,
}) = _TimingRepeat;