Back Up FHIR data to SQL Server through SSIS

This article illustrates using the FHIR ADO.NET Data Provider within a SQL Server SSIS workflow for the direct transfer of FHIR data to a Microsoft SQL Server database. It's worth noting that the identical process detailed below is applicable to any CData ADO.NET Data Providers, enabling the direct connection of SQL Server with remote data through SSIS.

1. Open Visual Studio and create a new Integration Services project.
2. Add a new Data Flow task from the toolbox onto the Control Flow screen.

3. In the Data Flow screen, add an ADO.NET Source and an OLE DB Destination from the toolbox.

4. Add a new connection and select .NET Providers\CData ADO.NET Provider for FHIR.

5. In the connection manager, enter the connection details for FHIR data.

   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.

6. Open the DataReader editor and set the following information:

   • ADO.NET connection manager: In the Connection Managers menu, select the Data Connection you just created.
   • Data access mode: Select 'SQL command'.
   • SQL command text: In the DataReader Source editor, open the Component Properties tab and enter a SELECT command, such as the one below:
     SELECT Id, [name-use] FROM Patient WHERE [address-city] = 'New York'

7. Close the DataReader editor and drag the arrow below the DataReader Source to connect it to the OLE DB Destination.

8. Open the OLE DB Destination and enter the following information in the Destination Component Editor.

   • Connection manager: Add a new connection. Enter your server and database information here. In this example, SQLExpress is running on a separate machine.
   • Data access mode: Set your data access mode to "table or view" and select the table or view to populate in your database.

9. Configure any properties you wish on the Mappings screen.

10. Close the OLE DB Destination Editor and run the project. After the SSIS task has finished executing, your database will be populated with data obtained from FHIR data.