> 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/high-level-design/health-campaign-system-high-level-design.md). # Health Campaign System High Level Design Health Campaign - High Level Design The high level design is divided into: 1. Master data 2. Registries/entities 3. Reusable DIGIT services 4. Form engine support 5. Multi-tenancy 6. Android offline first app 7. Web app - Campaign planning + dashboard 8. External integration - DHIS2 Base Health Campaign on DIGIT Core 2.8. ## Master Data Master data categorised on the complexity required to maintain them from the technical perspective. 1. Simple Masters 1. Roles 2. Additional field schemas for different entities 3. Project task configurations 4. Project type 5. Role-actions 6. Actions 2. Hierarchical Masters 1. Administrative boundary and hierarchy 3. Inter-Linking Masters 1. Field app config 2. Service registry ## Services/Registries ### Individual Registry * New service. * As users are registered to campaigns, populate the individual registry with basic information about them. * This registry is the first step towards the long term plans in DIGIT to move non users of the system away from the User service. However, due to the current dependency on User service for authN and authZ among other things, this registry will be a wrapper over the User service. ### Household Registry * New service. * Collection of Individuals living together (potentially receiving shared campaign intervention). ### Facility Registry * New service. * Needed to model storage Warehouses through which stock moves. ### Product Registry * New service. * Needed to model the resources that are distributed as part of projects both as part of stock movement and actual distribution to beneficiaries. ### Project Service * New service. * Models how services and benefits are typically distributed to citizens by governments. * Contains multiple endpoints within the service to map other entities such as beneficiaries, staff, facilities, resources to the projects. ### Stock Service * New service. * Track inflow and outflow of stock resources. ## Reusable DIGIT Services Many of the DIGIT-Core services can be reused without any changes. Some of them could be extended and enhanced to support the required features. ### DIGIT Services reused as-is * digit-mdms-service * Digit-location / boundary service * digit-access-control * Zuul API Gateway * digit-idgen * digit-persister * digit-indexer * digit-localization * DSS * Signed Audit ### DIGIT Services reused with enhancements No existing services being enhanced. ## Workflow The Health Campaign system does not make heavy use of workflows. Most flows in v1 are single actor and end after a single step (i.e. submitting collected data). ## High-Level Design Diagram ![](https://lh6.googleusercontent.com/Gnv9XNSQA1UoCQ59jh2CaPAulwd6q0eXClhR3YsLr211Tn4mYJ1PvoUlNi_d86GgWGj9SNcRgBqM-aU5UzCfcSXaGD289IxKR3oZtKq2gpx-dThnOos3r_ngIof9cHXYPO51IWxUpRgZ-R3M62Of3gDrT_0gph0XxPfqLANCE_k_y7dpfVj7B1HJ7Zd1JA) ## **ER Diagram** ![](https://lh4.googleusercontent.com/Ac3FtywEjTuUL35VLbvbOAIrdq1J7PfwOj4-QWvjMs78kdPdTMk791UqHUahQIyR3dZH40YPlMAKvIptBW835ACKWPFfJ4iFQX8DVj_k6R72MyzlHWF7PNpmTC8PVLbPKRtiLp4OhhMBeeknsGZesjtbFAfM8Ueb2AHR1smw6dpoa1T37UZjOeIeBpc-Tw) ## Form Engine Support Form engine support was pushing out timelines and has been dropped from v1 scope. ## Multi-Tenancy The proposal is to have a single installation to support multiple countries and multiple health campaigns within these countries. Different campaigns will need to share registries. Leveraging multi tenancy support in DIGIT for this. ## Android App ### Offline First Android app is proposed to be modelled on mGramSeva app and will be built in Flutter. This app will be used in areas with limited or no internet connectivity and hence will need to work while offline. Users will sync the data collected offline when they are in an area with network connectivity. SQLite will be used to model structured data and ISAR will be used for unstructured data. ### Form Renderer Out of scope for v1. ### Offline Dashboards The field workers will need to see dashboards based on the data stored in the offline database. Library - TBD ## Web App ### Campaign Planning App Out-of-scope for v1. ### Dashboards App The app will have some custom screens to capture information around the campaign plan. DSS dashboards are planned to be leveraged for reporting dashboards. ## External Integration ### DHIS2 This will be added to implementation scope. --- # 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/high-level-design/health-campaign-system-high-level-design.md?ask=&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.