first commit
This commit is contained in:
41
README.md
Normal file
41
README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# BD FHIR National Repository & Validation Engine
|
||||
|
||||
This is the central interoperability gateway for the **Directorate General of Health Services (DGHS), Bangladesh**. It provides a high-performance FHIR R4 repository with mandatory validation against national clinical standards.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
1. **Configure Environment:**
|
||||
`cp .env.example .env` (See **Project Manifest** for variable descriptions).
|
||||
2. **Initialize Database:**
|
||||
Run `postgres/fhir/init.sh` and `postgres/audit/init.sh` on the host.
|
||||
3. **Deploy:**
|
||||
`docker compose up -d`
|
||||
|
||||
---
|
||||
|
||||
## 📚 Operational Documentation
|
||||
|
||||
All technical and procedural guides are located in the `ops/` directory. Refer to these before making changes to the production environment:
|
||||
|
||||
| Guide | Description |
|
||||
| --- | --- |
|
||||
| **[Project Manifest](https://git.dghs.gov.bd/riaz.somc/bd-fhir-national/ops/project-manifest.md)** | Full file inventory, architectural decisions, and pre-flight checklist. |
|
||||
| **[Deployment Guide](https://git.dghs.gov.bd/riaz.somc/bd-fhir-national/ops/deployment-guide.md)** | Step-by-step setup for Ubuntu 22.04+ and nine mandatory acceptance tests. |
|
||||
| **[Keycloak Setup](https://git.dghs.gov.bd/riaz.somc/bd-fhir-national/ops/keycloak-setup.md)** | Instructions for realm roles, client mappers, and JWT authentication. |
|
||||
| **[Adding Additional IGs](https://git.dghs.gov.bd/riaz.somc/bd-fhir-national/ops/adding-additional-igs.md)** | How to load specialized IGs (MCCoD, IMCI) without breaking the core. |
|
||||
| **[Version Upgrade](https://www.google.com/search?q=ops/version-upgrade-integration.md)** | Procedure for ICD-11 version updates and terminology cache flushing. |
|
||||
| **[Scaling Roadmap](https://git.dghs.gov.bd/riaz.somc/bd-fhir-national/ops/scaling-roadmap.md)** | Thresholds for resource allocation and database partitioning. |
|
||||
| **[Technical Ops](https://git.dghs.gov.bd/riaz.somc/bd-fhir-national/ops/technical-operations-document.md)** | Runbooks for backup, recovery, and daily maintenance. |
|
||||
|
||||
---
|
||||
|
||||
## 🛠 Tech Stack
|
||||
|
||||
* **Engine:** HAPI FHIR 7.2.0 (R4) on Spring Boot 3.2
|
||||
* **Database:** PostgreSQL 15 + pgBouncer (Session Mode)
|
||||
* **Auth:** Keycloak (HRIS Realm)
|
||||
* **CI/CD:** Gitea Actions
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user