Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Mengekspor HealthLake data dengan FHIR `$export`
Anda dapat mengekspor data secara massal dari penyimpanan HealthLake data Anda menggunakan operasi FHIR \$1export. HealthLake mendukung `$export` penggunaan `POST` dan `GET` permintaan FHIR. Untuk membuat permintaan ekspor dengan`POST`, 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.
**catatan**
Semua permintaan HealthLake ekspor yang dibuat menggunakan FHIR dikembalikan dalam `ndjson` format dan diekspor ke bucket Amazon S3, di `$export` mana setiap objek Amazon S3 hanya berisi satu jenis sumber daya FHIR.
Anda dapat mengantri permintaan ekspor per kuota layanan AWS akun. Untuk informasi selengkapnya, lihat [Kuota layanan](reference-healthlake-endpoints-quotas.md#reference-healthlake-quotas).
HealthLake mendukung tiga jenis permintaan titik akhir ekspor massal berikut.
**HealthLake `$export`jenis massal**
| Tipe ekspor | Deskripsi | Sintaksis |
| --- | --- | --- |
| Sistem | Ekspor semua data dari server HealthLake FHIR. | `POST https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/$export` |
| Semua pasien | Ekspor semua data yang berkaitan dengan semua pasien termasuk jenis sumber daya yang terkait dengan jenis sumber daya Pasien. | `POST https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Patient/$export` `GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Patient/$export` |
| Sekelompok pasien | Ekspor semua data yang berkaitan dengan sekelompok pasien yang ditentukan dengan ID Grup. | `POST https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Group/id/$export` `GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Group/id/$export` |
## Sebelum Anda mulai
Memenuhi persyaratan berikut untuk membuat permintaan ekspor menggunakan FHIR REST API untuk HealthLake.
+ Anda harus menyiapkan pengguna, grup, atau peran yang memiliki izin yang diperlukan untuk membuat permintaan ekspor. Untuk mempelajari selengkapnya, lihat [Mengotorisasi permintaan `$export`](#export-rest-auth).
+ Anda harus telah membuat peran layanan yang memberikan HealthLake akses ke bucket Amazon S3 tempat Anda ingin data Anda diekspor. Peran layanan juga harus ditentukan HealthLake sebagai kepala layanan. Untuk informasi selengkapnya tentang menyiapkan izin, lihat[Menyiapkan izin untuk pekerjaan ekspor](getting-started-setting-up.md#setting-up-export-permissions).
## 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](getting-started-setting-up.md#setting-up-export-permissions).
**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](reference-smart-on-fhir-oauth-scopes.md#smart-on-fhir-scopes-rest).
**catatan**
FHIR `$export` dengan `GET` permintaan memerlukan metode otentikasi atau token pembawa yang sama (dalam kasus SMART di FHIR) untuk meminta ekspor dan mengambil file. File yang diekspor menggunakan FHIR `$export` dengan `GET` tersedia untuk diunduh selama 48 jam.
## 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:
1. Tentukan `$export` di URL `POST` permintaan untuk titik akhir yang didukung.
1. Tentukan parameter header yang diperlukan.
1. Tentukan badan permintaan yang mendefinisikan parameter yang diperlukan.
### Langkah 1: Tentukan `$export` URL `POST` permintaan untuk [titik akhir](reference-healthlake-endpoints-quotas.md#reference-healthlake-endpoints) 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.
+ `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`
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.
| Nama | Wajib? | Deskripsi | Contoh |
| --- | --- | --- | --- |
| \$1outputFormat | Tidak | Format untuk file Data Massal yang diminta untuk dihasilkan. Nilai yang diterima adalahapplication/fhir\$1ndjson,application/ndjson,ndjson. | |
| \$1type | Tidak | Serangkaian jenis sumber daya FHIR yang dibatasi koma yang ingin Anda sertakan dalam pekerjaan ekspor Anda. Kami merekomendasikan termasuk \$1type karena ini dapat memiliki implikasi biaya ketika semua sumber daya diekspor. | &\$1type=MedicationStatement, Observation |
| \$1since | Tidak | Jenis sumber daya dimodifikasi pada atau setelah stempel tanggal waktu. Jika jenis sumber daya tidak memiliki waktu pembaruan terakhir, mereka akan disertakan dalam respons Anda. | &\$1since=2024-05-09T00%3A00%3A00Z |
| \$1until | Tidak | Jenis sumber daya dimodifikasi pada atau sebelum stempel tanggal waktu. Digunakan dalam kombinasi dengan \$1since untuk menentukan rentang waktu tertentu untuk ekspor. Jika jenis sumber daya tidak memiliki waktu pembaruan terakhir, mereka akan dikecualikan dari respons Anda. | &\$1until=2024-12-31T23%3A59%3A59Z |
### Langkah 2: Tentukan parameter header yang diperlukan
Untuk membuat permintaan ekspor menggunakan FHIR REST API, Anda harus menentukan parameter header berikut.
+ Tipe Konten: `application/fhir+json`
+ Lebih suka: `respond-async`
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.
| Key | Wajib? | Deskripsi | Nilai |
| --- | --- | --- | --- |
| DataAccessRoleArn | Ya | ARN dari peran HealthLake layanan. Peran layanan yang digunakan harus ditentukan HealthLake sebagai prinsipal layanan. | arn:aws:iam::444455556666:role/your-healthlake-service-role |
| JobName | Tidak | Nama permintaan ekspor. | your-export-job-name |
| S3Uri | Ya | Bagian dari sebuah OutputDataConfig kunci. URI S3 dari bucket tujuan tempat data Anda yang diekspor akan diunduh. | s3://amzn-s3-demo-bucket/EXPORT-JOB/ |
| KmsKeyId | Ya | Bagian dari sebuah OutputDataConfig kunci. ARN dari AWS KMS kunci yang digunakan untuk mengamankan bucket Amazon S3. | arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab |
**Example Isi permintaan ekspor yang dibuat menggunakan FHIR REST API**
Untuk membuat permintaan ekspor dengan menggunakan FHIR REST API, Anda harus menentukan isi, seperti yang ditunjukkan dalam berikut ini.
```
{
"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 Anda`export-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.
| Nama | Wajib? | Deskripsi | Nilai |
| --- | --- | --- | --- |
| DataAccessRoleArn | Tidak | ARN dari peran HealthLake layanan. Peran layanan yang digunakan harus ditentukan HealthLake sebagai prinsipal layanan. | arn:aws:iam::444455556666:role/your-healthlake-service-role |
| SubmitTime | Tidak | Tanggal waktu pekerjaan ekspor diajukan. | Apr 21, 2023 5:58:02 |
| EndTime | Tidak | Waktu pekerjaan ekspor selesai. | Apr 21, 2023 6:00:08 PM |
| JobName | Tidak | Nama permintaan ekspor. | your-export-job-name |
| JobStatus | Tidak | | Nilai yang valid adalah:SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED |
FAILED
|
| S3Uri | Ya | Bagian dari suatu [OutputDataConfig](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_OutputDataConfig.html)objek. URI Amazon S3 dari bucket tujuan tempat data yang Anda ekspor akan diunduh. | s3://amzn-s3-demo-bucket/EXPORT-JOB/ |
| KmsKeyId | Ya | Bagian dari suatu [OutputDataConfig](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_OutputDataConfig.html)objek. ARN dari AWS KMS kunci yang digunakan untuk mengamankan bucket Amazon S3. | arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab |
**Example : Isi permintaan ekspor deskripsi yang dibuat menggunakan FHIR REST API**
Ketika berhasil, Anda akan mendapatkan respon JSON berikut.
```
{
"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",
}
}
```