Digital-Square-Tanzania/ucs-fetch-monthly-chw-status-service
Domain:
healthcareRecord type:
software
Creator:
Dig
Host:
# CHW Monthly Status Service
## Overview
This service is built using **Akka HTTP** to handle eligibility checks for Community Health Workers (CHWs) based on their activity in a given month. It exposes an endpoint that processes requests containing CHW details and responds with their eligibility status.
## Features
- Built using **Akka HTTP** for high-performance, non-blocking request handling.
- Uses **PostgreSQL** as the database.
- Implements **Jackson** for JSON serialization/deserialization.
- Provides a REST API endpoint for checking CHW monthly eligibility.
## Prerequisites
Ensure you have the following installed:
- **Java 11+**
- **PostgreSQL** (with the required database and tables set up)
- **Maven** or **Gradle** for dependency management
## Installation
Clone the repository and navigate into the project directory:
```sh
$ git clone github.com
$ cd chw-status-service
```
## Configuration
Set up environment variables or modify `application.conf` to match your database settings:
```
DB_HOST=127.0.0.1
DB_PORT=5432
DB_NAME=your_database_name
DB_USER=your_username
DB_PASSWORD=your_password
```
## API Endpoints
### 1. Check CHW Monthly Status
#### Endpoint:
```http
POST /chw/monthly-status
```
#### Request Body:
```json
{
"period": {
"month": "03",
"year": "2025"
},
"chws": [
{
"NationalIdentificationNumber": "19890823-53103-00002-23",
"OpenmrsProviderId": "agakhanchw"
},
{
"NationalIdentificationNumber": "19890823-00898-98783-30",
"OpenmrsProviderId": "NafubaCHW"
}
]
}
```
#### Response:
```json
[
{
"NationalIdentificationNumber": "19890823-53103-00002-23",
"Eligible": true
},
{
"NationalIdentificationNumber": "19890823-00898-98783-30",
"Eligible": true
}
]
```
## Building and Running the Service
To build and run the service after performing the above configurations, run the following:
```sh
./gradlew clean shadowJar
java -jar build/libs/ucs-fetch-monthly-chw-status-service- .jar
```
## Deployment via Docker
F …