> 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/campaign-setup.md).

# Campaign Setup

## Overview

The **Campaign Setup** feature allows administrators to define the details of a health campaign, including when and where it will be conducted, what services will be offered, and how progress will be tracked. This configuration forms the foundation for how field teams execute and monitor health interventions.

## Specifications

| Name of Field                                           | Description                                                                                         | Mandatory | Input  | Data Type | MinLength | MaxLength | Validation | Comments                                                                 | Need Data from Program/ State |
| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------- | ------ | --------- | --------- | --------- | ---------- | ------------------------------------------------------------------------ | ----------------------------- |
| ID                                                      | Unique system generated GUID                                                                        | Mandatory | System | String    | 2         | 64        |            |                                                                          | No                            |
| Tenant ID                                               | Unique tenant of the system                                                                         | Mandatory | System | String    | 2         | 64        |            |                                                                          | No                            |
| Campaign Type ID                                        | Unique ID of project type master data                                                               | Mandatory | System | String    | 2         | 64        |            |                                                                          | No                            |
| sub Campaign Type ID                                    | Unique ID of sub project type master data                                                           | Mandatory | System | String    | 2         | 64        |            |                                                                          | No                            |
| Address                                                 |                                                                                                     | Mandatory | User   | String    |           |           |            |                                                                          | Yes                           |
| Door No.                                                | House number or door number                                                                         | O         | User   | Numeric   | 2         | 64        |            |                                                                          |                               |
| Latitude                                                | Latitude of the address                                                                             | O         | System | Numeric   | -90       | 90        |            |                                                                          |                               |
| Longitude                                               | Longitude                                                                                           | O         | System | Numeric   | -180      | 180       |            |                                                                          |                               |
| Location Accuracy                                       | Accuracy of the address latitude and longitude in meters                                            | O         | System | Numeric   | 0         | 10000     |            |                                                                          |                               |
| Type                                                    | <p>Type of address<br>Permanent, Correspondence, Other</p>                                          | R         | User   | Drop Down |           |           |            |                                                                          |                               |
| Address Line 1                                          | Apartment, Block, Street of the address                                                             | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Address Line 2                                          | Locality, Area, Zone, Ward of the address                                                           | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Landmark                                                | Additional landmark to help locate the address                                                      | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| City                                                    | City of the address. Can be represented by the tenantid itself                                      | R         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Pincode                                                 | PIN code of the address                                                                             | R         | User   | String    | 2         | 64        |            | Indian pincodes will usually be all numbers.                             |                               |
| Building Name                                           | Name of the building                                                                                | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Street                                                  | Street Name                                                                                         | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Locality                                                |                                                                                                     |           |        |           |           |           |            |                                                                          |                               |
| Start Date                                              | Campaign start date                                                                                 | Mandatory | User   | Date      |           |           |            |                                                                          | Yes                           |
| End Date                                                | Campaign end date                                                                                   | Mandatory | User   | Date      |           |           |            |                                                                          | Yes                           |
| Parent                                                  | Parent Campaign ID                                                                                  | Mandatory | User   | String    | 2         | 64        |            |                                                                          | No                            |
| Targets                                                 |                                                                                                     |           |        |           |           |           |            | Targets will be provided after Microplanning exercise                    | Yes                           |
| Target ID                                               | Unique ID generated by the system                                                                   | Mandatory | System | String    | 2         | 64        |            |                                                                          | No                            |
| Beneificiary Type                                       |                                                                                                     | Mandatory | User   | String    | 2         | 64        |            |                                                                          |                               |
| Baseline                                                | Total number of individuals/ households                                                             | Mandatory | User   | Integer   |           |           |            |                                                                          | Yes                           |
| Target Number                                           | Total number of individuals/ households targetted from the baseline number                          | Mandatory | User   | Integer   |           |           |            |                                                                          | Yes                           |
| Department                                              | Project Department                                                                                  | Mandatory | User   | String    | 2         | 64        |            |                                                                          | Yes                           |
| Description                                             | Description of the project                                                                          | Mandatory | User   | String    | 2         | 64        |            |                                                                          | Yes                           |
|                                                         |                                                                                                     |           |        |           |           |           |            |                                                                          |                               |
| Setup Tasks to be carried out as a part of the campaign |                                                                                                     |           |        |           |           |           |            |                                                                          |                               |
| Task                                                    |                                                                                                     |           |        |           |           |           |            |                                                                          |                               |
| Task ID                                                 | Unique ID generated for the system for each task                                                    | Mandatory | System | String    | 2         | 64        |            |                                                                          | No                            |
| Campaign ID                                             | Link task to the project it is a part of                                                            | Mandatory | System | String    | 2         | 64        |            |                                                                          | No                            |
| Resources \[ ]                                          | Array of resources that are a part of the campaign                                                  |           |        |           |           |           |            |                                                                          |                               |
| Task Resources                                          |                                                                                                     |           |        |           |           |           |            |                                                                          |                               |
| ID                                                      | Unique ID generated for the system for each task resource                                           | Mandatory | System | String    | 2         | 64        |            |                                                                          | No                            |
| Product Variant ID                                      | Link task resource to the product variant ID                                                        | Mandatory | System | String    |           |           |            |                                                                          | No                            |
| Quantity                                                | Capture quantity of resources available for the campaign                                            | Mandatory | System | String    |           |           |            |                                                                          | No                            |
| Delivery Comment                                        | Capture comments regarding delivery of campaign resources                                           | Mandatory | User   | String    |           |           |            | Final list of reasons to be given by the state/program during impel      | Yes                           |
| Planned Start Date                                      |                                                                                                     | Mandatory | System | Integer   |           |           |            |                                                                          | No                            |
| Planned End Date                                        |                                                                                                     | Mandatory | System | Integer   |           |           |            |                                                                          | No                            |
| Actual Start Date                                       |                                                                                                     | Mandatory | System | Integer   |           |           |            |                                                                          | No                            |
| Actual End Date                                         |                                                                                                     | Mandatory | System | Integer   |           |           |            |                                                                          | No                            |
| Address                                                 |                                                                                                     | Mandatory | System | String    |           |           |            |                                                                          | No                            |
| Door No.                                                | House number or door number                                                                         | O         | User   | Numeric   | 2         | 64        |            |                                                                          |                               |
| Latitude                                                | Latitude of the address                                                                             | O         | System | Numeric   | -90       | 90        |            |                                                                          |                               |
| Longitude                                               | Longitude                                                                                           | O         | System | Numeric   | -180      | 180       |            |                                                                          |                               |
| Location Accuracy                                       | Accuracy of the address latitude and longitude in meters                                            | O         | System | Numeric   | 0         | 10000     |            |                                                                          |                               |
| Type                                                    | <p>Type of address<br>Permanent, Correspondence, Other</p>                                          | R         | User   | Drop Down |           |           |            |                                                                          |                               |
| Address Line 1                                          | Apartment, Block, Street of the address                                                             | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Address Line 2                                          | Locality, Area, Zone, Ward of the address                                                           | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Landmark                                                | Additional landmark to help locate the address                                                      | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| City                                                    | City of the address. Can be represented by the tenantid itself                                      | R         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Pincode                                                 | PIN code of the address                                                                             | R         | User   | String    | 2         | 64        |            | Indian pincodes will usually be all numbers.                             |                               |
| Building Name                                           | Name of the building                                                                                | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Street                                                  | Street Name                                                                                         | O         | User   | String    | 2         | 256       |            |                                                                          |                               |
| Locality                                                |                                                                                                     |           |        |           |           |           |            |                                                                          |                               |
| Status                                                  | <p>Status of task<br>Eg. Delivered, Not Delivered, Partial Delivery, Refused, In-sufficient etc</p> | Mandatory | User   | String    |           |           |            | Final list of task status to be given by the state/ program during impel | Yes                           |


---

# 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/campaign-setup.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.