Next-gen EHS 💉

I. Introduction

This is the course project for CSCI-410. We built a platform that allows easy and secure storage and retrieval of medical records for both the patients🤕 and the doctors👨🏻‍⚕️.

With personal information and medical records digitized, we can provide a smooth workflow among departments and people that the needed information will be delivered to the right person and new information will be collected automatically to form a new record entry.

At the bottom level, all the account information and record data are encrypted. We will also implement an access control mechanism to ensure certain information is only visible to specific user groups.

Ⅱ. Prerequisites

Before getting started you should have the following installed and running:

Yarn - instructions
Vue CLI 3 - instructions
Python 3 - instructions
Anaconda - instructions

Ⅲ. Setup Codebase

Step 1 : Clone the repo to local machine

$ git clone https://github.com/Boyan-Org/full-stack-integration
$ cd full-stack-integration

Step 2 : Install JavaScript dependencies

$ yarn install

Step 3 : Initialize python virtual environment (why?)

$ conda create -n venv
$ conda activate venv

Step 4 : Install Python dependencies

$ pip install -r requirement.txt

Step 5 : Initialize sqlite database

$ python manage.py migrate

To inspect sqlite database from GUI, install Sqlite Browser

Ⅳ. Running Development Servers

Step 1 : Run Django server

$ python manage.py runserver

The Django API and static files will be served from localhost:8000.

Step 2 : Run Vue.js server (in another tab)

$ yarn serve

The Vue application will be served from localhost:8080

Ⅴ. Run Unit Test

We have a series of unit test to help our develop procedure. The way to call test is:

$ python manage.py test

Ⅵ. Project Stricture

📂 django-vue-template
- 📄 README.md
- 📄 app.json
- 📂 backend
  - 📂 api
    - 📄 __init__.py
    - 📄 admin.py
    - 📄 apps.py
    - 📄 models.py
    - 📄 serializers.py
    - 📄 tests.py
    - 📄 views.py
  - 📂 settings
    - 📄 __init__.py
    - 📄 dev.py
    - 📄 prod.py
  - 📄 urls.py
  - 📄 wsgi.py
- 📄 database_models.png
- 📄 db.sqlite3
- 📄 manage.py
- 📄 package.json
- 📄 requirements.txt
- 📂 src
  - 📄 App.vue
  - 📂 assets
  - 📂 components
    - 📄 AccountInput.vue
    - 📄 DashInfo.vue
    - 📄 Dashboard.vue
    - 📄 InfoBoard.vue
    - 📄 Interview.vue
    - 📄 ListAppointment.vue
    - 📄 LoginForm.vue
    - 📄 MakeAppointment.vue
    - 📄 Med.vue
    - 📄 Page404.vue
    - 📄 Person.vue
    - 📄 RecordCreate.vue
    - 📄 RecordEdit.vue
    - 📄 RecordFilter.vue
    - 📄 RecordUpload.vue
    - 📄 RecordView.vue
    - 📄 RegForm.vue
    - 📄 Schedule.vue
  - 📄 main.js
  - 📄 router.js
- 📄 vue.config.js

Ⅶ. API Document

1. Login API

PATH:
    `localhost:8000/api/login/`

METHOD: POST

Request Format:

    { username: "frank",
        password: "frank" }

Response Status:

    200: Success
    401: `password` doesn't match the `username`
    404: `username` not found

Response Format:

    { id: 1,
        username: "userfrank",
        password: "frank",
        role    : "patient",
        name    : "Frank Zhou"
    }

2. Register API

PATH:
    `localhost:8000/api/register/`

METHOD: GET

Request Format:

    { username   : "userboyan",
        password: "boyan",
        role    : "patient",
        name    : "Boyan Xu"
        }
    }

Response Status:

    201: Success
    409: `Username` already taken by someone else

3. `personal_information` API

List all personal_information records

PATH:
  `localhost:8000/api/personal_information/`

