Fitur Utama Titik Akhir Operasi Parameter Permintaan Jenis Ekspor Dukungan Profil dan Logika Inklusi Pemfilteran temporal untuk ekspor PDeX Sampel Permintaan Contoh Respons Hubungan Sumber Daya Manajemen Job Format Output Penanganan Kesalahan Keamanan dan Otorisasi Praktik Terbaik Batasan Sumber Daya Tambahan

FHIR R4 `$` davinci-data-ekspor operasi untuk HealthLake

$davinci-data-exportOperasi ini adalah operasi FHIR asinkron yang dapat Anda gunakan untuk mengekspor data perawatan kesehatan. AWS HealthLake Operasi ini mendukung beberapa jenis ekspor, termasuk Atribusi Anggota (ATR), Akses Penyedia PDeX Payer-to-Payer, dan API Akses Anggota. Ini adalah versi khusus dari $export operasi FHIR standar, yang dirancang untuk memenuhi persyaratan panduan DaVinci implementasi.

Fitur Utama

Pemrosesan Asinkron: Mengikuti pola permintaan asinkron FHIR standar
Group-Level Ekspor: Mengekspor data untuk anggota dalam sumber daya Grup tertentu
Beberapa Jenis Ekspor: Mendukung ATR (Atribusi Anggota), Akses Penyedia PDeX Payer-to-Payer, dan API Akses Anggota
Dukungan Profil Komprehensif: Termasuk profil US Core, CARIN Blue Button, dan PDeX
Penyaringan Fleksibel: Mendukung penyaringan oleh pasien, jenis sumber daya, dan rentang waktu
Output NDJSON: Menyediakan data dalam format JSON yang dibatasi baris baru

Titik Akhir Operasi


GET [base]/Group/[id]/$davinci-data-export
POST [base]/Group/[id]/$davinci-data-export

Parameter Permintaan

Parameter	Kardinalitas	Deskripsi
`patient`	0.. *	Anggota tertentu yang datanya akan diekspor. Ketika dihilangkan, semua anggota dalam Grup diekspor.
`_type`	0.. 1	Comma-delimited daftar jenis sumber daya FHIR untuk diekspor. Saat dihilangkan, semua jenis sumber daya yang didukung untuk jenis ekspor yang ditentukan disertakan. Untuk ekspor ATR, ini default ke 8 jenis sumber daya atribusi. Untuk ekspor PDeX, ini mencakup semua jenis sumber daya atribusi ditambah jenis sumber daya klinis dan klaim dari profil US Core, CARIN Blue Button, dan PDeX.
`_since`	0.. 1	Hanya sertakan sumber daya yang diperbarui setelah tanggal dan waktu ini.
`_until`	0.. 1	Hanya sertakan sumber daya yang diperbarui sebelum tanggal dan waktu ini.
`exportType`	0.. 1	Jenis ekspor yang harus dilakukan. Nilai yang valid: `hl7.fhir.us.davinci-atr` (ATR), `hl7.fhir.us.davinci-pdex` (Akses Penyedia), `hl7.fhir.us.davinci-pdex#provider-snapshot` (snapshot Akses Penyedia), `hl7.fhir.us.davinci-pdex.p2p` (Payer-to-Payer), `hl7.fhir.us.davinci-pdex.member` (Akses Anggota). Default: `hl7.fhir.us.davinci-atr`.
`_includeEOB2xWoFinancial`	0.. 1	Ketika diatur ke`true`, termasuk `ExplanationOfBenefit` sumber daya yang mendeklarasikan profil CARIN BB 2.x Financial (Non-basis) dalam ekspor dengan data keuangan dilucuti. Sumber daya yang diekspor sesuai dengan profil Basis yang sesuai, tetapi sumber daya asli di penyimpanan data tidak dimodifikasi. Parameter ini tidak berpengaruh pada sumber daya yang sudah mendeklarasikan profil Basis, karena selalu disertakan dan data keuangan sisa dihapus secara otomatis. Default: `false`.
`_security`	0.. *	Filter sumber daya yang diekspor dengan nilai `meta.security` Coding. Gunakan `system\|code` format (karakter pipa harus URL-encoded sebagai`%7C`). Ketika beberapa nilai disediakan, sumber daya harus cocok dengan semuanya (DAN semantik). Gunakan `system\|` (trailing pipe, no code) untuk mencocokkan kode apa pun dari sistem tertentu.
`_tag`	0.. *	Filter sumber daya yang diekspor dengan nilai `meta.tag` Coding. Menggunakan `system\|code` format dan semantik yang sama dengan. `_security` Ketika keduanya `_security` dan `_tag` ditentukan, sumber daya harus cocok dengan kedua filter.

