Exportation de données depuis votre HealthLake banque de données avec FHIR REST API opérations - AWS HealthLake
Avant de commencerAutoriser une demande exportFaire une export demandeGestion de votre demande d'exportation

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Exportation de données depuis votre HealthLake banque de données avec FHIR REST API opérations

Une fois que vous avez terminéConfiguration des autorisations pour les tâches d'exportation, vous pouvez exporter les données de votre HealthLake banque de données avec FHIR REST API les opérations. Pour effectuer une demande d'exportation à l'aide de FHIR RESTAPI, vous devez disposer IAM d'un utilisateur, d'un groupe ou d'un rôle doté des autorisations requises, le spécifier dans le $export cadre de la POST demande et inclure les paramètres de la demande dans le corps de votre demande. Selon les FHIR spécifications, le FHIR serveur doit prendre en charge les GET demandes et peut prendre en charge les POST demandes. Afin de prendre en charge des paramètres supplémentaires, un corps est nécessaire pour démarrer l'exportation. Il HealthLake prend donc en charge les POST demandes.

Important

HealthLake les banques de données créées avant le 1er juin 2023 ne prennent en charge que les demandes de travail d'exportation FHIR REST API basées sur les exportations à l'échelle du système.

HealthLake les magasins de données créés avant le 1er juin 2023 ne permettent pas d'obtenir le statut d'une exportation à l'aide d'une GET demande sur le point de terminaison d'un magasin de données.

Toutes les demandes d'exportation que vous effectuez à l'aide du FHIR REST API sont renvoyées au ndjson format et exportées vers un compartiment Amazon S3. Chaque objet S3 ne contiendra qu'un seul type de FHIR ressource.

Vous pouvez mettre en file d'attente les demandes d'exportation conformément aux quotas du AWS compte. Pour en savoir plus sur les Quotas de Service associés à HealthLake, consultezAWS HealthLake points de terminaison et quotas.

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

Type Descriptions Syntaxe

Exportation du système

Exportez toutes les données depuis le HealthLake FHIR serveur.

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

Tous les patients

Exportez toutes les données relatives à tous les patients, y compris les types de ressources associés au type de ressource Patient.

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

Groupe de patients

Exportez toutes les données relatives à un groupe de patients spécifié par un identifiant de groupe.

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

Avant de commencer

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

  • Vous devez avoir configuré un utilisateur, un groupe ou un rôle disposant des autorisations nécessaires pour effectuer la demande d'exportation. Pour en savoir plus, consultez Autoriser une demande export.

  • Vous devez avoir créé un rôle de service qui accorde l' HealthLake accès au compartiment Amazon S3 vers lequel vous souhaitez que vos données soient exportées. Le rôle de service doit également être spécifié HealthLake comme principal de service. Pour plus d'informations sur la configuration des autorisations, consultezConfiguration des autorisations pour les tâches d'exportation.

Autoriser une demande export

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

Autoriser une demande en utilisant IAM

Lorsque vous faites une $export demande, l'utilisateur, le groupe ou le rôle doit avoir StartFHIRExportJobWithPost des CancelFHIRExportJobWithDelete IAM actions incluses dans la politique. DescribeFHIRExportJobWithGet

Important

HealthLake SDKles demandes d'exportation utilisant l'StartFHIRExportJobAPIopération et les demandes FHIR REST API d'exportation utilisant l'StartFHIRExportJobWithPostAPIopération ont IAM des actions distinctes. Les autorisations d'autorisation/de refus peuvent être traitées StartFHIRExportJob séparément pour chaque IAM actionStartFHIRExportJobWithPost, qu'il s'agisse d'une FHIR REST API exportation ou d'une exportation avec. SDK Si vous souhaitez restreindre à la fois les FHIR REST API exportations SDK et les exportations, assurez-vous de refuser les autorisations pour chaque IAM action.

Autoriser une demande à l'aide de SMART on FHIR (OAuth2.0)

Lorsque vous faites une $export demande SMART sur un magasin de HealthLake données FHIR activé, les étendues appropriées doivent vous être attribuées. Pour en savoir plus sur les étendues prises en charge, consultezHealthLake portées spécifiques aux FHIR ressources du magasin de données.

