DO.IBR.03 Benefit

DO.IBR.03: Benefit

This data object contains the details of the benefit received by a beneficiary.

Attribute	Type	Cardinality	Description
benefit_type	CD.IBR.03 benefit_type	0...1	The type of benefit received (e.g. cash, voucher etc.)
benefit_date	DF.COM.STRING.01 date_time	0...1	The date on which the benefit was received
benefit_value	DF.COM.STRING.08 currency	0...1	The value of the benefit received
benefit_description	DT.COM.02 string	0...1	A more specific description of the benefit (may be used to specify the type of in-kind benefit, e.g. sacks of rice)
benefit_quantity	DT.COM.03 integer	0...1	The quantity of benefit provided (may be used to specific quantities of in-kind benefit, e.g. 5)

Example JSON data structure of the benefit data object

{
  "message": {
    "search_response": [
      {
        "response_entity": "Benefit",
        "data": {
          "reg_records": [
            {
              "benefits": {
                "benefit_type": "In-kind",
                "benefit_date": "02.05.2024",
                "benefit_value": "USD 20",
                "benefit_label": "Shopping voucher",
                "benefit_unit": "",
                "benefit_quantity": "6",
              }
            }
          ]
        }
      }
    ]
  }
}

https://github.com/spdci/schemas/blob/main/extensions/ibr/v1/Benefit.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:Benefit",
  "@type": "rdfs:Class",
  "rdfs:comment": "The Benefit object provides information about benefits",
  "rdfs:label": "Benefit",
  "rdfs:subClassOf": [
    {
      "@type": "rdfs:Class",
      "rdfs:label": "Structured Entity"
    }
  ],
  "rdfs:property": [
    {
      "@id": "spdci:benefit_type",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Benefit",
      "rdfs:range": "spdci:BenefitTypeEnum",
      "rdfs:comment": "The type of benefit received"
    },
    {
      "@id": "spdci:benefit_date",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Benefit",
      "rdfs:range": "common:DateTime"
    },
    {
      "@id": "spdci:benefit_value",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Benefit",
      "rdfs:range": "common:Currency",
      "rdfs:comment": "The value of the benefit received"
    },
    {
      "@id": "spdci:benefit_description",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Benefit",
      "rdfs:range": "xsd:string",
      "rdfs:comment": "A more specific description of the benefit.  May be used to specify the type of in-kind benefit (eg sacks of rice)"
    },
    {
      "@id": "spdci:benefit_quantity",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Benefit",
      "rdfs:range": "xsd:integer",
      "rdfs:comment": "The quantity of benefit provided.  May be used to specific quantities of in-kind benefit (eg 5)"
    }
  ],
  "required": ["@context","@type", "spdci:benefit_type", "spdci:benefit_date"]
}