DO.IBR.01 Beneficiary

DO.IBR.01: Beneficiary

This data object contains information conveyed from SP-MIS to the IBR regarding beneficiaries, which could be individuals, families, or households, and the benefits received. For families or households, information about the head or nominated beneficiary is provided. The data object also includes details on the most recently provided benefit and current enrolment status in the program. Some personal data available in SP-MIS but not required in the IBR is excluded for data protection purposes.

Attribute	Type	Cardinality	Description
assistance_unit	CD.IBR.01 assistance_unit	0...1	The entity benefiting from the programme
group	DO.SR.02 Group	0...1	Household assistance unit
member	DO.SR.03 Member	0...1	An individual belonging to a family or household
programme_identifier	DO.IBR.02 Programme	0...*	The programme in which the beneficiary is/was enrolled and accompanying information
enrolment_date	DF.COM.STRING.01 date_time	0...1	The date the beneficiary was enrolled into the programme
enrolment_status	CD.IBR.02 enrolment_status	0...1	The beneficiaries status with a specific programme
status_change_date	DF.COM.STRING.01 date_time	0...*	The date the beneficiary enrolment status changed in the programme
benefits	DO.IBR.03 Benefit	0...*	List of benefits received by the beneficiary
additional_attributes	DT.COM.05 array	0...*	Additional attributes of the beneficiary

Example of JSON data structure for a family assistance unit beneficiary

{
  "@context": {
    "spdci": "https://schema.spdci.org/extensions/ibr/v1/",
    "social": "https://schema.spdci.org/extensions/social/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/"
  },
  "@type": "spdci:Beneficiary",
  "assistance_unit": "family",
  "group": {
    "@type": "Group",
    "group_identifier": [
    {
      "@type": "Identifier",
      "identifier_type": "UIN",
      "identifier_value": "847951632"
    }
  ],
    "group_type": "family",
    "place_address":0,
    "address": {
      "@type": "Address",
      "street_address": "123 Main St",
      "city": "Anytown",
      "postal_code": "12345",
      "country": "CountryName"
    }
  },
  "programme_identifier": [
    {
      "programme_name": "Health Support Program",
      "programme_code": "HSP001"
    },
    {
      "programme_name": "Education Aid",
      "programme_code": "EDU001"
    }
  ],
  "enrollment_date": "2023-01-01T08:00:00Z",
  "enrollment_status": "active",
  "status_change_date": ["2023-01-01T08:00:00Z"],
  "benefits": [
    {
      "@type": "Benefit",
      "benefit_name": "Healthcare Coverage",
      "benefit_amount": "1000",
      "currency": "USD",
      "date_received": "2023-01-01T08:00:00Z"
    },
    {
      "@type": "Benefit",
      "benefit_name": "Educational Grant",
      "benefit_amount": "500",
      "currency": "USD",
      "date_received": "2023-01-01T08:00:00Z"
    }
  ]
}

Example of JSON data structure for a person/group member assistance unit beneficiary

{
  "@context": {
    "spdci": "https://schema.spdci.org/extensions/ibr/v1/",
    "social": "https://schema.spdci.org/extensions/social/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/"
  },
  "@type": "spdci:Beneficiary",
  "assistance_unit": "member",
  "member": {
    "@type": "Member",
    "member_identifier": [{
        "identifier_type": "NationalID",
        "identifier_value": "1234567890"
      }],
    "demographic_info": {
      "@type": "Person",
      "identifier":[ {
        "@type": "Identifier",
        "identifier_type": "NationalID",
        "identifier_value": "1234567890"
      }],
      "name": {
        "@type": "Name",
        "surname": "Doe",
        "given_name": "John",
        "prefix": "Mr.",
        "suffix": ""
      },
      "sex": "male",
      "birth_date": "1980-01-01"
    }
  },
  "programme_identifier": [
    {
      "programme_name": "Health Support Program",
      "programme_code": "HSP001"
    },
    {
      "programme_name": "Education Aid",
      "programme_code": "EDU001"
    }
  ],
  "enrollment_date": "2023-01-01T08:00:00Z",
  "enrollment_status": "active",
  "status_change_date": ["2023-01-01T08:00:00Z"],
  "benefits": [
    {
      "benefit_name": "Healthcare Coverage",
      "benefit_amount": "1000",
      "currency": "USD",
      "date_received": "2023-01-15"
    },
    {
      "benefit_name": "Educational Grant",
      "benefit_amount": "500",
      "currency": "USD",
      "date_received": "2023-02-01"
    }
  ]
}

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

{
  "@context": {
    "spdci": "https://schema.spdci.org/extensions/ibr/v1/",
    "social": "https://schema.spdci.org/extensions/social/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:Beneficiary",
  "@type": "rdfs:Class",
  "rdfs:comment": "This data object contains information conveyed from SP-MIS to the IBR regarding beneficiaries, which could be individuals, families, or households, and the benefits received. For families or households, information about the head or nominated beneficiary is provided. The data object also includes details on the most recently provided benefit and current enrolment status in the program. Some personal data available in SP-MIS but not required in the IBR is excluded for data protection purposes",
  "rdfs:label": "Beneficiary",
  "rdfs:subClassOf": [
    {
      "@type": "rdfs:Class",
      "rdfs:label": "Structured Entity"
    }
  ],
  "rdfs:property": [
    {
      "@id": "spdci:assistance_unit",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Beneficiary",
      "rdfs:range": "spdci:AssistanceUnit",
      "rdfs:comment": "The entity benefiting from the programme"
    },
    {
      "@id": "spdci:group",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Beneficiary",
      "rdfs:range": "social:Group",
      "rdfs:comment": "Household assistance unit"
    },
    {
      "@id": "spdci:member",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Beneficiary",
      "rdfs:range": "social:Member",
      "rdfs:comment": "An individual belonging to a family or household"
    },
    {
      "@id": "spdci:programme_identifier",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Beneficiary",
      "rdfs:range": {
        "@type": "spdci:Programme",
        "@container": "@list"
      },
      "rdfs:comment": "The programme in which the beneficiary is/was enrolled and accompanying information"
    },
    {
      "@id": "spdci:enrollment_date",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Beneficiary",
      "rdfs:range": "common:DateTime",
      "rdfs:comment" : "The date the beneficiary was enrolled into the programme"
    },
    {
      "@id": "spdci:enrollment_status",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Beneficiary",
      "rdfs:range": "spdci:EnrollementStatusEnum",
      "rdfs:comment" : "The beneficiaries status with a specific programme"
    },
    {
      "@id": "spdci:status_change_date",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Beneficiary",
      "rdfs:range": {
        "@type": "common:DateTime",
        "@container": "@list"
      },
      "rdfs:comment" : "The date the beneficiary enrolment status changed in the programme"
    },
    {
      "@id": "spdci:benefits",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Beneficiary",
      "rdfs:range": {
        "@type": "spdci:Benefit",
        "@container": "@list"
      },
      "rdfs:comment": "List of benefits received by the beneficiary"
    },
    {
      "@id": "spdci:additional_attributes",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Household",
      "rdfs:range": {
        "@type": "xsd:string",
        "@container": "@list"
      },
      "rdfs:comment": "Additional attributes as an array of strings."
    }

  ],
  "required": ["@context","@type", "spdci:assistance_unit", "spdci:programme_identifier", "spdci:enrollment_date","spdci:enrollment_status","spdci:benefits"]
}