Tag kueri yang diperluas
Gambaran Umum
Secara default, layanan DICOM mendukung kueri pada tag DICOM yang ditentukan dalam pernyataan kesuaian. Dengan mengaktifkan tag kueri yang diperluas, daftar tag dapat dengan mudah diperluas berdasarkan kebutuhan aplikasi.
Dengan menggunakan API yang tercantum di bawah ini, pengguna dapat mengindeks studi, seri, dan instans DICOM mereka pada tag DICOM standar dan privat sehingga mereka dapat ditentukan dalam kueri QIDO-RS.
API
Versi: v1
Untuk membantu mengelola tag yang didukung dalam instans layanan DICOM tertentu, titik akhir API berikut telah ditambahkan.
| API | Deskripsi |
|---|---|
| POST .../extendedquerytags | Menambahkan Tag Kueri yang Diperluas |
| GET .../extendedquerytags | Mencantumkan Tag Kueri yang Diperluas |
| GET .../extendedquerytags/{tagPath} | Dapatkan Tag Kueri yang Diperluas |
| DELETE .../extendedquerytags/{tagPath} | Hapus Tag Kueri yang Diperluas |
| PATCH .../extendedquerytags/{tagPath} | Memperbarui Tag Kueri yang Diperluas |
| GET .../extendedquerytags/{tagPath}/errors | Mencantumkan Kesalahan Tag Kueri yang Diperluas |
| GET .../operations/{operationId} | Dapatkan Operasi |
Menambahkan tag kueri yang diperluas
Menambahkan satu atau beberapa tag kueri yang diperluas dan memulai operasi jangka panjang yang mengindeks ulang instans DICOM saat ini dengan tag yang ditentukan.
POST .../extendedquerytags
Meminta header
| Nama | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| Jenis-Konten | True | string | application/json didukung |
Isi permintaan
| Nama | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| isi | Tag Kueri yang Diperluas untuk Menambahkan[] |
Batasan
Jenis VR berikut didukung:
| VR | Deskripsi | Pencocokan Nilai Tunggal | Pencocokan Rentang | Pencocokan Fuzzy |
|---|---|---|---|---|
| AE | Entitas Aplikasi | X | ||
| AS | String Usia | X | ||
| CS | String Kode | X | ||
| DA | Tanggal | X | X | |
| DS | String Desimal | X | ||
| DT | Date Time | X | X | |
| FD | Floating Point Double | X | ||
| FL | Floating Point Single | X | ||
| IS | String Bilangan Bulat | X | ||
| LO | String Panjang | X | ||
| PN | Nama Orang | X | X | |
| SH | String Pendek | X | ||
| SL | Ditandatangani Panjang | X | ||
| SS | Pendek Ditandatangani | X | ||
| TM | Waktu | X | X | |
| UI | Pengidentifikasi Unik | X | ||
| UL | Panjang Tidak Ditandatangani | X | ||
| US | Pendek Tidak Ditandatangani | X |
Catatan
Tag berurutan, yang merupakan tag di bawah tag jenis Urutan Item (SQ), saat ini tidak didukung. Anda dapat menambahkan hingga 128 tag kueri yang diperluas.
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 202 (Diterima) | Referensi Operasi | Tag kueri yang diperluas telah ditambahkan, dan operasi yang berjalan lama telah mulai mengindeks ulang instans DICOM yang ada |
| 400 (Permintaan Buruk) | Isi permintaan memiliki data yang tidak valid | |
| 409 (Konflik) | Satu atau beberapa tag kueri yang diminta sudah didukung |
Mencantumkan tag kueri yang diperluas
Daftar semua tag kueri yang diperluas.
GET .../extendedquerytags
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 200 (OK) | Tag Kueri yang Diperluas[] |
Mengembalikan tag kueri yang diperluas |
Mendapatkan tag kueri yang diperluas
Mendapatkan tag kueri yang diperluas.
GET .../extendedquerytags/{tagPath}
Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
| tagPath | jalur | True | string | tagPath adalah jalur untuk tag, yang dapat berupa tag atau kata kunci. Misalnya, ID Pasien diwakili oleh 00100020 atau PatientId |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 200 (OK) | Tag Kueri yang Diperluas | Tag kueri yang diperluas dengan yang ditentukan tagPath |
| 400 (Permintaan Buruk) | Jalur tag yang diminta tidak valid | |
| 404 (Tidak Ditemukan) | Tag kueri yang diperluas dengan tagPath yang diminta tidak ditemukan |
Menghapus tag kueri yang diperluas
Menghapus tag kueri yang diperluas.
DELETE .../extendedquerytags/{tagPath}
Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
| tagPath | jalur | True | string | tagPath adalah jalur untuk tag, yang dapat berupa tag atau kata kunci. Misalnya, ID Pasien diwakili oleh 00100020 atau PatientId |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 204 (Tidak Ada Konten) | Tag kueri yang diperluas dengan tagPath yang diminta telah berhasil dihapus. | |
| 400 (Permintaan Buruk) | Jalur tag yang diminta tidak valid. | |
| 404 (Tidak Ditemukan) | Tag kueri yang diperluas dengan tagPath yang diminta tidak ditemukan |
Memperbarui tag kueri yang diperluas
Memperbarui tag kueri yang diperluas.
PATCH .../extendedquerytags/{tagPath}
Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
| tagPath | jalur | True | string | tagPath adalah jalur untuk tag, yang dapat berupa tag atau kata kunci. Misalnya, ID Pasien diwakili oleh 00100020 atau PatientId |
Meminta header
| Nama | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| Jenis-Konten | True | string | application/json tidak didukung. |
Isi permintaan
| Nama | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| isi | Tag Kueri yang Diperluas untuk Memperbarui |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 20 (OK) | Tag Kueri yang Diperluas | Tag kueri yang diperluas yang diperbarui |
| 400 (Permintaan Buruk) | Jalur atau isi tag yang diminta tidak valid | |
| 404 (Tidak Ditemukan) | Tag kueri yang diperluas dengan tagPath yang diminta tidak ditemukan |
Mencantumkan kesalahan tag kueri yang diperluas
Mencantumkan kesalahan pada tag kueri yang diperluas.
GET .../extendedquerytags/{tagPath}/errors
Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
| tagPath | jalur | True | string | tagPath adalah jalur untuk tag, yang dapat berupa tag atau kata kunci. Misalnya, ID Pasien diwakili oleh 00100020 atau PatientId |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 200 (OK) | Kesalahan Tag Kueri yang Diperluas[] |
Daftar kesalahan tag kueri yang diperluas yang terkait dengan tag |
| 400 (Permintaan Buruk) | Jalur tag yang diminta tidak valid | |
| 404 (Tidak Ditemukan) | Tag kueri yang diperluas dengan tagPath yang diminta tidak ditemukan |
Dapatkan operasi
Dapatkan operasi jangka panjang.
GET .../operations/{operationId}
Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
| operationId | jalur | True | string | ID operasi |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 200 (OK) | Operasi | Operasi yang selesai untuk ID yang ditentukan |
| 202 (Diterima) | Operasi | Operasi yang berjalan untuk ID yang ditentukan |
| 404 (Tidak Ditemukan) | Operasi tidak ditemukan |
QIDO dengan tag kueri yang diperluas
Status tag
Status tag kueri yang diperluas menunjukkan status saat ini. Saat tag kueri yang diperluas pertama kali ditambahkan, statusnya diatur ke Adding, dan operasi jangka panjang dimulai untuk mengindeks ulang instans DICOM yang ada. Setelah operasi selesai, status tag diperbarui ke Ready. Tag kueri yang diperluas sekarang dapat digunakan di QIDO.
Misalnya, jika tag Nama Model Produsen (0008.1090) ditambahkan, dan dalam Ready status, selanjutnya kueri berikut dapat digunakan untuk memfilter instans yang disimpan dengan Nama Model Produsen.
../instances?ManufacturerModelName=Microsoft
Mereka juga dapat digunakan dengan tag yang ada. Contohnya:
../instances?00081090=Microsoft&PatientName=Jo&fuzzyMatching=true
Status kueri tag
QueryStatus menunjukkan apakah QIDO diizinkan untuk tag. Ketika operasi indeks ulang gagal memproses satu atau beberapa instans DICOM untuk tag, QueryStatus tag tersebut diatur ke Disabled secara otomatis. Anda dapat memilih untuk mengabaikan kesalahan pengindeksan dan mengizinkan kueri menggunakan tag ini dengan mengatur QueryStatus ke Enabled melalui Update Extended Query Tag API. Setiap permintaan QIDO yang mereferensikan setidaknya satu tag yang diaktifkan secara manual akan menyertakan kumpulan tag dengan kesalahan pengindeksan di header erroneous-dicom-attributesrespons .
Misalnya, tag PatientAge kueri yang diperluas memiliki kesalahan selama pengindeksaian ulang, tetapi diaktifkan secara manual. Untuk kueri berikut, Anda akan dapat melihat PatientAge di erroneous-dicom-attributes header .
../instances?PatientAge=035Y
Definisi
Tag kueri yang diperluas
Tag DICOM yang akan didukung untuk QIDO-RS.
| Nama | Jenis | Deskripsi |
|---|---|---|
| Jalur | string | Jalur tag, biasanya terdiri dari ID grup dan ID elemen. misalnya, PatientId (0010.0020) memiliki jalur 00100020 |
| VR | string | Representasi nilai tag ini |
| PrivateCreator | string | Kode identifikasi dari pelaksana tag privat ini |
| Tingkat | Tingkat Tag Kueri yang Diperluas | Tingkat tag kueri yang diperluas |
| Status | Status Tag Kueri yang Diperluas | Status tag kueri yang diperluas |
| QueryStatus | Status Kueri Tag Kueri yang Diperluas | Status kueri tag kueri yang diperluas |
| Kesalahan | Referensi Kesalahan Tag Kueri yang Diperluas | Referensi ke kesalahan tag kueri yang diperluas |
| Operasi | Referensi Operasi | Referensi ke operasi yang berjalan lama |
Contoh kode 1 adalah tag standar (0008.0070) dalam Ready status.
{
"status": "Ready",
"level": "Instance",
"queryStatus": "Enabled",
"path": "00080070",
"vr": "LO"
}
Contoh kode 2 adalah tag standar (0010.1010) dalam Adding status. Operasi dengan ID 1a5d0306d9624f699929ee1a59ed57a0 berjalan di atasnya, dan 21 kesalahan telah terjadi sejauh ini.
{
"status": "Adding",
"level": "Study",
"errors": {
"count": 21,
"href": "https://localhost:63838/extendedquerytags/00101010/errors"
},
"operation": {
"id": "1a5d0306d9624f699929ee1a59ed57a0",
"href": "https://localhost:63838/operations/1a5d0306d9624f699929ee1a59ed57a0"
},
"queryStatus": "Disabled",
"path": "00101010",
"vr": "AS"
}
Referensi operasi
Referensi ke operasi jangka panjang.
| Nama | Jenis | Deskripsi |
|---|---|---|
| ID | string | ID operasi |
| Href | string | Uri ke operasi |
Operasi
Mewakili operasi jangka panjang.
| Nama | Jenis | Deskripsi |
|---|---|---|
| OperationId | string | ID operasi |
| Jenis Operasi | Jenis operasi | Jenis operasi jangka panjang |
| CreatedTime | string | Waktu ketika operasi dibuat |
| LastUpdatedTime | string | Waktu ketika operasi diperbarui terakhir kali |
| Status | Status Operasi | Mewakili status run time operasi |
| PercentComplete | Bilangan bulat | Persentase pekerjaan yang telah diselesaikan oleh operasi |
| Sumber | string[] |
Kumpulan lokasi sumber daya yang sedang dibuat atau dimanipulasi operasi |
Contoh kode berikut adalah operasi pengindeksan ulang yang sedang berjalan.
{
"resources": [
"https://localhost:63838/extendedquerytags/00101010"
],
"operationId": "a99a8b51-78d4-4fd9-b004-b6c0bcaccf1d",
"type": "Reindex",
"createdTime": "2021-10-06T16:40:02.5247083Z",
"lastUpdatedTime": "2021-10-06T16:40:04.5152934Z",
"status": "Running",
"percentComplete": 10
}
Status operasi
Mewakili status durasi operasi yang berjalan lama.
| Nama | Jenis | Deskripsi |
|---|---|---|
| Belum Dimulai | string | Operasi belum dimulai |
| Berjalan | string | Operasi sedang dijalankan dan belum selesai |
| Selesai | string | Operasi berhasil diselesaikan |
| Gagal | string | Operasi telah berhenti sebelum waktunya setelah mengalami satu atau beberapa kesalahan |
Kesalahan tag kueri yang diperluas
Kesalahan yang terjadi selama operasi pengindeksan tag kueri yang diperluas.
| Nama | Jenis | Deskripsi |
|---|---|---|
| StudyInstanceUid | string | UID instans studi tempat kesalahan pengindeksan terjadi |
| SeriesInstanceUid | string | UID instans seri tempat kesalahan pengindeksan terjadi |
| SopInstanceUid | string | UID instans sop tempat kesalahan pengindeksan terjadi |
| CreatedTime | string | Waktu ketika terjadi kesalahan (UTC) |
| ErrorMessage | string | Pesan kesalahan |
Contoh kode berikut berisi kesalahan panjang nilai yang tidak terduga pada instans DICOM. Itu terjadi pada 2021-10-06T16:41:44.4783136.
{
"studyInstanceUid": "2.25.253658084841524753870559471415339023884",
"seriesInstanceUid": "2.25.309809095970466602239093351963447277833",
"sopInstanceUid": "2.25.225286918605419873651833906117051809629",
"createdTime": "2021-10-06T16:41:44.4783136",
"errorMessage": "Value length is not expected."
}
Referensi kesalahan tag kueri yang diperluas
Referensi ke kesalahan tag kueri yang diperluas.
| Nama | Jenis | Deskripsi |
|---|---|---|
| Hitung | Bilangan bulat | Jumlah total kesalahan pada tag kueri yang diperluas |
| Href | string | URI ke kesalahan tag kueri yang diperluas |
Jenis operasi
Jenis operasi yang berjalan lama.
| Nama | Jenis | Deskripsi |
|---|---|---|
| Indeks Ulang | string | Operasi indeks ulang yang memperbarui indeks untuk data yang ditambahkan sebelumnya berdasarkan tag baru |
Status tag kueri yang diperluas
Status tag kueri yang diperluas.
| Nama | Jenis | Deskripsi |
|---|---|---|
| Menambahkan | string | Tag kueri yang diperluas telah ditambahkan, dan operasi jangka panjang mengindeksasi ulang instans DICOM yang ada |
| Siap | string | Tag kueri yang diperluas siap untuk QIDO-RS |
| Menghapus | string | Tag kueri yang diperluas sedang dihapus |
Tingkat tag kueri yang diperluas
Tingkat hierarki informasi DICOM tempat tag ini berlaku.
| Nama | Jenis | Deskripsi |
|---|---|---|
| Instance | string | Tag kueri yang diperluas relevan di tingkat instans |
| Seri | string | Tag kueri yang diperluas relevan pada tingkat seri |
| Studi | string | Tag kueri yang diperluas relevan di tingkat studi |
Status kueri tag kueri yang diperluas
Status kueri tag kueri yang diperluas.
| Nama | Jenis | Deskripsi |
|---|---|---|
| Nonaktif | string | Tag kueri yang diperluas tidak diizinkan untuk dikueri |
| Aktif | string | Tag kueri yang diperluas diizinkan untuk dikueri |
Catatan
Kesalahan selama operasi indeks ulang menonaktifkan QIDO pada tag kueri yang diperluas. Anda dapat memanggil UPDATE Extended Query Tag API untuk mengaktifkannya.
Tag kueri yang diperluas untuk memperbarui
Mewakili tag kueri yang diperluas untuk diperbarui.
| Nama | Jenis | Deskripsi |
|---|---|---|
| QueryStatus | Status Kueri Tag Kueri yang Diperluas | Status kueri dari tag kueri yang diperluas |
Tag kueri yang diperluas untuk ditambahkan
Mewakili tag kueri yang diperluas untuk ditambahkan.
| Nama | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| Jalur | True | string | Jalur tag, biasanya terdiri dari ID grup dan ID elemen yang ( PatientId 0010.0020) memiliki jalur 00100020 |
| VR | string | Representasi nilai dari tag ini. Ini opsional untuk tag standar, dan diperlukan untuk tag privat | |
| PrivateCreator | string | Kode identifikasi dari pelaksana tag privat ini. Hanya diatur saat tag adalah tag privat | |
| Tingkat | True | Tingkat Tag Kueri yang Diperluas | Mewakili hierarki di mana tag ini relevan. Harus menjadi salah satu Studi, Seri, atau Instans |
Contoh kode 1MicrosoftPC mendefinisikan tag privat (0401.1001) dengan SS representasi nilai pada tingkat instans.
{
"Path": "04011001",
"VR": "SS",
"PrivateCreator": "MicrosoftPC",
"Level": "Instance"
}
Contoh kode 2 menggunakan tag standar dengan kata kunci ManufacturerModelName dengan LO representasi nilai yang ditentukan pada tingkat seri.
{
"Path": "ManufacturerModelName",
"VR": "LO",
"Level": "Series"
}
Contoh kode 3 menggunakan tag standar (0010.0040) dan didefinisikan pada studi. Representasi nilai sudah ditentukan oleh standar DICOM.
{
"Path": "00100040",
"Level": "Study"
}
Ringkasan
Artikel konseptual ini memberi Anda gambaran umum tentang fitur Tag Kueri yang Diperluas dalam layanan DICOM.
Langkah berikutnya
Untuk informasi selengkapnya tentang menyebarkan layanan DICOM, lihat
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk