> 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/v2.0/design/architecture/low-level-design/services/microplan-low-level-design.md). # Microplan - Low Level Design ## Overview The Low Level Design (LLD) details on this page provide a detailed technical blueprint for implementing the **Microplanning** system. It translates functional requirements into concrete technical components, including APIs, service responsibilities, sequence flows, and database schemas. The LLD covers: * Internal architecture of Microplanning services * API specifications at a component level * Asynchronous processing flows * Sequence diagrams for key workflows * Database schema design and entity relationships ## System Overview The Microplanning system enables planning, estimation, and allocation of resources across administrative units, employees, and facilities. It is composed of two core backend services: 1. **Resource Generator Service** – Responsible for generating resource estimations asynchronously. 2. **Plan Management Service** – Manages the lifecycle of micro plans, including configuration, assignments, validation, and approval. Both services follow DIGIT’s event-driven, microservices-based architecture. ## Resource Management The Draft API is part of the **Resource Generator Service**. It initiates the resource estimation process for a given micro plan configuration. **Key Characteristics** * Fully asynchronous processing * Designed for large datasets * Non-blocking client interaction **Processing Flow** 1. Client invokes Draft API with plan configuration reference 2. Request is validated and accepted 3. The estimation job is triggered asynchronously 4. Input data is parsed and business logic applied 5. Output file is generated and uploaded to File Store 6. Plan configuration is updated with estimation metadata ### API Specification [Resource Generator API Specification](https://github.com/egovernments/DIGIT-Specs/blob/grouped-service-contracts/Domain%20Services/Resource%20Generator/resource-1.0.0.yaml) [Postman Collection](https://api.postman.com/collections/13428435-c702603a-b3c5-4954-9f67-17c06e41d225?access_key=PMAT-01JRA0QCZE111Z3JQSM4R8KZEP) ### Sequence Diagrams #### Draft API

## Plan Management The Plan Management Service handles the complete lifecycle of micro plans, including: * Micro plan creation and configuration * Employee assignment to plans * Facility linkage * Validation and approval of estimations Key Characteristics **Plan Configuration** * Create and update micro plans * Store administrative hierarchy and planning parameters **Plan Employee Assignment** * Assign employees to micro plans * Validate role and jurisdiction alignment **Plan Facility Linkage** * Link facilities (e.g., schools, health centres) to plans * Support one-to-many and many-to-many mappings **Plan Estimation Management** * Store estimation references * Track draft vs approved estimations **Validation & Approval** * Rule-based validation of estimation data * Approval workflows for finalised plans ### API Specification [Plan Management API Specification](https://github.com/egovernments/DIGIT-Specs/blob/grouped-service-contracts/Domain%20Services/Plan%20Service/plan-1.0.0.yaml) ### Sequence Diagrams #### Plan Configuration APIs

*Plan Configuration Create API Sequence Diagram*

*Plan Configuration Search API Sequence Diagram*

*Plan Configuration Update API Sequence Diagram*

### Plan Employee Assignment APIs

*Plan Employee Assignment Create API Sequence Diagram*

*Plan Employee Assignment Search API Sequence Diagram*

*Plan Employee Assignment Update API Sequence Diagram*

### Plan Facility APIs

*Plan Facility Create API Sequence Diagram*

*Plan Facility Search API Sequence Diagram*

*Plan Facility Update API Sequence Diagram*

### Plan Management APIs

## Database Schemas

*Plan Employee Assignment Database Schema*

## Census Management ### Overview The **Census Management Service** is responsible for managing population census data used as a key input for microplanning and resource estimation. It supports capture, validation, approval, and versioning of census data across administrative hierarchies. Census data acts as a foundational dataset for estimation logic and must pass through defined validation and approval workflows before it can be consumed by downstream services such as the Resource Generator. **Key Characteristics** * Capture population census data at multiple administrative levels * Maintain draft and approved versions of census datasets * Validate census data against configured rules * Support approval workflows for finalised census data * Expose approved census data to dependent services ### API Specifications [Census Management API Specification](https://github.com/egovernments/DIGIT-Specs/blob/grouped-service-contracts/Domain%20Services/Census/census-v1.0.0.yaml) ### Sequence Diagrams #### Census Management APIs

### Database Schemas

--- # 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/v2.0/design/architecture/low-level-design/services/microplan-low-level-design.md?ask=&goal= ``` `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.