Edit

Client application registration for Azure API for FHIR

  • Article

Important

Azure API for FHIR will be retired on September 30, 2026. Follow the migration strategies to transition to Azure Health Data Services FHIR service by that date. Due to the retirement of Azure API for FHIR, new deployments won't be allowed beginning April 1, 2025. Azure Health Data Services FHIR service is the evolved version of Azure API for FHIR that enables customers to manage FHIR, DICOM, and MedTech services with integrations into other Azure services.

In the previous tutorial, you deployed and set up your Azure API for FHIR. Now that you have your Azure API for FHIR setup, we’ll register a public client application. You can read through the full register a public client app how-to guide for more details or troubleshooting, but we’ve called out the major steps for this tutorial in this article.

  1. Navigate to Microsoft Entra ID

  2. Select App Registration --> New Registration

  3. Name your application

  4. Select Public client/native (mobile & desktop) and set the redirect URI to https://www.getpostman.com/oauth2/callback.

    Screenshot of the Register an application pane, and an example application name and redirect URL.

Client application settings

Once your client application is registered, copy the Application (client) ID and the Tenant ID from the Overview Page. You’ll need these two values later when accessing the client.

Screenshot of the client application settings pane, with the application and directory IDs highlighted.

Connect with web app

If you’ve written your web app to connect with the Azure API for FHIR, you also need to set the correct authentication options.

  1. In the left menu, under Manage, select Authentication.

  2. To add a new platform configuration, select Web.

  3. Set up the redirect URI in preparation for when you create your web application in the fourth part of this tutorial. To do this, add https://\<WEB-APP-NAME>.azurewebsites.net to the redirect URI list. If you choose a different name during the step where you write your web app, you’ll need to come back and update this.

  4. Select the Access Token and ID token check boxes.

    Screenshot of the app Authentication settings blade, with the steps to add a platform highlighted.

Add API permissions

Now that you have set up the correct authentication, set the API permissions:

  1. Select API permissions and select Add a permission.
  2. Under APIs my organization uses, search for Azure Health Data Services.
  3. Select user_impersonation and select add permissions.

Screenshot of the Add API permissions blade, with the steps to add API permissions highlighted.

Next Steps

You now have a public client application. In the next tutorial, we’ll walk through testing and gaining access to this application through Postman.

Test client application in Postman

FHIR® is a registered trademark of HL7 and is used with the permission of HL7.