Skip to content

Latest commit

 

History

History
152 lines (114 loc) · 5 KB

README.md

File metadata and controls

152 lines (114 loc) · 5 KB
Raw

TL;Dr.

TL;Dr. is a web application that helps summarize doctor notes to improve the patient handoff process, and to make discharge summaries more accessible to patients.


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Acknowledgments

About The Project

Screenshot

TL;Dr. reduces medical error that occurs at handoff and discharge stages of patient care. It does this by standardizing and automating the reporting procedure to provide higher quality communication from doctor-to-doctor and doctor-to-patient.

We use OpenAI's GPT-3 to summarize lengthy handoff notes into a standard format called IPASS. This is useful for hospitalists who usually work 7 on 7 off shifts: working with patients for a week before passing them to another hospitalist.

Another source of medical error is after hospital treatment, when a patient fails to properly read the discharge summary which may explain how to conduct check-ups after surgery, important things to avoid, and when to next call their doctor. This is because the summaries usually contain medical jargon and can be difficult for non-native English speakers. So, we use GPT-3's summarization and translation features to allow outpatients to better understand their discharge summaries.

Our project was awarded First Place in the Patient Safety Challenge sponsored by the Pittsburgh Regional Health Initiative at HackMIT.

Built With

React TypeScript Express MongoDB Python FastAPI OpenAI

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

Ensure that node, npm, and python are installed.

Installation

  1. Clone the repository. 
    git clone https://github.com/uyxela/hackmit2022.git
  2. Run the following command from the root directory. 
    # On Windows machines
start setup.bat

# On Mac/Linux machines
./setup.sh
  3. Run the following command from ./api/python. 
    pip install -r requirements.txt
  4. Enter the values in ./api/ts/.env. 
    MONGODB_URI=
JWT_SECRET=
OPENAI_API_KEY=
PYTHON_API_URL=
MAILER_PORT=
MAILER_HOST=
MAILER_USER=
MAILER_PASS=

Usage

To start the app, run the following command from the root directory.

npm run dev

Alternatively, the following commands can be used to run each of the services separately.

# Start the frontend
npm run app

# Start the Express backend
npm run ts

# Start the Python backend
npm run py

Contributing

If you have a suggestion that would make this better, please fork the repository and create a pull request. Don't forget to give the project a star!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

Thanks to the following people who helped greatly during the development of this project:

  • Isaac Chua
  • Cheralyn Johnson

(back to top)