Azure API for FHIR で FHIR データをエクスポートする
重要
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 です。
一括エクスポート機能を使用すると、FHIR 仕様に従って FHIR サーバーからデータをエクスポートできます。
$exportを使用する前に、それを使用するように Azure API for FHIR が構成されていることを確認する必要があります。 エクスポート設定を構成し、Azure ストレージ アカウントを作成する方法については、データのエクスポートの構成ページを参照してください。
Note
Azure API for FHIR の場合と同じサブスクリプション内のストレージ アカウントのみが、$export操作の宛先として登録できます。
$export コマンドの使用
エクスポート用に Azure API for FHIR を構成すると、$export コマンドを使用して、サービスからデータをエクスポートできます。 データは、エクスポートの構成時に指定したストレージ アカウントに格納されます。 FHIR サーバーで $export コマンドを呼び出す方法については、HL7 FHIR $export の仕様に関するドキュメントを参照してください。
ジョブが正しくない状態でスタックした
状況によっては、ジョブが不適切な状態で停止する可能性があります。 これは、ストレージ アカウントのアクセス許可が正しく設定されていない場合に特に発生する可能性があります。 エクスポートを検証する 1 つの方法は、ストレージ アカウントをチェックして、ndjson対応するコンテナー (つまり) ファイルが存在するかどうかを確認することです。 存在せず、実行中の他のエクスポート ジョブがない場合は、現在のジョブが正しくない状態でスタックしている可能性があります。 取り消し要求を送信してエクスポート ジョブを取り消し、ジョブをもう一度キューに入れ直す必要があります。 エクスポートが正しくない状態になった場合、停止して新しいジョブに移動するか、またはエクスポートを再試行するまでの既定の実行時間は 10 分です。
Azure API For FHIR では、次のレベルでの $export がサポートされています。
- システム:
GET https://<<FHIR service base URL>>/$export>> - 患者:
GET https://<<FHIR service base URL>>/Patient/$export>> - 患者のグループ* - Azure API for FHIR は関連するすべてのリソースをエクスポートしますが、グループの特性はエクスポートしません。
GET https://<<FHIR service base URL>>/Group/[ID]/$export>>
エクスポートでは、データは 1 種類のリソースのみを含む複数のファイルにエクスポートされます。 個々のファイル内のリソースの数は制限されます。 リソースの最大数は、システムのパフォーマンスに基づいています。 現在 5,000 に設定されていますが、変更される可能性があります。 その結果、リソースの種類に対して複数のファイルが取得される可能性があります。 ファイル名は'resourceName-number-number.ndjson' の形式に従います。 ファイルの順序は、データベース内のリソースの順序に対応するとは限りません。
Note
リソースが複数のリソースから成るコンパートメント内にある場合、または複数のグループに存在する場合は、Patient/$export と Group/[ID]/$export によって重複するリソースがエクスポートされることがあります。
さらに、キュー登録中に場所ヘッダーによって返された URL を介したエクスポートの状態の確認と、現行のエクスポート ジョブのキャンセルもサポートされています。
FHIR データを ADLS Gen2 にエクスポートする
現在、ADLS Gen2 対応のストレージ アカウントに対する $export がサポートされていますが、次の制限があります。
- ユーザーは階層型名前空間を利用できませんが、コンテナー内の特定のサブディレクトリへのエクスポートをターゲットにする方法はありません。 ターゲットにすることができるのは、特定のコンテナーだけです (エクスポートごとに新しいフォルダーが作成されます)。
- エクスポートが完了すると、そのフォルダーに再び何かがエクスポートされることはありません。同じコンテナーへの後続のエクスポートは新しく作成されたフォルダーに入れられるためです。
設定とパラメーター
ヘッダー
$export ジョブに設定する必要がある必須のヘッダー パラメーターが 2 つあります。 値は、現在の $export 仕様で定義されています。
- Accept - application/fhir+json
- Prefer - respond-async
クエリ パラメーター
Azure API for FHIR では、次のクエリ パラメーターがサポートされています。 これらのパラメーターはすべて省略可能です。
| Query parameter (クエリ パラメーター) | FHIR 仕様で定義されている | 説明 |
|---|---|---|
| _outputFormat | はい | 現在、FHIR 仕様に合わせて 3 つの値 (application/fhir+ndjson、application/ndjson、または ndjson) がサポートされています。 すべてのエクスポート ジョブが返 ndjson され、渡された値はコードの動作には影響しません。 |
| _ので | はい | 指定された時間以降に変更されたリソースのみをエクスポートできます |
| _type | はい | どの種類のリソースを含めるかを指定できます。 たとえば、_type=Patient は患者のリソースのみを返します |
| _typefilter | はい | きめ細かいフィルター処理を要求するには、_typefilterを _type パラメーターと共に使用できます。 _TypeFilter パラメーターの値は、結果をさらに限定する FHIR クエリのコンマ区切りリストです。 |
| _コンテナー | いいえ | データのエクスポート先となる、構成済みストレージ アカウント内のコンテナーを指定します。 コンテナーが指定されている場合は、そのコンテナーのフォルダーにデータがエクスポートされます。 コンテナーが指定されていない場合、データは新しいコンテナーにエクスポートされます。 |
| _まで | いいえ | 指定された時間まで変更されたリソースのみをエクスポートできます。 このパラメーターは、システム レベルのエクスポートにのみ適用されます。 この場合、履歴バージョンが無効または消去されていない場合、エクスポートでは true スナップショット ビューが保証されます。つまり、時間移動が有効になります。 |
| includeAssociatedData | いいえ | 履歴と論理的に削除されたリソースをエクスポートできます。 このフィルターは、'_typeFilter' クエリ パラメーターでは機能しません。 履歴/最新バージョン管理されていないリソースをエクスポートするには、値を "_history" として含めます。 論理的に削除されたリソースをエクスポートするには、値を "_deleted" として含めます。 |
| _isparallel | いいえ | "_isparallel" クエリ パラメーターをエクスポート操作に追加して、スループットを向上させることができます。 並列化を有効にするには、値を true に設定する必要があります。 このパラメーターを使用すると、エクスポートの有効期間中に要求ユニットの消費量が増加する可能性があることに注意してください。 |
Note
$export操作には既知の問題があり、その結果、状態が成功するとエクスポートが不完全になる可能性があります。 is_parallel フラグが使用されたときに問題が発生します。 2024 年 2 月 13 日以降、_isparallel クエリ パラメーターで実行されたエクスポート ジョブは、この問題の影響を受けます。
Azure Storage へのセキュア エクスポート
Azure API for FHIR では、セキュア エクスポート操作がサポートされます。 次の 2 つのオプションのいずれかを選択します。
Azure API for FHIR を Microsoft 信頼済みサービスとして Azure ストレージ アカウントにアクセスできるようにする。
Azure API for FHIR に関連付けられている特定の IP アドレスが Azure ストレージ アカウントにアクセスできるようにします。 このオプションでは、ストレージ アカウントが Azure API for FHIR と同じ場所にあるか、または別の場所にあるかに応じて、2 つの異なる構成が提供されます。
Azure API for FHIR を Microsoft 信頼済みサービスとして許可する
Azure portal からストレージ アカウントを選択し、続いて [ネットワーク] ブレードを選択します。 [ファイアウォールと仮想ネットワーク] タブで [選択されたネットワーク] を選択します。
重要
マネージド ID を使用して、Azure API for FHIR のストレージ アカウントへのアクセス許可が付与されていることを確認します。 詳細については、「エクスポート設定の構成とストレージ アカウントの設定」を参照してください。
[例外] セクションで、[信頼された Microsoft サービスによるこのストレージ アカウントに対するアクセスを許可します] を選択し、設定を保存します。
これで、ストレージ アカウントに FHIR データを安全にエクスポートする準備ができました。 ストレージ アカウントは、選択したネットワーク上にあり、パブリックにアクセスできないことに注意してください。 ファイルにアクセスするには、ストレージ アカウントのプライベート エンドポイントを有効にして使用するか、ストレージ アカウントのすべてのネットワークを短時間有効にすることします。
重要
ユーザー インターフェイスは後で更新され、Azure API for FHIR のリソースの種類と特定のサービス インスタンスを選択できるようになります。
特定の IP アドレスが他の Azure リージョンから Azure ストレージ アカウントにアクセスできるようにする
Azure portal で、Azure Data Lake Storage Gen2 アカウントに移動します。
左側のメニューで、[ネットワーク] を選択します。
[選択した仮想ネットワークと IP アドレスから有効] を選択します。
[ファイアウォール] セクションの [アドレス範囲] ボックスで、IP アドレスを指定します。 インターネットまたはオンプレミスのネットワークからのアクセスを許可する IP 範囲を追加します。 次の表に、FHIR サービスがプロビジョニングされている Azure リージョンの IP アドレスを示します。
Azure リージョン パブリック IP アドレス オーストラリア東部 20.53.44.80 カナダ中部 20.48.192.84 米国中部 52.182.208.31 米国東部 20.62.128.148 米国東部 2 20.49.102.228 米国東部 2 EUAP 20.39.26.254 ドイツ北部 51.116.51.33 ドイツ中西部 51.116.146.216 東日本 20.191.160.26 韓国中部 20.41.69.51 米国中北部 20.49.114.188 北ヨーロッパ 52.146.131.52 南アフリカ北部 102.133.220.197 米国中南部 13.73.254.220 東南アジア 23.98.108.42 スイス北部 51.107.60.95 英国南部 51.104.30.170 英国西部 51.137.164.94 米国中西部 52.150.156.44 西ヨーロッパ 20.61.98.66 米国西部 2 40.64.135.77
同じリージョン内の Azure ストレージ アカウントへのアクセスを特定の IP アドレスに許可する
同じリージョンの IP アドレスの構成プロセスは前の手順と同じですが、クラスレス Inter-Doメイン Routing (CIDR) 形式 (つまり、100.64.0.0/10) で特定の IP アドレス範囲を使用する点が異なります。 操作要求を行うたびに FHIR サービスの IP アドレスが割り当てられるため、IP アドレス範囲 (100.64.0.0 から 100.127.255.255) を指定する必要があります。
Note
10.0.2.0/24 の範囲内でプライベート IP アドレスを使用することはできますが、このような場合に操作が成功する保証はありません。 操作要求が失敗した場合は再試行できますが、100.64.0.0/10 の範囲内の IP アドレスを使用するまで、要求は成功しません。
IP アドレス範囲に対するこのネットワーク動作は仕様です。 代替策として、ストレージ アカウントを別のリージョンで構成する方法があります。
次のステップ
この記事では、$export コマンドを使用して、FHIR リソースをエクスポートする方法について説明しました。 次に、識別解除されたデータをエクスポートする方法については、以下を参照してください。
FHIR® は HL7 の登録商標であり、HL7 の許可を得て使用しています。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示