Exportación de datos de su almacén de HealthLake datos con FHIR REST API operaciones - AWS HealthLake
Antes de empezarAutorizar una solicitud exportRealizar una solicitud exportGestionar tu solicitud de exportación

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Exportación de datos de su almacén de HealthLake datos con FHIR REST API operaciones

Una vez finalizada la operaciónConfiguración de permisos para trabajos de exportación, puede exportar los datos del almacén de HealthLake datos con FHIR REST API operaciones. Para realizar una solicitud de exportación mediante el FHIR RESTAPI, debe tener un IAM usuario, grupo o rol con los permisos necesarios, especificarlo $export como parte de la POST solicitud e incluir los parámetros de la solicitud en el cuerpo de la solicitud. Según la FHIR especificación, el FHIR servidor debe admitir GET las solicitudes y puede POST admitirlas. Para admitir parámetros adicionales, se necesita un organismo que inicie la exportación y, por lo tanto, HealthLake admite POST las solicitudes.

importante

HealthLake Los almacenes de datos creados antes del 1 de junio de 2023 solo admiten solicitudes de trabajo de exportación FHIR REST API basadas en exportaciones a nivel de todo el sistema.

HealthLake Los almacenes de datos creados antes del 1 de junio de 2023 no permiten obtener el estado de una exportación mediante una GET solicitud en el punto final de un almacén de datos.

Todas las solicitudes de exportación que realice mediante el FHIR REST API se devuelven en ndjson formato y se exportan a un bucket de Amazon S3. Cada objeto de S3 contendrá un solo tipo FHIR de recurso.

Puede poner en cola las solicitudes de exportación según las cuotas de la AWS cuenta. Para obtener más información sobre los Service Quotas asociados a HealthLake, consulteAWS HealthLake puntos finales y cuotas.

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

Tipo Descripciones Sintaxis

Exportación del sistema

Exporte todos los datos del HealthLake FHIR servidor.

POST https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/r4/$export

Todos los pacientes

Exporte todos los datos relacionados con todos los pacientes, incluidos los tipos de recursos asociados al tipo de recurso del paciente.

POST https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/r4/Patient/$export

Grupo de pacientes

Exporte todos los datos relacionados con un grupo de pacientes especificado con un identificador de grupo.

POST https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/r4/Group/ID/$export

Antes de empezar

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

  • Debe haber configurado un usuario, grupo o rol que tenga los permisos necesarios para realizar la solicitud de exportación. Para obtener más información, consulte Autorizar una solicitud export.

  • Debe haber creado un rol de servicio que conceda HealthLake acceso al bucket de Amazon S3 al que quiere que se exporten sus datos. El rol de servicio también debe especificarse HealthLake como principal de servicio. Para obtener más información sobre la configuración de permisos, consulteConfiguración de permisos para trabajos de exportación.

Autorizar una solicitud export

Para realizar correctamente una solicitud de exportación mediante el FHIR RESTAPI, autorice su usuario, grupo o rol mediante una de las siguientes opciones: IAM o OAuth2 .0. 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 tener StartFHIRExportJobWithPost la política y CancelFHIRExportJobWithDelete IAM las acciones incluidas en ella. DescribeFHIRExportJobWithGet

importante

HealthLake SDKlas solicitudes de exportación mediante StartFHIRExportJob API la operación y las solicitudes de FHIR REST API exportación mediante StartFHIRExportJobWithPost API la operación tienen IAM acciones distintas. Los permisos de SDK autorización/denegación se pueden gestionar por StartFHIRExportJobWithPost separado para cada IAM acción (FHIRRESTAPIexportar con o exportar con). StartFHIRExportJob Si quieres restringir SDK tanto FHIR REST API las exportaciones como las exportaciones, asegúrate de denegar los permisos para cada IAM acción.

Autorizar una solicitud mediante SMART on FHIR (OAuth2.0)

Cuando realiza una $export solicitud SMART en un almacén de HealthLake datos FHIR habilitado, debe tener asignados los ámbitos adecuados. Para obtener más información sobre los ámbitos compatibles, consulte. HealthLake alcances específicos de FHIR los recursos del almacén de datos

Realizar una solicitud export

En esta sección se describen los pasos necesarios que debe seguir al realizar una solicitud de exportación mediante el FHIR RESTAPI.

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:

  1. Especifique export en la POST URL solicitud un punto final compatible.

  2. Especifique los parámetros de cabecera necesarios.

  3. Especifique el cuerpo de la solicitud que defina los parámetros necesarios.

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