Saring perilaku untuk _security dan _tag

_tagFilter _security dan berlaku untuk semua jenis ekspor, termasukhl7.fhir.us.davinci-atr. Filter ini juga mendukung pengubah pencarian FHIR berikut::not,,, :missing :text:above, dan. :below Misalnya, Anda dapat menggunakan _tag:not=archived atau_security:missing=true. Operasi mengecualikan dari ekspor sumber daya apa pun yang tidak cocok dengan filter yang disediakan.

ExplanationOfBenefit data keuangan

Bidang data keuangan berikut dihapus dari semua sumber daya CARIN BB 2.x yang diekspor, terlepas dari apakah ExplanationOfBenefit sumber daya tersebut menyatakan Basis atau profil Keuangan: jumlah ajudikasi,,,,,payment, total dan item dan. benefitPeriod benefitBalance net unitPrice Ini memastikan bahwa data keuangan tidak diekspor pada Akses dan Payer-to-Payer jalur Penyedia Da Vinci. ExplanationOfBenefitsumber daya yang hanya menyatakan profil Otorisasi Sebelumnya PDeX (tanpa profil CARIN BB 2.x) diekspor tidak berubah dan tidak ada data keuangan yang dihapus. Jika sumber daya menyatakan kedua profil, data keuangan dilucuti.

Jenis Sumber Daya yang Didukung

Jenis sumber daya yang didukung bergantung pada jenis ekspor yang Anda tentukan. Untuk ekspor ATR, jenis sumber daya berikut didukung:

Group
Patient
Coverage
RelatedPerson
Practitioner
PractitionerRole
Organization
Location

Untuk ekspor PDeX (Akses Penyedia Payer-to-Payer, dan Akses Anggota), semua jenis sumber daya klinis dan klaim didukung selain jenis sebelumnya. Untuk daftar lengkap jenis sumber daya yang didukung, lihat Panduan Implementasi Inti AS (STU 6.1), Panduan Implementasi Tombol Biru CARIN, dan Panduan Implementasi Dukungan Otorisasi Sebelumnya Da Vinci.

Jenis Ekspor

$davinci-data-exportOperasi ini mendukung jenis ekspor berikut. Anda menentukan jenis ekspor dengan menggunakan exportType parameter.

Jenis Ekspor	Tujuan	Lingkup Data	Batas Temporal
`hl7.fhir.us.davinci-atr`	Daftar Atribusi Anggota	Attribution-related sumber daya	Tidak ada
`hl7.fhir.us.davinci-pdex`	API Akses Penyedia	Data klinis dan klaim untuk pasien yang dikaitkan	Tidak ada
`hl7.fhir.us.davinci-pdex#provider-snapshot`	API Akses Penyedia (snapshot)	Semua klaim klinis, otorisasi sebelumnya, dan non-keuangan serta data pertemuan untuk pasien yang dikaitkan	Tidak ada
`hl7.fhir.us.davinci-pdex.p2p`	Payer-to-Payer Pertukaran	Data anggota historis untuk transisi asuransi	5 tahun
`hl7.fhir.us.davinci-pdex.member`	API Akses Anggota	Data kesehatan anggota sendiri	5 tahun

Batas sementara menurut jenis ekspor

