> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/health/access/public-health-product-suite/health-campaign-management-hcm/specifications/functional-specifications/beneficiary.md).

# Beneficiary

## Overview

The beneficiary entities include households, individuals, and structures. The specifications here define how beneficiaries are configured, identified, and managed within HCM campaigns. This specification governs the core data model that underpins registration, delivery, monitoring, and reporting.

## Specifications

<table><thead><tr><th width="200">Name of the field</th><th width="209">Description</th><th width="135">Mandatory</th><th width="141">Input</th><th width="141">Data type</th><th width="160">Minimum length</th><th width="168">Maximum length </th><th width="149">Validation</th><th width="185">Comments</th><th>Need input from program/state</th></tr></thead><tbody><tr><td></td><td><strong>Household details</strong></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td>ID</td><td>Unique system-generated GUID.</td><td>Mandatory</td><td>System</td><td>String</td><td>2</td><td>64</td><td></td><td></td><td>No</td></tr><tr><td>Client reference ID</td><td>Unique client-generated GUID.</td><td>Mandatory</td><td>Client generated</td><td>String</td><td>2</td><td>64</td><td></td><td></td><td>No</td></tr><tr><td>Household ID</td><td>The ID of the household.</td><td>Mandatory</td><td>User/system</td><td>String</td><td>2</td><td>64</td><td></td><td></td><td>No</td></tr><tr><td>Member count</td><td>The total number of individuals in a household.</td><td>Mandatory</td><td>User</td><td>Numeric</td><td>1</td><td>1000</td><td></td><td>A household can be created only when it has at least 1 individual assigned to the household.</td><td></td></tr><tr><td>Individual ID</td><td>The ID of the individual</td><td>Mandatory</td><td>User/system</td><td>String</td><td>2</td><td>64</td><td></td><td></td><td></td></tr><tr><td></td><td><strong>Individual details</strong></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td>ID</td><td>Unique system-generated GUID.</td><td>Mandatory</td><td>System</td><td>String</td><td>2</td><td>64</td><td></td><td></td><td>No</td></tr><tr><td>Client reference ID</td><td>Unique client-generated GUID.</td><td>Mandatory</td><td>Client generated</td><td>String</td><td>2</td><td>64</td><td></td><td></td><td>No</td></tr><tr><td>Name of the individual</td><td>Name of the individual being registered as the given name, family name, and other names.</td><td>Mandatory</td><td>User</td><td>String</td><td>2</td><td>200</td><td></td><td></td><td>No</td></tr><tr><td>Head of the household</td><td>Capture if the registered individual is also the head of the household.</td><td>Mandatory</td><td>User</td><td>Boolean</td><td></td><td></td><td></td><td></td><td>No</td></tr><tr><td>Type of ID</td><td>Capture the type of ID.</td><td>Mandatory</td><td>User</td><td>Array</td><td></td><td></td><td></td><td>The list of IDs to be given by the programme/state during impel. If no forms of ID are allowed, then a system generated ID is to be selected for the ID type.</td><td></td></tr><tr><td>Identity number</td><td>Capture the ID number belonging to the beneficiary.</td><td>Mandatory</td><td>User</td><td>String</td><td>2</td><td>64</td><td>If the individual has no forms of ID, then a unique system generated ID must be assigned.</td><td>Validations for specific ID types to be built during impel depending on the list of acceptable IDs.</td><td></td></tr><tr><td>Date of birth</td><td>Date of birth in DD/MM/YYYY format.</td><td>Optional</td><td>User</td><td>String</td><td></td><td></td><td>The DoB cannot be in the future. Error Message: DoB cannot be in the future.</td><td></td><td></td></tr><tr><td>Age</td><td>The age of the individual.</td><td>Optional</td><td>User</td><td>Integer</td><td></td><td></td><td>If DoB is not known, allow the  user to enter his/her age.</td><td></td><td></td></tr><tr><td>Contact number</td><td>The mobile number of the registered individual.</td><td>Optional</td><td>User</td><td>Integer</td><td></td><td></td><td></td><td>Any validations on mobile numbers to be built during impel as per country-specific requirements.</td><td></td></tr><tr><td>Gender</td><td>Gender of the registered individual.</td><td>Optional</td><td>User</td><td>String</td><td></td><td></td><td></td><td>A product allows three types of genders: male, female and other. Adding/deleting from this list to be done during impel in accordance with country-specific requirements.</td><td></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.digit.org/health/access/public-health-product-suite/health-campaign-management-hcm/specifications/functional-specifications/beneficiary.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.