How to Connect DBeaver to FHIR via a JDBC Driver

The CData JDBC Driver for FHIR implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to FHIR data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for FHIR Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for FHIR).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.fhir.FHIRDriver.
   • Set URL Template to jdbc:fhir:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.FHIR.jar).

Create a Connection to FHIR Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for FHIR) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   Set URL to the Service Base URL of the FHIR server. This is the address where the resources are defined in the FHIR server you would like to connect to. Set ConnectionType to a supported connection type. Set ContentType to the format of your documents. Set AuthScheme based on the authentication requirements for your FHIR server.

   Generic, Azure-based, AWS-based, and Google-based FHIR server implementations are supported.

   Sample Service Base URLs

   • Generic: http://my_fhir_server/r4b/
   • Azure: https://MY_AZURE_FHIR.azurehealthcareapis.com/
   • AWS: https://healthlake.REGION.amazonaws.com/datastore/DATASTORE_ID/r4/
   • Google: https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/

   Generic FHIR Instances

   The product supports connections to custom instances of FHIR. Authentication to custom FHIR servers is handled via OAuth (read more about OAuth in the Help documentation. Before you can connect to custom FHIR instances, you must set ConnectionType to Generic.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the FHIR JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.fhir.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   Below is a typical connection string:

   jdbc:fhir:URL=http://test.fhir.org/r4b/;ConnectionType=Generic;ContentType=JSON;AuthScheme=None;
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query FHIR Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial