> 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/release-notes.md).

# Release Notes

{% hint style="info" %}

## Release Date: 18 Nov 2026

{% endhint %}

## Release Summary

HCM v2.2 takes vaccination **beyond the front door**. Until now,  we were not able to configure campaigns happening outside the household. With this release, the same round can also reach children where people gather or pass through — schools, markets, bus stations, border crossings — and every place added is remembered for the next campaign in the same area.

Three big shifts define this release:

* **One campaign round, more than one way to deliver.** A Polio campaign can now run House-to-House and Outside Household delivery together, each with its own app screens, rules and resources. This is called **Group Vaccination**.
* **Places outside the home are planned, not patched in later.** Schools, bus stations and other "sites" are added in the microplan sheet during setup, or by field workers in the app during the campaign — and they flow both ways between the two.
* **Field workers can fill gaps on the ground.** Workers can add a village that is missing from the official list, and duplicate beneficiary IDs are stopped at the point of saving.

The release also improves the campaign setup screens, makes the console easier to use with a keyboard or screen reader, and tightens platform security.

## Highlights

With this release, a health programme can:

* **Vaccinate outside the household.** Workers vaccinate children at transit posts and community places using a single "Outside Household Vaccination" card in the app.
* **Plan sites in advance.** Administrators list schools, markets, bus stations and similar places directly in the microplan sheet — no more adding them by hand after the microplan is created.
* **Reuse sites across campaigns.** Permanent sites (such as a school) added in one campaign — from the sheet or from the app — are offered again in the next campaign in the same area.
* **Add missing villages in the field.** Authorised workers can add a settlement that is missing from the boundary list and work in it like any other village.
* **Trust beneficiary IDs.** Five fixes stop two people from ever receiving the same beneficiary ID.
* **Record children vaccinated elsewhere.** A revisit can mark a child as already vaccinated somewhere else, so they are not counted as missed.
* **Copy Polio campaigns faster.** A copied Polio campaign keeps its delivery rules, and the console tells you exactly what is left to fix.
* **Work in any language.** Microplan dropdowns show values in the user's own language, and campaign drafts no longer fail when the language is switched midway.

## New Features

**1. Outside Household vaccination**

Many children are not at home when a vaccination team calls. Outside Household lets a Polio campaign reach them where they are. There are two kinds of places, called **sites**:

* **Outside Household Places** — places where people gather, such as a school, market, health post or community centre. These are usually **permanent**, so they are offered again in later campaigns.
* **Transit Posts** — places people pass through, such as a bus station, border crossing, checkpoint or ferry terminal. These are usually **temporary**, used for one campaign only.

Each site in a campaign is either **Active** (used in this campaign) or **Inactive** (kept on record, but not used this time).

Sites can be added in two places, and they move between them:

<table><thead><tr><th width="180.1796875"></th><th>Microplan sheet (before the campaign)</th><th>HCM app (during the campaign)</th></tr></thead><tbody><tr><td>Who adds sites</td><td>Campaign administrator</td><td>Field worker</td></tr><tr><td>When</td><td>During campaign setup, or when editing a campaign</td><td>During the campaign, even without network</td></tr><tr><td>What happens next</td><td>Active sites appear in the field workers' app</td><td>The site is sent to the server and linked to the campaign once online</td></tr><tr><td>In the next campaign</td><td>Permanent sites are listed again, marked Inactive</td><td>Same as the microplan sheet</td></tr></tbody></table>

**2. Group Vaccination — more than one delivery strategy per round**

When setting up a Polio campaign, administrators now see a **Delivery Setup** step. Here they pick the delivery dates and tick the strategies the campaign will use: **House-to-House**, **Outside Household**, or both. The next step, Delivery Rules, shows a separate tab for each chosen strategy, each with its own conditions and resources.

When Outside Household is chosen, the microplan sheet automatically gains a fourth tab named **Outside Household**, where each row is one site.

{% hint style="info" %}
Delivery strategies apply to **single-round** campaigns only. Multi-round campaigns continue to use the existing cycle screens, unchanged.
{% endhint %}

**3. Outside Household in the field worker app**

Workers open one **Outside Household Vaccination** card on the home screen (it replaces the earlier separate cards). They:

1. Choose the village, then choose **Transit Post** or **Outside Household Place**.
2. Search the sites in that village and the area around it. Filters narrow by type and area, and a "nearby" search shows the closest sites first.
3. Pick an existing site, or create a new one by entering its name, type, area and GPS location.
4. Open the site and record vaccinations — each child is tagged to that site.

A new **location capture** screen shows how accurate the GPS reading is (Good / Fair / Low). A reading accurate to 5 metres or better saves on its own; after a short wait (30 seconds by default) the worker can save any reading, so no one gets stuck.

