Bevor Sie beginnen Autorisieren einer Anfrage export Eine export Anfrage stellen Verwaltung Ihrer Exportanfrage

Exportieren von Daten aus Ihrem HealthLake Datenspeicher mit FHIR REST API Operationen

Nachdem Sie den Vorgang abgeschlossen habenBerechtigungen für Exportaufträge einrichten, können Sie Daten mithilfe von FHIR REST API Vorgängen aus Ihrem HealthLake Datenspeicher exportieren. Um eine Exportanforderung mithilfe von stellen zu können FHIR RESTAPI, müssen Sie über einen IAM Benutzer, eine Gruppe oder eine Rolle mit den erforderlichen Berechtigungen verfügen, diese im $export Rahmen der POST Anfrage angeben und Anforderungsparameter in den Hauptteil Ihrer Anfrage aufnehmen. Gemäß der FHIR Spezifikation muss der FHIR Server GET Anfragen unterstützen und kann POST Anfragen unterstützen. Um zusätzliche Parameter zu unterstützen, ist ein Body erforderlich, um den Export zu starten. Daher werden POST Anfragen HealthLake unterstützt.

Wichtig

HealthLake Datenspeicher, die vor dem 1. Juni 2023 erstellt wurden, unterstützen nur FHIR REST API basierte Exportauftragsanforderungen für systemweite Exporte.

HealthLake Datenspeicher, die vor dem 1. Juni 2023 erstellt wurden, unterstützen nicht das Abrufen des Status eines Exports mithilfe einer GET Anfrage am Endpunkt eines Datenspeichers.

Alle Exportanfragen, die Sie mit dem stellen, FHIR REST API werden im ndjson Format zurückgegeben und in einen Amazon S3 S3-Bucket exportiert. Jedes S3-Objekt wird nur einen einzigen FHIR Ressourcentyp enthalten.

Sie können Exportanfragen gemäß den AWS Kontingenten in eine Warteschlange stellen. Weitere Informationen zu den damit verbundenen Service Quotas finden Sie unterAWS HealthLake Endpunkte und Kontingente. HealthLake

HealthLake unterstützt die folgenden drei Arten von Massenexport-Endpunktanforderungen.

Typ	Beschreibungen	Syntax
Systemexport	Exportieren Sie alle Daten vom HealthLake FHIR Server.	`POST https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/r4/$export`
Alle Patienten	Exportieren Sie alle Daten, die sich auf alle Patienten beziehen, einschließlich der Ressourcentypen, die dem Ressourcentyp Patient zugeordnet sind.	`POST https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/r4/Patient/$export`
Gruppe von Patienten	Exportieren Sie alle Daten, die sich auf eine Patientengruppe beziehen, für die eine Gruppen-ID angegeben wurde.	`POST https://healthlake.your-region.amazonaws.com/datastore/your-datastore-id/r4/Group/ID/$export`

Bevor Sie beginnen

Erfüllen Sie die folgenden Anforderungen, um mithilfe des Formulars FHIR REST API für eine Exportanfrage zu stellen HealthLake.

Sie müssen einen Benutzer, eine Gruppe oder eine Rolle eingerichtet haben, die über die erforderlichen Berechtigungen verfügt, um die Exportanfrage zu stellen. Weitere Informationen hierzu finden Sie unter Autorisieren einer Anfrage export.
Sie müssen eine Servicerolle erstellt haben, die HealthLake Zugriff auf den Amazon S3 S3-Bucket gewährt, in den Ihre Daten exportiert werden sollen. Die Servicerolle muss auch HealthLake als Dienstprinzipal angegeben werden. Weitere Informationen zum Einrichten von Berechtigungen finden Sie unterBerechtigungen für Exportaufträge einrichten.

Autorisieren einer Anfrage `export`

Um eine erfolgreiche Exportanfrage mit dem zu stellen FHIR RESTAPI, autorisieren Sie Ihren Benutzer, Ihre Gruppe oder Rolle, indem Sie entweder IAM oder OAuth2 .0 verwenden. Sie müssen außerdem über eine Servicerolle verfügen.

Autorisieren einer Anfrage mithilfe von IAM

Wenn Sie eine $export Anfrage stellen, müssen für den Benutzer, die Gruppe oder die Rolle CancelFHIRExportJobWithDelete IAM Aktionen StartFHIRExportJobWithPostDescribeFHIRExportJobWithGet, und in der Richtlinie enthalten sein.

Wichtig

