> For the complete documentation index, see [llms.txt](https://standards.spdci.org/standards/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://standards.spdci.org/standards/dci-standards/wip-integrated-beneficiary-registry-v1.0.0/ibr/1.-crvs/data/data-objects/do.ibr.o4-benefit-frequency.md).

# 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](https://dateutil.readthedocs.io/en/stable/rrule.html)

<table><thead><tr><th width="139">Attribute​</th><th width="179">Type​</th><th width="140">Cardinality</th><th>Description​</th></tr></thead><tbody><tr><td>freq</td><td><a data-mention href="/standards/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.02-string.md">DT.COM.02 string</a></td><td>0...1​</td><td>Frequency with which a programme delivers a benefit to beneficiaries​</td></tr><tr><td>dtstart​</td><td><a data-mention href="/standards/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.02-string/data-formats/df.com.string.01-date_time.md">DF.COM.STRING.01 date_time</a></td><td>0...1​</td><td>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.</td></tr><tr><td>interval​</td><td><a data-mention href="/standards/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.04-decimal.md">DT.COM.04 decimal</a>​</td><td>0...1​</td><td>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.​</td></tr><tr><td>wkst​</td><td><a data-mention href="/standards/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.02-string.md">DT.COM.02 string</a></td><td>0...1​</td><td>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. ​</td></tr><tr><td>count​</td><td><a data-mention href="/standards/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.03-integer.md">DT.COM.03 integer</a>​</td><td>0...1​</td><td>If given, this determines how many occurrences will be generated.​</td></tr><tr><td>until​</td><td><a data-mention href="/standards/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.02-string/data-formats/df.com.string.01-date_time.md">DF.COM.STRING.01 date_time</a>​</td><td>0...1​</td><td>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.​</td></tr><tr><td><a href="https://dateutil.readthedocs.io/en/stable/rrule.html">…........</a>​</td><td>​</td><td>​</td><td><a href="https://dateutil.readthedocs.io/en/stable/rrule.html">Additional attributes</a>​</td></tr></tbody></table>

{% @github-files/github-code-block url="<https://github.com/spdci/schemas/blob/main/extensions/ibr/v1/BenefitFrequency.jsonld>" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://standards.spdci.org/standards/dci-standards/wip-integrated-beneficiary-registry-v1.0.0/ibr/1.-crvs/data/data-objects/do.ibr.o4-benefit-frequency.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.