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:
- R4 versi 4.0.1 (Rilis 4)
- STU3 versi 3.0.1 (Rilis 3 - Standar untuk Penggunaan Uji Coba)
- DSTU2 versi 1.0.2 (Draf Standar untuk Penggunaan Uji Coba)
Saat membuat penyimpanan FHIR, tetapkan versi FHIR sebagai parameter pada
metode fhirStores.create
. Anda tidak dapat mengubah versi FHIR setelah
store dibuat.
Antarmuka API untuk setiap toko sesuai dengan versi FHIR penyimpanan tersebut. Misalnya,
interaksi conformance
DSTU2 berbeda dengan interaksi
capabilities
STU3, tetapi keduanya menggunakan jalur REST /fhir/metadata
yang sama, sehingga
jalur tersebut menampilkan respons yang berbeda berdasarkan versi FHIR toko.
Fungsi yang ditambahkan dalam versi FHIR baru akan tersedia di toko yang menggunakan
versi FHIR sebelumnya jika fungsi tersebut tidak membuat inkompatibilitas. Misalnya, interaksi patch
tersedia di penyimpanan DSTU2 meskipun interaksi tersebut hanya
ditentukan dari STU3 dan seterusnya.
Detail fungsionalitas yang didukung dalam API v1 oleh 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 dalam RESTful API yang menggunakan jenis konten JSON didukung, kecuali untuk:
- Interaksi histori tingkat jenis dan tingkat sistem yang mengambil histori di beberapa resource tidak didukung. Histori resource hanya dapat diambil untuk satu resource dalam satu waktu.
- Interaksi batch/transaction tidak mendukung operasi penelusuran di dalam paket.
- Validasi dan penerapan profil didukung.
- Parameter penelusuran yang ditetapkan pengguna, termasuk penelusuran tentang elemen ekstensi, didukung di API v1beta1.
Semua fungsi penelusuran didukung, kecuali untuk:
- Parameter penelusuran
Group-characteristic-value
,Location-near
,Bundle-composition
, danBundle-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 parameter penelusuran. Fungsi ini mengecualikan {i>field<i} yang tidak dapat dicari. Metode ini tidak mendukungAND
eksplisit (istilah secara implisit digabungkan denganAND
) atau tanda kurung. - Parameter penelusuran khusus
_query
,_filter
, dan_list
tidak didukung. - Jika digunakan pada kolom dengan elemen berulang, parameter
_sort
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 dari 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 lainnya tidak didukung.
Penelusuran menggunakan metode
POST
tidak menerima parameterapplication/x-www-form-urlencoded
dalam isi permintaan.Karakter pengganti (
*
) didukung untuk_include
, tetapi tidak didukung untuk_revinclude
.
- Parameter penelusuran
Area yang tidak didukung meliputi:
- Sebagian besar operasi yang diperluas tidak diterapkan.
- Jenis konten XML tidak didukung.
- Operasi patch tidak mendukung Patch XML atau Patch
FHIRPath
. - Permintaan HTTP HEAD tidak didukung.
- Endpoint
ExecuteBundle
tidak menerima pakethistory
.
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 dalam RESTful API yang menggunakan jenis konten JSON didukung, kecuali untuk:
- Interaksi histori tingkat jenis dan tingkat sistem yang mengambil histori di beberapa resource tidak didukung. Histori resource hanya dapat diambil untuk satu resource dalam satu waktu.
- Interaksi batch/transaction tidak mendukung operasi penelusuran di dalam paket.
Validasi dan penerapan profil didukung.
Parameter penelusuran yang ditetapkan pengguna, termasuk penelusuran tentang 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
, danBundle-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. Opsi ini mengecualikan {i>field<i} yang tidak dapat dicari. Metode ini tidak mendukungAND
eksplisit (istilah secara implisit digabungkan dengan AND) atau tanda kurung. - Parameter penelusuran khusus
_query
,_filter
, dan_list
tidak didukung. - Jika digunakan pada kolom dengan elemen berulang, parameter
_sort
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 parameterapplication/x-www-form-urlencoded
dalam isi permintaan. - Karakter pengganti (
*
) didukung untuk_include
, tetapi tidak didukung untuk_revinclude
.
- Parameter penelusuran
Area yang tidak didukung meliputi:
- Sebagian besar operasi yang diperluas tidak diterapkan.
- Jenis konten XML tidak didukung.
- Operasi patch tidak mendukung Patch XML atau Patch FHIRPath.
DSTU2
Pernyataan kesesuaian server menunjukkan bagian spesifikasi yang didukung.
- Mendukung penyimpanan dan pengambilan semua resource DSTU2, termasuk dukungan untuk elemen ekstensi. API menerima, menyimpan, dan menampilkan ekstensi pada elemen data apa pun.
- Semua metode dalam RESTful API yang menggunakan jenis konten JSON didukung, kecuali untuk:
- Interaksi histori tingkat jenis dan tingkat sistem yang mengambil histori di beberapa resource tidak didukung. Histori resource hanya dapat diambil untuk satu resource dalam satu waktu.
- Interaksi batch/transaction 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
, danCoverage-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. Opsi ini mengecualikan {i>field<i} yang tidak dapat dicari. Metode ini tidak mendukungAND
eksplisit (istilah secara implisit digabungkan dengan AND) atau tanda kurung. - Parameter penelusuran khusus
_query
,_filter
, dan_list
tidak didukung. - Jika digunakan pada kolom dengan elemen berulang, parameter
_sort
akan mengurutkan berdasarkan elemen pertama; ini berbeda dari spesifikasi. Semua parameter penelusuran yang didukung memenuhi syarat untuk_sort
, kecuali untuk parameter penelusuran khusus_content
. - Penelusuran menggunakan metode
POST
tidak menerima parameterapplication/x-www-form-urlencoded
dalam isi permintaan. - Karakter pengganti (
*
) didukung untuk_include
, tetapi tidak didukung untuk_revinclude
.
- Parameter penelusuran
Area yang tidak didukung meliputi:
- Sebagian besar operasi yang diperluas tidak diterapkan.
- Parameter penelusuran yang ditetapkan pengguna tidak didukung untuk DSTU2.
- Jenis konten XML tidak didukung.
Detail operasi di luar spesifikasi yang dipublikasikan
- FHIR gRPC API menawarkan antarmuka RPC untuk FHIR menggunakan framework gRPC. Metode ini tidak standar, dalam pengembangan, dan tidak mendukung semua metode FHIR.
- Konfigurasi penyimpanan FHIR menyertakan opsi untuk memberi tahu topik Pub/Sub yang ditentukan pengguna untuk semua perubahan pada resource di toko. Mekanisme notifikasi ini umum di semua penyimpanan Cloud Healthcare API dan tidak dimaksudkan untuk menggantikan fungsi Langganan FHIR (DSTU2, STU3, dan R4).
- Operasi ekspor toko FHIR ke tujuan Cloud Storage hanya menawarkan ekspor massal dari seluruh toko. Ini bukan implementasi spesifikasi draf FHIR Bulk Data.
- Operasi impor toko 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 bertemu pada metode API yang berbeda untuk kasus penggunaan ini.