**4. Adding missing villages ("new settlements")**

Official boundary lists are not always complete. On the village selection screen, authorised workers can now tap **Add Missed Village** ("Didn't find your village?"), fill in a short form, and start working in the new settlement straight away.

* Only roles approved by the programme can see this option.
* The new settlement is filed under its parent area, so all reports still roll up correctly; only the displayed name is new.
* Settlements added on one phone appear on every other phone in the same campaign.

**5. Reliable beneficiary IDs**

Five fixes close the gaps that could give two people the same beneficiary ID:

* Every save re-checks the ID; an ID that is already used, or belongs to another worker, is swapped for a free one.
* A temporary device-generated ID is upgraded to a proper ID from the worker's pool.
* IDs used on the phone but not yet synced are no longer released if the worker downloads IDs again.
* Editing a person who never received a pool ID now assigns one.
* Two app crashes linked to the ID screens are fixed.

{% hint style="warning" %}
Because of these checks, the ID saved for a person can occasionally differ from the one shown on screen if the displayed ID had already been taken.
{% endhint %}

**6. Easier mobile app configuration in the Console**

Administrators who design the field app's screens get several new tools:

* A **multi-select dropdown** field, with its own icon.
* A **date of birth** field that accepts either an exact date or an age.
* Pop-up settings separated from button settings, and button labels that can be changed independently.
* **Group fields** that can be switched on or off as a whole — a switched-off group no longer blocks saving.
* A configurable **GPS timer** for the location pop-up.
* Number fields that show a clear error instead of silently changing the typed value.
* A cleaner preview: for example, the Transit Post overview screen shrank from 13 settings rows to 3.

**7. Accessibility**

The campaign and app configuration screens were reviewed against accessibility standards. Pages now have proper headings and landmarks for screen readers, and controls that previously needed a mouse can now be used with a keyboard.

**What does the release offer different stakeholders?**

**For field users and programme delivery**

* **Outside Household vaccination** — vaccinate at schools, markets, bus stations and border crossings from one home-screen card.
* **Create sites on the spot** — add a new site with its GPS location, even without network.
* **Add missing villages** — authorised workers can add a settlement that is not on the boundary list.
* **"Vaccinated elsewhere"** — record that a child was already vaccinated at another location.
* **No duplicate IDs** — each person keeps a unique beneficiary ID.
* **Correct attendance lists** — workers enrolled after a given date no longer appear on that date's attendance.

**For campaign administrators**

* **Delivery Setup step** — choose House To House, Outside Household, or both for a Polio campaign.
* **Outside Household sheet in the microplan** — plan sites before the campaign, with an optional frontline worker name and phone number for each.
* **Sites carried forward** — permanent sites from earlier campaigns are pre-listed (as Inactive) so you only switch on the ones you need.
* **Clear upload checks** — errors are shown row by row. For example: a missing value, a category that does not match the site type, or a duplicate site.
* **Local-language dropdowns** in the microplan sheet, and campaign drafts that survive a language change.
* **Smoother campaign copying** for Polio campaigns.
* **Searchable dropdowns** in HRMS (employee type, department, designation, boundary) and Complaints (complaint type, boundary).

**For integrators**

* **No new APIs and no new services** — Group Vaccination uses the existing campaign data, and sites reuse the existing facility registry.
* **New status values** — a project task status `VACCINATED_ELSEWHERE` and a user action type `NEW_SETTLEMENT`.
* **Shared libraries upgraded** — `hcm-common-model` and `hcm-common-library`; services using them must be rebuilt.
* **App data change** — the field app's on-device database moves from version 12 to 13 automatically on first launch.

## New Services

No new services or database tables are added in this release. Outside Household sites are stored using the existing **facility registry**: a site is saved as a facility, and it is "Active" in a campaign when it is linked to that campaign's project. Sites are kept out of normal facility lists (warehouse, stock and referral screens) and only appear where site types are searched for.

<details>

<summary><strong>How to turn on features</strong></summary>

**1. Outside Household and Group Vaccination —&#x20;*****needs configuration***

