Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
# HealthLake Daten mit FHIR exportieren `$export`
Mithilfe der Operation FHIR \$1export können Sie HealthLake Daten in großen Mengen aus Ihrem Datenspeicher exportieren. HealthLake unterstützt die `$export` Verwendung `POST` von FHIR und Anfragen. `GET` Um eine Exportanfrage mit stellen zu können`POST`, benötigen Sie einen IAM-Benutzer, eine Gruppe oder eine IAM-Rolle mit den erforderlichen Berechtigungen, die Sie im `$export` Rahmen der Anfrage angeben und die gewünschten Parameter in den Anfragetext aufnehmen können.
**Anmerkung**
Alle mit FHIR gestellten HealthLake Exportanfragen `$export` werden im `ndjson` Format zurückgegeben und in einen Amazon S3 S3-Bucket exportiert, in dem jedes Amazon S3 S3-Objekt nur einen einzigen FHIR-Ressourcentyp enthält.
Sie können Exportanfragen im Rahmen der AWS Konto-Servicekontingente in die Warteschlange stellen. Weitere Informationen finden Sie unter [Servicekontingente](reference-healthlake-endpoints-quotas.md#reference-healthlake-quotas).
HealthLake unterstützt die folgenden drei Arten von Massenexport-Endpunktanforderungen.
**HealthLake `$export`Massentypen**
| Exporttyp | Description | Syntax |
| --- | --- | --- |
| System (System) | Exportieren Sie alle Daten vom HealthLake FHIR-Server. | `POST https://healthlake.region.amazonaws.com/datastore/datastoreId/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.region.amazonaws.com/datastore/datastoreId/r4/Patient/$export` `GET https://healthlake.region.amazonaws.com/datastore/datastoreId/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.region.amazonaws.com/datastore/datastoreId/r4/Group/id/$export` `GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Group/id/$export` |
## Bevor Sie beginnen
Erfüllen Sie die folgenden Anforderungen, um eine Exportanfrage mithilfe der FHIR REST-API für HealthLake zu stellen.
+ 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`](#export-rest-auth).
+ 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 unter[Berechtigungen für Exportaufträge einrichten](getting-started-setting-up.md#setting-up-export-permissions).
## Autorisieren einer Anfrage `$export`
Um eine erfolgreiche Exportanfrage mit der FHIR REST-API zu stellen, autorisieren Sie Ihren Benutzer, Ihre Gruppe oder Rolle entweder mit IAM oder .0. OAuth2 Sie müssen auch ü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 IAM-Aktionen in der Richtlinie enthalten sein. Weitere Informationen finden Sie unter [Berechtigungen für Exportaufträge einrichten](getting-started-setting-up.md#setting-up-export-permissions).
**Autorisieren einer Anfrage mit SMART auf FHIR (2.0) OAuth**
Wenn Sie eine `$export` Anfrage in einem SMART on FHIR-fähigen HealthLake Datenspeicher stellen, müssen Ihnen die entsprechenden Bereiche zugewiesen sein. Weitere Informationen finden Sie unter [Die Ressourcen von SMART auf FHIR umfassen folgende Bereiche HealthLake](reference-smart-on-fhir-oauth-scopes.md#smart-on-fhir-scopes-rest).
**Anmerkung**
FHIR `$export` mit `GET` Anfragen erfordert dieselbe Authentifizierungsmethode oder dasselbe Trägertoken (im Fall von SMART auf FHIR), um den Export anzufordern und Dateien abzurufen. Mit FHIR `$export` mit exportierte Dateien `GET` stehen 48 Stunden lang zum Download zur Verfügung.
## Eine `$export` Anfrage stellen
In diesem Abschnitt werden die erforderlichen Schritte beschrieben, die Sie ergreifen müssen, wenn Sie eine Exportanfrage mithilfe der FHIR REST-API stellen.
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:
1. Geben Sie `$export` in der `POST` Anfrage-URL einen unterstützten Endpunkt an.
1. Geben Sie die erforderlichen Header-Parameter an.
1. Geben Sie einen Anforderungstext an, der die erforderlichen Parameter definiert.
### Schritt 1: Geben Sie `$export` in der `POST` Anfrage-URL einen unterstützten [Endpunkt](reference-healthlake-endpoints-quotas.md#reference-healthlake-endpoints) 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, wo `$export` in der Anforderungs-URL angegeben werden muss.
+ `POST https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/$export`
+ `POST https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Patient/$export`
+ `POST https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Group/id/$export`
Sie können die folgenden unterstützten Suchparameter in der `POST` Anforderungszeichenfolge verwenden.
#### Unterstützte Suchparameter
HealthLake unterstützt die folgenden Suchmodifikatoren in Massenexportanfragen.
Die folgenden Beispiele enthalten Sonderzeichen, die vor dem Absenden Ihrer Anfrage codiert werden müssen.
| Name | Erforderlich? | Description | Beispiel |
| --- | --- | --- | --- |
| \$1outputFormat | Nein | Das Format für die angeforderten Massendatendateien, die generiert werden sollen. Zulässige Werte sindapplication/fhir\$1ndjson,application/ndjson,ndjson. | |
| \$1type | Nein | Eine Folge von durch Kommas getrennten FHIR-Ressourcentypen, die Sie in Ihren Exportauftrag aufnehmen möchten. Wir empfehlen die Aufnahme, \$1type da sich dies auf Kosten auswirken kann, wenn alle Ressourcen exportiert werden. | &\$1type=MedicationStatement, Observation |
| \$1since | 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. | &\$1since=2024-05-09T00%3A00%3A00Z |
| \$1until | Nein | Ressourcentypen, die am oder vor dem Datumszeitstempel geändert wurden. Wird in Kombination mit verwendet\$1since, um einen bestimmten Zeitraum für den Export zu definieren. Wenn für einen Ressourcentyp kein Datum der letzten Aktualisierung angegeben ist, wird er von Ihrer Antwort ausgeschlossen. | &\$1until=2024-12-31T23%3A59%3A59Z |
### Schritt 2: Geben Sie die erforderlichen Header-Parameter an
Um eine Exportanforderung mithilfe der FHIR REST-API zu stellen, müssen Sie die folgenden 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.
| Key (Schlüssel) | Erforderlich? | Description | Wert |
| --- | --- | --- | --- |
| DataAccessRoleArn | Ja | Ein ARN 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. Die S3-URI des Ziel-Buckets, in den Ihre exportierten Daten heruntergeladen werden. | s3://amzn-s3-demo-bucket/EXPORT-JOB/ |
| KmsKeyId | Ja | Teil eines OutputDataConfig Schlüssels. Der ARN des AWS KMS Schlüssels, der zur Sicherung des Amazon S3 S3-Buckets verwendet wurde. | arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab |
**Example Hauptteil einer Exportanfrage, die mit der FHIR REST-API gestellt wurde**
Um eine Exportanfrage mithilfe der FHIR REST-API zu stellen, 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://amzn-s3-demo-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.region.amazonaws.com/datastore/datastoreId/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 die Anfrage verwalten, indem `$export` Sie den Status einer aktuellen Exportanfrage beschreiben und `$export` eine aktuelle Exportanfrage stornieren.
Wenn Sie eine Exportanfrage mithilfe der REST-API stornieren, 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-URL an.
```
DELETE https://healthlake.region.amazonaws.com/datastore/datastoreId/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 verwenden`export-request-job-id`.
```
GET https://healthlake.region.amazonaws.com/datastore/datastoreId/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? | Description | Wert |
| --- | --- | --- | --- |
| DataAccessRoleArn | Nein | Ein 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 | | Folgende sind gültige Werte:SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED |
FAILED
|
| S3Uri | Ja | Teil eines [OutputDataConfig](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_OutputDataConfig.html)Objekts. Die Amazon S3 S3-URI des Ziel-Buckets, in den Ihre exportierten Daten heruntergeladen werden. | s3://amzn-s3-demo-bucket/EXPORT-JOB/ |
| KmsKeyId | Ja | Teil eines [OutputDataConfig](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_OutputDataConfig.html)Objekts. Der ARN des AWS KMS Schlüssels, der zur Sicherung des Amazon S3 S3-Buckets verwendet wurde. | arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab |
**Example : Hauptteil einer Exportanfrage zur Beschreibung, die mithilfe der FHIR REST-API gestellt wurde**
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://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",
}
}
```