Skip to content

HealthPixel/healthpixel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

371 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HealthPixel

HealthPixel is a web application designed to streamline the process of accessing and updating patient medical records. The platform enables healthcare professionals to quickly retrieve a patient’s medical history, update records in real-time, and ensure that patient data remains secure and accessible.

Features

  1. Quick Access to Patient Records Healthcare professionals can quickly access a patient's complete medical history by entering their unique ID into HealthPixel, allowing for informed decision-making without needing the patient to recount their medical history.

  2. Patient Data Privacy HealthPixel prioritizes patient data privacy, ensuring that only authorized healthcare professionals can access medical records. The platform employs secure authentication, and audit logs (in view) to maintain confidentiality.

  3. Updating Patient Records After consultations or treatments, healthcare professionals can easily update patient records with new test results, diagnoses, or treatments. This ensures that the latest medical information is always available for future visits.

  4. Real-Time Patient Access Patients can securely view their medical information in real time through unique, secure links provided by healthcare professionals. This feature eliminates the need for a traditional login interface while maintaining data security.

API Endpoints

HealthPixel offers a set of RESTful API endpoints for managing patient records, user authentication, and data access:

Authentication

  • POST /api/v1/auth/login (Authenticate healthcare professionals.)
  • POST /api/v1/auth/register (Register a new healthcare professional (Admin use).)
  • POST /api/v1/auth/logout (Log out of the system.)

Doctor Management

  • POST /api/v1/register-doctor (Register a new Doctor.)
  • GET /api/v1/doctor/id (Retrieve a Doctor record.)
  • GET /api/v1/doctors (Retrieve Doctors records.)
  • PUT /api/v1/doctor/id (Update a Doctor record.)
  • DELETE /api/v1/doctor/id (Delete a Doctor record.)

Patient Management

  • POST /api/v1/doctor/register-patient (Register a new Patient.)
  • GET /api/v1/patient/id (Retrieve a Patient record.)
  • GET /api/v1/patients (Retrieve Patients records.)
  • PUT /api/v1/patient/id (Update a Patient record.)
  • DELETE /api/v1/doctor/patient/id (Delete a Patient record.)

Installation

Clone the repository:

git clone https://github.com/HealthPixel/healthpixel.git
cd healthpixel

Install dependencies: All dependencies that would be needed by the application are all in the requirement.txt. Use the command below to install them.

pip install -r requirement.txt

Set up the database:

  • You need to have a MySQL server running in your terminal to store the db, If you don't have it you can follow this article to install it. How to install mysql on Ubuntu 20.04 (change the distribution or Ubuntu version to the one you're running)
  • Once your MySQL server is installed and running, you need to make sure root authenticates with a password by using either the mysql_native_password or caching_sha2_password authentication plugin (the article explains how to do that)

Create a MySQL database and configure the connection settings in the env_setup file:

sudo mysql -u root -p < setup_mysql_db.sql
source env_setup

Start the application:

python3 -m api.v1.app

Usage

Once the application is up and running, healthcare professionals can log in using their credentials to access patient records, update information, and manage patient data. Patients can view their records using secure links provided by their healthcare providers.

Authors

  • Samuel Odumu Github / Email - Frontend Development and API Testing
  • Keith Juma Github / Email - Backend and API Development
  • Fortune Iheanacho Github / Email - Backend and Frontend Development

Contributing

We welcome contributions to HealthPixel! Please fork the repository, create a new branch, and submit a pull request with your changes. Make sure to follow our coding guidelines and include tests where applicable.

License

HealthPixel is licensed under the MIT License. See the LICENSE file for more information.

Contact

For questions or support, please open an issue on GitHub or contact us at healthpixelproject@gmail.com.

About

ALX SE Foundations Portfolio Project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •