HealthLake Daten mit FHIR exportieren $export

Mithilfe der Operation FHIR $export 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önnenPOST, 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.

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

Bevor Sie beginnen

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

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.

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.

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:

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, wo $export in der Anforderungs-URL angegeben werden muss.

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.

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.

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

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

Die Exportanforderung erfordert auch einen Hauptteil im JSON Format. Der Körper kann die folgenden Parameter enthalten.

{
  "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 mit export und Ihrexport-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.

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