HealthLake SDKExportanfragen mithilfe von StartFHIRExportJob API Operation und FHIR REST API Exportanfragen mithilfe von StartFHIRExportJobWithPost API Operation haben separate IAM Aktionen. Für jede IAM Aktion, SDK Export mit StartFHIRExportJob und FHIR REST API Export mitStartFHIRExportJobWithPost, können Berechtigungen zum Erlauben/Verweigern separat behandelt werden. Wenn Sie möchten, dass SDK sowohl FHIR REST API Exporte als auch Exporte eingeschränkt werden, stellen Sie sicher, dass Sie für jede IAM Aktion die entsprechenden Berechtigungen verweigern.

Autorisieren einer Anfrage mit SMART on FHIR (OAuth2.0)

Wenn Sie eine $export Anfrage für einen SMART FHIR aktivierten HealthLake Datenspeicher stellen, müssen Ihnen die entsprechenden Bereiche zugewiesen werden. Weitere Informationen zu unterstützten Bereichen finden Sie unter. HealthLake FHIRressourcenspezifische Bereiche des Datenspeichers

Eine `export` Anfrage stellen

In diesem Abschnitt werden die erforderlichen Schritte beschrieben, die Sie ausführen müssen, wenn Sie eine Exportanfrage mithilfe von stellen FHIR RESTAPI.

Um zu vermeiden, dass Ihr AWS Konto versehentlich belastet wird, empfehlen wir, Ihre Anfragen zu testen, indem Sie eine POST Anfrage stellen, ohne die export Syntax anzugeben.

Um die Anfrage zu stellen, müssen Sie wie folgt vorgehen:

Geben Sie export in der POST Anfrage URL einen unterstützten Endpunkt an.
Geben Sie die erforderlichen Header-Parameter an.
Geben Sie einen Anforderungstext an, der die erforderlichen Parameter definiert.

Schritt 1: Geben Sie `export` in der `POST` Anfrage URL einen unterstützten Endpunkt an

HealthLake unterstützt drei Arten von Massenexport-Endpunktanfragen. Um eine Massenexportanfrage zu stellen, müssen Sie eine POST Anfrage auf einem der drei unterstützten Endpunkte stellen. Die folgenden Beispiele zeigen, wie Sie export in der Anfrage URL angeben.

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

In dieser POST Anforderungszeichenfolge können Sie die folgenden unterstützten Suchparameter verwenden.

Unterstützte Suchparameter

HealthLake unterstützt die folgenden Suchmodifikatoren in Massenexportanfragen.

Diese Beispiele beinhalten Sonderzeichen, die vor dem Absenden Ihrer Anfrage codiert werden müssen.

Name	Erforderlich?	Beschreibung	Beispiel
`_outputFormat`	Nein	Das Format für die angeforderten Massendatendateien, die generiert werden sollen. Zulässige Werte sind`application/fhir+ndjson`,`application/ndjson`,`ndjson`.
`_type`	Nein	Eine Reihe von durch Kommas getrennten FHIR Ressourcentypen, die Sie in Ihren Exportauftrag aufnehmen möchten. Wir empfehlen die Aufnahme, `_type` da sich dies negativ auf die Kosten auswirken kann, wenn alle Ressourcen exportiert werden.	`&_type=MedicationStatement, Observation`
`_since`	Nein	Ressourcentypen, die am oder nach dem Datums- und Zeitstempel geändert wurden. Wenn für einen Ressourcentyp kein Datum der letzten Aktualisierung angegeben ist, wird er in Ihre Antwort aufgenommen.	`&_since=2024-05-09T00%3A00%3A00Z`

Schritt 2: Geben Sie die erforderlichen Header-Parameter an

Um eine Exportanforderung mit dem zu stellen FHIR RESTAPI, müssen Sie die folgenden zwei Header-Parameter angeben.

Inhaltstyp: application/fhir+json
Bevorzugen Sie: respond-async

Als Nächstes müssen Sie die erforderlichen Elemente im Anfragetext angeben.

Schritt 3: Geben Sie einen Anforderungstext an, der die erforderlichen Parameter definiert.

Für die Exportanforderung ist auch ein Hauptteil im JSON Format erforderlich. Der Körper kann die folgenden Parameter enthalten.

Schlüssel	Erforderlich?	Beschreibung	Wert
DataAccessRoleArn	Ja	Ein ARN Mitglied einer HealthLake Servicerolle. Die verwendete Servicerolle muss HealthLake als Dienstprinzipal angegeben werden.	`arn:aws:iam::444455556666:role/your-healthlake-service-role`
JobName	Nein	Der Name der Exportanforderung.	`your-export-job-name`
S3Uri	Ja	Teil eines OutputDataConfig Schlüssels. Der S3 URI des Ziel-Buckets, in den Ihre exportierten Daten heruntergeladen werden.	`s3://DOC-EXAMPLE-DESTINATION-BUCKET/EXPORT-JOB/`
KmsKeyId	Ja	Teil eines OutputDataConfig Schlüssels. Der AWS KMS Schlüssel, ARN der zum Sichern des Amazon S3 S3-Buckets verwendet wurde.	`arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab`

