LogoLogo
WebsiteGitHubSlack
Integrated Beneficiary Registry v1.0.0
Integrated Beneficiary Registry v1.0.0
  • Integrated Beneficiary Registry and SP-MIS Interface
    • Introduction
    • Assumptions
    • Exception Handling
    • IBR with SP-MIS Standards
      • Process
        • PRS.IBR.01: SP-MIS queries the IBR to verify if a beneficiary is enrolled in a specific scheme
          • Example 1: Disability Cash Transfer Scheme
          • Example 2: Education Cash Transfer Scheme
        • PRS.IBR.02: SP-MIS publishes data on beneficiaries and the benefits that they have received
          • Example 1: Disability Cash Transfer Scheme
        • PRS.IBR.03: SP-MIS updates the IBR when the enrolment status of a beneficiary or household changes
          • Example 1: Disability Cash Transfer Scheme
        • PRS.IBR.04: IBR queries the social registry to request information needed for analysis
          • Example 1: Analysis of Disability Coverage of Social Protection Schemes
      • Data
        • Data Objects
          • DO.IBR.01 Beneficiary
          • DO.IBR.02 Programme
          • DO.IBR.03 Benefit
          • DO.IBR.O4 Benefit Frequency
          • DO.COM.02 Group
          • DO.COM.09 Member
        • Code Directory
          • CD.IBR.01 assistance_unit
          • CD.IBR.02 enrolment_status
          • CD.IBR.03 benefit_type
          • CD.IBR.04 institution_type
          • CD.IBR.05 legal_status
          • CD.IBR.06 social_protection_functions
          • CD.IBR.07 contribution_type
          • CD.IBR.08 programme_type
        • Data Types and Formats
          • DF.COM.STRING.01 date_time (Optional)
          • DF.COM.STRING.02 phone_number (Optional)
          • DT.COM.02 string
          • DT.COM.03 integer
          • DF.COM.STRING.08 currency
          • DT.COM.04 decimal
          • DT.COM.05 array
      • API
        • Design Principles
        • Versioning
        • Methods
          • API.COM.01 ASY Search (Async approach)
          • API.COM.01 SYN Search (Sync approach)
          • API.COM.02 Event Subscription
          • API.COM.03 Event Notification
          • API.COM.04 ASY Status (Async approach)
          • API.COM.04 SYN Status (Sync approach)
          • API.IBR.01 SYN Enrolment/updates
          • API.IBR.02 SYN Enrolled
    • Previous Versions
  • RESOURCES
    • Interoperability in Action #7
    • Standards Committee & Acknowledgments
Powered by GitBook
On this page
  • DO.IBR.03: Benefit
  • Example JSON Data Structure of the Benefit Data Object

Was this helpful?

  1. Integrated Beneficiary Registry and SP-MIS Interface
  2. IBR with SP-MIS Standards
  3. Data
  4. Data Objects

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

0...1

Type of benefit received (e.g. cash, voucher etc.)

benefit_date

0...1

Date on which the benefit was received

benefit_value

0...1

Value of the benefit received

benefit_description

0...1

More specific description of the benefit (may be used to specify the type of in-kind benefit, e.g. sacks of rice)

benefit_quantity

0...1

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",
              }
            }
          ]
        }
      }
    ]
  }
}

Last updated 2 months ago

Was this helpful?

CD.IBR.03 benefit_type
DF.COM.STRING.01 date_time
DF.COM.STRING.08 currency
DT.COM.02 string
DT.COM.03 integer
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"]
}