Faire une export demande

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

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 :

  1. Spécifiez export dans la POST demande un point URL de terminaison pris en charge.

  2. Spécifiez les paramètres d'en-tête requis.

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

Étape 1 : Spécifiez export dans la POST demande un point URL 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 comment spécifier export dans la demandeURL.

  • 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

Dans cette chaîne de POST requête, vous pouvez utiliser les paramètres de recherche pris en charge suivants.

Paramètres de recherche pris en charge

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

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

Nom Obligatoire ? Description Exemple
_outputFormat Non Format des fichiers de données en masse demandés à générer. Les valeurs acceptées sont application/fhir+ndjsonapplication/ndjson,ndjson.
_type Non Chaîne de types de FHIR ressources séparés par des virgules que vous souhaitez inclure dans votre tâche d'exportation. Nous vous recommandons de l'inclure, _type car cela peut avoir une incidence financière lorsque toutes les ressources sont exportées. &_type=MedicationStatement, Observation
_since Non Types de ressources modifiés le jour ou après l'horodatage. Si un type de ressource n'a pas d'heure de dernière mise à jour, il sera inclus dans votre réponse. &_since=2024-05-09T00%3A00%3A00Z

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

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

  • Type de contenu : application/fhir+json

  • Préférez : respond-async

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.

Clé Obligatoire ? Description Valeur
DataAccessRoleArn Oui Et ARN d'un rôle HealthLake de service. Le rôle de service utilisé doit être spécifié HealthLake comme principal de service. arn:aws:iam::444455556666:role/your-healthlake-service-role
JobName Non Nom de la demande d'exportation. your-export-job-name
S3Uri Oui Partie d'une OutputDataConfig clé. Le S3 URI du compartiment de destination dans lequel vos données exportées seront téléchargées. s3://DOC-EXAMPLE-DESTINATION-BUCKET/EXPORT-JOB/
KmsKeyId Oui Partie d'une OutputDataConfig clé. La ARN AWS KMS clé utilisée pour sécuriser le compartiment Amazon S3. arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
Exemple — Le corps d'une demande d'exportation effectuée à l'aide du FHIR REST API

Pour effectuer une demande d'exportation à l'aide du FHIR RESTAPI, vous devez spécifier un corps, comme indiqué ci-dessous.

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

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

En-tête de réponse

content-location: https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/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 gérer cette demande en utilisant export pour décrire le statut d'une demande d'exportation en cours et export pour annuler une demande d'exportation en cours.

Lorsque vous annulez une demande d'exportation à l'aide du RESTAPI, vous ne serez 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 la demandeURL.

DELETE https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/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.your-region.amazonaws.com/datastore/your-datastore-id/r4/export/your-export-request-id

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

NomObligatoire ?DescriptionValeur
DataAccessRoleArnNonEt ARN d'un rôle HealthLake de service. Le rôle de service utilisé doit être spécifié HealthLake comme principal de service.arn:aws:iam::444455556666:role/your-healthlake-service-role
SubmitTimeNonDate à laquelle une tâche d'exportation a été soumise.Apr 21, 2023 5:58:02
EndTimeNon

Heure à laquelle une tâche d'exportation a été terminée.

Apr 21, 2023 6:00:08 PM
JobNameNonNom de la demande d'exportation.your-export-job-name
JobStatusNonLes valeurs valides sont :
SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED |
      FAILED
S3UriOuiPartie d'un OutputDataConfigobjet. L'Amazon S3 URI du compartiment de destination dans lequel vos données exportées seront téléchargées.s3://DOC-EXAMPLE-DESTINATION-BUCKET/EXPORT-JOB/
KmsKeyIdOuiPartie d'un OutputDataConfigobjet. La ARN AWS KMS clé utilisée pour sécuriser le compartiment Amazon S3.arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
Exemple : corps d'une description de la demande d'exportation effectuée à l'aide du FHIR REST API

En cas de succès, vous obtiendrez la JSON réponse suivante.

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