Beispiel — Der Hauptteil einer Exportanfrage, die mit dem FHIR REST API

Um eine Exportanfrage mithilfe von zu stellen FHIR RESTAPI, müssen Sie einen Hauptteil angeben, wie im Folgenden dargestellt.


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

Wenn Ihre Anfrage erfolgreich ist, erhalten Sie die folgende Antwort.

Header der Antwort


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

Hauptteil der Antwort


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

Verwaltung Ihrer Exportanfrage

Nachdem Sie eine erfolgreiche Exportanfrage gestellt haben, können Sie diese Anfrage verwaltenexport, indem Sie den Status einer aktuellen Exportanfrage beschreiben und export eine aktuelle Exportanfrage stornieren.

Wenn Sie eine Exportanfrage mithilfe von stornieren RESTAPI, wird Ihnen nur der Teil der Daten in Rechnung gestellt, der bis zum Absenden der Stornierungsanforderung exportiert wurde.

In den folgenden Themen wird beschrieben, wie Sie den Status einer aktuellen Exportanfrage abrufen oder diese stornieren können.

Eine Exportanfrage stornieren

Um eine Exportanfrage zu stornieren, stellen Sie eine DELETE Anfrage und geben Sie die Job-ID in der Anfrage anURL.


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

Wenn Ihre Anfrage erfolgreich ist, erhalten Sie Folgendes.


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

Wenn Ihre Anfrage nicht erfolgreich ist, erhalten Sie Folgendes.


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

Beschreibung einer Exportanfrage

Um den Status einer Exportanfrage abzurufen, stellen Sie eine GET Anfrage, indem Sie export und Ihr verwendenexport-request-job-id.


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

Die JSON Antwort wird ein ExportJobProperties Objekt enthalten. Sie kann die folgenden Schlüssel/Wert-Paare enthalten.

Name	Erforderlich?	Beschreibung	Wert
DataAccessRoleArn	Nein	Ein Mitglied ARN einer HealthLake Servicerolle. Die verwendete Servicerolle muss HealthLake als Dienstprinzipal angegeben werden.	`arn:aws:iam::444455556666:role/your-healthlake-service-role`
SubmitTime	Nein	Das Datum, zu dem ein Exportauftrag gesendet wurde.	`Apr 21, 2023 5:58:02`
EndTime	Nein	Die Uhrzeit, zu der ein Exportauftrag abgeschlossen wurde.	`Apr 21, 2023 6:00:08 PM`
JobName	Nein	Der Name der Exportanforderung.	`your-export-job-name`
JobStatus	Nein		Gültige Werte für sind: `SUBMITTED \| IN_PROGRESS \| COMPLETED_WITH_ERRORS \| COMPLETED \| FAILED`
S3Uri	Ja	Teil eines OutputDataConfigObjekts. Der Amazon S3 URI des Ziel-Buckets, in den Ihre exportierten Daten heruntergeladen werden.	`s3://DOC-EXAMPLE-DESTINATION-BUCKET/EXPORT-JOB/`
KmsKeyId	Ja	Teil eines OutputDataConfigObjekts. Der AWS KMS Schlüssel, ARN der zum Sichern des Amazon S3 S3-Buckets verwendet wurde.	`arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab`

Beispiel : Hauptteil einer Exportanfrage zur Beschreibung, die mit dem FHIR REST API

Bei Erfolg erhalten Sie die folgende JSON Antwort.


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

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Daten mit der HealthLake Konsole exportieren oder AWS SDKs

Löschen eines Datenspeichers

Exportieren von Daten aus Ihrem HealthLake Datenspeicher mit FHIR REST API Operationen

Wichtig

Bevor Sie beginnen

Autorisieren einer Anfrage export

Autorisieren einer Anfrage mithilfe von IAM

Wichtig

Autorisieren einer Anfrage mit SMART on FHIR (OAuth2.0)

Eine export Anfrage stellen

Schritt 1: Geben Sie export in der POST Anfrage URL einen unterstützten Endpunkt an

Unterstützte Suchparameter

Schritt 2: Geben Sie die erforderlichen Header-Parameter an

Schritt 3: Geben Sie einen Anforderungstext an, der die erforderlichen Parameter definiert.

Beispiel — Der Hauptteil einer Exportanfrage, die mit dem FHIR REST API

Verwaltung Ihrer Exportanfrage

Eine Exportanfrage stornieren

Beschreibung einer Exportanfrage

Beispiel : Hauptteil einer Exportanfrage zur Beschreibung, die mit dem FHIR REST API

Autorisieren einer Anfrage `export`

Eine `export` Anfrage stellen

Schritt 1: Geben Sie `export` in der `POST` Anfrage URL einen unterstützten Endpunkt an