https://github.com/pintu544/patient-appointment-system

Implement API endpoints for an out-patient appointment system. Doctors practice on a weekly schedule. API implementation is expected for doctors listing, doctor detail page, availability and appointment booking.
https://github.com/pintu544/patient-appointment-system

Last synced: 24 days ago
JSON representation

Implement API endpoints for an out-patient appointment system. Doctors practice on a weekly schedule. API implementation is expected for doctors listing, doctor detail page, availability and appointment booking.

• Host: GitHub
• URL: https://github.com/pintu544/patient-appointment-system
• Owner: pintu544
• Created: 2024-04-18T10:54:45.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-18T10:59:33.000Z (9 months ago)
• Last Synced: 2024-04-18T12:19:29.764Z (9 months ago)
• Language: JavaScript
• Size: 69.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        


```markdown

# Outpatient Appointment System API

This API provides a system for managing outpatient appointments. Key features include:

* **Doctor Information:** Retrieve doctor listings and detailed profiles.

* **Availability Checking:** Find available appointment slots for doctors, with optional filtering by date and duration.

* **Appointment Booking:** Schedule appointments for patients.

## Setup

1. **Clone the repository:**

  ```bash

  git clone (https://github.com/pintu544/patient-appointment-system)

  ```

2. **Install dependencies:**

  ```bash

  npm  install 

  ```

3. **Run :**

  ```bash

 npm start

  ```

4. **Start the development server:**

  ```bash

  python manage.py runserver

  ```

## API Endpoints

* **GET /doctors/**

   * Retrieves a list of doctors (name, specialty, location).

* **GET /doctors//**  

   * Retrieves details about a specific doctor (name, specialty, location, bio).

* **GET /doctors//availability**

   * Retrieves available appointment slots for a doctor.

      * Optional query parameters:

          * `date` (YYYY-MM-DD): Filter by date.

          * `duration` (minutes): Filter slots by appointment duration.

* **POST /api/appointments/** 

   *  Books an appointment.

      *  **Payload:**

           ```json

           {

               "doctor": ,  

               "patient_name": "Patient Name",

               "patient_contact": "[email address removed]",

               "start_time": "YYYY-MM-DDTHH:MM:SSZ" 

           }

           ```

## Authentication (optional)

* Describe the authentication method (if any) used in your API, for instance, Basic Auth or token-based authentication.

## Error Handling

*   Provide a brief overview of how errors are represented in API responses (e.g., HTTP status codes, specific error message structures).