Batas sementara 5 tahun hanya berlaku untuk jenis ekspor Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) dan Akses Anggota (hl7.fhir.us.davinci-pdex.member). Jenis ekspor Akses Penyedia (hl7.fhir.us.davinci-pdexdanhl7.fhir.us.davinci-pdex#provider-snapshot) tidak memiliki batasan temporal. Untuk jenis ekspor yang terbatas sementara, batas 5 tahun tidak berlaku untuk jenis sumber daya ATR (Group,,,Patient,Coverage, RelatedPerson PractitionerPractitionerRole,Organization). Location Sumber daya ini selalu disertakan tanpa memandang usia.

Dasar penyaringan temporal

Batas temporal dan _until parameter _since dan dievaluasi terhadap meta.lastUpdated stempel waktu masing-masing sumber daya daripada tanggal klinis atau layanan. Ini memberikan pemfilteran temporal yang konsisten di semua jenis sumber daya.

ATR (hl7.fhir.us.davinci-atr)

Dengan tipe ekspor ATR, Anda dapat mengekspor data Daftar Atribusi Anggota. Gunakan jenis ekspor ini untuk mengambil sumber daya terkait atribusi bagi anggota dalam Grup. Untuk informasi lebih lanjut, lihat Operasi Ekspor ATR Da Vinci.

Jenis Sumber Daya yang Didukung: Group, Patient, Coverage, RelatedPerson, Practitioner, PractitionerRole, Organization, Location
Penyaringan Temporal: Tidak ada penyaringan temporal yang diterapkan. Semua sumber daya yang cocok diekspor terlepas dari tanggal.

Jenis Ekspor PDeX

Semua jenis ekspor PDeX berbagi profil yang didukung dan logika pemfilteran yang sama. Untuk informasi selengkapnya, lihat Da Vinci PDeX Provider Access API. Profil berikut didukung:

US Core 3.1.1, 6.1.0, dan 7.0.0
Otorisasi Sebelumnya PDeX (tidak didukung untuk Akses Anggota)
CARIN BB 2.x Profil dasar: Institusional Rawat Inap, Kelembagaan Rawat Jalan, Profesional, Lisan, Farmasi NonClinician

Untuk ekspor PDeX, sumber daya klinis dan klaim secara otomatis ditemukan untuk setiap pasien di Grup. Anda tidak perlu secara eksplisit mereferensikan sumber daya ini di sumber daya Grup. Operasi mencari semua sumber daya kompartemen pasien (sepertiObservation,,,Condition, Coverage RelatedPersonMedicationRequest, danExplanationOfBenefit) milik pasien yang dikaitkan. HanyaPatient,Group, dan tipe ATR non-kompartemen pasien (Practitioner,, PractitionerRoleOrganization,Location) yang memerlukan referensi eksplisit dalam Grup.

Akses Penyedia (hl7.fhir.us.davinci-pdex): Memungkinkan penyedia dalam jaringan untuk mengambil data pasien untuk pasien yang dikaitkan.
Akses Penyedia - snapshot () hl7.fhir.us.davinci-pdex#provider-snapshot: Mengembalikan snapshot lengkap dari semua klaim klinis, otorisasi sebelumnya, dan non-keuangan dan data pertemuan untuk pasien yang dikaitkan. Jenis ekspor ini berperilaku sama seperti hl7.fhir.us.davinci-pdex dan tidak tunduk pada batas temporal.
Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p): Memungkinkan pertukaran data antara pembayar ketika pasien mengubah asuransi.
Akses Anggota (hl7.fhir.us.davinci-pdex.member): Memungkinkan anggota untuk mengakses data kesehatan mereka sendiri.

Dukungan Profil dan Logika Inklusi

Untuk ekspor PDeX, $davinci-data-export operasi menggunakan deklarasi profil dalam meta.profile elemen untuk menentukan sumber daya mana yang akan disertakan dalam ekspor.

ExplanationOfBenefit Penanganan Sumber Daya

ExplanationOfBenefitSumber daya (EOB) disertakan atau dikecualikan dari ekspor PDeX berdasarkan deklarasinya: meta.profile