METHOD: GET

Response Format:
    {
      name       : "userboyan",
      addr       : "Weifan Road 401",
      gender     : "Male",
      email      : "one@nyu.edu",
      dateOfBirth: "1998-03-20",
      marital    : "Single",
      phone      : "17878728172",
    }

Response Status:
            200  : OK
            Other: Buggy

Create a personal_information record

 PATH:
   `localhost:8000/api/personal_information/`

 METHOD: POST

 Request Format:
   {
       id           : "1",
       address      : "Weifang Road 401",
       dateOfBirth  : "1998-03-20"
       email        : "one@nyu.edu",
       gender       : "Male",
       maritalStatus: "Single",
       name         : "Boyan Xu",
       phoneNumber  : "17878728172",
   }

 Response Status:
     201: Created
     400: Creation Failed

Retrieve personal_information record with id=x

PATH:
    localhost:8000/api/personal_info/<int>

METHOD:
      GET

Response Format:
    {
      id           : "1",
      address      : "Weifang Road 401",
      dateOfBirth  : "1998-03-20"
      email        : "one@nyu.edu",
      gender       : "Male",
      maritalStatus: "Single",
      name         : "Boyan Xu",
      phoneNumber  : "17878728172"
  }

Response Status:
    200: OK
    404: Record Not Found

Delete personal_information record with id=x

PATH:
    localhost:8000/api/personal_info/<int>

METHOD: DELETE

Response Status:
            204: Deleted
            404: Not Found

Update personal_information record with id=x

PATH:
    localhost:8000/api/personal_info/<int>

METHOD: PATCH

Request Format: (Each Attribute is optionally given)
{
    id           : "1",
    address      : "Weifang Road 401",
    dateOfBirth  : "1998-03-20"
    email        : "one@nyu.edu",
    gender       : "Male",
    maritalStatus: "Single",
    name         : "Boyan Xu",
    phoneNumber  : "17878728172",
}

Response Format: Same as request payload

Response Status:
            200: OK
            404: Not Found
            400: Update Failed

4. `medical_info` API

List all medical_info records

PATH:
  localhost:8000/api/medical_information/

METHOD: GET

Response Format:
    {
      bloodType      : "A",
      height         : 180,
      weight         : 50,
      allergies      : "None",
      familyHistory  : "None",
      surgicalHistory: "None",
      habits         : "None",
    }

Response Status:
            200  : OK
            Other: Buggy

Create medical_info record

 PATH:
   localhost:8000/api/medical_information/<int>

 METHOD: POST

 Request Format:
     {
       bloodType      : "A",
       height         : 180,
       weight         : 50,
       allergies      : "None",
       familyHistory  : "None",
       surgicalHistory: "None",
       habits         : "None",
     }

 Response Status:
     201: Created
     400: Creation Failed

Retrieve medical_info record with id=x

PATH:
  localhost:8000/api/medical_information/<int>

METHOD:
      GET

Response Format:
    {
      bloodType      : "A",
      height         : 180,
      weight         : 50,
      allergies      : "None",
      familyHistory  : "None",
      surgicalHistory: "None",
      habits         : "None",
    }

Response Status:
    200: OK
    404: Record Not Found

Delete medical_info record with id=x

PATH:
  localhost:8000/api/medical_information/<int>

METHOD: DELETE

Response Status:
            204: Deleted
            404: Not Found

Update medical_info record with id=x

PATH:
  localhost:8000/api/medical_information/<int>

METHOD: PATCH

Request Format: (Attributes are optionally given)
    {
      bloodType      : "A",
      height         : 180,
      weight         : 50,
      allergies      : "None",
      familyHistory  : "None",
      surgicalHistory: "None",
      habits         : "None",
    }

Response Format: Same as request payload

Response Status:
            200: OK
            404: Not Found
            400: Update Failed

5. `medical_record`

List all medical_record records

PATH:
  localhost:8000/api/medical_record/

