FHIR
FHIR
Setup Guide
Follow these steps to connect FHIR to your CData Connect account:
-
Open the Connections page of the CData Connect dashboard.
-
Click + Add Connection in the upper-right corner.
-
Type FHIR into the search field, then click the data source name.
-
On the Basic Settings tab of the new connection, enter a connection name or keep the default name.
-
Set your Connection Type. The connection type determines the authorization method you will use.
Generic Authentication Methods
GenericOAuth
-
Enter the following information:
-
Callback URL—you must supply this when setting up your OAuth app. This is sometimes referred to as a ‘Redirect URL’. On CData Connect, this is marked as
https://oauth.cdata.com/oauth/
. Use this when you configure your OAuth app on FHIR. -
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/
.
-
-
Click Sign in to connect securely through OAuth. This action opens the FHIR sign-in page in a new tab.
-
Log into your FHIR account and provide the requested permissions (if applicable).
-
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-
None
-
Enter the URL for your connection. A sample generic URL is as follows:
http://my_fhir_server/r4b/
. -
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-
Azure Authentication Methods
AzureAD
-
Enter the URL of the FHIR server. A sample Azure URL is as follows:
https://MY_AZURE_FHIR.azurehealthcareapis.com/
. -
Click Sign in to connect securely through OAuth. This action opens the FHIR sign-in page in a new tab.
-
Log into your FHIR account and provide the requested permissions (if applicable).
-
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-
AzureServicePrincipal
-
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/
.
-
-
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-
AWS Authentication Methods
Enter an AWS Region, and then select an Auth Scheme.
AwsRootKeys
-
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/
.
-
-
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-
AwsIAMRoles
-
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/
.
-
-
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-
Google Authentication Methods
OAuth
-
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/
. -
Click Sign in with Google to connect securely through OAuth. This action opens the FHIR sign-in page on a new tab.
-
Log into your FHIR account.
-
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-
OAuthJWT
-
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/
.
-
-
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-
InterSystems Authentication Methods
ApiKey
-
Enter the API Key for your FHIR account.
-
Enter the URL of the FHIR server.
-
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-
None
-
Enter the URL of the FHIR server.
-
At the top of the CData Connect Add FHIR Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Then, try again.
-