Configure Dataverse healthcare APIs

  • Article

This article provides a step-by-step guide for configuring the Dataverse healthcare APIs.

Grant an Azure application access to the Dataverse environment

The first step to enable access to the Dataverse healthcare APIs is to grant an Azure application permission to the Dataverse environment. These steps first guide you through setting up an App registration in Azure, and then granting that application access to Dataverse by setting up an application user.

  1. Register an Azure application. After you configure the app registration, make sure you capture the Application/Client ID for the following steps.

  2. In the Power Platform admin center, open your Dataverse environment.

  3. On the action pane, select Settings.

  4. Under Users + Permissions, select Application users.

  5. On the action pane, select New app user.

  6. In the panel that opens, select Add an app.

  7. Search by using your Application/Client ID, select your app, and then select Add.

  8. Select your Business unit.

  9. Select the Sync admin for FHIR App Reg User security role, and then select Save.

  10. Select Create.

Integration settings

The integration settings area in Data integration toolkit gives you access to Dataverse environment variables that you can use to configure the Dataverse healthcare APIs.

With writeback support, you can also configure entity maps for Dataverse records to be written back to the remote server. After configuration, new records created in Dataverse, or records created using the Dataverse healthcare inbound APIs can be updated and posted to the remote endpoint.

In addition to the configuration steps, the following section also describes the integration settings required to connect to the remote endpoint for writeback events.

  1. Sign in to Microsoft Power Apps.

  2. On the Environments pane, select the environment where you've deployed Data integration toolkit.

  3. On the left pane, select Apps, and then select Data Integration Toolkit.

    A screenshot displaying the Data integration toolkit selection.

  4. Under Application Config, select Integration Settings, and then select Dataverse Healthcare API.

    A screenshot displaying the integration settings section.

  5. Set the variables with values for your environment.

    The following table describes the general environment variable settings:

    Environment variable Description Value
    Logging Level Controls the level of information logged to Dataverse for both the inbound Dataverse healthcare API and writeback events. By default, the value is Disabled.

    For more information, go to Review Dataverse healthcare API logs.    		 Use one of the following values:

    Information Only: Log details marked as information.
    Warning Only: Log details marked as warning.
    Exception Only: Log details marked as error or exception.
    Verbose: Log all details.
    Disabled: Disable logging.
    FHIR Bundle Size Limit for Upsert The maximum number of resources in a bundle. By default, the value is 100. Use a value from 1 through 500 to control the maximum number of resources in a valid bundle. If the bundle size exceeds the configured limit, the upsert bundle API responds with an error.

    The following table describes the environment variable settings for the writeback solution configuration:

    Environment variable Description Value
    Application/Client ID The application registration user ID configured for the remote endpoint to which the writeback service connects. Application Registration User ID (GUID)
    Client Secret The client secret associated with the application registration user ID.

    Note: For security, you can't access the client secret value using the administration tools after it has been saved.    		 Client Secret (string)
    Resource The Resource or Scope string of the remote endpoint used in acquiring the authentication token. For Azure Health Data Services, this value is typically the same value as the endpoint URL. String, or properly formatted URL
    Endpoint Base URL The URL of the remote endpoint to which the writeback service connects. Properly formatted URL
    Authority URL URL of the OAuth authority provider, including the tenant ID. The writeback uses this URL to authenticate using the client ID and secret. Properly formatted URL
    Max Retry Timeout The maximum number of minutes between automatic retries before failing a message. Retry timeout (minutes)
    Default value: 5
    Max Retry Count The maximum number of retries before failing a message. Number of retries (count)
    Default value: 3
    FHIR Application Registration User ID The application registration user ID configured for inbound message processing. This variable allows the writeback processor to filter the inbound messages and avoid circular processing. Application Registration User ID (GUID)

After you update the integration settings, you have the option of posting data directly to the custom API endpoint. Or, you can deploy an Azure Logic App to help with relaying the data between Dataverse and the Azure Health Data Services FHIR server. For more information, see:

See also

What is Microsoft Cloud for Healthcare?
Overview of Data integration toolkit
Overview of Dataverse healthcare APIs
Overview of writeback for Dataverse healthcare APIs
Use the Dataverse healthcare APIs