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	DT.COM.02 string	0...1​	The frequency with which a programme delivers a benefit to beneficiaries​
dtstart​	DF.COM.STRING.01 date_time	0...1​	The recurrence start. As well as being the base for the recurrence, missing parameters in the final recurrence instances will also be extracted from this date. If not given, the current time will be used instead.​
interval​	DT.COM.04 decimal​	0...1​	The 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​	DT.COM.02 string	0...1​	The 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​	DT.COM.03 integer​	0...1​	If given, this determines how many occurrences will be generated.​
until​	DF.COM.STRING.01 date_time​	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.​
…........​	​	​	Additional attributes​

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

{
  "@context": {
    "spdci": "https://schema.spdci.org/extensions/ibr/v1/",
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "owl": "http://www.w3.org/2002/07/owl#",
    "common": "https://schema.spdci.org/common/v1/"
  },
  "@id": "spdci:BenefitFrequency",
  "@type": "rdfs:Class",
  "rdfs:comment": "This data object outlines the frequency at which a beneficiary receives benefits from a program. It refers to the RRULE.",
  "rdfs:label": "BenefitFrequency",
  "rdfs:subClassOf": [
    {
      "@type": "rdfs:Class",
      "rdfs:label": "Structured Entity"
    }
  ],
  "rdfs:property": [
    {
      "@id": "spdci:freq",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:BenefitFrequency",
      "rdfs:range": "xsd:string",
      "rdfs:comment": "The frequency with which a programs delivers a benefit to beneficiaries​"
    },
    {
      "@id": "spdci:dtstart",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:BenefitFrequency",
      "rdfs:range": "common:DateTime",
      "rdfs:comment": "The recurrence start. Besides being the base for the recurrence, missing parameters in the final recurrence instances will also be extracted from this date. If not given, the current time will be used instead.​"
    },
    {
      "@id": "spdci:interval",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:BenefitFrequency",
      "rdfs:range": "xsd:decimal",
      "rdfs:comment": "The 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.​"
    },
    {
      "@id": "spdci:wkst",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:BenefitFrequency",
      "rdfs:range": "xsd:string",
      "rdfs:comment": "The week start day. Must be one of the MO, TU, WE constants, or an integer, specifying the first day of the week. This will affect recurrences based on weekly periods. "
    },
    {
      "@id": "spdci:count",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:BenefitFrequency",
      "rdfs:range": "xsd:integer",
      "rdfs:comment": "If given, this determines how many occurrences will be generated.​"
    },
    {
      "@id": "spdci:until",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:BenefitFrequency",
      "rdfs:range": "common:DateTime",
      "rdfs:comment": "If given, this must be a date specifying the upper-bound limit of the recurrence. The last recurrence in the rule is the greatest datetime that is less than or equal to the value specified in the until parameter.​​"
    }
  ],
  "required": ["@context","@type", "spdci:benefit_type", "spdci:benefit_date"]
}