Pernyataan kesesuaian FHIR

Penyimpanan FHIR dalam Cloud Healthcare API mendukung beberapa versi spesifikasi Fast Healthcare Interoperability Resources (FHIR) yang dipublikasikan oleh Health Level 7 International (HL7).

API v1 mendukung versi berikut:

Saat membuat penyimpanan FHIR, Anda menentukan versi FHIR sebagai parameter untuk metode fhirStores.create. Anda tidak dapat mengubah versi FHIR setelah penyimpanan dibuat.

Antarmuka API ke setiap penyimpanan sesuai dengan versi FHIR penyimpanan tersebut. Misalnya, interaksi conformance DSTU2 berbeda dengan interaksi capabilities STU3, tetapi keduanya memiliki jalur REST /fhir/metadata yang sama, sehingga jalur tersebut menampilkan respons yang berbeda berdasarkan versi FHIR penyimpanan.

Fungsi yang ditambahkan di versi FHIR yang lebih baru tersedia di penyimpanan yang menggunakan versi FHIR sebelumnya jika tidak menyebabkan inkompatibilitas. Misalnya, interaksi patch tersedia di toko DSTU2 meskipun interaksi tersebut hanya ditentukan dari STU3 dan seterusnya.

Detail fungsi yang didukung di API v1 menurut versi FHIR

R4

Pernyataan kemampuan server menunjukkan bagian spesifikasi yang didukung.

  • Penyimpanan dan pengambilan semua resource R4, termasuk dukungan untuk elemen ekstensi. API menerima, menyimpan, dan menampilkan ekstensi pada elemen data apa pun.
  • Semua metode di RESTful API yang menggunakan jenis konten JSON didukung, kecuali untuk:
    • Interaksi histori level jenis dan level sistem yang mengambil histori di beberapa resource tidak didukung. Histori resource hanya dapat diambil untuk satu resource sekaligus.
    • Interaksi batch/transaksi tidak mendukung operasi penelusuran di dalam paket.
  • Validasi dan penerapan Profil didukung.
  • Parameter penelusuran yang ditentukan pengguna, termasuk penelusuran pada elemen ekstensi, didukung di API v1beta1.

  • Semua fungsi penelusuran didukung, kecuali untuk:

    • Parameter penelusuran Group-characteristic-value, Location-near, Bundle-composition, dan Bundle-message tidak didukung.
    • Parameter penelusuran yang melakukan pencocokan fonetik tidak didukung.
    • Parameter hasil penelusuran _contained, _containedType, _summary=count, dan _summary=true tidak didukung.
    • Parameter penelusuran khusus _content menelusuri semua kolom resource yang dirujuk oleh parameter penelusuran. Tindakan ini mengecualikan kolom yang tidak dapat ditelusuri. Fungsi ini tidak mendukung AND eksplisit (istilah digabungkan secara implisit dengan AND) atau tanda kurung.
    • Parameter penelusuran khusus _query, _filter, dan _list tidak didukung.
    • Parameter _sort, saat digunakan pada kolom dengan elemen berulang, akan diurutkan berdasarkan elemen pertama; hal ini berbeda dengan spesifikasi. Semua parameter penelusuran yang didukung memenuhi syarat untuk _sort, kecuali untuk parameter penelusuran khusus _content.
    • Pengubah penelusuran token :of-type dan pengubah penelusuran referensi :identifier tidak didukung.
    • Penelusuran referensi kanonis tidak didukung. Referensi kanonis diperlakukan sebagai referensi normal.
    • Saat menggunakan parameter _type, hanya parameter penelusuran umum (untuk semua resource) yang dapat digunakan, bukan persimpangan jenis resource yang ditentukan.

    • Subset parameter penelusuran gabungan berikut didukung:

      • DocumentReference-relationship
      • Observation-code-value-concept
      • Observation-code-value-date
      • Observation-code-value-quantity
      • Observation-code-value-string
      • Observation-combo-code-value-concept
      • Observation-combo-code-value-quantity
      • Observation-component-code-value-concept
      • Observation-component-code-value-quantity

      Parameter penelusuran gabungan yang tersisa tidak didukung.

    • Penelusuran menggunakan metode POST tidak menerima parameter application/x-www-form-urlencoded dalam isi permintaan.

    • Karakter pengganti (*) didukung untuk _include, tetapi tidak didukung untuk _revinclude.

