FHIR

Setup Guide

Follow these steps to connect FHIR to your Connect AI account:

1. Open the Connections page of the Connect AI dashboard.

2. Click + Add Connection in the upper-right corner.

3. Type FHIR into the search field, then click the data source name.

4. On the Basic Settings tab of the new connection, enter a connection name or keep the default name.

5. Set your Connection Type. The connection type determines the authentication method you will use.

Generic Authentication Methods

GenericOAuth

The Callback URL, or Redirect URL, is the URL you need (https://oauth.cdata.com/oauth/) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

1. Enter the following information:

   • OAuth Client Id—the Id assigned when you registered your FHIR account.
   • OAuth Client Secret—the client secret for your FHIR account.
   • OAuth Authorization URL—the URL where the user logs into OAuth and grants permissions to the application.
   • OAuth Access Token URL—the URL where authorization tokens can be exchanged for access tokens.
   • URL—the URL of the FHIR server. A sample generic URL is as follows: http://my_fhir_server/r4b/.
2. Click Sign in to connect securely through OAuth. This action opens the FHIR sign-in page in a new tab.

3. Log in to your FHIR account and provide the requested permissions (if applicable).

4. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

None

1. Enter the URL for your connection. A sample generic URL is as follows: http://my_fhir_server/r4b/.

2. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

Azure Authentication Methods

AzureAD

1. Enter the URL of the FHIR server. A sample Azure URL is as follows: https://MY_AZURE_FHIR.azurehealthcareapis.com/.

2. Click Sign in to connect securely through OAuth. This action opens the FHIR sign-in page in a new tab.

3. Log in to your FHIR account and provide the requested permissions (if applicable).

4. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

AzureServicePrincipal

1. Enter the following information:

   • OAuth Client Id—the Id assigned when you registered your FHIR account.
   • OAuth Client Secret—the client secret for your FHIR account.
   • URL—the URL of the FHIR server. A sample Azure URL is as follows: https://MY_AZURE_FHIR.azurehealthcareapis.com/.
2. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

AWS Authentication Methods

Enter an AWS Region, and then select an Auth Scheme.

AwsRootKeys

1. Enter the following information:

   • AWS Access Key—your AWS account access key. This value is found in your AWS security credentials page.
   • AWS Secret Key—your AWS account secret key. This value is found in your AWS security credentials page.
   • URL—the URL of the FHIR server. A sample AWS URL is as follows: https://healthlake.REGION.amazonaws.com/datastore/DATASTORE_ID/r4/.
2. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

AwsIAMRoles

1. Enter the following information:

   • AWS Access Key—your AWS account access key. This value is found in your AWS security credentials page.
   • AWS Secret Key—your AWS account secret key. This value is found in your AWS security credentials page.
   • AWS Role ARN—the Amazon Resource Name of the role you want to use when authenticating.
   • URL—the URL of the FHIR server. A sample AWS URL is as follows: https://healthlake.REGION.amazonaws.com/datastore/DATASTORE_ID/r4/.
2. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

Google Authentication Methods

OAuth

1. Enter the URL of the FHIR server. A sample Google URL is as follows: https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/.

2. Click Sign in with Google to connect securely through OAuth. This action opens the FHIR sign-in page on a new tab.

3. Log in to your FHIR account.

4. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

OAuthJWT

1. Enter the following information:

   • OAuth JWT Cert—the contents of the certificate file provided by Google. A sample format is provided.
   • OAuth JWT Subject—(optional) the email address of the user whose data you want to access. Only set this value if the service account is part of a GSuite domain and you want to enable delegation.
   • URL—the URL of the FHIR server. A sample Google URL is as follows: https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/.
2. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

InterSystems Authentication Methods

ApiKey

1. Enter the API Key for your FHIR account.

2. Enter the URL of the FHIR server.

3. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

None

1. Enter the URL of the FHIR server.

2. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

More Information

For more information about interactions between Connect AI and FHIR, see this information page.