Ready to get started?

Download a free trial of the FHIR Data Provider to get started:

 Download Now

Learn more:


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

Automate FHIR Integration Tasks from PowerShell

Are you in search of a quick and easy way to access FHIR data from PowerShell? This article demonstrates how to utilize the FHIR Cmdlets for tasks like connecting to FHIR data, automating operations, downloading data, and more.

The CData Cmdlets for FHIR are standard PowerShell cmdlets that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to FHIR.

PowerShell Cmdlets or ADO.NET Provider?

The Cmdlets are not only a PowerShell interface to FHIR, but also an SQL interface; this tutorial shows how to use both to retrieve FHIR data. We also show examples of the ADO.NET equivalent, which is possible with the CData ADO.NET Provider for FHIR. To access FHIR data from other .NET applications, like LINQPad, use the CData ADO.NET Provider for FHIR.

Once you have acquired the necessary connection properties, accessing FHIR data in PowerShell can be enabled in three steps.

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:
  • AWS:
  • Google:

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.


  1. Install the module:

    Install-Module FHIRCmdlets
  2. Connect:

    $fhir = Connect-FHIR -URL "$URL" -ConnectionType "$ConnectionType" -ContentType "$ContentType" -AuthScheme "$AuthScheme"
  3. Search for and retrieve data:

    $[address-city] = "New York" $patient = Select-FHIR -Connection $fhir -Table "Patient" -Where "[address-city] = `'$[address-city]`'" $patient

    You can also use the Invoke-FHIR cmdlet to execute SQL commands:

    $patient = Invoke-FHIR -Connection $fhir -Query 'SELECT * FROM Patient WHERE [address-city] = @[address-city]' -Params @{'@[address-city]'='New York'}


  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData ADO.NET Provider for FHIR\lib\System.Data.CData.FHIR.dll")
  2. Connect to FHIR:

    $conn= New-Object System.Data.CData.FHIR.FHIRConnection("URL=;ConnectionType=Generic;ContentType=JSON;AuthScheme=None;") $conn.Open()
  3. Instantiate the FHIRDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Id, [name-use] from Patient" $da= New-Object System.Data.CData.FHIR.FHIRDataAdapter($sql, $conn) $dt= New-Object System.Data.DataTable $da.Fill($dt) $dt.Rows | foreach { Write-Host $ $_.[name-use] }