Connect to FHIR Data in Aqua Data Studio

The CData JDBC Driver for FHIR integrates FHIR data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to FHIR data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The FHIR data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, FHIR.
   • Driver Location: Click the Browse button and select the cdata.jdbc.fhir.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.fhir.FHIRDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:fhir: and is followed by a semicolon-separated list of 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

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

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query FHIR Data

You can now query the tables exposed.