PatientAPI Documentation

Developer(s) SEP 2023 - JAN 2024

_{Tim Kuijpers}

👨‍💻 Short Introduction

The PatientAPI is a service within the Medix-hub system that is operated to create, mutate, retrieve and delete the personal data of a patient.

These patients get enlisted into the system when visiting a hospital or general practitioners office but only if the patient agrees on data being stored.

Languages and Tools used

These following technologies are used the most frequent amount within this project:

The following technologies also contribute to this project:

Entity Framework
Snyk
SonarCloud
Azure
K6 by Grafana
Grafana
Influx DB
Proto
JSON Transcoding
Postman
GHZ performance tests

API Endpoints (from gateway)

The application has the following endpoints:

HTTP method	API endpoints	Description
GET	/api/v1/patient	Get all patients
GET	/api/v1/patient/{id}	Get patient by ID
POST	/api/v1/patient	Create patient
POST	/api/v1/deceased	Declare patient as deceased
PUT	/api/v1/patient	Update patient
DELETE	/api/v1/patient/{id}	Delete patient

(Upcoming with enterprise KrakenD)

GRCP method	API endpoints	Description
GET	/grpc/v1/patient	Get all patients
GET	/grpc/v1/patient/{id}	Get patient by ID
POST	/grpc/v1/patient	Create patient
POST	/grpc/v1/deceased	Declare patient as deceased
PUT	/grpc/v1/patient	Update patient
DELETE	/grpc/v1/patient/{id}	Delete patient

Cloning & local instance

To get this service running on your local device look at the Medix-Hub repository.

Contributing

Pull requests are not desired. This was a project for school within my study at Fontys HBO-ICT Software engineering.