|
| 1 | +--- |
| 2 | +title: Deploy Azure Health Data Services FHIR service using Bicep |
| 3 | +description: Learn how to deploy FHIR service by using Bicep |
| 4 | +author: schaffererin |
| 5 | +ms.service: healthcare-apis |
| 6 | +ms.topic: tutorial |
| 7 | +ms.author: v-eschaffer |
| 8 | +ms.date: 05/27/2022 |
| 9 | +--- |
| 10 | + |
| 11 | +# Deploy a FHIR service within Azure Health Data Services using Bicep |
| 12 | + |
| 13 | +In this article, you'll learn how to deploy FHIR service within the Azure Health Data Services using Bicep. |
| 14 | + |
| 15 | +[Bicep](../../azure-resource-manager/bicep/overview.md) is a domain-specific language (DSL) that uses declarative syntax to deploy Azure resources. It provides concise syntax, reliable type safety, and support for code reuse. Bicep offers the best authoring experience for your infrastructure-as-code solutions in Azure. |
| 16 | + |
| 17 | +## Prerequisites |
| 18 | + |
| 19 | +# [PowerShell](#tab/PowerShell) |
| 20 | + |
| 21 | +* An Azure account with an active subscription. [Create one for free](https://azure.microsoft.com/free/). |
| 22 | +* If you want to run the code locally: |
| 23 | + * [Azure PowerShell](/powershell/azure/install-az-ps). |
| 24 | + |
| 25 | +# [CLI](#tab/CLI) |
| 26 | + |
| 27 | +* An Azure account with an active subscription. [Create one for free](https://azure.microsoft.com/free/). |
| 28 | +* If you want to run the code locally: |
| 29 | + * A Bash shell (such as Git Bash, which is included in [Git for Windows](https://gitforwindows.org)). |
| 30 | + * [Azure CLI](/cli/azure/install-azure-cli). |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## Review the Bicep file |
| 35 | + |
| 36 | +The Bicep file used in this article is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/azure-api-for-fhir/). |
| 37 | + |
| 38 | +:::code language="bicep" source="~/quickstart-templates/quickstarts/microsoft.healthcareapis/azure-api-for-fhir/main.bicep"::: |
| 39 | + |
| 40 | +The Bicep file defines three Azure resources: |
| 41 | + |
| 42 | +* [Microsoft.HealthcareApis/workspaces](/azure/templates/microsoft.healthcareapis/workspaces): create a Microsoft.HealthcareApis/workspaces resource. |
| 43 | + |
| 44 | +* [Microsoft.HealthcareApis/workspaces/fhirservices](/azure/templates/microsoft.healthcareapis/workspaces/fhirservices): create a Microsoft.HealthcareApis/workspaces/fhirservices resource. |
| 45 | + |
| 46 | +* [Microsoft.Storage/storageAccounts](/azure/templates/microsoft.storage/storageaccounts): create a Microsoft.Storage/storageAccounts resource. |
| 47 | + |
| 48 | +## Deploy the Bicep file |
| 49 | + |
| 50 | +1. Save the Bicep file as **main.bicep** to your local computer. |
| 51 | +1. Deploy the Bicep file using either Azure CLI or Azure PowerShell. |
| 52 | + |
| 53 | + # [CLI](#tab/CLI) |
| 54 | + |
| 55 | + ```azurecli |
| 56 | + az group create --name exampleRG --location eastus |
| 57 | + az deployment group create --resource-group exampleRG --template-file main.bicep --parameters serviceName=<service-name> location=<location> |
| 58 | + ``` |
| 59 | +
|
| 60 | + # [PowerShell](#tab/PowerShell) |
| 61 | +
|
| 62 | + ```azurepowershell |
| 63 | + New-AzResourceGroup -Name exampleRG -Location eastus |
| 64 | + New-AzResourceGroupDeployment -ResourceGroupName exampleRG -TemplateFile ./main.bicep -serviceName "<service-name>" -location "<location>" |
| 65 | + ``` |
| 66 | +
|
| 67 | + --- |
| 68 | +
|
| 69 | + Replace **\<service-name\>** with the name of the service. Replace **\<location\>** with the location of the Azure API for FHIR. Location options include: |
| 70 | +
|
| 71 | + * australiaeast |
| 72 | + * eastus |
| 73 | + * eastus2 |
| 74 | + * japaneast |
| 75 | + * northcentralus |
| 76 | + * northeurope |
| 77 | + * southcentralus |
| 78 | + * southeastasia |
| 79 | + * uksouth |
| 80 | + * ukwest |
| 81 | + * westcentralus |
| 82 | + * westeurope |
| 83 | + * westus2 |
| 84 | +
|
| 85 | + > [!NOTE] |
| 86 | + > When the deployment finishes, you should see a message indicating the deployment succeeded. |
| 87 | +
|
| 88 | +## Review the deployed resources |
| 89 | +
|
| 90 | +Use the Azure portal, Azure CLI, or Azure PowerShell to list the deployed resources in the resource group. |
| 91 | +
|
| 92 | +# [CLI](#tab/CLI) |
| 93 | +
|
| 94 | +```azurecli-interactive |
| 95 | +az resource list --resource-group exampleRG |
| 96 | +``` |
| 97 | + |
| 98 | +# [PowerShell](#tab/PowerShell) |
| 99 | + |
| 100 | +```azurepowershell-interactive |
| 101 | +Get-AzResource -ResourceGroupName exampleRG |
| 102 | +``` |
| 103 | + |
| 104 | +--- |
| 105 | + |
| 106 | +> [!NOTE] |
| 107 | +> You can also verify that the FHIR service is up and running by opening a browser and navigating to `https://<yourfhirservice>.azurehealthcareapis.com/metadata`. If the |
| 108 | +> capability statement is automatically displayed or downloaded, your deployment was successful. Make sure to replace **\<yourfhirservice\>** with the **\<service-name\>** you |
| 109 | +> used in the deployment step of this quickstart. |
| 110 | +
|
| 111 | +## Clean up the resources |
| 112 | + |
| 113 | +When no longer needed, use the Azure portal, Azure CLI, or Azure PowerShell to delete the resource group and its resources. |
| 114 | + |
| 115 | +# [CLI](#tab/CLI) |
| 116 | + |
| 117 | +```azurecli-interactive |
| 118 | +az group delete --name exampleRG |
| 119 | +``` |
| 120 | + |
| 121 | +# [PowerShell](#tab/PowerShell) |
| 122 | + |
| 123 | +```azurepowershell-interactive |
| 124 | +Remove-AzResourceGroup -Name exampleRG |
| 125 | +``` |
| 126 | + |
| 127 | +--- |
| 128 | + |
| 129 | +## Next steps |
| 130 | + |
| 131 | +In this quickstart guide, you've deployed the FHIR service within Azure Health Data Services using Bicep. For more information about FHIR service supported features, proceed to the following article: |
| 132 | + |
| 133 | +>[!div class="nextstepaction"] |
| 134 | +>[Supported FHIR Features](fhir-features-supported.md) |
0 commit comments