smallEHR

Empowering Technology Learning in Healthcare

Limited purpose Electronic Health Record system.
Used to explore ideas in healthcare technology, and as a teaching tool for those who would like to enter the healthcare tech space.

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

[]

(back to top)

Built With

• Rust
• Diesel
• Axum

(back to top)

Getting Started

To get a local copy up and running follow one of these two sets of example steps.

Local Install

Prerequisites

• rust
  • Install rust following the official documentation
• postgreSQL client an library (libpq)
• mysqlclient (for Diesel CLI)
• sqlite3 (for Diesel CLI)
• diesel_cli crate - follow the docs at https://diesel.rs/guides/getting-started

Installation

1. Clone the repo

   git clone https://github.com/CoderHausTS/smallEHR.git

2. Install crates and get the project ready

   cargo build 

3. Spin up PostgreSQL docker container

   docker compose up

4. Run diesel setup and migrations

   diesel setup

   diesel migration run

5. Run environment script (maybe)

   . ./somescript.sh

6. Build and run

   cargo run -- run

Using docker compose

Prerequisites

1. Install docker.

Installation

1. Clone the repo

   git clone https://github.com/CoderHausTS/smallEHR.git

2. Start up the docker containers

   docker compose up

Post install

1. Import data Use synthetic data if you are testing. A good resource is Mitre Synthea
2. Use the data cleaning scripts in file_utils to clean and prep your data for the schema.
3. Either import via your fav CLI tool, or use the built in import commands such as

    cargo run -- import csv patients "file_location"

(back to top)

Usage

To run the server side, simply build and feed run to the executable, or build the project and do the same sh cargo run -- run

(back to top)

Roadmap

• Import/export data functionality
• RESTful APIs
• User/Roles
  • Authorization/authentication
• Front end
• FHIR integration

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Project Link: https://github.com/CoderHausTS/smallEHR

(back to top)

Acknowledgments

(back to top)