<table><thead><tr><th width="127.73828125"></th><th></th></tr></thead><tbody><tr><td>Delivery strategies</td><td>Add <code>deliveryMethods</code> (House To House and Outside Household) to the Polio record in <code>HCM-PROJECT-TYPES.projectTypes</code>. The Console only shows the Delivery Setup step when these are set.</td></tr><tr><td>Round types</td><td>Add <code>roundTypes</code> to <strong>every</strong> project type record (Polio: <code>["SINGLE_ROUND"]</code>). Without it, the round choice screen shows two disabled options with no explanation.</td></tr><tr><td>Site types</td><td>Set site types, their categories and the default Permanent/Temporary status in <code>HCM.OUTSIDE_HOUSEHOLD_TYPES</code>.</td></tr><tr><td>Microplan sheet</td><td>Set the Outside Household sheet rules in <code>HCM-ADMIN-CONSOLE.schemas</code> (<code>outside-household-microplan-ingestion</code>), and add the sheet to <code>excelIngestionGenerate</code> and <code>excelIngestionProcess</code>.</td></tr><tr><td>App screens</td><td>Publish <code>HOUSEHOLDSTRATEGY.POLIO</code> and <code>OUTSIDEHOUSEHOLD.POLIO</code> app configurations (<code>HCM-ADMIN-CONSOLE.FormConfigTemplate</code> / <code>FormConfig</code>). Transit Post and Community Living Facility are two flows inside the Outside Household configuration, not separate strategies.</td></tr><tr><td>Permissions</td><td>In <code>ACCESSCONTROL-ROLEACTIONS</code>, allow field roles to add and update sites and their campaign links.</td></tr><tr><td>Translations</td><td>Upload labels for the sheet (<code>hcm-admin-schemas</code>), the app (<code>hcm-outsidehousehold-&#x3C;campaign></code>), and the console (<code>GV_*</code>, <code>CAMPAIGN_DELIVERY_METHOD_*</code>, <code>HCM_DELIVERY_SETUP_*</code>, <code>HCM_DELIVERY_DATES_*</code>, <code>HCM_CLONE_*</code>).</td></tr></tbody></table>

**2. New settlements —&#x20;*****needs configuration***

<table><thead><tr><th width="137.83984375"></th><th></th></tr></thead><tbody><tr><td>Who can add</td><td>List the allowed roles in <code>HCM.ROLES_FOR_MISSED_PLACES</code>.</td></tr><tr><td>Form</td><td>Publish the <code>MISSEDPLACE</code> form configuration.</td></tr><tr><td>Translations</td><td>Upload <code>hcm-missedplace</code> and <code>hcm-missedplace-&#x3C;campaign></code> (the base module was previously <code>hcm-base-missedplace-polio</code>).</td></tr></tbody></table>

**3. Beneficiary IDs —&#x20;*****partly configuration***

<table><thead><tr><th width="100.1640625"></th><th></th></tr></thead><tbody><tr><td>Pool</td><td>Set <code>HCM.BENEFICIARY_ID_CONFIG</code>, and make sure every registering user has an ID allocation. A user with no allocation receives 0 IDs while the app still reports success.</td></tr><tr><td>Optional</td><td>Hiding the <strong>Skip</strong> button when no IDs are left, and edit mode for IDs, are switched on through MDMS.</td></tr><tr><td>Order</td><td><strong>Release the v2.2 app first.</strong> Older app versions crash when a pop-up button is hidden.</td></tr></tbody></table>

**4. Field app update —&#x20;*****action required***

<table><thead><tr><th width="154.16015625"></th><th></th></tr></thead><tbody><tr><td>Before updating</td><td>Ask all workers to sync pending records.</td></tr><tr><td>Database</td><td>The on-device database migrates from version 12 to 13 on first launch.</td></tr><tr><td>Home screen labels</td><td>Each home card label now carries the campaign type, e.g. <code>HOME_SYNC_DATA_LABEL_POLIO</code>. Upload these before rollout — missing ones show as raw codes.</td></tr><tr><td>Login screen</td><td>Upload <code>USERNAME_PLACEHOLDER</code> and <code>USERNAME_PLACEHOLDER_IS_REQUIRED</code> (renamed from <code>USER_ID_PLACEHOLDER</code>).</td></tr><tr><td>Name fields</td><td>Write field validation patterns as "allowed characters" lists, not "forbidden characters" lists — the latter wipes the field on the first keystroke. The DEMO environment's site-name patterns were fixed accordingly.</td></tr><tr><td>IMMUNISATION campaigns</td><td>Campaign types containing <code>IMMUNISATION</code> now behave like Polio on the home screen.</td></tr><tr><td>Packages</td><td>Update all eight app packages together (see Changed).</td></tr></tbody></table>

**5. Console app configuration —&#x20;*****needs configuration***

<table><thead><tr><th width="126.08984375"></th><th></th></tr></thead><tbody><tr><td>Masters</td><td><code>HCM-ADMIN-CONSOLE.FieldPropertiesPanelConfig</code> (panel settings, number limits, GPS timer) and <code>HCM-ADMIN-CONSOLE.FieldTypeMappingConfig</code> (including the multi-select type).</td></tr></tbody></table>

**6. Dashboard translations —&#x20;*****check before upgrading***

<table><thead><tr><th width="111.2890625"></th><th></th></tr></thead><tbody><tr><td>Change</td><td>The dashboard no longer loads the <code>rainmaker-hcm-dss</code> translation module. Confirm all dashboard labels exist under <code>hcm-dss</code>.</td></tr></tbody></table>

</details>

#### Changed

* Field worker app released as **version 2.2.0**, with eight updated packages: `digit_data_model` 1.5.2, `digit_crud_bloc` 0.1.2, `digit_data_converter` 0.0.5, `digit_forms_engine` 0.1.3, `digit_flow_builder` 0.2.3, `digit_ui_components` 0.3.3, `survey_form` 1.0.6, `transit_post` 1.0.3
* Separate CLF and Transit Post home cards replaced by one **Outside Household Vaccination** card
* Delivery strategies are now saved on **every** campaign save, so a later step can no longer erase them
* Delivery strategies are cleared automatically if the campaign type is changed after a draft is saved
* Campaign type `IMMUNISATION` is now treated the same as Polio in the field app
* Primary field added to selected backend service tables
* Shared backend libraries `hcm-common-model` and `hcm-common-library` upgraded
* Web console component libraries upgraded (for example `digit-ui-components` dev-66 → dev-78, `digit-ui-health-css` 1.0.55 → 1.0.65)
* Platform-wide security fixes applied

#### Fixes

<table><thead><tr><th width="70.47265625">#</th><th width="177.76953125">Area</th><th>Fix</th></tr></thead><tbody><tr><td>1</td><td>Campaign drafts</td><td>Campaigns drafted while the user's language changes no longer fail</td></tr><tr><td>2</td><td>Microplan sheet</td><td>Dropdowns show values in the user's language; upload errors now show a readable message instead of a code</td></tr><tr><td>3</td><td>Beneficiary IDs</td><td>An already-used ID can no longer be given to a second person</td></tr><tr><td>4</td><td>Beneficiary IDs</td><td>IDs used on the phone but not yet synced stay reserved when IDs are downloaded again</td></tr><tr><td>5</td><td>Beneficiary IDs</td><td>Skipping the ID step no longer saves a temporary device ID</td></tr><tr><td>6</td><td>Attendance</td><td>Workers enrolled after the marking date no longer appear on that day's register</td></tr><tr><td>7</td><td>New settlements</td><td>Selecting a just-added settlement no longer crashes the next screen</td></tr><tr><td>8</td><td>Boundary selection</td><td>Swapping one boundary for another is now detected correctly; the level list is kept when the lowest level is unknown</td></tr><tr><td>9</td><td>Delivery setup</td><td>The delivery end date can no longer be set before the start date by typing it in</td></tr><tr><td>10</td><td>Multi-round campaigns</td><td>The Mobile App step is no longer locked waiting for a delivery step that multi-round campaigns never see</td></tr><tr><td>11</td><td>Resource card</td><td>Products show again for campaigns that do not use delivery strategies</td></tr><tr><td>12</td><td>Local languages</td><td>Labels typed in Malayalam, Sinhala or Bengali are no longer corrupted on save</td></tr><tr><td>13</td><td>Campaign copy</td><td>Create Campaign is disabled while copied dates are invalid, instead of failing after the click</td></tr><tr><td>14</td><td>Upload validation</td><td>The screen no longer freezes when the server reports a particular kind of upload error</td></tr><tr><td>15</td><td>Payments</td><td>Boundary selection is stored correctly and no longer saved on every screen refresh</td></tr><tr><td>16</td><td>HRMS</td><td>Fields in the deactivate-employee pop-up now line up correctly</td></tr><tr><td>17</td><td>Dashboard</td><td>Rounded bar corners now appear on the correct segment in percentage charts</td></tr><tr><td>18</td><td>Other</td><td>Mobile number prefix, update-dates, Polio download template and app-configuration caching fixes</td></tr></tbody></table>

## Related Documents

<table><thead><tr><th width="387.5703125">Technical Documents</th><th>Functional Documents</th></tr></thead><tbody><tr><td><a href="https://docs.digit.org/health/release-notes/migration-guide.md">Migration Guide</a></td><td><a href="https://docs.digit.org/health/access/public-health-product-suite/health-campaign-management-hcm/outside-household.md">Outside Household User Manual</a></td></tr><tr><td><a href="https://docs.digit.org/health/release-notes/service-build-updates.md">Service Build Updates</a></td><td><a href="https://docs.digit.org/health/community/hcm-declarative-statements-and-faqs.md">HCM Declarative Statements &#x26; FAQs</a></td></tr><tr><td><a href="https://docs.digit.org/health/design/architecture/low-level-design/registries/facility/outside-household-design.md">Outside Household Design </a></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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digit.org/health/release-notes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
