使用 FHI HealthLake R 导出数据 $export

您可以使用 FHIR $export 操作从 HealthLake 数据存储中批量导出数据。 HealthLake 支持 FHIR $export 使用POST和GET请求。要向发出导出请求POST，您必须拥有具有所需权限的 IAM 用户、群组或角色，在请求中指定$export，并在请求正文中包含所需的参数。

HealthLake 支持以下三种类型的批量导出端点请求。

开始前的准备工作

要使用适用 HealthLake的 FHIR REST API 提出导出请求，请满足以下要求。

对请求进行授$export权

要使用 FHIR REST API 成功发出导出请求，请使用 IAM 或 OAuth2 .0 对您的用户、群组或角色进行授权。您还必须具有服务角色。

使用 IAM 对请求进行授权

当您提出$export请求时，用户、群组或角色的策略中必须包含 IAM 操作。有关更多信息，请参阅 为导出任务设置权限。

在 FHIR 上使用 SMART 授权请求 (2.0) OAuth

在支持 FHIR 的 SMART HealthLake 数据存储上$export发出请求时，必须分配相应的范围。有关更多信息，请参阅 SMART 对 FHIR 的资源范围适用于 HealthLake。

提出$export请求

本节介绍使用 FHIR REST API 发出导出请求时必须采取的必要步骤。

为避免意外向您的 AWS 账户收费，我们建议您在不提供$export语法的情况下通过提出POST请求来测试您的请求。

要提出请求，您必须执行以下操作：

步骤 1：$export在POST请求网址中指定支持的终端节点。

HealthLake 支持三种类型的批量导出端点请求。要发出批量导出请求，您必须在三个支持的终端节点之一上发出POST基于请求的请求。以下示例演示了在请求网址$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请提出请求并在请求网址中提供任务 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."
    }
  ]
}

描述导出请求

要获取导出请求的状态，GET请使用export和您的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",
  }
}