base on Hospital Management API built in Spring Boot # Hospital Management - API Module 
## About the project
Hospital Management API built in Spring Boot
### Prerequisites:
- Spring Boot 3.2.1
- JDK 17
- Maven 4.0.0
### Running the application
1. `git clone https://github.com/MirnaGama/hospital-management-api/`
2. `cd hospital-management-api`
3. `mvn clean install`<br>
It will build the jar file in the target folder
4. `mvn spring-boot:run`<br>
It will compile and run the application on default port (8080)
### Running tests
- `mvn test`<br>
It will executes all the tests.
- `mvn -Dtest=packageName.className test`<br>
It will execute only one test class
- `mvn -Dtest=packageName.className#methodName test`<br>
It will run only one test method from one test class
### Features - v1.0
- [X] R1 - Doctor Registration
- [X] R2 - List of Doctors
- [X] R3 - Doctor Update
- [X] R4 - Doctor Exclusion
- [X] R5 - Patient Registration
- [X] R6 - List of Patients
- [X] R7 - Patient Update
- [X] R8 - Patient Exclusion
- [X] R9 - Consultation Scheduling
- [X] R10 - Consultation Cancellation
## API Documentation - /swagger-ui/index.html
### authentication
#### POST - [**/api/auth/register**] - Register a new user
- **Body:**
```
{
"login" (string, required),
"password" (string, required),
}
```
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `400` | _Validation Error_ |
#### POST - [**/api/auth/login**] - Perform the login
- **Body:**
```
{
"login" (string, required),
"password" (string, required),
}
```
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `400` | _Validation Error_ |
| `403` | _Incorrect credentials_ |
### doctors
#### POST - [**/api/v1.0/doctors**] - Adds a new doctor
- **Body:**
```
{
"name" (string, required),
"email" (string, required),
"crm" (string, required),
"telephone" (string, required),
"specialty" (string, required),
"address": {
"street" (string, required),
"neighborhood" (string, required),
"zipCode" (string, required),
"city" (string, required),
"state" (string, required),
"additionalDetails" (string, optional),
"houseNumber" (string, optional)
}
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `201` | _Successfully created_ |
| `400` | _Validation Error_ |
| `403` | _Unauthorized / Invalid token_ |
#### GET - [**/api/v1.0/doctors/{id}**] - Get an existing doctor
- **Response Body Example:**
```
{
"id": 1,
"name": "DOCTOR TEST",
"email": "
[email protected]",
"crm": "12456",
"telephone": "(81) 99999999",
"specialty": "ORTHOPEDICS",
"active": true,
"address": {
"street": "TEST STR.",
"neighborhood": "TEST NEIGHBORHOOD",
"zipCode": "12345678",
"city": "TEST CITY",
"state": "ST",
"additionalDetails": null,
"houseNumber": null
}
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Request Parameters:**
| Key | Description |
| ------------- | ------------- |
| `id` | _Unique identifier of the doctor who will be fetched_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `404` | _Entity not found_ |
| `403` | _Unauthorized / Invalid token_ |
#### GET - [**/api/v1.0/doctors**] - Get a list of doctors
- **Response Body Example:**
```
{
"content": [
{
"name": "Test1",
"email": "
[email protected]",
"crm": "123456",
"specialty": "ORTHOPEDICS"
},
{
"name": "Test2",
"email": "
[email protected]",
"crm": "789101",
"specialty": "ORTHOPEDICS"
},
{
"name": "Test3",
"email": "
[email protected]",
"crm": "112131",
"specialty": "ORTHOPEDICS"
},
],
"pageable": {
"pageNumber": 0,
"pageSize": 10,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"offset": 0,
"paged": true,
"unpaged": false
},
"totalPages": 1,
"totalElements": 3,
"last": true,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"number": 0,
"size": 10,
"first": true,
"numberOfElements": 3,
"empty": false
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Request Parameters:**
| Key | Description |
| ------------- | ------------- |
| `size` | _Number of records that should be returned_ |
| `sort` | _Sort by object attribute in descending order_ |
| `page` | _Page number_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `403` | _Unauthorized / Invalid token_ |
#### PUT - [**/api/v1.0/doctors**] - Updates an existing doctor
- **Body:**
```
{
"id" (number, required),
"name" (string, optional),
"telephone" (string, optional),
"address": {
"street" (string, optional),
"neighborhood" (string, optional),
"zipcode" (string, optional),
"city" (string, optional),
"state" (string, optional),
"additionalDetails" (string, optional),
"houseNumber" (string, optional),
}
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `400` | _Validation Error_ |
| `403` | _Unauthorized / Invalid token_ |
#### DELETE - [**/api/v1.0/doctors/{id}**] - Deactivates an existing doctor
- **Response Body Example:**
```
{
"id": 2,
"name": "DEACTIVATED DOCTOR TEST",
"email": "
[email protected]",
"crm": "12456",
"telephone": "(81) 99999999",
"specialty": "ORTHOPEDICS",
"active": false,
"address": {
"street": "TEST STR.",
"neighborhood": "TEST NEIGHBORHOOD",
"zipCode": "12345678",
"city": "TEST CITY",
"state": "ST",
"additionalDetails": null,
"houseNumber": null
}
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Request Parameters:**
| Key | Description |
| ------------- | ------------- |
| `id` | _Unique identifier of the doctor who will be deactivated_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `400` | _Validation Error_ |
| `404` | _Entity not found_ |
| `403` | _Unauthorized / Invalid token_ |
### patients
#### POST - [**/api/v1.0/patients**] - Adds a new patient
- **Body:**
```
{
"name" (string, required),
"email" (string, required),
"cpf" (string, required),
"telephone" (string, required),
"address": {
"street" (string, required),
"neighborhood" (string, required),
"zipCode" (string, required),
"city" (string, required),
"state" (string, required),
"additionalDetails" (string, optional),
"houseNumber" (string, optional)
}
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `201` | _Successfully created_ |
| `400` | _Validation Error_ |
| `403` | _Unauthorized / Invalid token_ |
#### GET - [**/api/v1.0/patients/{id}**] - Get an existing patient
- **Response Body Example:**
```
{
"id": 1,
"name": "PATIENT TEST",
"email": "
[email protected]",
"cpf": "11111111111",
"telephone": "(81) 99999999",
"active": true,
"address": {
"street": "TEST STR.",
"neighborhood": "TEST NEIGHBORHOOD",
"zipCode": "12345678",
"city": "TEST CITY",
"state": "ST",
"additionalDetails": null,
"houseNumber": null
}
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Request Parameters:**
| Key | Description |
| ------------- | ------------- |
| `id` | _Unique identifier of the patient who will be fetched_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `404` | _Entity not found_ |
| `403` | _Unauthorized / Invalid token_ |
#### GET - [**/api/v1.0/patients**] - Get a list of patients
- **Response Body Example:**
```
{
"content": [
{
"name": "Test1",
"email": "
[email protected]",
"cpf": "123456"
},
{
"name": "Test2",
"email": "
[email protected]",
"cpf": "789101"
},
{
"name": "Test3",
"email": "
[email protected]",
"cpf": "112131"
},
],
"pageable": {
"pageNumber": 0,
"pageSize": 10,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"offset": 0,
"paged": true,
"unpaged": false
},
"totalPages": 1,
"totalElements": 3,
"last": true,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"number": 0,
"size": 10,
"first": true,
"numberOfElements": 3,
"empty": false
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Request Parameters:**
| Key | Description |
| ------------- | ------------- |
| `size` | _Number of records that should be returned_ |
| `sort` | _Sort by object attribute in descending order_ |
| `page` | _Page number_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `403` | _Unauthorized / Invalid token_ |
#### PUT - [**/api/v1.0/patients**] - Updates an existing patient
- **Body:**
```
{
"id" (number, required),
"name" (string, optional),
"telephone" (string, optional),
"address": {
"street" (string, optional),
"neighborhood" (string, optional),
"zipcode" (string, optional),
"city" (string, optional),
"state" (string, optional),
"additionalDetails" (string, optional),
"houseNumber" (string, optional),
}
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `400` | _Validation Error_ |
| `403` | _Unauthorized / Invalid token_ |
#### DELETE - [**/api/v1.0/patients/{id}**] - Deactivates an existing patient
- **Response Body Example:**
```
{
"id": 1,
"name": "DEACTIVATED PATIENT TEST",
"email": "
[email protected]",
"cpf": "11111111111",
"telephone": "(81) 99999999",
"active": false,
"address": {
"street": "TEST STR.",
"neighborhood": "TEST NEIGHBORHOOD",
"zipCode": "12345678",
"city": "TEST CITY",
"state": "ST",
"additionalDetails": null,
"houseNumber": null
}
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Request Parameters:**
| Key | Description |
| ------------- | ------------- |
| `id` | _Unique identifier of the patient who will be deactivated_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `400` | _Validation Error_ |
| `404` | _Entity not found_ |
| `403` | _Unauthorized / Invalid token_ |
### consultations
#### POST - [**/api/v1.0/consultations**] - Adds a new consultation
- **Body:**
```
{
"patientId" (number, required),
"consultationDate" (string, required),
"doctorId" (number, required if _specialty_ field is not filled),
"specialty" (string, required if _doctorId_ field is not filled)
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `201` | _Successfully created_ |
| `400` | _Validation Error_ |
| `403` | _Unauthorized / Invalid token_ |
| `404` | _Entity not found_ |
#### GET - [**/api/v1.0/consultations/{id}**] - Get an existing consultation
- **Response Body Example:**
```
{
"id": 1,
"consultationDate": "22/04/2024 10:34",
"patient": {...},
"doctor": {...},
"canceled": false,
"reasonCancellation: ""
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Request Parameters:**
| Key | Description |
| ------------- | ------------- |
| `id` | _Unique identifier of the consultation that will be fetched_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `404` | _Entity not found_ |
| `403` | _Unauthorized / Invalid token_ |
#### DELETE - [**/api/v1.0/consultations**] - Cancels a scheduled consultation
- **Body:**
```
{
"consultationId" (number, required),
"reasonCancellation" (string, required),
}
```
- **Request Headers:**
| Key | Description |
| ------------- | ------------- |
| `Authorization` | _Authorization token_ |
- **Responses:**
| Code | Description |
| ------------- | ------------- |
| `200` | _Successful operation_ |
| `403` | _Unauthorized / Invalid token_ |
| `404` | _Entity not found_ |
", Assign "at most 3 tags" to the expected json: {"id":"7522","tags":[]} "only from the tags list I provide: [{"id":39,"name":"3d-generation","display_name":"3D generation","slug":"3d-generation"},{"id":3,"name":"ai-agent","display_name":"AI agent","slug":"ai-agent"},{"id":8,"name":"ai-coding","display_name":"AI coding assistant","slug":"ai-coding"},{"id":5,"name":"ai-image","display_name":"AI image generation","slug":"ai-image"},{"id":9,"name":"ai-infrastructure","display_name":"AI infrastructure","slug":"ai-infrastructure"},{"id":10,"name":"ai-memory","display_name":"AI memory","slug":"ai-memory"},{"id":11,"name":"ai-skills","display_name":"AI skills","slug":"ai-skills"},{"id":12,"name":"ai-translation","display_name":"AI translation","slug":"ai-translation"},{"id":6,"name":"ai-video","display_name":"AI video generation","slug":"ai-video"},{"id":4,"name":"ai-voice","display_name":"AI voice","slug":"ai-voice"},{"id":7,"name":"ai-workflow","display_name":"AI workflow","slug":"ai-workflow"},{"id":22,"name":"audio-processing","display_name":"Audio processing","slug":"audio-processing"},{"id":29,"name":"authentication","display_name":"Authentication","slug":"authentication"},{"id":51,"name":"bundler","display_name":"Bundler","slug":"bundler"},{"id":41,"name":"chatbot","display_name":"Chatbot","slug":"chatbot"},{"id":27,"name":"cloud-native","display_name":"Cloud native","slug":"cloud-native"},{"id":1,"name":"computer-vision","display_name":"Computer vision","slug":"computer-vision"},{"id":37,"name":"crypto-trading","display_name":"Crypto trading","slug":"crypto-trading"},{"id":57,"name":"curated-list","display_name":"Curated list","slug":"curated-list"},{"id":54,"name":"data-streaming","display_name":"Data streaming","slug":"data-streaming"},{"id":35,"name":"data-visualization","display_name":"Data visualization","slug":"data-visualization"},{"id":16,"name":"database-backup","display_name":"Database backup","slug":"database-backup"},{"id":49,"name":"design-system","display_name":"Design system","slug":"design-system"},{"id":38,"name":"digital-human","display_name":"Digital human","slug":"digital-human"},{"id":34,"name":"document-processing","display_name":"Document processing","slug":"document-processing"},{"id":44,"name":"ecommerce","display_name":"E-commerce","slug":"ecommerce"},{"id":45,"name":"emulator","display_name":"Emulator","slug":"emulator"},{"id":46,"name":"file-management","display_name":"File management","slug":"file-management"},{"id":32,"name":"fintech","display_name":"Fintech","slug":"fintech"},{"id":31,"name":"game-development","display_name":"Game development","slug":"game-development"},{"id":24,"name":"headless-browser","display_name":"Headless browser","slug":"headless-browser"},{"id":52,"name":"headless-cms","display_name":"Headless CMS","slug":"headless-cms"},{"id":36,"name":"home-automation","display_name":"Home automation","slug":"home-automation"},{"id":20,"name":"image-editing","display_name":"Image editing","slug":"image-editing"},{"id":28,"name":"iot","display_name":"IoT","slug":"iot"},{"id":13,"name":"local-llm","display_name":"Local LLM","slug":"local-llm"},{"id":17,"name":"mcp","display_name":"MCP","slug":"mcp"},{"id":47,"name":"monitoring","display_name":"Monitoring","slug":"monitoring"},{"id":2,"name":"nlp","display_name":"NLP","slug":"nlp"},{"id":26,"name":"observability","display_name":"Observability","slug":"observability"},{"id":40,"name":"pentesting","display_name":"Pentesting","slug":"pentesting"},{"id":48,"name":"programming-examples","display_name":"Programming examples","slug":"programming-examples"},{"id":42,"name":"proxy","display_name":"Proxy","slug":"proxy"},{"id":14,"name":"rag","display_name":"RAG","slug":"rag"},{"id":56,"name":"resume-building","display_name":"Resume building","slug":"resume-building"},{"id":33,"name":"robotics","display_name":"Robotics","slug":"robotics"},{"id":30,"name":"search","display_name":"Search","slug":"search"},{"id":43,"name":"self-hosted","display_name":"Self-hosted","slug":"self-hosted"},{"id":50,"name":"static-analysis","display_name":"Static analysis","slug":"static-analysis"},{"id":18,"name":"synthetic-data","display_name":"Synthetic data","slug":"synthetic-data"},{"id":19,"name":"text-to-speech","display_name":"Text to speech","slug":"text-to-speech"},{"id":53,"name":"ui-components","display_name":"UI components","slug":"ui-components"},{"id":15,"name":"vector-database","display_name":"Vector database","slug":"vector-database"},{"id":21,"name":"video-editing","display_name":"Video editing","slug":"video-editing"},{"id":25,"name":"web-scraping","display_name":"Web scraping","slug":"web-scraping"},{"id":55,"name":"webassembly","display_name":"WebAssembly","slug":"webassembly"},{"id":23,"name":"workflow-automation","display_name":"Workflow automation","slug":"workflow-automation"}]" returns me the "expected json"