クイックスタート: ARM テンプレートを使用して Azure API for FHIR をデプロイする

[アーティクル]
03/04/2024

重要

Azure API for FHIR は、2026 年 9 月 30 日に廃止されます。 移行戦略に従って、その日までに Azure Health Data Services FHIR® サービスに切り替えてください。 Azure API for FHIR が廃止されたため、2025 年 4 月 1 日以降、新しいデプロイは許可されません。 Azure Health Data Services FHIR サービスは、お客様が他の Azure サービスへの統合を使用して、FHIR、DICOM、および MedTech サービスを管理できるようにする、進化したバージョンの Azure API for FHIR です。

このクイックスタートでは、Azure Resource Manager テンプレート (ARM テンプレート) を使って Azure API for FHIR® (高速ヘルスケア相互運用性リソース) をデプロイする方法について説明します。 Azure API for FHIR は、Azure portal、PowerShell、CLI のいずれかを使用してデプロイできます。

Azure Resource Manager テンプレートは JavaScript Object Notation (JSON) ファイルであり、プロジェクトのインフラストラクチャと構成が定義されています。このテンプレートでは、宣言型の構文が使用されています。デプロイしようとしているものを、デプロイを作成する一連のプログラミングコマンドを記述しなくても記述できます。

環境が前提条件を満たしていて、ARM テンプレートの使用に慣れている場合は、 [Azure へのデプロイ] ボタンを選択します。サインインすると、Azure portal でテンプレートが開きます。

前提条件

アクティブなサブスクリプションが含まれる 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)]"
        }
      }
    }
  ]
}

テンプレートでは、1 つの Azure リソースを定義します。

Microsoft.HealthcareApis/services

テンプレートのデプロイ

Azure portal から ARM テンプレートを使用して Azure API for FHIR をデプロイするには、次のリンクを選択します。

[Deploy Azure API for FHIR]\(Azure API for FHIR のデプロイ\) ページで、次の作業を行います。

[サブスクリプション] が既定値になっているので、必要に応じて別のサブスクリプションに変更します。
[リソースグループ] の [新規作成] を選択し、新しいリソースグループの名前を入力し、 [OK] を選択します。
新しいリソースグループを作成した場合は、リソースグループのリージョンを選択します。
新しいサービス名を入力し、Azure API for FHIR の場所を選択します。この場所は、リソースグループのリージョンと同じでも異なっていてもかまいません。
[Review + create](レビュー + 作成) を選択します。
利用規約を読んで、 [作成] を選択します。

Note

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

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

デプロイが完了するまでに数分かかる場合があります。デプロイされたリソースの確認で使うので、Azure API for FHIR サービスの名前とリソースグループを記録しておきます。

デプロイされているリソースを確認する

新しい Azure API for FHIR サービスの概要を確認するには、次の手順に従います。

Azure portal で、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"

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 portal で、 [リソースグループ] を検索して選択します。
リソースグループの一覧で、リソースグループの名前を選択します。
リソースグループの [概要] ページで、 [リソースグループの削除] を選択します。
確認のダイアログボックスでリソースグループの名前を入力し、 [削除] を選択します。

$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 テンプレートを作成してデプロイするチュートリアルを参照してください。