Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chgl/magnifhir

Basic Patient resource browser to provide visibility into your FHIR servers.
https://github.com/chgl/magnifhir

blazor blazor-server ehr electronic-health-record fhir healthcare

Last synced: 2 months ago
JSON representation

Basic Patient resource browser to provide visibility into your FHIR servers.

Host: GitHub
URL: https://github.com/chgl/magnifhir
Owner: chgl
License: apache-2.0
Created: 2022-07-30T20:05:36.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-04-16T10:01:05.000Z (9 months ago)
Last Synced: 2024-04-16T13:45:41.130Z (9 months ago)
Topics: blazor, blazor-server, ehr, electronic-health-record, fhir, healthcare
Language: HTML
Homepage:
Size: 1.41 MB
Stars: 5
Watchers: 1
Forks: 0
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

# magniFHIR

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/chgl/magniFHIR/badge)](https://api.securityscorecards.dev/projects/github.com/chgl/magniFHIR)
[![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)

Visibility into your FHIR server.

## Running

```sh
docker run --rm -it -p 8080:8080 \
-e FhirServers__0__Name="HAPI FHIR Test Server" \
-e FhirServers__0__BaseUrl="https://hapi.fhir.org/baseR4" \
ghcr.io/chgl/magnifhir:v1.5.2
```

Open in your browser, select the `HAPI FHIR Test Server` in the server selection and click on `Patient Browser` in the left-hand menu.

## Screenshots

![Screenshot showing the server selection](/docs/img/screenshots/server-selection.png "Configure multiple FHIR servers to connect to")

![Screenshot showing the patient browser](/docs/img/screenshots/patient-browser.png "List all Patient resources stored in the server")

![Screenshot showing the patient record conditions tab](/docs/img/screenshots/patient-record-conditions.png "See a Patient's Condition resources")

![Screenshot showing the patient record observations tab](/docs/img/screenshots/patient-record-observations.png "See a Patient's Observation resources")

## Configuration

Multiple FHIR servers can be configured including support for basic authentication.
You can use environment variables to set each entry in the `FhirServers` key, as done above,
or mount a file called `appsettings.Production.json` inside the container as `/opt/magnifhir/appsettings.Production.json`.

The basic structure and available configuration options is shown here:

```json
{
"FhirServers": [
{
"Name": "HAPI FHIR JPA Server",
"BaseUrl": "http://hapi-fhir-server.127.0.0.1.nip.io/fhir"
},
{
"Name": "Linux4Health FHIR Server (empty)",
"BaseUrl": "http://l4h-fhir-server.127.0.0.1.nip.io/fhir-server/api/v4",
"Auth": {
"Basic": {
"Username": "fhiruser",
"Password": "change-user-password"
}
}
}
]
}
```

## Customizing Resource Browsers

> **Warning**
> This is an experimental feature. No guarantees that there won't be changes to the default
> resource tables or the way data is displayed.

It is possible to customize the tables displaying FHIR resources in the `Patient Record` view.
This allows changing the type of resources displayed and the path within each resource to show as a column in the table.
See the `ResourceBrowsers` key in [appsettings.json](./src/magniFHIR/appsettings.json) for the defaults.

It's easiest to define a custom `appsettings.Production.json` and mount it inside the container.
See the [configuration section](#configuration) above.

## Development

### Docker Compose

Start all prerequisite services for development by running:

```sh
docker compose -f hack/compose.yaml --profile=l4h --profile=azure up
```

This will start three FHIR servers and their corresponding databases. The servers are running behind Traefik as a
reverse proxy to provide nice URLs that are resolved to `localhost`:

| Type | Base URL |
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [HAPI FHIR JPA Server Starter](https://github.com/hapifhir/hapi-fhir-jpaserver-starter) | |
| [Linux4Health FHIR Server](https://github.com/LinuxForHealth/FHIR) | |
| [FHIR Server for Azure](https://github.com/microsoft/fhir-server) | |

The HAPI FHIR JPA Server is pre-filled with sample Synthea data. To only start the HAPI FHIR server, you can remove the `--profile=l4h --profile=azure` flags
from the `docker compose` invocation.

Install the packages and launch the server in [Hot-Reload mode](https://docs.microsoft.com/en-us/aspnet/core/test/hot-reload?view=aspnetcore-6.0):

```sh
dotnet restore
dotnet watch --project=src/magniFHIR
```

### Kubernetes (KinD)

Prerequisites:

- [KinD](https://kind.sigs.k8s.io/)
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
- [Kustomize](https://kustomize.io/)
- [Skaffold](https://skaffold.dev/)
- [Helm](https://helm.sh/)

Create a cluster for testing using KinD:

```sh
kind create cluster --name=magnifhir-dev
```

Build the container image and deploy to the cluster in development mode:

```sh
skaffold dev
```

This includes a HAPI FHIR server deployed via Helm and the same set of sample data as used
by the Docker Compose setup.

Skaffold is used to re-build the container image whenever the source code changes, deploy the HAPI FHIR server as a test-dependency, and also build and deploy the job used to load sample data into the server. See [skaffold.yaml](./skaffold.yaml) and the contents of the `hack/k8s` directory for details.