FHIRlink
Microsoft FHIRlink creates a direct connection between healthcare apps built on Microsoft Azure services and FHIR's servers, bypassing the need to duplicate data from Microsoft Dataverse.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft Cloud for Healthcare |
| URL | https://www.microsoft.com/en-us/industry/health/microsoft-cloud-for-healthcare |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft Cloud for Healthcare |
| Website | https://www.microsoft.com/en-us/industry/health/microsoft-cloud-for-healthcare |
| Privacy policy | https://privacy.microsoft.com/en-us/privacystatement |
| Categories | Data |
Microsoft FHIRlink creates a direct connection between healthcare apps built on Microsoft Azure services and FHIR services, bypassing the need to duplicate data from Microsoft Dataverse.
FHIRlink reduces the complexity and cost of building low code/no code applications on Power Platform and Azure because developers can build their apps directly against the FHIR services rather than having to duplicate data between systems. Connect Power Automate Flows, Power Platform Canvas Apps, and Azure Logic Apps to various FHIR services and perform your create, retrieve, update and delete operations directly on FHIR resources.
For more details on how to setup and use the FHIRlink connector, please visit Set up FHIRlink connector at our Microsoft Learn site.
Supported providers
The Microsoft FHIRlink Connector works with:
- Azure Health Data Services FHIR service - Azure Health Data Services is a cloud-based solution that helps you collect, store, and analyze health data from different sources and formats.
- Google Cloud™ Healthcare API service for HL7® FHIR® - Google's FHIR API.
- Epic® on FHIR® - Epics's FHIR API services.
Prerequisites
You will need the following to proceed:
- A Microsoft Azure subscription and Azure Health Data Services FHIR® Service instance OR
- A Google Cloud subscription and Google Cloud™ Healthcare API service for HL7® FHIR® OR
- An Epic® on FHIR® subscription
Each service requires administrative access to configure requisite application registrations for authentication and user accounts configured with the appropriate FHIR service access.
FHIR®, Google and Epic® are registered trademarks owned, respectively, by Health Level Seven International and Epic Systems Corporation. Use of these trademarks on this page does not constitute endorsement by Health Level Seven International or Epic Systems.
Creating a connection
The connector supports the following authentication types:
| Bring your own Epic® on FHIR® application | Log in using your own Epic® on FHIR® app. | All regions | Not shareable |
| Bring your own Google application | Log in using your own Google app. | All regions | Not shareable |
| Use default Microsoft Azure shared application | Log in using the standard Microsoft Azure application. | All regions | Not shareable |
| Default [DEPRECATED] | This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. | All regions | Not shareable |
Bring your own Epic® on FHIR® application
Auth ID: byoa-epic
Applicable: All regions
Log in using your own Epic® on FHIR® app.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Epic® on FHIR® API URL | string | Epic® on FHIR® API URL. For example, 'https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4' | True |
| Client ID | string | Client (or Application) ID of your Epic® on FHIR® application. | True |
| Client Secret | securestring | Client secret of your Epic® on FHIR® application. | True |
| Authorization URL | string | Provide your Epic® on FHIR® authorization URL | True |
| Token URL | string | Provide your Epic® on FHIR® token URL | True |
| Token refresh URL | string | Provide your Epic® on FHIR® token refresh URL | True |
Bring your own Google application
Auth ID: byoa-google
Applicable: All regions
Log in using your own Google app.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Google Cloud™ Healthcare API service for HL7® FHIR® endpoint URL | string | Google Cloud™ Healthcare API service for HL7® FHIR® endpoint URL. For example, 'https://healthcare.googleapis.com/{{fhirservicepath}}/fhir' | True |
| Client ID | string | Client (or Application) ID of your Google application. | True |
| Client Secret | securestring | Client secret of your Google application. | True |
Use default Microsoft Azure shared application
Auth ID: azure-shared-app
Applicable: All regions
Log in using the standard Microsoft Azure application.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Azure Health Data Services FHIR service endpoint URL | string | Azure Health Data Services FHIR service endpoint URL. For example, 'https://{{fhirservicename}}.fhir.azurehealthcareapis.com' | True |
| Azure Health Data Services FHIR service resource URI | string | The identifier used in Microsoft Entra ID to identify the target FHIR service resource. Usually for Azure Health Data Services FHIR service, URI like 'https://{{fhirservicename}}.fhir.azurehealthcareapis.com' | True |
Default [DEPRECATED]
Applicable: All regions
This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create a resource |
Create a new resource of the specified type |
| Delete a resource |
Delete a resource by ID |
| Get a resource |
Get a resource by ID |
| List resources by type |
List resource entries for the specified resource type. |
| Patch a resource |
Patch a resource by ID |
| Retrieve all patient information |
Retrieve all information related to a patient |
| Update or create a resource |
Update or create a resource of the specified type |
Create a resource
Create a new resource of the specified type
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Resource type
|
resourceType | True | string |
A type of resource exposed via the restful interface. |
|
FHIR Resource JSON
|
body | True | string |
Payload containing the FHIR resource JSON data. |
Delete a resource
Delete a resource by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Resource type
|
resourceType | True | string |
A type of resource exposed via the restful interface. |
|
Resource ID
|
id | True | string |
Resource ID to execute operation with |
Returns
Get a resource
Get a resource by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Resource type
|
resourceType | True | string |
A type of resource exposed via the restful interface. |
|
Resource ID
|
id | True | string |
Resource ID to execute operation with |
List resources by type
List resource entries for the specified resource type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Resource type
|
resourceType | True | string |
A type of resource exposed via the restful interface. |
|
_id
|
_id | string |
Specify the resource ID to search for. |
|
|
_elements
|
_elements | string |
Comma-separated list of element names to be returned as part of a resource. |
|
|
_sort
|
_sort | string |
Specify which order results should be returned in. |
|
|
_count
|
_count | number |
Number to limit the match results per page of response. |
|
|
_include
|
_include | string |
Include additional resources, based on following links forward across references. |
|
|
_revinclude
|
_revinclude | string |
Include additional resources, based on following reverse links across references. |
|
|
_total
|
_total | string |
Specify the precision for the total number of results for a request. |
|
|
_summary
|
_summary | string |
Return only portions of resources, based on pre-defined levels. |
|
|
Additional parameters
|
additionalParameters | string |
Provide additional FHIR query parameters represented as a query string, this can include page token and advanced search filters. Examples: |
Patch a resource
Patch a resource by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Resource type
|
resourceType | True | string |
A type of resource exposed via the restful interface. |
|
Resource ID
|
id | True | string |
Resource ID to execute operation with |
|
Content type
|
contentType | True | string |
Payload content type |
|
Patch resource type
|
resourceType | string |
Resource type of the FHIR Patch resource. |
|
|
Operations list
|
parameter |
A list of operations to perform on the specified resource. |
Retrieve all patient information
Retrieve all information related to a patient
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Patient ID
|
patientId | True | string |
ID of the Patient resource for which you want to retrieve information. |
Update or create a resource
Update or create a resource of the specified type
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Resource type
|
resourceType | True | string |
A type of resource exposed via the restful interface. |
|
Resource ID
|
id | True | string |
Resource ID to execute operation with |
|
If-Match
|
If-Match | string |
The If-Match request header. |
|
|
FHIR Resource JSON
|
body | True | string |
Payload containing the FHIR resource JSON data. |