快速入門：使用 ARM 範本部署 Azure API for FHIR

發行項
09/25/2024

重要

Azure API for FHIR 將於 2026 年 9 月 30 日淘汰。 請依照移轉策略，在該日期前轉換至 Azure 健康資料服務 FHIR® 服務。由於 Azure API for FHIR 已淘汰，因此從 2025 年 4 月 1 日開始，將不允許新的部署。 Azure 健康資料服務 FHIR 服務是 Azure API for FHIR 的進化版本，可讓客戶透過與其他 Azure 服務整合來管理 FHIR、DICOM 和醫療技術服務。

在本快速入門中，您了解如何使用 Azure Resource Manager 範本 (ARM 範本)，來部署適用於快速健康照護互通資源 (FHIR®) 的 Azure API。您可以透過 Azure 入口網站、PowerShell 或 CLI 來部署 Azure API for FHIR。

Azure Resource Manager 範本是一個 JavaScript 物件標記法 (JSON) 檔案，會定義專案的基礎結構和設定。範本使用宣告式語法。您可以描述預期的部署，而不需要撰寫程式設計命令順序來建立部署。

如果您的環境符合必要條件，而且您很熟悉 ARM 範本，請選取 [部署至 Azure] 按鈕。一旦您登入，範本就會在 Azure 入口網站中開啟。

必要條件

具有有效訂用帳戶的 Azure 帳戶。免費建立一個。

檢閱範本

本快速入門中使用的範本是來自 Azure 快速入門範本。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.5.6.12127",
      "templateHash": "9588053699595008971"
    }
  },
  "parameters": {
    "serviceName": {
      "type": "string",
      "metadata": {
        "description": "The name of the service."
      }
    },
    "location": {
      "type": "string",
      "allowedValues": [
        "australiaeast",
        "eastus",
        "eastus2",
        "japaneast",
        "northcentralus",
        "northeurope",
        "southcentralus",
        "southeastasia",
        "uksouth",
        "ukwest",
        "westcentralus",
        "westeurope",
        "westus2"
      ],
      "metadata": {
        "description": "Location of Azure API for FHIR"
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.HealthcareApis/services",
      "apiVersion": "2021-11-01",
      "name": "[parameters('serviceName')]",
      "location": "[parameters('location')]",
      "kind": "fhir-R4",
      "properties": {
        "authenticationConfiguration": {
          "audience": "[format('https://{0}.azurehealthcareapis.com', parameters('serviceName'))]",
          "authority": "[uri(environment().authentication.loginEndpoint, subscription().tenantId)]"
        }
      }
    }
  ]
}

範本會定義一個 Azure 資源。

Microsoft.HealthcareApis/services

部署範本

選取下列連結，以在 Azure 入口網站中使用 ARM 範本，來部署 Azure API for FHIR：

在 [部署 Azure API for FHIR] 頁面上：

如果您想要的話，請將 [訂用帳戶] 從預設值變更為不同的訂用帳戶。
針對 [資源群組]，選取 [新建]，然後輸入新資源群組的名稱並選取 [確認]。
如果您已建立新的資源群組，請選取資源群組的 [區域]。
輸入新的 [服務名稱] ，然後選擇 Azure API for FHIR 的 [位置]。此位置可以與資源群組的區域相同或不同。
選取 [檢閱 + 建立]。
閱讀條款及條件，然後選取 [建立]。

注意

如果您想要在本機執行 PowerShell 指令碼，請先輸入 Connect-AzAccount 來設定您的 Azure 認證。

如果 Microsoft.HealthcareApis 資源提供者尚未針對您的訂用帳戶註冊，您可以使用下列互動式程式碼加以註冊。若要在 Azure Cloud Shell 中執行程式碼，請在任何程式碼區塊的右上角選取 [試用]。

Register-AzResourceProvider -ProviderNamespace Microsoft.HealthcareApis

使用下列程式碼，利用 ARM 範本來部署 Azure API for FHIR 服務。此程式碼會提示您提供新的 FHIR 服務名稱、新資源群組的名稱，以及其中每一個的位置。

$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"

az extension add --name healthcareapis

使用下列程式碼，利用 ARM 範本來部署 Azure API for FHIR 服務。此程式碼會提示您提供新的 FHIR 服務名稱、新資源群組的名稱，以及其中每一個的位置。

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: "

注意

部署需要數分鐘的時間才能完成。記下 Azure API for FHIR 服務和資源群組的名稱，以用於檢閱已部署的資源。

檢閱已部署的資源

請依照下列步驟來查看新 Azure API for FHIR 服務的概觀：

在 Azure 入口網站中，搜尋並選取 [Azure API for FHIR]。
在 FHIR 清單中，選取您的新服務。新 Azure API for FHIR 服務的 [概觀] 頁面隨即出現。
若要驗證是否已佈建新的 FHIR API 帳戶，請選取 [FHIR 中繼資料端點] 旁的連結，以擷取 FHIR API 功能陳述式。連結的格式為 https://<service-name>.azurehealthcareapis.com/metadata。如果已佈建帳戶，則會顯示 JSON 檔案。

執行下列互動式程式碼以檢視 Azure API for FHIR 服務的詳細資料。您必須輸入新服務的名稱和資源群組。

$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"

執行下列互動式程式碼以檢視 Azure API for FHIR 服務的詳細資料。您必須輸入新服務的名稱和資源群組。

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: "

清除資源

不再需要資源群組時，請加以刪除。這會刪除資源群組中的資源。

在 Azure 入口網站中，搜尋並選取 [資源群組]。
在 [資源群組] 清單中，選擇資源群組的名稱。
在資源群組的 [概觀] 頁面中，選取 [刪除資源群組]。
在確認對話方塊凹輸入您的資源群組名稱，然後選取 [刪除]。

$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"

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: "

如需逐步教學課程，以引導您完成建立 ARM 範本的流程，請參閱：建立和部署第一個 ARM 範本教學課程