METHOD: GET

Response Format:
    {
      bloodType      : "A",
      height         : 180,
      weight         : 50,
      allergies      : "None",
      familyHistory  : "None",
      surgicalHistory: "None",
      habits         : "None",
    }

Response Status:
            200  : OK
            Other: Buggy

Create a medical_record record

 PATH:
   localhost:8000/api/medical_record/<int>

 METHOD: POST

 Request Format:
     {
       bloodType      : "A",
       height         : 180,
       weight         : 50,
       allergies      : "None",
       familyHistory  : "None",
       surgicalHistory: "None",
       habits         : "None",
     }

 Response Status:
     201: Created
     400: Creation Failed

Retrieve medical_record record with id=x

PATH:
  localhost:8000/api/medical_record/<int>

METHOD:
      GET

Response Format:
        {
          recordID        : 1,
          patient_id      : 1,
          patient_name    : "Frank",
          doctor_id       : 1
          doctor_name     : "Boyan",
          symptoms        : "Headache",
          treatments      : "Sleep more",
          diagnosis       : "神经衰弱",
          department      : "神经内科",
          patient_birthday: "1998-02-12",
          patient_gender  : "Male",
          dateTime        : "2020-12-21",
          attachmentNb    : "2",
          flag            : false,
        }

Response Status:
    200: OK
    404: Record Not Found

Delete medical_record record with id=x

PATH:
  localhost:8000/api/medical_record/<int>

METHOD: DELETE

Response Status:
            204: Deleted
            404: Not Found

Update medical_record record with id=x

PATH:
  localhost:8000/api/medical_record/<int>

METHOD: PATCH

Request Format: (Attributes are optionally given)
        {
          recordID        : 1,
          patient_id      : 1,
          patient_name    : "Frank",
          doctor_id       : 1
          doctor_name     : "Boyan",
          symptoms        : "Headache",
          treatments      : "Sleep more",
          diagnosis       : "神经衰弱",
          department      : "神经内科",
          patient_birthday: "1998-02-12",
          patient_gender  : "Male",
          dateTime        : "2020-12-21",
          attachmentNb    : "2",
          flag            : false,
        }

Response Format: Same as request payload

Response Status:
            200: OK
            404: Not Found
            400: Update Failed

Filter medical_record record with given condition

PATH:
    localhost/api/medical_record/filter_record/

Method: POST

Request JSON:
    {
        filter_entry: value
    }

Response JSON:
    {
      record_data: [
          {
            dateTime    : "2020-11-29T00:17:34",
            department  : "dept1",
            doctor_name : "Boyan Xu",
            patient_name: "Frank Zhou",
            recordID    : 1
          },],
      record_num: 1
    }

6. `department_information` API

List all department_information records

PATH:
  localhost:8000/api/department_information/

METHOD: GET

Request Format:
      {
        department        : "神经内科",
        supervisor      : 1,
        workingHour    : [[0,1],[0,0],[1,0],[1,1],[1,1],[0,0],[0,1]]
      }

Response Status:
            200  : OK
            Other: Buggy

Create a department_information record

 PATH:
   localhost:8000/api/department_information/<int>

 METHOD: POST

 Request Format:
       {
         department        : "神经内科",
         supervisor      : 1,
         workingHour    : [[0,1],[0,0],[1,0],[1,1],[1,1],[0,0],[0,1]]
       }

 Response Status:
     201: Created
     400: Creation Failed

Retrieve department_information record with id=x

PATH:
  localhost:8000/api/department_information/<int>

METHOD:
      GET

Response Format:
      {
        department        : "神经内科",
        supervisor      : 1,
        workingHour    : [[0,1],[0,0],[1,0],[1,1],[1,1],[0,0],[0,1]]
      }

Response Status:
    200: OK
    404: Record Not Found

Delete department_information record with id=x

PATH:
  localhost:8000/api/department_information/<int>

