Skip to content

Commit b448f6a

Browse files
authored
Merge pull request #312038 from cebundy-work/fhir-deploy-portal-update
update deploy FHIR service via portal quickstart
2 parents b5ec06c + 97eb51e commit b448f6a

4 files changed

Lines changed: 62 additions & 57 deletions

File tree

articles/healthcare-apis/fhir/deploy-azure-portal.md

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
---
2-
title: Deploy the FHIR service in Azure Health Data Services
2+
title: Deploy the FHIR service in Azure Health Data Services via Azure portal
33
description: Learn how to deploy the FHIR service in Azure Health Data Services by using the Azure portal. This article covers prerequisites, workspace deployment, service creation, and security settings.
44
author: EXPEkesheth
55
ms.service: azure-health-data-services
66
ms.topic: quickstart
7-
ms.date: 10/01/2025
7+
ms.date: 02/23/2026
88
ms.author: kesheth
99
ms.custom:
1010
- mode-api
1111
- sfi-image-nochange
1212
---
1313

14-
# Deploy the FHIR service by using the Azure portal
14+
# Quickstart: Deploy the FHIR service via the Azure portal
1515

16-
The Azure portal provides a web interface with guided workflows, making it an efficient tool for deploying the FHIR® service, and ensuring accurate configuration within Azure Health Data Services.
16+
In this quickstart, you learn how to create and deploy a FHIR service instance via the Azure portal. The Azure portal provides a web interface with guided workflows, making it an efficient tool for deploying the FHIR® service.
1717

1818
## Prerequisites
1919

20-
- Verify you have an Azure subscription and permissions for creating resource groups and deploy resources.
20+
- An Azure subscription. If you don't have an Azure account, create a [free account](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn) before you begin.
2121

22-
- Deploy a workspace for Azure Health Data Services. For steps, see [Deploy workspace in the Azure portal](../healthcare-apis-quickstart.md).
22+
- An Azure Health Data Services workspace. To create and deploy a workspace, see [Deploy workspace in the Azure portal](../healthcare-apis-quickstart.md).
2323

24-
## Create a new FHIR service
24+
## Create and deploy a new FHIR service
2525

26-
1. From your Azure Health Data Services workspace, choose **Create FHIR service**.
27-
1. Choose **Add FHIR service**.
28-
1. On the **Create FHIR service** page, complete the fields on each tab.
26+
1. Go to your Azure Health Data Services workspace resource.
27+
1. On the menu, select **Services** > **FHIR service**.
28+
1. Select **+ Add FHIR service**.
2929

3030
- **Basics tab**: Give the FHIR service a friendly and unique name. Select the **FHIR version** (**STU3** or **R4**), and then choose **Next: Additional settings**.
3131

@@ -34,44 +34,34 @@ The Azure portal provides a web interface with guided workflows, making it an ef
3434
- **Additional settings tab (optional)**: This tab allows you to:
3535
- **View authentication settings**: The default configuration for the FHIR service is **Use Azure RBAC for assigning data plane roles**. When configured in this mode, the authority for the FHIR service is set to the Microsoft Entra tenant for the subscription.
3636

37-
- **Integration with non-Microsoft Entra ID (optional)**: Use this option when you need to configure up to two additional identity providers other than Microsoft Entra ID to authenticate and access FHIR resources with SMART on FHIR scopes.
37+
- **Integration with non-Microsoft Entra ID (optional)**: Use this option when you need to configure up to two more identity providers other than Microsoft Entra ID to authenticate and access FHIR resources with SMART on FHIR scopes.
3838

3939
- **Setting versioning policy (optional)**: The versioning policy controls the history setting for FHIR service at the system level or individual resource type level. For more information, see [FHIR versioning policy and history management](fhir-versioning-policy-and-history-management.md). Choose **Next: Security**.
4040

4141
- On the **Security settings** tab, review the fields.
4242

43-
By default, data is encrypted with Microsoft-managed keys. For additional control over encryption keys, you can supply customer-managed keys to use for encryption of data. Customer-managed keys must be stored in an Azure Key Vault. You can either create your own keys and store them in a key vault, or use the Azure Key Vault APIs to generate keys. For more information, see [Configure customer-managed keys for the FHIR service](configure-customer-managed-keys.md). Choose **Next: Tags**.
43+
By default, data is encrypted with Microsoft-managed keys. For more control over encryption keys, you can supply customer-managed keys to use for encryption of data. Customer-managed keys must be stored in an Azure Key Vault. You can either create your own keys and store them in a key vault, or use the Azure Key Vault APIs to generate keys. For more information, see [Configure customer-managed keys for the FHIR service](configure-customer-managed-keys.md). Choose **Next: Tags**.
4444

4545
- On the **Tags** tab (optional), enter any tags.
4646

4747
Tags are name and value pairs used for categorizing resources and aren't required. For more information, see [Use tags to organize your Azure resources and management hierarchy](../../azure-resource-manager/management/tag-resources.md).
4848

49-
- Choose **Review + Create** to begin the validation process. Wait until you receive confirmation that the deployment completed successfully. Review the confirmation screen, and then choose **Create** to begin the deployment.
49+
1. Choose **Review + Create** to begin the validation process. Wait until you receive confirmation that the deployment completed successfully. Review the confirmation screen, and then choose **Create** to begin the deployment.
5050

5151
The deployment process might take several minutes. When the deployment completes, you see a confirmation message.
5252

5353
:::image type="content" source="media/fhir-service/deployment-success-fhir-service-sml.png" alt-text="Screenshot showing successful deployment." lightbox="media/fhir-service/deployment-success-fhir-service-sml.png":::
5454

55-
1. Validate the deployment. Fetch the capability statement from your new FHIR service. Fetch a capability statement by browsing to `https://<WORKSPACE-NAME>-<FHIR-SERVICE-NAME>.fhir.azurehealthcareapis.com/metadata`.
55+
## Validate the deployment
5656

57-
## Troubleshoot FHIR service deployment
58-
Below are the error messages along with recommended actions to resolve the problems during deployment.
57+
From the deployment confirmation page, select **Go to resource** Copy the **FHIR metadata endpoint** and paste in a browser to fetch the capability statement from your new FHIR service.
5958

60-
**What should I do if I accidentally deployed the Azure API for FHIR into the wrong subscription, deleted it, and am now facing a deployment failure in the correct subscription with a message stating that the resource name is not available?**
59+
## Clean up resources
6160

62-
Once a service name has been used, it cannot be reused in a different subscription, even after deletion. This restriction is in place to prevent impersonation and primarily impacts Azure API for FHIR.
61+
To avoid incurring costs, you can delete unneeded resources by deleting the FHIR service, or its containing workspace or resource group.
6362

64-
If deployed to the wrong subscription, you can move the resource to the desired subscription instead of deleting and recreating it. [Move Azure Resources](../../azure-resource-manager/management/move-resource-group-and-subscription.md)
6563

66-
**How can I delete a service and then re-add it with the same settings?**
67-
68-
To replicate settings between FHIR instance, you can follow below steps
69-
70-
* Create standard ARM templates with the configurations.
71-
72-
* Create a service and add configuration as per requirement.
73-
74-
## Related content
64+
## Next step
7565

7666
[Access the FHIR service](../fhir/get-started-with-fhir.md#access-the-fhir-service)
7767

0 commit comments

Comments
 (0)