Exportación HealthLake de datos con FHIR $export

Puede exportar datos de forma masiva desde su almacén de HealthLake datos mediante la operación $export de FHIR. HealthLake admite el $export uso POST y las solicitudes del FHIR. GET Para realizar una solicitud de exportaciónPOST, debe tener un usuario, grupo o rol de IAM con los permisos necesarios, especificarlo $export como parte de la solicitud e incluir los parámetros deseados en el cuerpo de la solicitud.

HealthLake admite los siguientes tres tipos de solicitudes de punto final de exportación masiva.

Antes de empezar

Cumpla los siguientes requisitos para realizar una solicitud de exportación mediante la API REST del FHIR para HealthLake.

Autorizar una solicitud $export

Para realizar correctamente una solicitud de exportación mediante la API REST de FHIR, autorice a su usuario, grupo o rol mediante IAM o .0. OAuth2 También debe tener un rol de servicio.

Autorizar una solicitud mediante IAM

Al realizar una $export solicitud, el usuario, el grupo o el rol deben incluir las acciones de IAM en la política. Para obtener más información, consulte Configurar los permisos para los trabajos de exportación.

Autorizar una solicitud mediante SMART en el FHIR (2.0) OAuth

Al realizar una $export solicitud en un almacén de HealthLake datos compatible con SMART on FHIR, debe tener asignados los ámbitos adecuados. Para obtener más información, consulte Los alcances de los recursos de SMART on FHIR son: HealthLake.

¿Hacer una solicitud $export

En esta sección se describen los pasos necesarios que debe seguir al realizar una solicitud de exportación mediante la API REST del FHIR.

Para evitar cargos accidentales en tu AWS cuenta, te recomendamos probar tus solicitudes realizando una POST solicitud sin proporcionar la $export sintaxis.

Para realizar la solicitud, debes hacer lo siguiente:

Paso 1: especifique $export en la URL de la POST solicitud un punto final compatible.

HealthLake admite tres tipos de solicitudes de punto final de exportación masiva. Para realizar una solicitud de exportación masiva, debe realizar una solicitud POST basada en uno de los tres puntos de enlace compatibles. Los siguientes ejemplos muestran dónde especificar $export en la URL de la solicitud.

Puede utilizar los siguientes parámetros de búsqueda admitidos en la cadena de POST solicitud.

Parámetros de búsqueda compatibles

HealthLake admite los siguientes modificadores de búsqueda en las solicitudes de exportación masiva.

Los siguientes ejemplos incluyen caracteres especiales que deben codificarse antes de enviar la solicitud.

Paso 2: especifique los parámetros de cabecera necesarios

Para realizar una solicitud de exportación mediante la API REST del FHIR, debe especificar los siguientes parámetros de encabezado.

A continuación, debe especificar los elementos necesarios en el cuerpo de la solicitud.

Paso 3: especifique un cuerpo de solicitud que defina los parámetros necesarios.

La solicitud de exportación también requiere un cuerpo en JSON formato. El cuerpo puede incluir los siguientes 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"
    }
  }
}

Cuando la solicitud se realice correctamente, recibirá la siguiente respuesta.

Encabezado de respuesta

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

Cuerpo de respuesta

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

Gestionar tu solicitud de exportación

Tras realizar correctamente una solicitud de exportación, puede gestionarla $export para describir el estado de una solicitud de exportación actual y $export cancelar una solicitud de exportación actual.

Cuando cancelas una solicitud de exportación mediante la API REST, solo se te facturará la parte de los datos que se exportaron hasta el momento en que enviaste la solicitud de cancelación.

En los siguientes temas se describe cómo puede obtener el estado de una solicitud de exportación actual o cancelarla.

Cancelar una solicitud de exportación

Para cancelar una solicitud de exportación, realice una DELETE solicitud e introduzca el identificador de trabajo en la URL de la solicitud.

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

Cuando la solicitud se realice correctamente, recibirá lo siguiente.

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

Si su solicitud no se acepta, recibirá lo siguiente.

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

Describir una solicitud de exportación

Para conocer el estado de una solicitud de exportación, haga una GET solicitud utilizando export y suexport-request-job-id.

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

La respuesta de JSON contendrá un ExportJobProperties objeto. Puede contener los siguientes pares clave-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",
  }
}