FHIR Database Configuration

By default, XES Module for FHIR uses an embedded Apache Derby database engine to store resource data. This default XES Module for FHIR installation deploys a ready-to-use Apache Derby database and requires no additional deploymens. However, for the production environment Edifecs recommends that you use an MS SQL database for data storage.

To use an MS SQL database, follow the steps below:

1. Initialize the database.

   You have to create a database schema in the MS SQL Server for use by XES Module for FHIR. The name of this database must figure in the file ${XESModuleForFHIR}\tomcat\conf\fhir.properties (specified in the fhir.db.url property).

   If the database user with the credentials you specified in the fhir.db.username and fhir.db.password properties has the permissions to create tables and database structures, the database structure is created automatically. Otherwise, you have to run the sqlserver-create-tables-only.sql script from the directory ${XESModuleForFHIR}\config\sql\db-creation\ as a database administrator. This script populates an existing MS SQL database with the required tables.

   Click here for details if you use Windows authentication to authenticate users into the SQL Server

   Note This capability is available from XES Module for FHIR 9.1 hotfix 1.

   If you use the Windows authentication to authenticate users in the SQL Server, follow the steps below:

   1. In the file ${XESModuleForFHIR}\tomcat\conf\fhir.properties, do not specify user credentials and extend the connectivity string (the fhir.db.url property) with the key-value pair integratedSecurity=true to use the current Windows account credentials for authentication.
   2. In the XES Module for FHIR Windows service, on the Log On tab, enter the credentials of the user who has the permissions to access the SQL Server.
   3. Download Microsoft JDBC Driver 7.4 for SQL Server, unzip the package, and copy the Windows library file auth\x64\sqljdbc_auth.dll or auth\x86\sqljdbc_auth.dll (depending on the JVM you are using) to the XESModuleForFHIR\tomcat\bin directory.

2. Specify the database connection settings.

   Once the database is ready, specify the database connection settings in the file ${XESModuleForFHIR}\tomcat\conf\fhir.properties. An example of the fhir.properties file configured to work with an MS SQL database below:

   Click to view the contents of the file fhir.properties

   # Database Configuration
   

   # jdbc driver to be used:

   fhir.db.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver

   # Database connection URL:

   fhir.db.url=jdbc:sqlserver://localhost;databaseName=fhir_bridge
   

   # DB user credentials to connect to the database:

   fhir.db.username={user_name}

   fhir.db.password={password}

    

   # Hibernate Configuration

   # DBMS-specific SQL dialect:

   hibernate.dialect=org.hibernate.dialect.SQLServer2012Dialect

   hibernate.format_sql=true

   hibernate.show_sql=false

   hibernate.hbm2ddl.auto=update

   hibernate.jdbc.batch_size=20

   hibernate.cache.use_query_cache=false

   hibernate.cache.use_second_level_cache=false

   hibernate.cache.use_structured_entries=false

   hibernate.cache.use_minimal_puts=false

   hibernate.search.model_mapping=ca.uhn.fhir.jpa.search.LuceneSearchMappingFactory

   hibernate.search.default.directory_provider=filesystem

   hibernate.search.default.indexBase=../db/lucenefiles

   hibernate.search.lucene_version=LUCENE_CURRENT

   Note The user specified in the fhir.db.username property must have at least the following permissions: db_datawriter, db_datareader.

   Tip The directory ${XESModuleForFHIR}\config\sql\connection-properties\ contains sample configuration files that you can use as templates.

3. Drop the MS SQL jdbc driver into the directory ${XESModuleForFHIR}\tomcat\lib.
4. Restart the XES Module for FHIR service.