medical-visits Project

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

Create image with docker ./mvnw package -DskipTests -Dquarkus.native.container-build=true

Then start containers with:

docker compose -f src/main/docker/docker-compose.yaml up

Tech stack

Java 17 with Quarkus
Mongo

Testing application

Unit and Integration tests

Launch in a shell the command

./mvnw verify

Note

Integration tests make use of Mongodb docker container, so you must have a working docker container environment.

Diagrams

Class diagram

NOTE The patient collection follow the embedded document pattern that applies to One-to-Many Relationship.

Open API

For the API documentation, check this URL:

http://localhost:8080/q/swagger-ui/

Curl examples

Add new patient

curl --location --request POST 'http://localhost:8080/patients' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Pino",
    "surname": "Scorre",
    "birthDate": "2022-01-03",
    "socialSecurityNumber": "AA123456Z"
}'

Get patient information

curl --location --request GET 'http://localhost:8080/patients/<objectId>' \
--header 'Accept: application/json'

Add a visit for the patient

curl --location --request POST 'http://localhost:8080/patients/<objectId>/visits' \
--header 'Content-Type: application/json' \
--data-raw '{
    "time": "2022-01-03 23:02",
    "reason": "RECURRING",
    "type": "HOME"
}'

Update visit for the patient

curl --location --request PUT 'http://localhost:8080/patients/<ObjectId>/visits/<index>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "RECURRING",
    "time": "2022-01-03 23:02",
    "type": "DOCTOR_OFFICE"
}'

View visit for the patient

curl --location --request GET 'http://localhost:8080/patients/<ObjectId>/visits/<index>'

Improvement points

Separate database entities from rest model interfaces
Add specific API Gateway components (i.e. adopt Backend For Frontend pattern) for different clients (mobile, web application, 3rd part library)

fstarred/medical-visits