Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: 'Quickstart: Deploy Azure API for FHIR using an ARM template' description: In this quickstart, learn how to deploy Azure API for Fast Healthcare Interoperability Resources (FHIR®), by using an Azure Resource Manager template (ARM template). author: expekesheth ms.service: azure-health-data-services ms.subservice: fhir ms.topic: quickstart ms.custom: subject-armqs, devx-track-azurepowershell, mode-api, devx-track-arm-template ms.author: kesheth ms.date: 07/24/2025 --- # Quickstart: Use an ARM template to deploy Azure API for FHIR [!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)] In this quickstart, you learn how to use an Azure Resource Manager template (ARM template) to deploy Azure API for Fast Healthcare Interoperability Resources (FHIR®). You can deploy Azure API for FHIR through the Azure portal, PowerShell, or CLI. [!INCLUDE[About Azure Resource Manager](~/reusable-content/ce-skilling/azure/includes/resource-manager-quickstart-introduction.md)] If your environment meets the prerequisites and you're familiar with using ARM templates, select the **Deploy to Azure** button. The template opens in the Azure portal once you sign in. :::image type="content" source="~/reusable-content/ce-skilling/azure/media/template-deployments/deploy-to-azure-button.svg" alt-text="Button to deploy the Resource Manager template to Azure." border="false" link="https://portal.azure.com/#create/Microsoft.Template/uri/https%3a%2f%2fraw.githubusercontent.com%2fAzure%2fazure-quickstart-templates%2fmaster%2fquickstarts%2fmicrosoft.healthcareapis%2fazure-api-for-fhir%2fazuredeploy.json"::: ## Prerequisites # [Portal](#tab/azure-portal) An Azure account with an active subscription. [Create one for free](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn). # [PowerShell](#tab/PowerShell) * An Azure account with an active subscription. [Create one for free](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn). * If you want to run the code locally, [Azure PowerShell](/powershell/azure/install-azure-powershell). # [CLI](#tab/CLI) * An Azure account with an active subscription. [Create one for free](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn). * If you want to run the code locally: * A Bash shell (such as Git Bash, which is included in [Git for Windows](https://gitforwindows.org)). * [Azure CLI](/cli/azure/install-azure-cli). --- ## Review the template The template used in this quickstart is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/azure-api-for-fhir/). :::code language="json" source="~/quickstart-templates/quickstarts/microsoft.healthcareapis/azure-api-for-fhir/azuredeploy.json"::: The template defines one Azure resource. * **Microsoft.HealthcareApis/services** <!-- Replace the line above with the following line once https://learn.microsoft.com/azure/templates/microsoft.healthcareapis/services goes live: * [**Microsoft.HealthcareApis/services**](/azure/templates/microsoft.healthcareapis/services) This file does not exist. I am leaving this note here, but anticipate no changes in this matter before Azure API for FHIR retires. --> ## Deploy the template # [Portal](#tab/azure-portal) Select the following link to deploy the Azure API for FHIR using the ARM template in the Azure portal: :::image type="content" source="~/reusable-content/ce-skilling/azure/media/template-deployments/deploy-to-azure-button.svg" alt-text="Button to deploy the Resource Manager template to Azure." border="false" link="https://portal.azure.com/#create/Microsoft.Template/uri/https%3a%2f%2fraw.githubusercontent.com%2fAzure%2fazure-quickstart-templates%2fmaster%2fquickstarts%2fmicrosoft.healthcareapis%2fazure-api-for-fhir%2fazuredeploy.json"::: On the **Deploy Azure API for FHIR** page: 1. If you want, change the **Subscription** from the default to a different subscription. 2. For **Resource group**, select **Create new**, enter a name for the new resource group, and select **OK**. 3. If you created a new resource group, select a **Region** for the resource group. 4. Enter a new **Service Name** and choose the **Location** of the Azure API for FHIR. The location can be the same as or different from the region of the resource group. [](media/fhir-resource-manager-template/deploy-azure-api-fhir.png#lightbox) 5. Select **Review + create**. 6. Read the terms and conditions, and then select **Create**. # [PowerShell](#tab/PowerShell) > [!NOTE] > If you want to run the PowerShell scripts locally, first enter `Connect-AzAccount` to set up your Azure credentials. If the `Microsoft.HealthcareApis` resource provider isn't already registered for your subscription, you can register it with the following interactive code. To run the code in Azure Cloud Shell, select **Try it** at the upper corner of any code block. ```azurepowershell-interactive Register-AzResourceProvider -ProviderNamespace Microsoft.HealthcareApis ``` Use the following code to deploy the Azure API for FHIR service using the ARM template. The code prompts you for the new FHIR service name, the name of a new resource group, and the locations for each of them. ```azurepowershell-interactive $serviceName = Read-Host -Prompt "Enter a name for the new Azure API for FHIR service" $serviceLocation = Read-Host -Prompt "Enter an Azure region (for example, westus2) for the service" $resourceGroupName = Read-Host -Prompt "Enter a name for the new resource group to contain the service" $resourceGroupRegion = Read-Host -Prompt "Enter an Azure region (for example, centralus) for the resource group" Write-Verbose "New-AzResourceGroup -Name $resourceGroupName -Location $resourceGroupRegion" -Verbose New-AzResourceGroup -Name $resourceGroupName -Location $resourceGroupRegion Write-Verbose "Run New-AzResourceGroupDeployment to create an Azure API for FHIR service using an ARM template" -Verbose New-AzResourceGroupDeployment -ResourceGroupName $resourceGroupName ` -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.healthcareapis/azure-api-for-fhir/azuredeploy.json ` -serviceName $serviceName ` -location $serviceLocation Read-Host "Press [ENTER] to continue" ``` # [CLI](#tab/CLI) If the `Microsoft.HealthcareApis` resource provider isn't already registered for your subscription, you can register it with the following interactive code. To run the code in Azure Cloud Shell, select **Try it** at the upper corner of any code block. ```azurecli-interactive az extension add --name healthcareapis ``` Use the following code to deploy the Azure API for FHIR service using the ARM template. The code prompts you for the new FHIR service name, the name of a new resource group, and the locations for each of them. ```azurecli-interactive read -p "Enter a name for the new Azure API for FHIR service: " serviceName && read -p "Enter an Azure region (for example, westus2) for the service: " serviceLocation && read -p "Enter a name for the new resource group to contain the service: " resourceGroupName && read -p "Enter an Azure region (for example, centralus) for the resource group: " resourceGroupRegion && params='serviceName='$serviceName' location='$serviceLocation && echo "CREATE RESOURCE GROUP: az group create --name $resourceGroupName --location $resourceGroupRegion" && az group create --name $resourceGroupName --location $resourceGroupRegion && echo "RUN az deployment group create, which creates an Azure API for FHIR service using an ARM template" && az deployment group create --resource-group $resourceGroupName --parameters $params --template-uri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.healthcareapis/azure-api-for-fhir/azuredeploy.json && read -p "Press [ENTER] to continue: " ``` --- > [!NOTE] > The deployment takes a few minutes to complete. Note the names for the Azure API for FHIR service and the resource group, for use in reviewing deployed resources. ## Review deployed resources # [Portal](#tab/azure-portal) Follow these steps to see an overview of your new Azure API for FHIR service: 1. In the [Azure portal](https://portal.azure.com), search for and select **Azure API for FHIR**. 2. In the FHIR list, select your new service. The **Overview** page for the new Azure API for FHIR service appears. 3. To validate that the new FHIR API account is provisioned, select the link next to **FHIR metadata endpoint** to fetch the FHIR API capability statement. The link has a format of `https://<service-name>.azurehealthcareapis.com/metadata`. If the account is provisioned, a JSON file is displayed. # [PowerShell](#tab/PowerShell) Run the following interactive code to view details about your Azure API for FHIR service. You have to enter the name and resource group of the new service. ```azurepowershell-interactive $serviceName = Read-Host -Prompt "Enter the name of your Azure API for FHIR service" $resourceGroupName = Read-Host -Prompt "Enter the resource group name" Write-Verbose "Get-AzHealthcareApisService -ResourceGroupName $resourceGroupName -Name $serviceName" -Verbose Get-AzHealthcareApisService -ResourceGroupName $resourceGroupName -Name $serviceName Read-Host "Press [ENTER] to fetch the FHIR API capability statement, which shows that the new service has been provisioned" $requestUri="https://" + $serviceName + ".azurehealthcareapis.com/metadata" $metadata = Invoke-WebRequest -Uri $requestUri $metadata.RawContent Read-Host "Press [ENTER] to continue" ``` # [CLI](#tab/CLI) Run the following interactive code to view details about your Azure API for FHIR service. You have to enter the name of the new service and the resource group. ```azurecli-interactive read -p "Enter the name of your Azure API for FHIR service: " serviceName && read -p "Enter the resource group name: " resourceGroupName && echo "SHOW SERVICE DETAILS: az healthcareapis service show --resource-group $resourceGroupName --resource-name $serviceName" && az healthcareapis service show --resource-group $resourceGroupName --resource-name $serviceName && read -p "Press [ENTER] to fetch the FHIR API capability statement, which shows that the new service has been provisioned: " && requestUrl='https://'$serviceName'.azurehealthcareapis.com/metadata' && curl --url $requestUrl && read -p "Press [ENTER] to continue: " ``` --- ## Clean up resources When no longer needed, delete the resource group. This deletes the resources in the resource group. # [Portal](#tab/azure-portal) 1. In the [Azure portal](https://portal.azure.com), search for and select **Resource groups**. 2. In the resource group list, choose the name of your resource group. 3. In the **Overview** page of your resource group, select **Delete resource group**. 4. In the confirmation dialog box, type the name of your resource group, and then select **Delete**. # [PowerShell](#tab/PowerShell) ```azurepowershell-interactive $resourceGroupName = Read-Host -Prompt "Enter the name of the resource group to delete" Write-Verbose "Remove-AzResourceGroup -Name $resourceGroupName" -Verbose Remove-AzResourceGroup -Name $resourceGroupName Read-Host "Press [ENTER] to continue" ``` # [CLI](#tab/CLI) ```azurecli-interactive read -p "Enter the name of the resource group to delete: " resourceGroupName && echo "DELETE A RESOURCE GROUP (AND ITS RESOURCES): az group delete --name $resourceGroupName" && az group delete --name $resourceGroupName && read -p "Press [ENTER] to continue: " ``` --- For a step-by-step tutorial that guides you through the process of creating an ARM template, see the [tutorial to create and deploy your first ARM template](../../azure-resource-manager/templates/template-tutorial-create-first-template.md) ## Next steps In this quickstart guide, you've deployed the Azure API for FHIR into your subscription. For information about how to register applications and the Azure API for FHIR configuration settings, see the following. >[!div class="nextstepaction"] >[Register Applications Overview](fhir-app-registration.md) >[!div class="nextstepaction"] >[Configure Azure RBAC](configure-azure-rbac.md) >[!div class="nextstepaction"] >[Configure local RBAC](configure-local-rbac.md) >[!div class="nextstepaction"] >[Configure database settings](configure-database.md) >[!div class="nextstepaction"] >[Configure customer-managed keys](customer-managed-key.md) >[!div class="nextstepaction"] >[Configure CORS](configure-cross-origin-resource-sharing.md) >[!div class="nextstepaction"] >[Configure Private Link](configure-private-link.md) [!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]