Validate FHIR Data with QuerySurge

QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData JDBC Driver for FHIR, QuerySurge can work with live FHIR data. This article walks through connecting to FHIR data from QuerySurge.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live FHIR data. When you issue complex SQL queries to FHIR, the driver pushes supported SQL operations, like filters and aggregations, directly to FHIR and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze FHIR data using native data types.

Connecting to FHIR Data in QuerySurge

To connect to live FHIR data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.

Deploy the JDBC Driver

1. Download the CData JDBC Driver for FHIR installer, unzip the package, and run the JAR file to install the driver.
2. Once the driver is installed, stop the Agent Service.
3. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for FHIR\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
4. Restart the Agent Service.

For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.

Configure a New Connection to FHIR

1. Log into QuerySurge and navigate to the Admin view.
2. Click Configuration -> Connections in the Administration Tree.
3. Click Add to create a new connection.
4. In the QuerySurge Connection Wizard, click Next.
5. Name the connection (e.g. CData JDBC Connection to FHIR).
6. Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
7. Set the Driver Class to cdata.jdbc.fhir.FHIRDriver and click Next.

8. Set the Connection URL using the necessary connection properties to authenticate with FHIR. Your Connection URL will look something like the following:

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

   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.

   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.

9. Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM Patient LIMIT 1) and click Next.
10. Click Test Connection to ensure the connection is configured properly and click Save to add the connection.

Once the connection is added, you can write SQL queries against your FHIR data in QuerySurge.

Compare FHIR Data Queries with a QueryPair

With the connection configured, you can follow the steps below to compare querying FHIR data with a QueryPair.

1. Select "Design Library" from the Design Menu
2. Click QueryPairs under QuerySurge Design
3. Click "Create New QueryPair"
4. Name the QueryPair and click Save
5. In either the Source or Target panes, select the connection created above (select the same connection to query FHIR twice or another connection to perform a comparison)
6. Write queries in the Editor for each pane, e.g. SELECT * FROM Patient
7. Click the "Design-Time Run" tab to execute the queries
8. When the query execution is finished, click "View Query Results" to see the FHIR data returned by the query

Download a free, 30-day trial of the CData JDBC Driver for FHIR and start working with your live FHIR data in QuerySurge. Reach out to our Support Team if you have any questions.