HealthLake admite tres tipos de solicitudes de puntos finales 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 cómo especificar export en la solicitudURL.

  • POST https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/r4/$export

  • POST https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/r4/Patient/$export

  • POST https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/r4/Group/ID/$export

En esa cadena de POST solicitud, puede utilizar los siguientes parámetros de búsqueda compatibles.

Parámetros de búsqueda compatibles

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

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

Nombre ¿Obligatorio? Descripción Ejemplo
_outputFormat No El formato para generar los archivos de datos masivos solicitados. Los valores aceptados sonapplication/fhir+ndjson,application/ndjson,ndjson.
_type No Cadena de tipos de FHIR recursos delimitados por comas que desea incluir en su trabajo de exportación. Recomendamos incluirlo _type porque esto puede tener repercusiones en los costes cuando se exportan todos los recursos. &_type=MedicationStatement, Observation
_since No Tipos de recursos modificados en o después de la marca de fecha y hora. Si un tipo de recurso no tiene una hora de última actualización, se incluirá en la respuesta. &_since=2024-05-09T00%3A00%3A00Z

Paso 2: especifique los parámetros de cabecera necesarios

Para realizar una solicitud de exportación mediante el FHIR RESTAPI, debe especificar los dos parámetros de encabezado siguientes.

  • Content-Type: application/fhir+json

  • Prefiero: respond-async

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.

Clave ¿Obligatorio? Descripción Valor
DataAccessRoleArn Sí Una función ARN de HealthLake servicio. El rol de servicio utilizado debe especificarse HealthLake como principal de servicio. arn:aws:iam::444455556666:role/your-healthlake-service-role
JobName No El nombre de la solicitud de exportación. your-export-job-name
S3Uri Sí Parte de una OutputDataConfig clave. El S3 URI del depósito de destino donde se descargarán los datos exportados. s3://DOC-EXAMPLE-DESTINATION-BUCKET/EXPORT-JOB/
KmsKeyId Sí Parte de una OutputDataConfig clave. La ARN AWS KMS clave utilizada para proteger el bucket de Amazon S3. arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
ejemplo — Cuerpo de una solicitud de exportación realizada mediante el FHIR REST API

Para realizar una solicitud de exportación mediante el FHIR RESTAPI, debe especificar un cuerpo, como se muestra a continuación.

{
  "DataAccessRoleArn": "arn:aws:iam::444455556666:role/your-healthlake-service-role",
  "JobName": "your-export-job",
  "OutputDataConfig": {
    "S3Configuration": {
      "S3Uri": "s3://DOC-EXAMPLE-DESTINATION-BUCKET/EXPORT-JOB",
      "KmsKeyId": "arn:aws:kms:region-of-bucket:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    }
  }
}

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

Encabezado de respuesta

content-location: https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/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, puedes export gestionarla describiendo el estado de una solicitud de exportación actual y export cancelando una solicitud de exportación actual.

Si cancela una solicitud de exportación mediante el RESTAPI, solo se le facturará la parte de los datos que se exportaron hasta el momento en que envió 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, haga una DELETE solicitud e introduzca el identificador de trabajo en la solicitudURL.

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

Cuando la solicitud se haya realizado 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.your-region.amazonaws.com/datastore/your-datastore-id/r4/export/your-export-request-id

La JSON respuesta contendrá un ExportJobProperties objeto. Puede contener los siguientes pares clave-valor.

Nombre¿Obligatorio?DescripciónValor
DataAccessRoleArnNoUna ARN de las funciones de HealthLake servicio. El rol de servicio utilizado debe especificarse HealthLake como principal de servicio.arn:aws:iam::444455556666:role/your-healthlake-service-role
SubmitTimeNoFecha y hora en que se envió un trabajo de exportación.Apr 21, 2023 5:58:02
EndTimeNo

La hora en que se completó un trabajo de exportación.

Apr 21, 2023 6:00:08 PM
JobNameNoEl nombre de la solicitud de exportación.your-export-job-name
JobStatusNoLos valores válidos son:
SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED |
      FAILED
S3UriSíParte de un OutputDataConfigobjeto. El Amazon S3 URI del depósito de destino donde se descargarán los datos exportados.s3://DOC-EXAMPLE-DESTINATION-BUCKET/EXPORT-JOB/
KmsKeyIdSíParte de un OutputDataConfigobjeto. La ARN AWS KMS clave utilizada para proteger el bucket de Amazon S3.arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
ejemplo : Cuerpo de una solicitud de exportación descrita realizada mediante el FHIR REST API

Si se ejecuta correctamente, obtendrá la siguiente JSON respuesta.

{
  "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://DOC-EXAMPLE-DESTINATION-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",
  }
}