> 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/v1.5/technology/architecture/field-app-architecture/ui-packages/closed-household-package.md).

# Closed HouseHold package

It’s been built as a new module (pub package)- closed\_household and It will be a dependency of registration and delivery package.

To learn more about Registration and Delivery, [click here.](https://pub.dev/packages/closed_household)\
\
Link to the pub package:

{% embed url="<https://pub.dev/packages/closed_household>" %}

## Role

* DISTRIBUTOR

## **Features**

* Create a closed household
* Update task if closed household gets registered

## Getting Started

To use this package, add the following dependency to your pubspec.yaml file:

```
dependencies:
  closed_household: ^latest
```

## Integrating with the HCM Application:&#x20;

1. To integrate this package with the HCM Application, run the main function located in `health-campaign-field-worker-app/tools/closed_household_imports.dart.`&#x20;
   * This will automatically add the necessary imports, mapper initializers, route config, setting initial data, and repository initialization to the required files.
2. Make sure you are on the path `apps/health_campaign_field_worker_app` and run the command:

```dart
dart run build_runner build --delete-conflicting-outputs
```

This adds a package route to the `main router.gr.dart`&#x20;

3. Install the application and you should have Registration and Delivery integrated into your base app.

By following these steps, you can successfully integrate and use the closed household module within your application.

**Sequence  Diagram**\
\ <br>

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXeAfzq8R3vsLSszhLHRgzKBPFWvaAXcmRZnHHvFuDol_Fa8yOHgsFIk9QuGnIhPQzlTov827uLcR71S1PpfHxmDoiJp3vZo6pVy6DC2oagFboHJb-dMeRY8P0eDPvlWPgQoD8KfhoBzWSkoNIE_S975nTuE?key=9Nh1qYotTAKkaU2_CLeYjA" alt=""><figcaption></figcaption></figure>

Package published : <https://pub.dev/packages/closed_household>


---

# 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/v1.5/technology/architecture/field-app-architecture/ui-packages/closed-household-package.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.