Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ir4y committed May 14, 2024
1 parent bf6cd05 commit 867fe5a
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 37 deletions.
58 changes: 27 additions & 31 deletions docs/Welcome/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,35 @@
sidebar_position: 2
---


# Features

## Medical Records
- Patient demographics
- Medical history
- Medical encounters
- Appointment and Encounters (visits management, scheduling)
- Electronic Medical Records
- based on Questionnaire and QuestionnaireResponse resources
- Questionnaire population, initial and calculated expressions
- extraction FHIR data from QuestionnaireResponse on save
- EMR Questionnaire form builder
- HealthcareService management
- Invoice management
- Medication management
- Warehouse management
- Prescriptions management
- Patient medical information
- Patients management
- Practitioners management
- Role-based functionality (Admin, Receptionist, Practitioner, Patient)
- Telemedicine
- Treatment notes
- Active conditions
- Diagnoses
- Medications
- Immunization dates
- Allergies
- Vital signs
- Lab results

## Scheduling
- Appointments Booking
- Clinicians availability management

## Patient Portal
- Access to all Medical Records
- Ability to provide health information
- Integrated wearables data tracking
- Managing access for your Health Records
- Web and Mobile platforms supported

## Consent Management

## Telehealth
# Benefits

## Clinical Forms Management tools
- Clinician-friendly

- AI-powered tool to creating forms by description

- Advanced tool to design sophisticated logic for tech-savvy users
- Fully FHIR compatible:
- all app data are stored as FHIR resources
- any app data are available via FHIR API
- Extremely flexible:
- use extensions and profiles to adjust FHIR data model
- Fast to build forms and CRUD
- all forms in the app are just Questionnaire resources
- Build the app with no-code
- app provides UI Questionnaire builder for creating Questionnaires
102 changes: 96 additions & 6 deletions docs/Welcome/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,102 @@ sidebar_position: 1

[![beda-emr-logo](https://user-images.githubusercontent.com/6428960/222070888-a97e2d97-7eb0-4cb3-8310-5fdb7b56aa10.svg)](https://beda.software/emr)

__Project Status__: _development_
### Design
EMR design is open source and publicly available ->
[Figma](https://www.figma.com/file/2bxMDfG3lRPEZpRwDC4gTB/SaaS-EMR-System)

__Promo web page__: [beda.software/emr](https://beda.software/emr)
### Demo
The easiest way to check the system is our publicly availabe demo imstalation: [emr.beda.software](https://emr.beda.software/)
[This YouTube playlist](https://www.youtube.com/watch?v=k1qDO8qBPWw&list=PLrnm9AbXp-mhg1_26EGBxBjtTd6j-M7rt) contains all basic scenarios, you can try all of them in the demo environment.

__Design__: [Figma](https://www.figma.com/file/2bxMDfG3lRPEZpRwDC4gTB/SaaS-EMR-System)

You can start by reviewing the source code on [GitHub]([https://github.com/beda-software/fhir-emr](https://github.com/beda-software/fhir-emr#installation))
Or you can watch video demos of Beda EMR features on [YouTube](https://www.youtube.com/watch?v=k1qDO8qBPWw&list=PLrnm9AbXp-mhg1_26EGBxBjtTd6j-M7rt)
and play with sandbox environment [emr.beda.software](https://emr.beda.software)

## License
The EMR source code is licensed by [MIT License](https://github.com/beda-software/fhir-sdc/blob/master/LICENSE).

## FHIR Backend
Beda EMR is a frontend. It is a user interfcae that requre a FHIR server to store medical data.
For both developemnt and production environments we are using Aidbox FHIR Server.
It is a primary backend platform for Beda EMR.
You can get a free Aidbox trial license to run the application locally.
You need by Aidbox license for any production installation or installation that manages PHI data.
[Here](https://docs.aidbox.app/getting-started/editions-and-pricing) you can find more information about Aidbox licensing.
Obviously, you can try any other FHIR server. All core features just need FHIR API.
However you have to adjust some parts of the application that is not covered in the FHIR specification and wher we use Aidbox API.

## Installation

### Setup env variables

```
cp .env.tpl .env
# Get aidbox license at https://aidbox.app/ and place licence JWT to .env
```

### Local setup

#### Video calls local setup
Before you start you need to set up your own Jitsi Meet video instance. See this [guide from Jitsi](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker/)

Also, you need to configure JWT authentication on the video server side. See this [guide](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker/#authentication-using-jwt-tokens)

**Important note**: We use react component to represent the video call frame from [jitsi-meet-react-sdk](https://github.com/jitsi/jitsi-meet-react-sdk/tree/main). This component requires HTTPS schema for the Jitsi server, so you need to publish your server with this requirement

In the EMR folder add these variables to `.env` file with values you generated on the video server side:

```
# Application identifier
JWT_APP_ID=
JWT_APP_SECRET=
JWT_ACCEPTED_ISSUERS=
JWT_ACCEPTED_AUDIENCES=
```

To run EMR with our Jitsi authentication backend service run:
`make up-video`

#### Prepare frontend configuration

```
cp shared/src/config.local.ts shared/src/config.ts
```

This file (`shared/src/config.ts`) is ignored by git. So, feel free to change it.

```sh
yarn
yarn compile
```

#### Docker
You need to set up docker to run Aidbox, SDC, and other microservices. https://docker.com/
Once you get docker installed in your local machine, you can run all project dependencies
```sh
make build-seeds
make up
```
The first start may take a few minutes since it synchronizes the terminology.

### Start

```sh
yarn start # start watch all workspaces
```

### Test

```sh
yarn test # launch tests for all workspaces
```

## Update seeds

To see the changes that were added to `resources/seeds` follow the next steps

```sh
make seeds
```

## Project History

Started as part of [https://github.com/HealthSamurai/xmas-hackathon-2021](https://github.com/HealthSamurai/xmas-hackathon-2021/issues/13) FHIR EMR evolved into something bigger.

0 comments on commit 867fe5a

Please sign in to comment.