Area yang tidak didukung meliputi:

  • Sebagian besar operasi yang diperluas tidak diimplementasikan.
  • Jenis konten XML tidak didukung.
  • Operasi patch tidak mendukung Patch XML atau Patch FHIRPath.
  • Permintaan HTTP HEAD tidak didukung.

Area tempat API menyimpang dari spesifikasi FHIR untuk memungkinkan kompatibilitas mundur:

  • null diterima untuk kolom wajib diisi
  • Kode kosong diterima untuk kolom wajib diisi
  • Referensi urn:uuid diizinkan dalam paket batch

STU3

Pernyataan kemampuan server menunjukkan bagian spesifikasi yang didukung.

  • Penyimpanan dan pengambilan semua resource STU3 didukung, termasuk dukungan untuk elemen ekstensi. API menerima, menyimpan, dan menampilkan ekstensi pada elemen data apa pun.

  • Semua metode di RESTful API yang menggunakan jenis konten JSON didukung, kecuali untuk:

    • Interaksi histori level jenis dan level sistem yang mengambil histori di beberapa resource tidak didukung. Histori resource hanya dapat diambil untuk satu resource sekaligus.
    • Interaksi batch/transaksi tidak mendukung operasi penelusuran di dalam paket.

  • Validasi dan penerapan Profil didukung.

  • Parameter penelusuran yang ditentukan pengguna, termasuk penelusuran pada elemen ekstensi, didukung di API v1beta1.

  • Semua fungsi penelusuran didukung, kecuali untuk:

    • Parameter penelusuran Group-characteristic-value, Sequence-coordinate, Location-near, Location-near-distance, Bundle-composition, dan Bundle-message tidak didukung.
    • Parameter penelusuran yang melakukan pencocokan fonetik tidak didukung.
    • Parameter hasil penelusuran _contained, _containedType, _summary=count, dan _summary=true tidak didukung.
    • Parameter penelusuran khusus _content menelusuri semua kolom resource yang dirujuk oleh parameter penelusuran. Tindakan ini mengecualikan kolom yang tidak dapat ditelusuri. Fitur ini tidak mendukung AND eksplisit (istilah digabungkan secara implisit dengan AND) atau tanda kurung.
    • Parameter penelusuran khusus _query, _filter, dan _list tidak didukung.
    • Parameter _sort, saat digunakan pada kolom dengan elemen berulang, akan diurutkan berdasarkan elemen pertama; hal ini berbeda dengan spesifikasi. Semua parameter penelusuran yang didukung memenuhi syarat untuk _sort, kecuali untuk parameter penelusuran khusus _content.
    • Penelusuran menggunakan metode POST tidak menerima parameter application/x-www-form-urlencoded dalam isi permintaan.
    • Karakter pengganti (*) didukung untuk _include, tetapi tidak didukung untuk _revinclude.

Area yang tidak didukung meliputi:

  • Sebagian besar operasi yang diperluas tidak diimplementasikan.
  • Jenis konten XML tidak didukung.
  • Operasi patch tidak mendukung XML Patch atau FHIRPath Patch.

Area tempat API menyimpang dari spesifikasi FHIR untuk memungkinkan kompatibilitas mundur:

  • null diterima untuk kolom wajib diisi
  • Kode kosong diterima untuk kolom wajib diisi
  • Referensi urn:uuid diizinkan dalam paket batch

DSTU2

