DO.IBR.02 Programme

DO.IBR.02: Programme

This data object contains information related to the programme in which the beneficiary is enrolled and receiving benefits from.

Attribute	Type	Cardinality	Description
programme_name	DT.COM.02 string	1...1	Name of the programme in which the person is/was enrolled
programme_identifier	DT.COM.02 string	1...1	Identifier of the programme in which the person is/was enrolled
programme_description	DT.COM.02 string	0...1	Description of the programme and its objectives
implementing_institution	DT.COM.02 string	0...1	Name of the institution responsible for implementing the programme
institution_type	CD.IBR.04 institution_type	0...1	Type of institution responsible for implementing the programme
legal_status	CD.IBR.05 legal_status	0...1	Specifies if the programme is anchored in legislation
social_protection_functions	CD.IBR.06 social_protection_functions	0...*	Type of social protection functions provided by the programme (more than one value may be provided)
contribution_type	CD.IBR.07 contribution_type	0...1	Specifies if a contribution is required by beneficiaries
programme_type	CD.IBR.08 programme_type	0...1	Specifies the mechanism used by the programme to support beneficiaries
benefit	DO.IBR.03 Benefit	0...*	Benefits provided by the programme
benefit_frequency	DO.IBR.O4 Benefit Frequency	0...*	Periodicity of benefit delivery

Example of JSON Data Structure for the Programme Data Object

{
  "message": {
    "search_response": [
      {
        "response entity": "Programme",
        "data": {
          "reg_records": [
            {
              "programme": {
                "programme_identifier": "DCI001",
                "programme_name": "Test Programme",
                "programme_description": "",
                "implementing_institution": "GIZ",
                "institution_type": "",
                "legal_status": "",
                "social_protection_functions": "",
                "contribution_type": "",
                "programme_type": "",
                "program_status": "",
                "benefits": {
                  "benefit_type": "Cash",
                  "benefit_date": "02.05.2024",
                  "benefit_value": "USD 50",
                  "benefit_label": "Shopping voucher",
                  "benefit_unit": "",
                  "benefit_quantity": "6"
                },
                "benefit_frequency": "Monthly"
              }
            }
          ]
        }
      }
    ]
  }
}

https://github.com/spdci/schemas/blob/main/extensions/ibr/v1/Programme.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#"
  },
  "@id": "spdci:Programme",
  "@type": "rdfs:Class",
  "rdfs:label": "Programme Enrollment",
  "rdfs:subClassOf": [
    {
      "@type": "rdfs:Class",
      "rdfs:label": "Structured Entity"
    }
  ],
  "rdfs:property": [
    {
      "@id": "spdci:programme_name",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": "xsd:string",
      "rdfs:comment": "The name for the programme in which the person is/was enrolled."
    },
    {
      "@id": "spdci:programme_identifier",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": "xsd:string",
      "rdfs:comment": "The identifier for a programme in which the person is/was enrolled."
    },
    {
      "@id": "spdci:programme_description",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": "xsd:string",
      "rdfs:comment": "A description of the programme and it's objectives"
    },
    {
      "@id": "spdci:implementing_institution",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": "xsd:string",
      "rdfs:comment": "A description of the programme and it's objectives"
    },
    {
      "@id": "spdci:institution_type",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": "spdci:InstitutionEnum",
      "rdfs:comment": "The type of institution responsible for implementing the programme"
    },
    {
      "@id": "spdci:legal_status",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": "spdci:LegalStatusEnum",
      "rdfs:comment": "Specifies if the programme is anchored in legislation"
    },
    {
      "@id": "spdci:social_protection_functions",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": {
        "@type": "spdci:SocialProtectionFunctionEnum",
        "@container": "@list"
      },
      "rdfs:comment": "The type of social protection functions provided by the programme.  More than one value may be provided"
    },
    {
      "@id": "spdci:contribution_type",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": "spdci:ContributionTypeEnum",
      "rdfs:comment": "Specifies if a contribution is required by beneficiaries"
    },
    {
      "@id": "spdci:programme_type",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": "spdci:ContributionTypeEnum",
      "rdfs:comment": "Specifies if a contribution is required by beneficiaries"
    },
    {
      "@id": "spdci:benefit",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": {
        "@type": "spdci:Benefit",
        "@container": "@list"
      },
      "rdfs:comment": "The benefits provided by the programme"
    },
    {
      "@id": "spdci:benefit_frequency",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Programme",
      "rdfs:range": {
        "@type": "spdci:BenefitFrequency",
        "@container": "@list"
      },
      "rdfs:comment": "The benefits provided by the programme"
    }
  ],
  "required": ["@context","@type", "spdci:programme_name", "spdci:programme_identifier", "spdci:enrolment_date", "spdci:enrolment_status"]
}