How to connect to FHIR Data from IntelliJ

The CData JDBC Driver for FHIR enables you to access FHIR as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to FHIR data in IntelliJ.

Create a JBDC Data Source for FHIR

Follow the steps below to add the driver JAR and define connection properties required to connect to FHIR data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.fhir.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.fhir.FHIRDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:fhir: and includes connection properties separated with semicolons.

     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.

     A typical JDBC URL is the following:

     jdbc:fhir:URL=http://test.fhir.org/r4b/;ConnectionType=Generic;ContentType=JSON;AuthScheme=None;

Edit and Save FHIR Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.