fasten-onprem/README.md

128 lines
6.5 KiB
Markdown
Raw Normal View History

2022-10-13 09:44:14 -06:00
<p align="center">
<a href="https://github.com/fastenhealth/fasten-onprem">
<img width="400" alt="fasten_view" src="frontend/src/assets/banner/banner.png">
</a>
</p>
2022-09-26 19:54:54 -06:00
# Fasten - On Premise/Self-Hosted
2022-08-22 18:51:46 -06:00
2022-10-13 23:21:11 -06:00
[![CI](https://github.com/fastenhealth/fasten-onprem/actions/workflows/ci.yaml/badge.svg)](https://github.com/fastenhealth/fasten-onprem/actions/workflows/ci.yaml)
[![codecov](https://codecov.io/gh/fastenhealth/fasten-onprem/branch/main/graph/badge.svg?token=6O0ZUABEHT&style=flat-square)](https://codecov.io/gh/fastenhealth/fasten-onprem)
2022-10-13 10:17:28 -06:00
[![GitHub license](https://img.shields.io/github/license/fastenhealth/fasten-onprem?style=flat-square)](https://github.com/fastenhealth/fasten-onprem/blob/main/LICENSE.md)
2022-10-13 23:26:17 -06:00
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/fastenhealth/fasten-onprem?style=flat-square)](https://github.com/fastenhealth/fasten-onprem/releases/latest)
2022-10-13 23:27:12 -06:00
[![Discord Join](https://img.shields.io/badge/discord-join-blueviolet?style=flat-square&logo=discord)](https://discord.gg/Bykz6BAN8p)
2023-03-10 21:06:37 -07:00
[![Request Providers](https://img.shields.io/static/v1?label=request+providers&message=form&color=orange&style=flat-square)](https://forms.gle/4oU8372y4KyM8DbdA)
[![Join Mailing List](https://img.shields.io/static/v1?label=join&message=mailing+list&color=blue&style=flat-square)](https://forms.gle/SNsYX9BNMXB6TuTw6)
[![GitHub Sponsors](https://img.shields.io/github/sponsors/analogj?style=flat-square)](https://github.com/sponsors/AnalogJ/)
2022-10-13 09:44:14 -06:00
**Fasten securely connects your healthcare providers together, creating a personal health record that never leaves your hands**
2023-04-17 09:33:54 -06:00
> NOTE: Fasten is a Work-in-Progress and can only communicate with a limited number of Healthcare Instutions (approx 10,000 at last count).
2022-10-13 23:20:28 -06:00
> Please fill out this [Google Form](https://forms.gle/SNsYX9BNMXB6TuTw6) if you'd like to be kept up-to-date on Fasten
2022-10-13 09:44:14 -06:00
# Introduction
Like many of you, I've worked for many companies over my career. In that time, I've had multiple health, vision and dental
insurance providers, and visited many different clinics, hospitals and labs to get procedures & tests done.
Recently I had a semi-serious medical issue, and I realized that my medical history (and the medical history of my family members)
is a lot more complicated than I realized and distributed across the many healthcare providers I've used over the years.
I wanted a single (private) location to store our medical records, and I just couldn't find any software that worked as I'd like:
- self-hosted/offline - this is my medical history, I'm not willing to give it to some random multi-national corporation to data-mine and sell
- It should aggregate my data from multiple healthcare providers (insurance companies, hospital networks, clinics, labs) across multiple industries (vision, dental, medical) -- all in one dashboard
- automatic - it should pull my EMR (electronic medical record) directly from my insurance provider/clinic/hospital network - I dont want to scan/OCR physical documents (unless I have to)
- open source - the code should be available for contributions & auditing
So, I built it
**Fasten is an open-source, self-hosted, personal/family electronic medical record aggregator, designed to integrate with 1000's of insurances/hospitals/clinics**
Here's a couple of screenshots that'll give you an idea of what it looks like:
2022-10-13 18:27:35 -06:00
<p align="center">
<a href="https://imgur.com/a/vfgojBD">
<img alt="fasten_view" src="https://i.imgur.com/UaZyEbN.png">
</a>
<br/>
<a href="https://imgur.com/a/vfgojBD">See more Fasten screenshots</a>
</p>
2022-10-13 09:44:14 -06:00
# Features
It's pretty basic right now, but it's designed with a easily extensible core around a solid foundation:
- Self-hosted
- Designed for families, not Clinics (unlike OpenEMR and other popular EMR systems)
- Supports the Medical industry's (semi-standard) FHIR protocol
- Uses OAuth2 (Smart-on-FHIR) authentication (no passwords necessary)
- Uses OAuth's `offline_access` scope (where possible) to automatically pull changes/updates
- Multi-user support for household/family use
- (Future) Dashboards & tracking for diagnostic tests
- (Future) Integration with smart-devices & wearables
# Getting Started
There are 2 flavors of Fasten:
- `ghcr.io/fastenhealth/fasten-onprem:sandbox` - This version only allows you to connect to a handful of Healthcare providers, using Sandbox accounts that are meant for testing, and contain synthetic(fake) data to give you an idea what Fasten will look like, without requiring personal medical information.
- `ghcr.io/fastenhealth/fasten-onprem:main` - This version allows you to connect to 650+ different Healthcare providers, using your existing accounts. It will allow you to connect and retrieve your personal electronic medical record and store it within Fasten. **Be careful, this is YOUR health data**
2022-10-13 09:44:14 -06:00
## Instructions
Run the following commands to download and start the Fasten docker container.
```
docker pull ghcr.io/fastenhealth/fasten-onprem:main
docker run --rm -p 9090:8080 ghcr.io/fastenhealth/fasten-onprem:main
```
Next, open a browser to `http://localhost:9090`
At this point you'll be redirected to the login page.
### Logging In
Before you can use the Fasten BETA, you'll need to [Create an Account](http://localhost:9090/web/auth/signup).
It can be as simple as
- **Username:** `testuser`
- **Password:** `testuser`
## Usage
If you're using the `sandbox` version of Fasten, you'll only be able to connect to Sources using test credentials
https://github.com/fastenhealth/docs/blob/main/BETA.md#connecting-a-new-source
2022-10-13 09:44:14 -06:00
# FAQ's
See [FAQs](https://github.com/fastenhealth/docs/blob/main/FAQs.md) for common questions (& answers) regarding Fasten
# Contributing
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for instructions for how to develop and contribute to the Fasten codebase.
Work your magic and then submit a pull request. We love pull requests!
If you find the documentation lacking, help us out and update this README.md. If you don't have the time to work on Fasten, but found something we should know about, please submit an issue.
# Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
# Authors
Jason Kulatunga - Initial Development - @AnalogJ
# Licenses
- GPLv3
2022-08-22 18:51:46 -06:00
2022-10-13 09:44:14 -06:00
# Sponsors
2022-08-22 18:51:46 -06:00
2022-10-13 09:44:14 -06:00
Fasten is only possible with the help of my [Github Sponsors](https://github.com/sponsors/AnalogJ/) and Reddit supporters!
I'd also like to thank the following Corporate Sponsors:
<a href="https://depot.dev/"><img src="https://raw.githubusercontent.com/fastenhealth/docs/main/img/sponsors/depot.png" height="100px" /></a>