Ready to get started?

Download a free trial of the FHIR Driver to get started:

 Download Now

Learn more:

FHIR Icon FHIR JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with FHIR.

Connect to FHIR Data in NetBeans



Connect to FHIR data in NetBeans with the data source configuration wizard.

The CData JDBC Driver for FHIR integrates connectivity to live FHIR data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to FHIR data in NetBeans. You will create a connection and load FHIR data in the Table Editor.

Create a JDBC Data Source for FHIR in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

  • Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.fhir.jar file. The driver JAR is located in the lib subfolder of the installation directory.
  • Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.fhir.FHIRDriver from the menu.
  • Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

  1. In the Service window, right-click the Database node and click New Connection.

  2. In the New Connection Wizard, enter the following connection properties:

    • Driver Name: In the menu, select the CData JDBC Driver for FHIR.
    • User Name: Enter the username. This can also be defined in the JDBC URL.
    • Password: Enter the password. This can also be defined in the JDBC URL.
    • JDBC URL: Specify the JDBC URL.

      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;

Query FHIR Data

To connect to FHIR data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data..