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

Features

• R1 - Doctor Registration
• R2 - List of Doctors
• R3 - Doctor Update
• R4 - Doctor Exclusion
• R5 - Patient Registration
• R6 - List of Patients
• R7 - Patient Update
• R8 - Patient Exclusion
• R9 - Consultation Scheduling
• R10 - Consultation Cancellation

API Documentation

/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)
    } 
}

• Responses:

Code	Description
200	Successful operation
400	Validation Error

GET - [/api/v1.0/doctors] - Get a list of doctors

• Response Body Example:

{
    "content": [
        {
            "name": "Test1",
            "email": "test1@gmail.com",
            "crm": "123456",
            "specialty": "ORTHOPEDICS"
        },
        {
            "name": "Test2",
            "email": "test2@gmail.com",
            "crm": "789101",
            "specialty": "ORTHOPEDICS"
        },
        {
            "name": "Test3",
            "email": "test3@gmail.com",
            "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 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

PUT - [/api/v1.0/doctors] - Updates a 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),
    } 
}

• Responses:

Code	Description
200	Successful operation
400	Validation Error