On this page:

5.1FHIR Storage (Relational) Module


The FHIR Storage (Relational) module is responsible for resource storage and retrieval. It stores data in two places:

  • A relational database is used as the primary storage mechanism. All resources are stored in the database and indexes are created to help in finding them.
  • A Lucene filesystem is used to provide fulltext searching capability, as well as to support some terminology service functions.

5.1.1Preparing for a New Installation


To create a new FHIR Storage (Relational) module, you should first ensure that your host server (or virtual machine, docker container, etc.) has access to a dedicated directory with a sufficiently large amount of storage to keep its data.

This directory can be a mounted filesystem or a directory on a local disk but it should be dedicated to the given node. In other words, if this directory is network mounted, it should not be shared across multiple nodes of the cluster.

You will also require a relational database with a user and schema created. See the Platform Requirements page for information on supported database platforms.

5.1.2Creating the Module


When creating a FHIR Storage (Relational) module, you must first choose which version of FHIR it will support. There are multiple types of FHIR Storage (Relational) modules, and each one supports a specific version of FHIR.

5.1.3Database Schema


Details on the database schema for the FHIR Storage (Relational) module can be found in the HAPI FHIR Documentation. Initialization scripts can be found in the Database Administration section.



Database Configuration

Once you have selected your module type, the first set of configuration options will be the relational database configuration itself. A complete reference of options is found on the Database configuration page.

Most importantly, you will need to configure the following properties:

Lucene FullText Configuration

The Lucene FullText configuration sets up the local filesystem to use for indexing. A complete reference of options is found on the Lucene FullText Indexing configuration page.

Most importantly, you should configure the following property:


The configuration options available for this module type are as follows: