search

FHIR / fhir-candle

fhir-candle - A FHIR development and test server implemented in C#
MIT License
4 stars 0 forks source link
csharp developer-tools development-environment fhir fhir-server hl7 testing-tools

readme

fhir-candle

Tests Publish dotnet tool Publish Docker image to ghcr.io Deploy to `argo.run`

When you need a small FHIR.

fhir-candle is a small in-memory FHIR server that can be used for testing and development. It is NOT intended to be used for production workloads.

The project is intended to serve as a platform for rapid development and testing for FHIR - both for features in the core specification as well as Implementation Guide development.

While there are many existing OSS FHIR servers, somewhere between most and all of them are intended to support production workloads. In my own work on Reference Implementations, I often found it challenging to add the types of features I wanted due to the conflicts that causes. To that end, here are some principles I generally use while developing this project:

FHIR Foundation Project Statement

Contributing

There are many ways to contribute:

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Security

To report a security issue, please use the GitHub Security Advisory "Report a Vulnerability" tab.

For more information, please see the Security Readme.

Documentation

Get Started with .Net

Install .NET 8 or newer and run this command:

dotnet tool install --global fhir-candle

Note that this software is still under heavy development.

Start a FHIR server and open the browser by running:

fhir-candle -o

Get Started with Docker

Install Docker and run these commands:

docker pull ghcr.io/fhir/fhir-candle:latest
docker run -p 8080:5826 ghcr.io/fhir/fhir-candle:latest

This will run the docker image with the default configuration, mapping port 5826 from the container to port 8080 in the host. Once running, you can access http://localhost:8080/ in the browser to access the fhir-candle's UI or access the default endpoints:

Note that additional arguments can be passed directly via the docker run command. For example, to run the server with only an R4 endpoint named 'test':

docker run -p 8080:5826 ghcr.io/fhir/fhir-candle:latest --r4 test

Get Started via cloning this repository

To run the default server from the command line:

dotnet run --project src/fhir-candle/fhir-candle.csproj

To pass arguments when using dotnet run, add an extra --. For example, to see help:

dotnet run --project src/fhir-candle/fhir-candle.csproj -- --help

To build a release version of the project:

dotnet build src/fhir-candle/fhir-candle.csproj -c Release

The output of the release build can be run (from the root directory of the repo)

FHIR Tenants

By default, this software loads three FHIR 'tenants':

The tenants can be controlled by command line arguments - note that manually specifying any tenants overrides the default configuration and will only load the ones specified. To load only an R4 endpoint at 'fhir', the arguments would include --r4 fhir. You can specify multiple tenants for the same version, for example --r5 fhir --r5 also-fhir will create two endpoints.

Loading Initial Data

The server will load initial data specified by the --fhir-source argument. If the path specified is a relative path, the software will look for the directory starting at the current running path.

If the system is loading multiple tenants, it will check the path for additional directories based on the tenant names. For example, a path like fhirData passed into the default server will look for fhirData/r4, fhirData/r4b, and fhirData/r5. If tenant directories are not found, all tenants will try to load resources from the specified path.

Subscriptions Reference Implementation

This project also contains the reference stack for FHIR Subscriptions. To use the default landing page of the subscriptions RI, the following command can be used:

fhir-candle --reference-implementation subscriptions --load-package hl7.fhir.uv.subscriptions-backport#1.1.0 --load-examples false --protect-source true -m 1000

Using OpenTelemetry

OpenTelemetry instrumentation can be enabled via either the --otel-otlp-endpoint argument or the OTEL_EXPORTER_OTLP_ENDPOINT environment variable. For example, to send traces to a Jaeger instance running on localhost:4317: fhir-candle -o --otel-otlp-endpoint http://localhost:4317.

For local testing, you can run a Jaeger instance in Docker with the following command:

docker run --rm --name jaeger -p 4317:4317 -p 4318:4318 -p 5778:5778 -p 16686:16686 -p 14250:14250 jaegertracing/all-in-one:latest

To-Do

Note: items are unsorted within their priorities

High priority

Mid Priority

The long tail

More Information

FHIR® is the registered trademark of HL7 and is used with the permission of HL7.