Parameter pencarian yang dapat dipilih (Pratinjau)
Penting
Kemampuan parameter pencarian yang dapat dipilih tersedia untuk pratinjau. API pratinjau dan SDK disediakan tanpa perjanjian tingkat layanan (SLA). Kami menyarankan agar Anda tidak menggunakannya untuk beban kerja produksi. Beberapa fitur mungkin tidak didukung, atau mungkin memiliki kemampuan yang dibatasi. Untuk mengetahui informasi selengkapnya, lihat Ketentuan Penggunaan Tambahan untuk Pratinjau Microsoft Azure.
Mencari sumber daya sangat mendasar untuk layanan FHIR®. Setiap sumber daya dalam layanan FHIR membawa informasi sebagai sekumpulan elemen. Parameter pencarian berfungsi untuk mengkueri informasi dalam elemen ini. Ketika layanan FHIR disebarkan, parameter pencarian bawaan diaktifkan secara default. Layanan FHIR melakukan pencarian yang efisien dengan mengekstrak dan mengindeks properti tertentu dari sumber daya FHIR selama penyerapan data.
Parameter pencarian yang dapat dipilih memungkinkan Anda mengaktifkan atau menonaktifkan parameter pencarian bawaan. Kemampuan ini membantu Anda menyimpan lebih banyak sumber daya di ruang penyimpanan yang dialokasikan dan meningkatkan performa dengan hanya mengaktifkan parameter pencarian yang Anda butuhkan.
Untuk melakukan pembaruan status pada parameter pencarian, ikuti langkah-langkah utama berikut:
- Dapatkan status parameter pencarian.
- Perbarui status parameter pencarian.
- Jalankan pekerjaan reindex.
Dalam artikel ini, kami menunjukkan sintaks pencarian FHIR dalam contoh panggilan API dengan tempat penampung {{FHIR_URL}} untuk mewakili URL server FHIR.
Mendapatkan status parameter pencarian
Titik akhir API ('$status') disediakan untuk melihat status parameter pencarian. Ada empat status untuk respons:
| Keadaan | Deskripsi |
|---|---|
| Didukung | Parameter pencarian didukung oleh layanan FHIR, dan Anda mengirimkan permintaan untuk mengaktifkan parameter pencarian. Jalankan operasi reindex untuk dijalankan dari yang didukung ke diaktifkan. |
| Diaktifkan | Parameter pencarian diaktifkan untuk pencarian. Status ini adalah langkah berikutnya setelah status yang didukung. |
| PendingDisable | Menonaktifkan parameter pencarian tertunda setelah eksekusi operasi indeks ulang. |
| Nonaktif | Parameter pencarian dinonaktifkan. |
Untuk mendapatkan status di semua parameter pencarian, gunakan permintaan berikut. Permintaan ini mengembalikan daftar semua parameter pencarian dan statusnya. Gulir daftar untuk menemukan parameter pencarian yang Anda butuhkan.
GET {{FHIR_URL}}/SearchParameter/$status
Untuk mengidentifikasi status masing-masing atau subset parameter pencarian, gunakan filter ini:
- Nama. Untuk mengidentifikasi status parameter pencarian berdasarkan nama, gunakan permintaan ini:
GET {{FHIR_URL}}/SearchParameter/$status?code=<name of search parameter/ sub string>
- URL. Untuk mengidentifikasi status parameter pencarian dengan pengidentifikasi kanonisnya, gunakan permintaan ini:
GET {{FHIR_URL}}/SearchParameter/$status?url=<SearchParameter url>
- Jenis sumber daya. Di FHIR, parameter pencarian diaktifkan di tingkat sumber daya individual untuk memungkinkan pemfilteran dan pengambilan subset sumber daya tertentu. Untuk mengidentifikasi status semua parameter pencarian yang dipetakan ke sumber daya, gunakan permintaan ini:
GET {{FHIR_URL}}/SearchParameter/$status?resourcetype=<ResourceType name>
Sebagai respons terhadap permintaan GET ke titik akhir $status, jenis sumber daya parameter dikembalikan dengan status parameter pencarian. Lihat contoh respons:
{
"resourceType" : "Parameters",
"parameter" : [
"name" : "searchParameterStatus",
"part" : {
{
"name" : "url",
"valueString" : "http://hl7.org/fhir/SearchParameter/Account-identifier"
},
{
"name" : "status",
"valueString" : "supported"
}
}
]
}
Memperbarui status parameter pencarian
Setelah Anda mendapatkan status parameter pencarian, perbarui status parameter pencarian ke Supported atau Disabled.
Catatan
Untuk memperbarui status parameter pencarian, Anda memerlukan peran RBAC Azure Search Parameter Manager .
Status parameter pencarian dapat diperbarui untuk satu parameter pencarian atau secara massal.
Memperbarui status parameter pencarian tunggal
Untuk memperbarui status parameter pencarian tunggal, gunakan permintaan API ini:
PUT {{FHIR_URL}}/SearchParameter/$status
{
"resourceType": "Parameters",
"parameter": [
{
"name": "searchParameterStatus",
"part": [
{
"name": "url",
"valueUrl": "http://hl7.org/fhir/SearchParameter/Resource-test-id"
},
{
"name": "status",
"valueString": "Supported"
}
]
}
]
}
Bergantung pada kasus penggunaan, Anda dapat menyimpan nilai status ke 'Didukung' atau 'Dinonaktifkan' untuk parameter pencarian. Saat Anda mengirim status Disabled dalam permintaan, respons kembali sebagai PendingDisable karena pekerjaan reindex harus berjalan untuk menghapus asosiasi sepenuhnya.
Jika Anda menerima kode status HTTP 400 dalam respons, itu berarti tidak ada kecocokan unik untuk Parameter pencarian yang diidentifikasi. Periksa ID parameter pencarian.
Memperbarui status parameter pencarian secara massal
Untuk memperbarui status parameter pencarian secara massal, permintaan 'PUT' harus memiliki daftar sumber daya 'Parameter' di isi permintaan. Daftar perlu berisi parameter pencarian individual yang perlu diperbarui.
PUT {{FHIR_URL}}/SearchParameter/$status
{
"resourceType" : "Parameters",
"parameter" : [
{
"name" : "searchParameterStatus",
"part" :{
"name" : "url",
"valueString" : "http://hl7.org/fhir/SearchParameter/Endpoint-name"
},
"part":{
"name" : "status",
"valueString" : "supported"
}
},
"name" : "searchParameterStatus",
"part" :{
"name" : "url",
"valueString" : "http://hl7.org/fhir/SearchParameter/HealthcareService-name"
},
"part":{
"name" : "status",
"valueString" : "supported"
}
},
...
]
}
Menjalankan pekerjaan reindex
Setelah Anda memperbarui status parameter pencarian ke Supported atau Disabled, langkah selanjutnya adalah menjalankan pekerjaan indeks ulang.
Hingga parameter pencarian diindeks, Enabled status dan Disabled parameter pencarian tidak diaktifkan. Eksekusi pekerjaan reindex memperbarui status dari Supported ke Enabled atau PendingDisable ke Disabled.
Pekerjaan reindex dapat dijalankan terhadap seluruh database layanan FHIR atau terhadap parameter pencarian tertentu. Pekerjaan reindex dapat menjadi performa intensif. Untuk informasi selengkapnya, lihat Menjalankan pekerjaan reindex.
Catatan
Dokumen pernyataan kemampuan adalah serangkaian perilaku untuk server FHIR. Pernyataan kemampuan tersedia untuk titik akhir /metadata. Enabled parameter pencarian tercantum dalam pernyataan kemampuan untuk layanan FHIR Anda.
Pertanyaan Umum
Apa perilaku jika kueri menyertakan parameter pencarian dengan status 'Didukung'?
Parameter pencarian dalam status 'Didukung' perlu diindeks ulang. Sampai saat itu, parameter pencarian tidak diaktifkan. Jika kueri dijalankan pada parameter pencarian non-aktif, layanan FHIR akan merender respons tanpa mempertimbangkan parameter pencarian tersebut. Dalam respons, akan ada pesan peringatan yang menunjukkan bahwa parameter pencarian tidak diindeks dan karenanya tidak digunakan dalam kueri. Untuk merender kesalahan dalam situasi seperti itu, gunakan header 'Prefer: handling' dengan nilai 'strict'. Dengan mengatur header ini, peringatan akan dilaporkan sebagai kesalahan.