FHIR を使用した HealthLake データのエクスポート $export

FHIR $export オペレーションを使用して、HealthLake データストアからデータを一括エクスポートできます。HealthLake は、 POSTおよび GETリクエスト$exportを使用した FHIR をサポートしています。でエクスポートリクエストを行うにはPOST、必要なアクセス許可を持つ IAM ユーザー、グループ、またはロールがあり、リクエスト$exportの一部として を指定し、リクエスト本文に必要なパラメータを含める必要があります。

HealthLake は、次の 3 種類の一括エクスポートエンドポイントリクエストをサポートしています。

[開始する前に]

HealthLake 用の FHIR REST API を使用してエクスポートリクエストを行うには、次の要件を満たします。

$export リクエストの承認

FHIR REST API を使用してエクスポートリクエストを成功させるには、IAM または OAuth2.0. サービスロールも必要です。

IAM を使用したリクエストの承認

$export リクエストを行うときは、ユーザー、グループ、またはロールに IAM アクションがポリシーに含まれている必要があります。詳細については、「エクスポートジョブのアクセス許可の設定」を参照してください。

SMART on FHIR (OAuth 2.0) を使用したリクエストの承認

SMART on FHIR 対応 HealthLake データストアで$exportリクエストを行うときは、適切なスコープを割り当てる必要があります。詳細については、「HealthLake の FHIR リソーススコープに関する SMART」を参照してください。

$export リクエストを行う

このセクションでは、FHIR REST API を使用してエクスポートリクエストを行うときに必要な手順について説明します。

AWS アカウントで誤って課金されないように、$export構文を指定せずにリクエストを実行してPOSTリクエストをテストすることをお勧めします。

リクエストを行うには、以下を実行する必要があります。

ステップ 1: サポートされているエンドポイント$exportのPOSTリクエスト URL で を指定します。

HealthLake は、3 種類の一括エクスポートエンドポイントリクエストをサポートしています。一括エクスポートリクエストを行うには、サポートされている 3 つのエンドポイントのいずれかに対して POSTベースのリクエストを行う必要があります。次の例は、リクエスト URL $exportで を指定する場所を示しています。

POST リクエスト文字列では、次のサポートされている検索パラメータを使用できます。

サポートされている検索パラメータ

HealthLake は、一括エクスポートリクエストで次の検索修飾子をサポートしています。

次の例には、リクエストを送信する前にエンコードする必要がある特殊文字が含まれています。

ステップ 2: 必要なヘッダーパラメータを指定する

FHIR REST API を使用してエクスポートリクエストを行うには、次のヘッダーパラメータを指定する必要があります。

次に、リクエスト本文で必要な要素を指定する必要があります。

ステップ 3: で必要なパラメータを定義するリクエスト本文を指定します。

エクスポートリクエストには、 JSON形式の本文も必要です。本文には、次のパラメータを含めることができます。

{
  "DataAccessRoleArn": "arn:aws:iam::444455556666:role/your-healthlake-service-role",
  "JobName": "your-export-job",
  "OutputDataConfig": {
    "S3Configuration": {
      "S3Uri": "s3://amzn-s3-demo-bucket/EXPORT-JOB",
      "KmsKeyId": "arn:aws:kms:region-of-bucket:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    }
  }
}

リクエストが成功すると、次のレスポンスを受け取ります。

レスポンスヘッダー

content-location: https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/export/your-export-request-job-id

レスポンス本文

{
  "datastoreId": "your-data-store-id",
  "jobStatus": "SUBMITTED",
  "jobId": "your-export-request-job-id"
}

エクスポートリクエストの管理

エクスポートリクエストが成功したら、 を使用して現在のエクスポートリクエストのステータスを$export記述し、現在のエクスポートリクエストをキャンセル$exportして、リクエストを管理できます。

REST API を使用してエクスポートリクエストをキャンセルすると、キャンセルリクエストを送信した時点までにエクスポートされたデータの一部に対してのみ課金されます。

以下のトピックでは、現在のエクスポートリクエストのステータスを取得またはキャンセルする方法について説明します。

エクスポートリクエストのキャンセル

エクスポートリクエストをキャンセルするには、DELETEリクエストを行い、リクエスト URL にジョブ ID を指定します。

DELETE https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/export/your-export-request-job-id

リクエストが成功すると、以下が表示されます。

{
  "exportJobProperties": {
    "jobId": "your-original-export-request-job-id",
    "jobStatus": "CANCEL_SUBMITTED",
    "datastoreId": "your-data-store-id"
  }
}

リクエストが成功しない場合、次の情報が表示されます。

{
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "not-supported",
      "diagnostics": "Interaction not supported."
    }
  ]
}

エクスポートリクエストの説明

エクスポートリクエストのステータスを取得するには、 exportと を使用してGETリクエストを行いますexport-request-job-id。

GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/export/your-export-request-id

JSON レスポンスには ExportJobProperties オブジェクトが含まれます。これには、次のキーと値のペアが含まれる場合があります。

SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED |
      FAILED

{
  "exportJobProperties": {
    "jobId": "your-export-request-id",
    "JobName": "your-export-job",
    "jobStatus": "SUBMITTED",
    "submitTime": "Apr 21, 2023 5:58:02 PM",
    "endTime": "Apr 21, 2023 6:00:08 PM",
    "datastoreId": "your-data-store-id",
    "outputDataConfig": {
      "s3Configuration": {
        "S3Uri": "s3://amzn-s3-demo-bucket/EXPORT-JOB",
        "KmsKeyId": "arn:aws:kms:region-of-bucket:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab""
      }
    },
    "DataAccessRoleArn": "arn:aws:iam::444455556666:role/your-healthlake-service-role",
  }
}