DO.COM.08 Household

DO.COM.08: Household

A household represents a group of related individuals in the social registry. Note this data object is used primarily for linking associated household members and defining other characteristics of the household such as the poverty score and registration date.

Attribute	Type	Cardinality	Description
household_identifier*	string	0...1	The identifier for a household that individuals are linked to
address*	DO.COM.03 Address	0...1	Current residential address of the household
poverty_score	DT.COM.04 decimal	0...1	A metric generated based on the assessment of various household characteristics.
poverty_score_type	string	0...1	The types of poverty scores that are is to measure and categorize the level of poverty.
household_head_info*	DO.CRVS.01 CRVSPerson	0...1	Personal details of the head of the household
household_size*	DT.COM.03 integer	0...1	The total number of members in the household
member_list*	DT.COM.01 HouseholdMember	0...*	A list of the related individuals in a household
registration_date*	DF.COM.STRING.01 date_time	0...1	The date the details of the household were registered
last_updated	DF.COM.STRING.01 date_time	0...1	The date the details of the household were last updated
additional_attributes	array	0...*	Additional attributes of the household

Example of JSON data for the Household Data Object

{
  "message": {
    "search_response": [{
      "response_entity": "Household",
      "data": {
        "reg_records": [{
          "household": {
            "household_identifier": "HS02052024",
            "address": "XXXXXX",
            "poverty_score": "4.0",
            "poverty_score_type": "",
            "additional_attributes": "",
            "household_size": "1",
            "household_head_info": {
              "person": {
                "identifier_type": "NID",
                "identifier_value": "0205202401",
                "name": {
                  "first_name": "Test",
                  "second_name": "Test2",
                  "surname": "Test3"
                },
                "sex": "F",
                "birth_date": "02.05.2004",
                "death_date": "",
                "address": "",
                "phone_number": "",
                "email": ""
              }
            },
            "member_list": [{
              "household_member": {
                "member_identifier": "HS0205202401",
                "demographic_info": {
                  "person": {
                    "identifier_type": "NID",
                    "identifier_value": "0205202401",
                    "name": {
                      "first_name": "Test",
                      "second_name": "Test2",
                      "surname": "Test3"
                    },
                    "sex": "F",
                    "birth_date": "02.05.2004",
                    "death_date": "",
                    "address": "",
                    "phone_number": "",
                    "email": ""
                  },
                  "relationship_head": "self",
                  "related_person": "",
                  "is_disabled": "0",
                  "disability_info": "",
                  "marital_status": "Single",
                  "employment_status": "employed",
                  "occupation": "Caregiver",
                  "income_level": "",
                  "language_code": "Eng",
                  "education_level": "Highschool",
                  "additional_attributes": ""
                },
                "registration_date": "02.05.2024",
                "last_update": ""
              }
            }]
          }
        }]
      }
    }]
  }
}

The provided JSON snippet outlines a household's record, including details about the household head and members.

{
  "message": {
    "search_response": [
      {
        "response entity": "Household",
        "data": {
          "reg_records": [
            {
              "household": {
                "household_identifier": "HS02052024",
                "address": "XXXXXX",
                "poverty_score": "4.0",
                "poverty_score_type": "",
                "additional_attributes": "",
                "household_size": "2",
                "household_head_info": {
                  "person": {
                    "identifier_type": "NID",
                    "identifier_value": "0205202401",
                    "name": {
                      "first_name": "Test",
                      "second_name": "Test2",
                      "surname": "Test3"
                    },
                    "sex": "F",
                    "birth_date": "02.05.2004",
                    "death_date": " ",
                    "address": "",
                    "phone_number": " ",
                    "email": ""
                  }
                },
                "member_list": [
                  {
                    "household_member": {
                      "member_identifier": "HS0205202401",
                      "demographic_info": {
                        "person": {
                          "identifier_type": "NID",
                          "identifier_value": "0205202401",
                          "name": {
                            "first_name": "Test",
                            "second_name": "Test2",
                            "surname": "Test3"
                          },
                          "sex": "F",
                          "birth_date": "02.05.2004",
                          "death_date": "",
                          "address": "",
                          "phone_number": "",
                          "email": ""
                        },
                        "relationship_head": "self",
                        "related_person": "",
                        "is_disabled": "0",
                        "disability_info": "",
                        "marital_status": "Single",
                        "employment_status": "employed",
                        "occupation": "Caregiver",
                        "income_level": "",
                        "language_code": "Eng",
                        "education_level": "Highschool",
                        "additional_attributes": ""
                      },
                      {
                      "member_identifier": "HS0205202402",
                      "demographic_info": {
                        "person": {
                          "identifier_type": "BRN",
                          "identifier_value": "BC989991",
                          "name": {
                            "first_name": "Child",
                            "second_name":"Child2",
                            "surname": "Child3"
                          },
                          "sex": "F",
                          "birth_date": "02.05.2021",
                          "death_date": "",
                          "address": "",
                          "phone_number": "",
                          "email": ""
                        },
                        "relationship_head": "Child",
                        "related_person": "",
                        "is_disabled": "0",
                        "disability_info": "",
                        "marital_status": "Not married",
                        "employment_status": "",
                        "occupation": "",
                        "income_level": "",
                        "language_code": "Eng",
                        "education_level": "",
                        "additional_attributes": ""
                      },
                      "registration_date": "02.05.2024",
                      "last_update": ""
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

JSON-LD File on GitHub

https://github.com/spdci/schemas/blob/main/common/v1/Household.jsonld

{
  "@context": {
    "spdci": "https://schema.spdci.org/common/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#",
    "schema": "http://schema.org/"
  },
  "@id": "spdci:Household",
  "@type": "rdfs:Class",
  "rdfs:comment": "A household or other grouping representing a group of individual beneficiaries in the social registry.",
  "rdfs:label": "Household",
  "rdfs:subClassOf": [
    {
      "@type": "rdfs:Class",
      "rdfs:label": "Structured Entity"
    }
  ],
  "rdfs:property": [
    {
      "@id": "spdci:household_identifier",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Household",
      "rdfs:range": "xsd:string",
      "rdfs:comment": "The unique identifier for a household."
    },
    {
      "@id": "spdci:group_type",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Household",
      "rdfs:range": "spdci:GroupTypeEnum",
      "rdfs:comment": "The type of group."
    },
    {
      "@id": "spdci:identifier",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Household",
      "rdfs:range": {
        "@id": "spdci:Identifier",
        "@type": "rdfs:Class",
        "@container": "@list"
      },
      "rdfs:comment": "The unique identifier for a household member."
    },
    {
      "@id": "spdci:household_status",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Household",
      "rdfs:range": {
         "@id": "spdci:HouseholdStatusEnum",
         "@type": "xsd:string",
         "@container": "@list"
      },
      "rdfs:comment": "Defines the status of each person in the household."
    },
    {
      "@id": "spdci:household_size",
      "@type": "rdfs:Datatype",
      "rdfs:domain": "spdci:Household",
      "rdfs:range": "xsd:integer",
      "rdfs:comment": "The total number of members in the household."
    }
  ]
}