使用 FHIR 匯出 HealthLake 資料 $export

您可以使用 FHIR $export 操作，從 HealthLake 資料存放區大量匯出資料。HealthLake 支援$export使用 POST和 GET請求的 FHIR。若要使用 提出匯出請求POST，您必須擁有具有必要許可的 IAM 使用者、群組或角色、指定 $export做為請求的一部分，並在請求內文中包含所需的參數。

HealthLake 支援下列三種類型的大量匯出端點請求。

開始之前

符合下列要求，以使用適用於 HealthLake 的 FHIR REST API 提出匯出請求。

授權$export請求

若要使用 FHIR REST API 提出成功的匯出請求，請使用 IAM 或 OAuth2.0. 您還必須擁有服務角色。

使用 IAM 授權請求

當您提出$export請求時，使用者、群組或角色必須在政策中包含 IAM 動作。如需詳細資訊，請參閱設定匯出任務的許可。

在 FHIR 上使用 SMART 授權請求 (OAuth 2.0)

當您在啟用 FHIR 的 HealthLake 資料存放區上對 SMART 提出$export請求時，您必須指派適當的範圍。如需詳細資訊，請參閱HealthLake 的 FHIR 資源範圍上的 SMART。

提出$export請求

本節說明使用 FHIR REST API 提出匯出請求時必須採取的必要步驟。

為了避免 AWS 您的帳戶意外產生費用，我們建議您在不提供$export語法的情況下提出請求來測試您的POST請求。

若要提出請求，您必須執行下列動作：

步驟 1：在支援端點的POST請求 URL $export中指定 。

HealthLake 支援三種類型的大量匯出端點請求。若要提出大量匯出請求，您必須在三個支援的端點之一上提出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",
  }
}