Exporter HealthLake des données avec FHIR $export

Vous pouvez exporter des données en masse depuis votre magasin de HealthLake données à l'aide de l'opération FHIR $export. HealthLake prend en charge l'$exportutilisation POST et les GET demandes de FHIR. Pour effectuer une demande d'exportation avecPOST, vous devez disposer d'un utilisateur, d'un groupe ou d'un rôle IAM doté des autorisations requises, le spécifier dans le $export cadre de la demande et inclure les paramètres souhaités dans le corps de la demande.

HealthLake prend en charge les trois types suivants de demandes de terminaux d'exportation en masse.

Avant de commencer

Répondez aux exigences suivantes pour effectuer une demande d'exportation à l'aide de l'API REST FHIR pour HealthLake.

Autoriser une demande $export

Pour effectuer une demande d'exportation réussie à l'aide de l'API REST FHIR, autorisez votre utilisateur, votre groupe ou votre rôle à l'aide d'IAM ou OAuth2 .0. Vous devez également avoir un rôle de service.

Autoriser une demande à l'aide d'IAM

Lorsque vous faites une $export demande, les actions IAM de l'utilisateur, du groupe ou du rôle doivent être incluses dans la politique. Pour de plus amples informations, veuillez consulter Configuration des autorisations pour les tâches d'exportation.

Autoriser une demande à l'aide de SMART sur FHIR (2.0) OAuth

Lorsque vous faites une $export demande sur un magasin de HealthLake données compatible SMART sur FHIR, les étendues appropriées doivent vous être attribuées. Pour de plus amples informations, veuillez consulter SMART sur les champs de ressources FHIR pour HealthLake.

Faire une $export demande

Cette section décrit les étapes obligatoires que vous devez suivre lorsque vous effectuez une demande d'exportation à l'aide de l'API REST FHIR.

Pour éviter des frais accidentels sur votre AWS compte, nous vous recommandons de tester vos demandes en effectuant une POST demande sans fournir de $export syntaxe.

Pour faire la demande, vous devez effectuer les opérations suivantes :

Étape 1 : Spécifiez $export dans l'URL de POST demande un point de terminaison pris en charge.

HealthLake prend en charge trois types de demandes d'exportation groupées pour les terminaux. Pour effectuer une demande d'exportation groupée, vous devez effectuer une demande POST basée sur l'un des trois points de terminaison pris en charge. Les exemples suivants montrent où spécifier $export dans l'URL de la demande.

Vous pouvez utiliser les paramètres de recherche pris en charge suivants dans la chaîne de POST requête.

Paramètres de recherche pris en charge

HealthLake prend en charge les modificateurs de recherche suivants dans les demandes d'exportation groupées.

Les exemples suivants incluent des caractères spéciaux qui doivent être codés avant de soumettre votre demande.

Étape 2 : Spécifier les paramètres d'en-tête requis

Pour effectuer une demande d'exportation à l'aide de l'API REST FHIR, vous devez spécifier les paramètres d'en-tête suivants.

Ensuite, vous devez spécifier les éléments requis dans le corps de la demande.

Étape 3 : Spécifiez un corps de demande qui définit les paramètres requis.

La demande d'exportation nécessite également un corps au JSON format. Le corps peut inclure les paramètres suivants.

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

Lorsque votre demande sera acceptée, vous recevrez la réponse suivante.

En-tête de réponse

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

Organisme de réponse

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

Gestion de votre demande d'exportation

Après avoir effectué une demande d'exportation réussie, vous pouvez la gérer en $export décrivant le statut d'une demande d'exportation en cours et $export en annulant une demande d'exportation en cours.

Lorsque vous annulez une demande d'exportation à l'aide de l'API REST, vous n'êtes facturée que pour la partie des données exportées jusqu'au moment où vous avez soumis la demande d'annulation.

Les rubriques suivantes décrivent comment vous pouvez obtenir le statut d'une demande d'exportation en cours ou l'annuler.

Annulation d'une demande d'exportation

Pour annuler une demande d'exportation, faites une DELETE demande et indiquez l'ID de tâche dans l'URL de la demande.

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

Lorsque votre demande est acceptée, vous recevez ce qui suit.

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

Lorsque votre demande n'aboutit pas, vous recevez ce qui suit.

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

Décrire une demande d'exportation

Pour connaître le statut d'une demande d'exportation, faites une GET demande en utilisant export et votreexport-request-job-id.

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

La réponse JSON contiendra un ExportJobProperties objet. Il peut contenir les paires clé:valeur suivantes.

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