DO.SR.03 Family

DO.SR.03 family

A family unit represents a group of related individuals in the social registry. This data object is used to group family members and define attributes such as poverty score and location details.

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

Example of JSON data for the Household Data Object

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

{
  "message": {
    "search_response": [{
      "response_entity": "family",
      "data": {
        "reg_records": [{
          "family": {
            "family_identifier": "HS02052024",
            "address": "XXXXXX",
            "poverty_score": "4.0",
            "poverty_score_type": "",
            "additional_attributes": "",
            "unit_size": "1",
            "family_head_info": {
              "member": {
                "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": [{
              "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": ""
                  },
                  "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": ""
              }
            }]
          }
        }]
      }
    }]
  }
}