Esportazione di HealthLake dati con FHIR $export

Puoi esportare i dati in blocco dal tuo archivio HealthLake dati utilizzando l'operazione FHIR $export. HealthLake supporta l'utilizzo e le richieste di FHIR$export. POST GET Per effettuare una richiesta di esportazionePOST, devi disporre di un utente, gruppo o ruolo IAM con le autorizzazioni richieste, specificarlo $export come parte della richiesta e includere i parametri desiderati nel corpo della richiesta.

HealthLake supporta i seguenti tre tipi di richieste endpoint di esportazione in blocco.

Prima di iniziare

Soddisfa i seguenti requisiti per effettuare una richiesta di esportazione utilizzando l'API REST FHIR per HealthLake.

Autorizzazione di una richiesta $export

Per effettuare correttamente una richiesta di esportazione utilizzando l'API REST FHIR, autorizza il tuo utente, gruppo o ruolo utilizzando IAM o .0. OAuth2 È inoltre necessario avere un ruolo di servizio.

Autorizzazione di una richiesta tramite IAM

Quando effettui una $export richiesta, l'utente, il gruppo o il ruolo devono includere azioni IAM nella policy. Per ulteriori informazioni, consulta Impostazione delle autorizzazioni per i lavori di esportazione.

Autorizzazione di una richiesta utilizzando SMART on FHIR (2.0) OAuth

Quando si effettua una $export richiesta su un HealthLake data store compatibile con SMART on FHIR, è necessario assegnare gli ambiti appropriati. Per ulteriori informazioni, consulta SMART sugli ambiti di risorse FHIR per HealthLake.

Effettuare una richiesta $export

Questa sezione descrive i passaggi necessari da eseguire quando si effettua una richiesta di esportazione utilizzando l'API REST FHIR.

Per evitare addebiti accidentali sul tuo AWS account, ti consigliamo di testare le tue richieste effettuando una POST richiesta senza fornire la $export sintassi.

Per effettuare la richiesta, devi fare quanto segue:

Passo 1: Specificare $export nell'URL della POST richiesta un endpoint supportato.

HealthLake supporta tre tipi di richieste endpoint di esportazione in blocco. Per effettuare una richiesta di esportazione in blocco, è necessario effettuare una richiesta POST basata su uno dei tre endpoint supportati. Gli esempi seguenti mostrano dove specificare $export nell'URL della richiesta.

È possibile utilizzare i seguenti parametri di ricerca supportati nella stringa di POST richiesta.

Parametri di ricerca supportati

HealthLake supporta i seguenti modificatori di ricerca nelle richieste di esportazione in blocco.

I seguenti esempi includono caratteri speciali che devono essere codificati prima di inviare la richiesta.

Passaggio 2: Specificare i parametri di intestazione richiesti

Per effettuare una richiesta di esportazione utilizzando l'API REST FHIR, è necessario specificare i seguenti parametri di intestazione.

Successivamente, è necessario specificare gli elementi richiesti nel corpo della richiesta.

Fase 3: Specificare un corpo della richiesta e definire i parametri richiesti.

La richiesta di esportazione richiede anche un corpo in JSON formato. Il corpo può includere i seguenti parametri.

{
  "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 la richiesta avrà esito positivo, riceverai la seguente risposta.

Intestazione della risposta

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

Corpo di risposta

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

Gestione della richiesta di esportazione

Dopo aver effettuato una richiesta di esportazione corretta, puoi gestirla descrivendo $export lo stato di una richiesta di esportazione corrente e $export annullando una richiesta di esportazione corrente.

Quando annulli una richiesta di esportazione utilizzando l'API REST, ti viene fatturata solo la parte dei dati che sono stati esportati fino al momento in cui hai inviato la richiesta di annullamento.

I seguenti argomenti descrivono come impostare o annullare una richiesta di esportazione corrente.

Annullamento di una richiesta di esportazione

Per annullare una richiesta di esportazione, effettua una DELETE richiesta e fornisci l'ID del lavoro nell'URL della richiesta.

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

Quando la richiesta ha esito positivo, riceverai quanto segue.

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

Quando la tua richiesta non va a buon fine, ricevi quanto segue.

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

Descrizione di una richiesta di esportazione

Per conoscere lo stato di una richiesta di esportazione, effettua una GET richiesta utilizzando export and yourexport-request-job-id.

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

La risposta JSON conterrà un ExportJobProperties oggetto. Può contenere le seguenti coppie chiave:valore.

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