Mengekspor HealthLake data dengan FHIR $export

Anda dapat mengekspor data secara massal dari penyimpanan HealthLake data Anda menggunakan operasi FHIR $export. HealthLake mendukung $export penggunaan POST dan GET permintaan FHIR. Untuk membuat permintaan ekspor denganPOST, Anda harus memiliki pengguna, grup, atau peran IAM dengan izin yang diperlukan, tentukan $export sebagai bagian dari permintaan, dan sertakan parameter yang diinginkan dalam badan permintaan.

HealthLake mendukung tiga jenis permintaan titik akhir ekspor massal berikut.

Sebelum memulai

Memenuhi persyaratan berikut untuk membuat permintaan ekspor menggunakan FHIR REST API untuk HealthLake.

Mengotorisasi permintaan $export

Untuk membuat permintaan ekspor yang berhasil menggunakan FHIR REST API, otorisasi pengguna, grup, atau peran Anda menggunakan IAM atau .0. OAuth2 Anda juga harus memiliki peran layanan.

Mengotorisasi permintaan menggunakan IAM

Saat Anda membuat $export permintaan, pengguna, grup, atau peran harus memiliki tindakan IAM yang disertakan dalam kebijakan. Untuk informasi selengkapnya, lihat Menyiapkan izin untuk pekerjaan ekspor.

Mengotorisasi permintaan menggunakan SMART di FHIR (2.0) OAuth

Saat Anda membuat $export permintaan pada SMART di penyimpanan HealthLake data berkemampuan FHIR, Anda harus memiliki cakupan yang sesuai yang ditetapkan. Untuk informasi selengkapnya, lihat SMART pada cakupan sumber daya FHIR untuk HealthLake.

Membuat $export permintaan

Bagian ini menjelaskan langkah-langkah yang diperlukan yang harus Anda ambil saat membuat permintaan ekspor menggunakan FHIR REST API.

Untuk menghindari tagihan yang tidak disengaja pada AWS akun Anda, kami sarankan untuk menguji permintaan Anda dengan membuat POST permintaan tanpa menyediakan sintaks. $export

Untuk membuat permintaan, Anda harus melakukan hal berikut:

Langkah 1: Tentukan $export URL POST permintaan untuk titik akhir yang didukung.

HealthLake mendukung tiga jenis permintaan titik akhir ekspor massal. Untuk membuat permintaan ekspor massal, Anda harus membuat permintaan POST berbasis pada salah satu dari tiga titik akhir yang didukung. Contoh berikut menunjukkan di mana harus menentukan $export dalam URL permintaan.

Anda dapat menggunakan parameter pencarian yang didukung berikut dalam string POST permintaan.

Parameter pencarian yang didukung

HealthLake mendukung pengubah pencarian berikut dalam permintaan ekspor massal.

Contoh berikut termasuk karakter khusus yang harus dikodekan sebelum mengirimkan permintaan Anda.

Langkah 2: Tentukan parameter header yang diperlukan

Untuk membuat permintaan ekspor menggunakan FHIR REST API, Anda harus menentukan parameter header berikut.

Selanjutnya, Anda harus menentukan elemen yang diperlukan di badan permintaan.

Langkah 3: Tentukan badan permintaan yang menentukan parameter yang diperlukan.

Permintaan ekspor juga membutuhkan badan dalam JSON format. Tubuh dapat mencakup parameter berikut.

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

Ketika permintaan Anda berhasil, Anda akan menerima tanggapan berikut.

Respon Header

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

Respon Tubuh

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

Mengelola permintaan ekspor Anda

Setelah membuat permintaan ekspor berhasil, Anda dapat mengelola permintaan menggunakan $export untuk menjelaskan status permintaan ekspor saat ini, dan $export untuk membatalkan permintaan ekspor saat ini.

Saat membatalkan permintaan ekspor menggunakan REST API, Anda hanya ditagih untuk bagian data yang diekspor hingga saat Anda mengirimkan permintaan pembatalan.

Topik berikut menjelaskan bagaimana Anda bisa mendapatkan status atau membatalkan permintaan ekspor saat ini.

Membatalkan permintaan ekspor

Untuk membatalkan permintaan ekspor, buat DELETE permintaan dan berikan ID pekerjaan di URL permintaan.

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

Ketika permintaan Anda berhasil, Anda menerima yang berikut ini.

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

Ketika permintaan Anda tidak berhasil, Anda menerima yang berikut ini.

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

Menjelaskan permintaan ekspor

Untuk mendapatkan status permintaan ekspor, buat GET permintaan dengan menggunakan export dan Andaexport-request-job-id.

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

Respons JSON akan berisi ExportJobProperties objek. Ini mungkin berisi pasangan key:value berikut.

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