DO.IBR.O4 Benefit Frequency

DO.IBR.04: BenefitFrequency

This data object outlines the frequency at which a beneficiary receives benefits from a programme. It refers to the RRULE. For details and examples, see the reference link below.

Reference: RRULE

Attribute​
Type​
Cardinality
Description​

freq

0...1​

Frequency with which a programme delivers a benefit to beneficiaries​

dtstart​

0...1​

Recurrence start – as well as being the base for the recurrence, missing parameters in the final recurrence instances are also extracted from this date. If not given, the current time will be used instead.

interval​

0...1​

Interval between each frequency iteration - for example, when using YEARLY, an interval of 2 means once every two years, but with HOURLY, it means once every two hours. The default interval is 1.​

wkst​

0...1​

Week start day - must be one of MO, TU, WE constants, or an integer, specifying the first day of the week. This will affect recurrences based on weekly periods. ​

count​

0...1​

If given, this determines how many occurrences will be generated.​

until​

0...1​

If given, this date specifies the upper-bound limit of the recurrence. The last recurrence in the rule is the greatest date/time that is less than or equal to the value specified in the until parameter.​

https://github.com/spdci/schemas/blob/main/extensions/ibr/v1/BenefitFrequency.jsonld

Last updated

Was this helpful?