FHIR을 사용하여 HealthLake 데이터 내보내기 $export

FHIR $export 작업을 사용하여 HealthLake 데이터 스토어에서 대량으로 데이터를 내보낼 수 있습니다. HealthLake는 POST 및 GET 요청을 $export 사용하여 FHIR을 지원합니다. 를 사용하여 내보내기 요청을 수행하려면 필요한 권한이 있는 IAM 사용자, 그룹 또는 역할이 있어야 하며 요청의 $export 일부로를 지정하고 요청 본문에 원하는 파라미터를 포함해야 POST합니다.

HealthLake는 다음과 같은 세 가지 유형의 대량 내보내기 엔드포인트 요청을 지원합니다.

시작하기 전 준비 사항

HealthLake용 FHIR REST API를 사용하여 내보내기 요청을 하려면 다음 요구 사항을 충족해야 합니다.

$export 요청 권한 부여

FHIR REST API를 사용하여 내보내기 요청을 성공적으로 수행하려면 IAM 또는 OAuth2.0. 서비스 역할도 있어야 합니다.

IAM을 사용하여 요청 권한 부여

$export 요청을 할 때 사용자, 그룹 또는 역할에 IAM 작업이 정책에 포함되어야 합니다. 자세한 내용은 내보내기 작업에 대한 권한 설정 단원을 참조하십시오.

FHIR(OAuth 2.0)에서 SMART를 사용하여 요청 권한 부여

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",
  }
}