Pernyataan kepatuhan server menunjukkan bagian spesifikasi yang didukung.

  • Penyimpanan dan pengambilan semua resource DSTU2 didukung, termasuk dukungan untuk elemen ekstensi. API menerima, menyimpan, dan menampilkan ekstensi pada elemen data apa pun.
  • Semua metode di RESTful API yang menggunakan jenis konten JSON didukung, kecuali untuk:
    • Interaksi histori level jenis dan level sistem yang mengambil histori di beberapa resource tidak didukung. Histori resource hanya dapat diambil untuk satu resource dalam satu waktu.
    • Interaksi batch/transaksi tidak mendukung operasi penelusuran di dalam paket.
  • Validasi dan penerapan Profil didukung.
  • Semua fungsi penelusuran didukung, kecuali untuk:
    • Parameter penelusuran Group-characteristic-value, Location-near, Location-near-distance, Bundle-composition, Bundle-message, Coverage-dependent, dan Coverage-sequence tidak didukung.
    • Parameter penelusuran yang ditentukan pada elemen ekstensi tidak didukung.
    • Parameter penelusuran yang melakukan pencocokan fonetik tidak didukung.
    • Parameter hasil penelusuran _contained, _containedType, _summary=count, dan _summary=true tidak didukung.
    • Parameter penelusuran khusus _content menelusuri semua kolom resource yang dirujuk oleh parameter penelusuran. Tindakan ini mengecualikan kolom yang tidak dapat ditelusuri. Fitur ini tidak mendukung AND eksplisit (istilah digabungkan secara implisit dengan AND) atau tanda kurung.
    • Parameter penelusuran khusus _query, _filter, dan _list tidak didukung.
    • Parameter _sort, saat digunakan pada kolom dengan elemen berulang, mengurutkan berdasarkan elemen pertama; hal ini berbeda dengan spesifikasi. Semua parameter penelusuran yang didukung memenuhi syarat untuk _sort, kecuali parameter penelusuran khusus _content.
    • Penelusuran menggunakan metode POST tidak menerima parameter application/x-www-form-urlencoded dalam isi permintaan.
    • Karakter pengganti (*) didukung untuk _include, tetapi tidak didukung untuk _revinclude.

Area yang tidak didukung meliputi:

  • Sebagian besar operasi yang diperluas tidak diimplementasikan.
  • Parameter penelusuran yang ditentukan pengguna tidak didukung untuk DSTU2.
  • Jenis konten XML tidak didukung.

Area tempat API menyimpang dari spesifikasi FHIR untuk memungkinkan kompatibilitas mundur:

  • null diterima untuk kolom wajib diisi
  • Kode kosong diterima untuk kolom wajib diisi
  • Referensi urn:uuid diizinkan dalam paket batch

Detail operasi di luar spesifikasi yang dipublikasikan

  • Konfigurasi penyimpanan FHIR menyertakan opsi untuk memberi tahu topik Pub/Sub yang ditentukan pengguna untuk semua perubahan pada resource di penyimpanan. Mekanisme pemberitahuan ini umum di semua penyimpanan Cloud Healthcare API dan tidak dimaksudkan untuk menggantikan fungsi langganan FHIR (DSTU2, STU3, dan R4).
  • Operasi ekspor penyimpanan FHIR ke tujuan Cloud Storage hanya menawarkan ekspor massal seluruh penyimpanan. Ini bukan implementasi spesifikasi draf Data Massal FHIR.
  • Operasi impor penyimpanan FHIR tidak ditentukan dalam spesifikasi.
  • Operasi Resource-purge yang menghapus versi historis resource tidak ditentukan dalam spesifikasi. API ini dapat berubah di masa mendatang jika proses standar atau implementasi FHIR lainnya berkonvergensi pada metode API yang berbeda untuk kasus penggunaan ini.
  • Endpoint ExecuteBundle menerima paket history di v1beta1 untuk membuat versi historis resource.