The Healthcare Management System is a microservices-based application designed to streamline various healthcare-related tasks such as patient management, appointment scheduling, medical records management, billing, and reporting. This README provides an overview of the project structure, services, and setup instructions.
The main objectives of this project are:
- Implement a scalable and maintainable healthcare system using microservices architecture.
- Utilize various technologies and concepts such as Spring Boot, Spring Cloud, Docker, Docker Compose, Kafka, Prometheus, and more.
- Ensure security using Spring Security for authentication and authorization.
- Facilitate CI/CD pipelines with Jenkins Pipeline for automated build, test, and deployment.
- Provide thorough documentation and instructions for setting up and running the project.
The system consists of the following microservices:
- Patient Service: Manages patient registration, profile management, and medical history tracking.
- Doctor Service: Handles doctor registration, profile management, and schedule management.
- Appointment Service: Manages appointment scheduling with conflict resolution and notification functionalities.
- Medical Records Service: Deals with medical record creation, retrieval, and update functionalities.
- Billing Service: Handles billing generation, invoicing, and payment tracking functionalities.
- Reporting Service: Provides reporting functionalities for generating insights into patient demographics, appointment trends, and revenue analysis.
The project includes the following shared libraries:
- Common Library: Contains shared code, models, and utilities used across multiple services.
- Security Library: Contains security-related functionality such as authentication and authorization.
- โ๏ธ Spring Boot
- โ๏ธ Spring Cloud (Gateway API, Load Balancing, Cache, Health, Metrics)
- ๐ Spring Security
- ๐ ๏ธ Docker, Dockerfile, Docker Compose
- ๐ค๏ธ Flyway Migration, JPA, PostgreSQL, MongoDB
- ๐ OpenAPI (Swagger), HATEOAS Rest
- ๐จ Apache Kafka, Email, Prometheus, Grafana, Testcontainers (Unit Test, Functional Test, Integration Test with Mockito)
- ๐ CI/CD with Jenkins Pipeline
- ๐ ๏ธ Dev Configuration and Production Environment Setup
The entity model includes entities such as:
- Patient
- Doctor
- Appointment
- MedicalRecord
- Billing
- Report
Each microservice manages its related entities and exposes APIs for CRUD operations and business-specific functionality.
- Clone the repository.
- Install Docker and Docker Compose.
- Navigate to the project directory.
- Run
docker-compose up
to build and start the microservices and their dependencies. - Access the individual microservices' endpoints as per their documentation for further configuration and usage.
If you'd like to contribute to this project, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or fix.
- Make your changes and commit them.
- Push to your fork and submit a pull request.
This project is licensed under the MIT License.