Exportação de HealthLake dados com o FHIR $export

Você pode exportar dados em massa do seu armazenamento de HealthLake dados usando a operação FHIR $export. HealthLake suporta o $export uso POST e as solicitações do FHIR. GET Para fazer uma solicitação de exportação comPOST, você precisa ter um usuário, grupo ou função do IAM com as permissões necessárias, especificar $export como parte da solicitação e incluir os parâmetros desejados no corpo da solicitação.

HealthLake suporta os três tipos de solicitações de endpoint de exportação em massa a seguir.

Antes de começar

Atenda aos requisitos a seguir para fazer uma solicitação de exportação usando a API FHIR REST para. HealthLake

Autorizando uma solicitação $export

Para fazer uma solicitação de exportação bem-sucedida usando a API REST FHIR, autorize seu usuário, grupo ou função usando IAM ou .0. OAuth2 Você também deve ter uma função de serviço.

Autorizar uma solicitação usando o IAM

Quando você faz uma $export solicitação, o usuário, o grupo ou a função devem ter ações do IAM incluídas na política. Para obter mais informações, consulte Configurando permissões para trabalhos de exportação.

Autorizando uma solicitação usando SMART no FHIR (2.0) OAuth

Ao fazer uma $export solicitação em um SMART no armazenamento de HealthLake dados habilitado para FHIR, você deve ter os escopos apropriados atribuídos. Para obter mais informações, consulte SMART nos escopos de recursos do FHIR para HealthLake.

Fazendo uma $export solicitação

Esta seção descreve as etapas necessárias que você deve seguir ao fazer uma solicitação de exportação usando a API FHIR REST.

Para evitar cobranças acidentais em sua AWS conta, recomendamos testar suas solicitações fazendo uma POST solicitação sem fornecer a $export sintaxe.

Para fazer a solicitação, você deve fazer o seguinte:

Etapa 1: especifique $export no URL da POST solicitação para um endpoint compatível.

HealthLake oferece suporte a três tipos de solicitações de endpoint de exportação em massa. Para fazer uma solicitação de exportação em massa, você deve fazer uma solicitação POST com base em um dos três endpoints compatíveis. Os exemplos a seguir demonstram onde especificar $export na URL da solicitação.

Você pode usar os seguintes parâmetros de pesquisa compatíveis na string de POST solicitação.

Parâmetros de pesquisa compatíveis

HealthLake suporta os seguintes modificadores de pesquisa em solicitações de exportação em massa.

Os exemplos a seguir incluem caracteres especiais que devem ser codificados antes de enviar sua solicitação.

Etapa 2: Especificar os parâmetros de cabeçalho necessários

Para fazer uma solicitação de exportação usando a API REST FHIR, você deve especificar os seguintes parâmetros de cabeçalho.

Em seguida, você deve especificar os elementos necessários no corpo da solicitação.

Etapa 3: especifique um corpo de solicitação que defina os parâmetros necessários.

A solicitação de exportação também exige um corpo em JSON formato. O corpo pode incluir os seguintes parâmetros.

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

Quando sua solicitação for bem-sucedida, você receberá a seguinte resposta.

cabeçalho de resposta

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

Corpo de resposta

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

Gerenciando sua solicitação de exportação

Depois de fazer uma solicitação de exportação bem-sucedida, você pode gerenciar a solicitação usando $export para descrever o status de uma solicitação de exportação atual e $export cancelar uma solicitação de exportação atual.

Ao cancelar uma solicitação de exportação usando a API REST, você só é cobrado pela parte dos dados que foram exportados até o momento em que você enviou a solicitação de cancelamento.

Os tópicos a seguir descrevem como você pode obter o status de uma solicitação de exportação atual ou cancelá-la.

Cancelamento de uma solicitação de exportação

Para cancelar uma solicitação de exportação, faça uma DELETE solicitação e forneça o ID do trabalho na URL da solicitação.

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

Quando sua solicitação for bem-sucedida, você receberá o seguinte.

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

Quando sua solicitação não for bem-sucedida, você receberá o seguinte.

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

Descrever uma solicitação de exportação

Para obter o status de uma solicitação de exportação, faça uma GET solicitação usando export e seuexport-request-job-id.

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

A resposta JSON conterá um ExportJobProperties objeto. Ele pode conter os seguintes pares chave-valor.

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