ExplanationOfBenefit sumber daya dengan profil CARIN BB 1.x dikecualikan dari ekspor.
ExplanationOfBenefit sumber daya tanpa meta.profile set dikecualikan dari ekspor.
ExplanationOfBenefit sumber daya dengan profil CARIN BB 2.x Basis selalu disertakan, dengan data keuangan sisa dihapus sehingga sumber daya sesuai dengan profil Carin BB 2.x Basis. Non-Financial
ExplanationOfBenefit sumber daya dengan profil CARIN BB 2.x yang berisi data keuangan dikecualikan secara default. Ketika _includeEOB2xWoFinancial=true diatur, mereka disertakan dengan data keuangan yang dilucuti dan sumber daya diubah ke profil Basis yang sesuai.
ExplanationOfBenefit sumber daya dengan profil Otorisasi Sebelumnya PDeX selalu disertakan.

Profil diutamakan untuk pengupasan data keuangan

Ketika ExplanationOfBenefit sumber daya mendeklarasikan beberapa profil, pengupasan data keuangan lebih diutamakan daripada pass-through. Untuk sumber daya yang mendeklarasikan profil Basis (atau Keuangan) dan profil Otorisasi Sebelumnya PDeX, operasi menghapus data keuangan sebelum mengekspor sumber daya.

Transformasi Data Keuangan

Ketika Anda mengatur_includeEOB2xWoFinancial=true, operasi mengubah ExplanationOfBenefit sumber daya CARIN BB 2.x ke profil Basis yang sesuai dengan menghapus data keuangan. Misalnya, C4BB ExplanationOfBenefit Oral sumber daya diubah menjadiC4BB ExplanationOfBenefit Oral Basis, yang menghapus data keuangan dari catatan per spesifikasi FHIR.

Operasi menghapus elemen data keuangan berikut dalam dua skenario: ketika mengubah sumber daya keuangan CARIN BB 2.x menjadi profil Dasarnya (menggunakan_includeEOB2xWoFinancial=true), dan ketika menghapus data keuangan sisa dari sumber daya CARIN BB 2.x Basis:

totalElemen
paymentElemen
benefitPeriodElemen
benefitBalanceElemen
adjudicationJumlah entri (amountirisan; entri non-keuangan seperti benefitpaymentstatus dan billingnetworkstatus dilestarikan)
item.netElemen
item.unitPriceElemen
item.adjudicationJumlah entri

Operasi ini juga memperbarui metadata profil selama transformasi:

meta.profilediperbarui ke URL kanonik profil Dasar
Versi diperbarui ke versi CARIN BB 2.x Basis
Sumber daya yang ada di penyimpanan data tidak dimodifikasi
Sumber daya yang diekspor tidak disimpan kembali ke penyimpanan data

Aturan Deteksi Profil

Operasi menggunakan aturan berikut untuk mendeteksi dan memvalidasi profil:

Deteksi versi didasarkan pada URL meta.profile kanonik
Sumber daya disertakan jika ADA profil yang dideklarasikan sesuai dengan kriteria ekspor
Validasi profil terjadi selama pemrosesan ekspor

Pemfilteran temporal untuk ekspor PDeX

