Awesome

LinuxForHealth FHIR Server

The LinuxForHealth FHIR® Server (formerly the IBM® FHIR® Server) is a modular Java implementation of the HL7 FHIR specification that supports versions R4 and R4B with a focus on performance and configurability.

For a detailed description of FHIR conformance, see https://linuxforhealth.github.io/FHIR/Conformance.

The server is available in the following forms:

• a web application archive (war)
• a zip file with installation script
• a Linux container image from GitHub Packages
• a helm chart registered on ArtifactHub

Running the server

Guides for configuring, operating, and extending the LinuxForHealth FHIR Server are available from https://linuxforhealth.github.io/FHIR/guides/FHIRServerUsersGuide.

From the zip installer

Download the fhir-persistence-schema and fhir-install assets from the Releases tab and follow the instructions from the User's Guide to:

1. Use fhir-persistence-schema-VERSION-cli.jar to deploy the schema.
2. Unzip, install, and configure the server.

From the container image

Quickstart:

docker run -p 9443:9443 -e BOOTSTRAP_DB=true ghcr.io/linuxforhealth/fhir-server

Note:

1. The Docker image ghcr.io/linuxforhealth/fhir-schematool is an early technology preview and is experimental.
2. The Docker image ghcr.io/linuxforhealth/fhir-bucket-tool is an early technology preview and is experimental.
3. The Docker image ghcr.io/linuxforhealth/fhir-term-loader is an early technology preview and is experimental.

From the helm chart

Quickstart:

helm repo add linuxforhealth https://linuxforhealth.github.io/lfh-helm
export POSTGRES_PASSWORD=$(openssl rand -hex 20)
helm upgrade --install --render-subchart-notes fhir-server linuxforhealth/fhir-server --set postgresql.postgresqlPassword=${POSTGRES_PASSWORD} --set ingress.hostname=example.com --set 'ingress.tls[0].secretName=cluster-tls-secret'

See https://artifacthub.io/packages/helm/linuxforhealth/fhir-server for more information.

Building with the LinuxForHealth FHIR Modules

Each of the LinuxForHealth FHIR Server modules are published to Maven Central under org.linuxforhealth.fhir.

To use the artifacts from a Maven project, declare the dependencies. For example, to use our visitable, thread-safe FHIR object model (including our high-performance parsers and generators), declare a dependency on the fhir-model module:

...
<dependencies>
    <dependency>
      <groupId>org.linuxforhealth.fhir</groupId>
      <artifactId>fhir-model</artifactId>
      <version>${fhir.version}</version>
    </dependency>
    ...

LinuxForHealth FHIR modules

The LinuxForHealth FHIR Server is modular and extensible. The following tables provide an overview of all the modules, along with an indicator of the stability of the Java APIs defined in each module. This indicator is only applicable to the direct usage of the modules, not for usage of the LinuxForHealth FHIR Server as a whole.

Core

Model and Profile Support

Server

Extended Operations

Client

Clinical Quality

Tools and Utilities

Contributing to the LinuxForHealth FHIR Server

The LinuxForHealth FHIR Server is under active development. To help develop the server, clone or download the project and build it using Maven. See Setting up for development for more information.

See CONTRIBUTING.md for contributing your changes back to the project.

See CODE_OF_CONDUCT.md for code of conduct.

License

The LinuxForHealth FHIR Server and its corresponding modules are licensed under the Apache 2.0 license. The full license text is available at LICENSE.

FHIR® is the registered trademark of HL7 and is used with the permission of HL7. Use of the FHIR trademark does not constitute endorsement of this product by HL7. IBM and the IBM logo are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available at https://ibm.com/trademark.