METHOD: DELETE

Response Status:
            204: Deleted
            404: Not Found

Update department_information record with id=x

PATH:
  localhost:8000/api/department_information/<int>

METHOD: PATCH

Request Format: (Attributes are optionally given)
      {
        department        : "神经内科",
        supervisor      : 1,
        workingHour    : [[0,1],[0,0],[1,0],[1,1],[1,1],[0,0],[0,1]]
      }

Response Format: Same as request payload

Response Status:
            200: OK
            404: Not Found
            400: Update Failed

7. `Appointment` API

List all appointment records

PATH:
  localhost:8000/api/appointment/

METHOD: GET

Request Format:
      {
        date      : "2020-11-29",
        time      : "morning",
        submitTime: "2020-11-28T22:00:00",
        doctor    : 2,
        patient   : 1
      }

Response Status:
            200  : OK
            Other: Buggy

Create a appointment record

 PATH:
   localhost:8000/api/appointment/<int>

 METHOD: POST

 Request Format:
       {
         date      : "2020-11-29",
         time      : "morning",
         submitTime: "2020-11-28T22:00:00",
         doctor    : 2,
         patient   : 1
       }

 Response Status:
     406: Data not acceptable
     409: condition not satisfied (check response.data["error"])
     201: Created

Retrieve appointment record with id=x

PATH:
  localhost:8000/api/appointment/<int>

METHOD:
      GET

Response Format:
      {
        date      : "2020-11-29",
        time      : "morning",
        submitTime: "2020-11-28T22:00:00",
        doctor    : 2,
        patient   : 1
      }

Response Status:
    200: OK
    404: Record Not Found

Delete appointment record with id=x

PATH:
  localhost:8000/api/appointment/<int>

METHOD: DELETE

Response Status:
            204: Deleted
            404: Not Found

Update appointment record with id=x

PATH:
  localhost:8000/api/appointment/<int>

METHOD: PATCH

Request Format: (Attributes are optionally given)
      {
        date      : "2020-11-29",
        time      : "morning",
        submitTime: "2020-11-28T22:00:00",
        doctor    : 2,
        patient   : 1
      }

Response Format: Same as request payload

Response Status:
            200: OK
            404: Not Found
            400: Update Failed

Filter appointment record with given condition

PATH:
    localhost/api/appointment/filter_record/

Method: POST

Request JSON:
    {
        filter_entry1: value,
        filter_entry2: value,
        ...
    }

Response JSON:
    {
      record_data: [
          {
            dateTime    : "2020-11-29T00:17:34",
            department  : "dept1",
            doctor_name : "Boyan Xu",
            patient_name: "Frank Zhou",
            recordID    : 1
          },],
      record_num: 1
    }

Get available slot

The slot is available if and only if:

The doctor works at that slot
There are less than 10 people book the slot with the doctor
The patient has not booked the slot with the doctor

PATH:
    localhost/api/appointment/get_available_slots/

Method: POST

Request JSON:
    {
        patient_id: 1,
    }

Response JSON:
    {
        dates: [
            "2020-12-14",
            "2020-12-11",
            "2020-12-07",
            "2020-12-17",
            "2020-12-04",
            "2020-12-13",
            "2020-12-10",
            "2020-12-09",
            "2020-12-06",
            "2020-12-16"
        ],
        dept_names: [
            "dept2",
            "dept1"
        ],
        doctor_names: [
            "Hellen Wang",
            "Boyan Xu"
        ],
        slots: [
            {
                date: "2020-12-04",
                department: "dept1",
                doctor_id: 2,
                doctor_name: "Boyan Xu",
                time: "morning"
            },
            {
                date: "2020-12-17",
                department: "dept1",
                doctor_id: 2,
                doctor_name: "Boyan Xu",
                time: "afternoon"
            },
            ...,
        ],
        times: [
            "morning",
            "afternoon"
        ]
    }

yjl450/full-stack-integration