HealthLake menerapkan filter temporal 5 tahun untuk jenis ekspor Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) dan Akses Anggota (hl7.fhir.us.davinci-pdex.member). Filter didasarkan pada kapan sumber daya terakhir diperbarui. Jenis ekspor Akses Penyedia (hl7.fhir.us.davinci-pdexdanhl7.fhir.us.davinci-pdex#provider-snapshot) tidak tunduk pada batas sementara apa pun. Untuk jenis ekspor terbatas sementara, filter berlaku untuk semua sumber daya kecuali jenis sumber daya atribusi inti berikut, yang selalu diekspor tanpa memandang usia:

Patient
Coverage
Organization
Practitioner
PractitionerRole
RelatedPerson
Location
Group

Sumber daya administratif dan demografis ini dikecualikan karena menyediakan konteks penting untuk data yang diekspor. Ekspor ATR tidak tunduk pada penyaringan temporal apa pun.

Sampel Permintaan

Contoh berikut menunjukkan cara memulai pekerjaan ekspor untuk berbagai jenis ekspor.

Ekspor ATR


GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Group,Patient,Coverage,Practitioner,Organization&exportType=hl7.fhir.us.davinci-atr

POST https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Group,Patient,Coverage,Practitioner,Organization&exportType=hl7.fhir.us.davinci-atr
Content-Type: application/json

{
  "DataAccessRoleArn": "arn:aws:iam::444455556666:role/your-healthlake-service-role",
  "JobName": "attribution-export-job",
  "OutputDataConfig": {
    "S3Configuration": {
      "S3Uri": "s3://your-export-bucket/EXPORT-JOB",
      "KmsKeyId": "arn:aws:kms:region:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    }
  }
}

Ekspor Akses Penyedia dengan penghapusan data ExplanationOfBenefit keuangan


GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Observation,Condition,MedicationRequest,ExplanationOfBenefit&exportType=hl7.fhir.us.davinci-pdex&_includeEOB2xWoFinancial=true

Ekspor snapshot Akses Penyedia


GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?exportType=hl7.fhir.us.davinci-pdex%23provider-snapshot

Payer-to-Payer ekspor


GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Coverage,ExplanationOfBenefit,Condition,Procedure&exportType=hl7.fhir.us.davinci-pdex.p2p&_includeEOB2xWoFinancial=true

Ekspor Akses Anggota untuk pasien tertentu


GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Observation,Condition,ExplanationOfBenefit,MedicationRequest&exportType=hl7.fhir.us.davinci-pdex.member&patient=Patient/example-patient-id

Contoh Respons


{
  "datastoreId": "eaee622d8406b41eb86c0f4741201ff9",
  "jobStatus": "SUBMITTED",
  "jobId": "48d7b91dae4a64d00d54b70862f33f61"
}

Hubungan Sumber Daya

Operasi mengekspor sumber daya berdasarkan hubungan mereka dalam Daftar Atribusi Anggota:


Group (Attribution List)
├── Patient (Members)
├── Coverage → RelatedPerson (Subscribers)
├── Practitioner (Attributed Providers)
├── PractitionerRole → Location
└── Organization (Attributed Providers)

catatan

Diagram hubungan sumber daya sebelumnya berlaku untuk ekspor ATR. Untuk ekspor PDeX, sumber daya klinis dan klaim secara otomatis ditemukan melalui pencarian pasien dan tidak memerlukan referensi eksplisit dalam sumber daya Grup.

Sumber Sumber Daya

Sumber daya	Lokasi Sumber	Deskripsi
`Patient`	`Group.member.entity`	Pasien yang menjadi anggota daftar atribusi
`Coverage`	`Group.member.extension:coverageReference`	Cakupan yang mengakibatkan keanggotaan pasien
`Organization`	`Group.member.extension:attributedProvider`	Organizations yang dikaitkan dengan pasien
`Practitioner`	`Group.member.extension:attributedProvider`	Praktisi individu yang dikaitkan dengan pasien
`PractitionerRole`	`Group.member.extension:attributedProvider`	Peran praktisi yang dikaitkan dengan pasien
`RelatedPerson`	`Coverage.subscriber`	Pelanggan cakupan
`Location`	`PractitionerRole.location`	Lokasi yang terkait dengan peran praktisi
`Group`	Titik akhir masukan	Daftar atribusi itu sendiri

Manajemen Job

Periksa Status Job: GET [base]/export/[job-id]
Batalkan Tugas: DELETE [base]/export/[job-id]

Siklus Hidup Tugas

SUBMITTED- Job telah diterima dan diantrian
IN_PROGRESS- Job sedang aktif memproses
COMPLETED- Job selesai dengan sukses, file tersedia untuk diunduh
FAILED- Job mengalami kesalahan

Format Output

Format File: NDJSON (JSON Terbatas Baris Baru)
Organisasi File: File terpisah untuk setiap jenis sumber daya
Ekstensi File: .ndjson
Lokasi: Bucket dan jalur S3 yang ditentukan

Penanganan Kesalahan

Operasi mengembalikan HTTP 400 Bad Request dengan OperationOutcome untuk kondisi berikut:

Kesalahan Otorisasi

Peran IAM yang ditentukan dalam DataAccessRoleArn tidak memiliki izin yang cukup untuk melakukan operasi ekspor. Untuk daftar lengkap izin S3 dan KMS yang diperlukan, lihat Menyiapkan izin untuk pekerjaan ekspor.

Kesalahan Validasi Parameter

patientParameter tidak diformat sebagai Patient/id,Patient/id,...
Satu atau lebih referensi pasien tidak valid atau bukan milik Grup yang ditentukan
Nilai exportType parameter bukan jenis ekspor yang didukung
_typeParameter berisi jenis sumber daya yang tidak didukung untuk jenis ekspor yang ditentukan
_typeParameter tidak memiliki tipe sumber daya yang diperlukan (GroupPatient,,Coverage) untuk jenis hl7.fhir.us.davinci-atr ekspor
Nilai _includeEOB2xWoFinancial parameter bukan boolean yang valid

Kesalahan Validasi Sumber Daya

Sumber daya Grup yang ditentukan tidak ada di penyimpanan data
Sumber daya Grup yang ditentukan tidak memiliki anggota
Satu atau lebih anggota Grup mereferensikan sumber daya Pasien yang tidak ada di penyimpanan data

Keamanan dan Otorisasi

$davinci-data-exportadalah operasi massal backend yang disahkan melalui izin IAM atau SMART tingkat sistem pada cakupan FHIR (OAuth 2.0); permintaan yang menyajikan cakupan tingkat pasien atau pengguna ditolak. Operasi tidak mengevaluasi sumber daya Persetujuan FHIR untuk menyaring atau membatasi data yang diekspor.

Mekanisme otorisasi FHIR standar berlaku
Peran akses data harus memiliki izin IAM yang diperlukan untuk operasi S3 dan KMS. Untuk daftar lengkap izin yang diperlukan, lihat Menyiapkan izin untuk pekerjaan ekspor.

Praktik Terbaik

Pemilihan Jenis Sumber Daya: Hanya minta jenis sumber daya yang Anda perlukan untuk meminimalkan ukuran ekspor dan waktu pemrosesan
Time-Based Pemfilteran: Gunakan _since parameter untuk ekspor tambahan
Penyaringan Pasien: Gunakan patient parameter saat Anda hanya membutuhkan data untuk anggota tertentu
Job Monitoring: Secara teratur memeriksa status pekerjaan untuk ekspor besar
Penanganan Kesalahan: Menerapkan logika coba lagi yang tepat untuk pekerjaan yang gagal
Kesadaran Filter Temporal: Untuk Payer-to-Payer dan ekspor Akses Anggota, pertimbangkan filter temporal 5 tahun saat Anda memilih jenis sumber daya
Penghapusan Data Keuangan: Gunakan _includeEOB2xWoFinancial=true saat Anda membutuhkan data klaim tanpa informasi keuangan
Manajemen Profil: Pastikan sumber daya memiliki deklarasi profil yang sesuai, validasi terhadap profil target sebelum konsumsi, dan gunakan versi profil untuk mengontrol perilaku ekspor

Batasan

Maksimal 500 pasien dapat ditentukan dalam patient parameter
Ekspor terbatas hanya untuk Group-level operasi
Hanya mendukung kumpulan tipe sumber daya yang telah ditentukan untuk setiap jenis ekspor
Output selalu dalam format NDJSON
Payer-to-Payer dan ekspor Akses Anggota dibatasi hingga 5 tahun data klinis dan klaim
Transformasi data keuangan hanya berlaku untuk profil CARIN BB 2.x ExplanationOfBenefit

Sumber Daya Tambahan

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

$confirm-attribution-list

$ dokumen

FHIR R4 $ davinci-data-ekspor operasi untuk HealthLake