IBM / Fhir

IBM FHIR Server

The IBM® FHIR® Server is a modular Java implementation of version 4 of the HL7 FHIR specification with a focus on performance and configurability.

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

The server can be packaged as a set of jar files, a web application archive (war), an application installer, or a Docker image.

Running the IBM FHIR Server

The IBM FHIR Server is available from the Releases tab as a zip file with installation scripts for Mac/Linux and Windows or as a docker image at https://hub.docker.com/r/ibmcom/ibm-fhir-server.

Note: The Docker image ibmcom/ibm-fhir-schematool is an early technology preview and is experimental.

More information on installing and running the server is available in the User Guide at https://ibm.github.io/FHIR/guides/FHIRServerUsersGuide.

Building on top of the IBM FHIR Server Modules

Each of the IBM FHIR Server modules are published to a public Maven repository on JFrog Bintray.

To use the artifacts from a Maven project:

1. Add the repository to your pom.xml:

   <repositories>
       <repository>
           <id>ibm-fhir</id>
           <url>https://dl.bintray.com/ibm-watson-health/ibm-fhir-server-releases</url>
       </repository>
       ...
   

2. Declare the dependencies:

   For example, to use our visitable, thread-safe FHIR R4 object model (including our high-performance parsers and generators), declare a dependency on the fhir-model module:

   ...
   <dependencies>
       <dependency>
         <groupId>com.ibm.fhir</groupId>
         <artifactId>fhir-model</artifactId>
         <version>${fhir.version}</version>
       </dependency>
       ...
   

IBM FHIR Server Module Catalog

The IBM FHIR Server is modular and extensible. The following tables provide an overview of all the IBM FHIR 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 IBM FHIR Server as a whole.

Core

Model and Profile Support

Server

Extended Operations

Client

Tools and Utilities

Contributing to the IBM FHIR Server

The IBM 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 IBM FHIR Server is licensed under the Apache 2.0 license. 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 on https://ibm.com/trademark.