The project is a Java application built with Spring Boot and Lombok. It uses Flyway for database migrations, Maven as the build tool, and Docker for containerization. The application uses a PostgreSQL database to store patient consults, pathologies, and symptoms.
The objective of the application is to enable logging of patient consultations in the hospital and facilitate the tracking of their medical conditions and symptoms. The hospital administration intends to add new patient consultations and records on a daily basis. At present, the hospital board is satisfied with the medical conditions and symptoms in their database and therefore, expanding it is not a part of this project's scope.
Run the following commands in the command line:
- Clone the repository to your local machine using git clone .
- Navigate to the project directory using 'cd '.
- Build the application using Maven by running 'mvn clean install'.
- Build the Docker image using the provided Dockerfile by running 'docker build -t challenge-1.0.0.jar '.
- Run the Docker container using the command 'docker-compose up'
Once the application is running, you can access it using a web browser or a REST API client like Postman. The following endpoints are available:
GET /patient: retrieves a paginated list of all patients, filtered and sorted by either name or age. curl http://localhost:8080/challenge/patient?page=0&search=a&size=10&sort=age,DESC
GET /patient/{patientId}/consults: retrieves all consults with symptoms associated with a specific patient. curl http://localhost:8080/challenge/patient/1/consults
GET /speciality: retrieves a list of top specialities based on the number of distinct patients assigned to each one. curl http://localhost:8080/challenge/speciality
POST /consult: creates a new consult based on the given ConsultDTO and returns the ID of the created consult in the response body. curl 'http://localhost:8080/challenge/consult' --header 'Content-Type: application/json' --data-raw '{ "doctorId": 1, "patientId": 1, "specialityId": 1 }'
The application uses a PostgreSQL database to store patient consults, pathologies, and symptoms. Flyway is used to manage database migrations, so you don't need to manually create or modify database tables. The database connection properties are configured in the application.properties file located in the project's src/main/resources directory and the migrations are in the same directory inside the package db.
