Bővített lekérdezéscímkék
Áttekintés
Alapértelmezés szerint a DICOM szolgáltatás támogatja a megfelelőségi utasításban megadott DICOM-címkék lekérdezését. A kiterjesztett lekérdezéscímkék engedélyezésével a címkék listája egyszerűen kibontható az alkalmazás igényei alapján.
Az alább felsorolt API-k használatával a felhasználók a DICOM-tanulmányokat, -sorozatokat és -példányokat szabványos és privát DICOM-címkéken is indexelhetik, így a QIDO-RS-lekérdezésekben megadhatók.
API-k
Verzió: 1-es verzió
Egy adott DICOM-szolgáltatáspéldány támogatott címkéinek kezeléséhez a következő API-végpontok lettek hozzáadva.
API | Leírás |
---|---|
POST .../extendedquerytags | Bővített lekérdezéscímkék hozzáadása |
GET .../extendedquerytags | Bővített lekérdezéscímkék listázása |
GET .../extendedquerytags/{tagPath} | Bővített lekérdezéscímke lekérése |
DELETE .../extendedquerytags/{tagPath} | Bővített lekérdezéscímke törlése |
PATCH .../extendedquerytags/{tagPath} | Bővített lekérdezéscímke frissítése |
GET .../extendedquerytags/{tagPath}/errors | Bővített lekérdezéscímkék hibáinak listázása |
GET .../operations/{operationId} | Művelet lekérése |
Bővített lekérdezéscímkék hozzáadása
Hozzáad egy vagy több kiterjesztett lekérdezéscímkét, és elindít egy hosszú ideig futó műveletet, amely újraindexeli az aktuális DICOM-példányokat a megadott címké(k)vel.
POST .../extendedquerytags
Kérelem fejléce
Name | Kötelező | Típus | Leírás |
---|---|---|---|
Content-Type | True (Igaz) | sztring | application/json támogatott |
A kérés törzse
Name | Kötelező | Típus | Leírás |
---|---|---|---|
body (Törzs) | Bővített lekérdezéscímke hozzáadáshoz[] |
Korlátozások
A következő VR-típusok támogatottak:
VR | Leírás | Egyetlen értékegyeztetés | Tartományegyeztetés | Homályos egyezés |
---|---|---|---|---|
AE | Alkalmazásentitás | X | ||
AS | Korsztring | X | ||
CS | Kódsztring | X | ||
DA | Dátum | X | X | |
DS | Decimális sztring | X | ||
DT | Dátum és idő | X | X | |
FD | Lebegőpontos dupla | X | ||
FL | Lebegőpontos egypontos | X | ||
IS | Egész szám sztringje | X | ||
LO | Hosszú sztring | X | ||
PN | Személy neve | X | X | |
SH | Rövid sztring | X | ||
SL | Aláírt hosszú | X | ||
SS | Rövid alá van írva | X | ||
TM | Idő | X | X | |
Felhasználói felület | Egyedi azonosító | X | ||
UL | Aláíratlan hosszú | X | ||
USA | Aláíratlan rövid | X |
Megjegyzés
A szekvenciális címkék, amelyek elemek sorozata (SQ) típusú címkében találhatók, jelenleg nem támogatottak. Legfeljebb 128 kiterjesztett lekérdezéscímkét adhat hozzá.
Válaszok
Név | Típus | Leírás |
---|---|---|
202 (Elfogadva) | Műveleti referencia | Bővített lekérdezéscímkék lettek hozzáadva, és egy hosszú ideig futó művelet indult el a meglévő DICOM-példányok újraindexeléséhez |
400 (Hibás kérés) | A kérelem törzse érvénytelen adatokkal rendelkezik | |
409 (Ütközés) | Egy vagy több kért lekérdezéscímke már támogatott |
Bővített lekérdezéscímkék listázása
Az összes kiterjesztett lekérdezéscímke(ek) listája.
GET .../extendedquerytags
Válaszok
Név | Típus | Leírás |
---|---|---|
200 (OK) | Bővített lekérdezéscímke[] |
Kiterjesztett lekérdezéscímkéket ad vissza |
Bővített lekérdezéscímke lekérése
Bővített lekérdezéscímke lekérése.
GET .../extendedquerytags/{tagPath}
URI-paraméterek
Name | In | Kötelező | Típus | Leírás |
---|---|---|---|---|
tagPath | path | True (Igaz) | sztring | A tagPath a címke elérési útja, amely lehet címke vagy kulcsszó. A betegazonosítót például a vagy a 00100020 PatientId |
Válaszok
Név | Típus | Leírás |
---|---|---|
200 (OK) | Bővített lekérdezéscímke | A kiterjesztett lekérdezéscímke a megadott tagPath |
400 (Hibás kérés) | A kért címke elérési útja érvénytelen | |
404 (nem található) | A kért tagPathtal rendelkező bővített lekérdezéscímke nem található |
Bővített lekérdezéscímke törlése
Bővített lekérdezéscímke törlése.
DELETE .../extendedquerytags/{tagPath}
URI-paraméterek
Name | In | Kötelező | Típus | Leírás |
---|---|---|---|---|
tagPath | path | True (Igaz) | sztring | A tagPath a címke elérési útja, amely lehet címke vagy kulcsszó. A betegazonosítót például a vagy a 00100020 PatientId |
Válaszok
Név | Típus | Leírás |
---|---|---|
204 (Nincs tartalom) | A kért tagPathtal rendelkező bővített lekérdezéscímke sikeresen törölve lett. | |
400 (Hibás kérés) | A kért címke elérési útja érvénytelen. | |
404 (nem található) | A kért tagPathtal rendelkező bővített lekérdezéscímke nem található |
Bővített lekérdezéscímke frissítése
Bővített lekérdezéscímke frissítése.
PATCH .../extendedquerytags/{tagPath}
URI-paraméterek
Name | In | Kötelező | Típus | Leírás |
---|---|---|---|---|
tagPath | path | True (Igaz) | sztring | A tagPath a címke elérési útja, amely lehet címke vagy kulcsszó. A betegazonosítót például a vagy a 00100020 PatientId |
Kérelem fejléce
Name | Kötelező | Típus | Leírás |
---|---|---|---|
Content-Type | True (Igaz) | sztring | application/json támogatott. |
A kérés törzse
Name | Kötelező | Típus | Leírás |
---|---|---|---|
body (Törzs) | Bővített lekérdezéscímke frissítéshez |
Válaszok
Név | Típus | Leírás |
---|---|---|
20 (OK) | Bővített lekérdezéscímke | A frissített kiterjesztett lekérdezéscímke |
400 (Hibás kérés) | A kért címke elérési útja vagy törzse érvénytelen | |
404 (nem található) | A kért tagPathtal rendelkező bővített lekérdezéscímke nem található |
Bővített lekérdezéscímkék hibáinak listázása
A bővített lekérdezéscímkék hibáit sorolja fel.
GET .../extendedquerytags/{tagPath}/errors
URI-paraméterek
Name | In | Kötelező | Típus | Leírás |
---|---|---|---|---|
tagPath | path | True (Igaz) | sztring | A tagPath a címke elérési útja, amely lehet címke vagy kulcsszó. A betegazonosítót például a vagy a 00100020 PatientId |
Válaszok
Név | Típus | Leírás |
---|---|---|
200 (OK) | Kiterjesztett lekérdezéscímke-hiba[] |
A címkéhez társított kiterjesztett lekérdezéscímke-hibák listája |
400 (Hibás kérés) | A kért címke elérési útja érvénytelen | |
404 (nem található) | A kért tagPathtal rendelkező bővített lekérdezéscímke nem található |
Művelet lekérése
Hosszú ideig futó művelet lekérése.
GET .../operations/{operationId}
URI-paraméterek
Name | In | Kötelező | Típus | Leírás |
---|---|---|---|---|
operationId | path | True (Igaz) | sztring | A művelet azonosítója |
Válaszok
Név | Típus | Leírás |
---|---|---|
200 (OK) | Művelet | A megadott azonosító befejezett művelete |
202 (Elfogadva) | Művelet | A megadott azonosító futó művelete |
404 (nem található) | A művelet nem található |
QIDO kiterjesztett lekérdezési címkékkel
Címke állapota
A bővített lekérdezési címke állapota az aktuális állapotot jelzi. A kiterjesztett lekérdezéscímke első hozzáadásakor az állapota a értékre Adding
van állítva, és egy hosszú ideig futó művelet indul el a meglévő DICOM-példányok újraindexeléséhez. A művelet befejezése után a címke állapota a következőre frissül: Ready
. A kiterjesztett lekérdezéscímke mostantól használható a QIDO-ban.
Ha például hozzáadja a Gyártói modell neve (00081090) címkét, és állapotban Ready
van, a következő lekérdezésekkel szűrheti a tárolt példányokat a Gyártói modell neve alapján.
../instances?ManufacturerModelName=Microsoft
Meglévő címkékkel is használhatók. Például:
../instances?00081090=Microsoft&PatientName=Jo&fuzzyMatching=true
A lekérdezés állapotának címkézése
A QueryStatus azt jelzi, hogy a QIDO engedélyezve van-e a címkéhez. Ha egy újraindexelési művelet egy címke egy vagy több DICOM-példányát nem tudja feldolgozni Disabled
, a címke QueryStatus értéke automatikusan lesz beállítva. Dönthet úgy, hogy figyelmen kívül hagyja az indexelési hibákat, és engedélyezi, hogy a lekérdezések ezt a címkét használják, ha az QueryStatus
Enabled
Update Extended Query Tag API-t választja. Minden olyan QIDO-kérés, amely legalább egy manuálisan engedélyezett címkére hivatkozik, az indexelési hibákkal rendelkező címkéket tartalmazza a válaszfejlécben erroneous-dicom-attributes
.
Tegyük fel például, hogy a kiterjesztett lekérdezéscímkének PatientAge
voltak hibái az újraindexelés során, de manuálisan engedélyezték. Az alábbi lekérdezés esetén a fejlécben erroneous-dicom-attributes
is látható PatientAge
lesz.
../instances?PatientAge=035Y
Definíciók
Bővített lekérdezéscímke
A QIDO-RS-hez támogatott DICOM-címke.
Név | Típus | Leírás |
---|---|---|
Elérési út | sztring | A címke elérési útja, amely általában csoportazonosítóból és elemazonosítóból áll. Például PatientId a (0010 0020) elérési útja 00100020 |
VR | sztring | A címke értékábrázolása |
PrivateCreator | sztring | A magáncímke végrehajtójának azonosító kódja |
Level | Bővített lekérdezéscímkeszint | Bővített lekérdezéscímke szintje |
Állapot | Bővített lekérdezéscímke állapota | A kiterjesztett lekérdezéscímke állapota |
QueryStatus | Bővített lekérdezéscímke lekérdezési állapota | Bővített lekérdezéscímke lekérdezési állapota |
Hibák | Bővített lekérdezéscímke hibáinak referenciája | Hivatkozás kiterjesztett lekérdezéscímkék hibáira |
Művelet | Műveleti referencia | Hivatkozás hosszú ideig futó műveletre |
Az 1. kódminta egy szabványos címke (0008,0070) állapotbanReady
.
{
"status": "Ready",
"level": "Instance",
"queryStatus": "Enabled",
"path": "00080070",
"vr": "LO"
}
A 2. kódminta egy szabványos címke (0010,1010) állapotban Adding
. Egy azonosítóval 1a5d0306d9624f699929ee1a59ed57a0
rendelkező művelet fut rajta, és eddig 21 hiba történt.
{
"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"
}
Művelethivatkozás
Hivatkozás egy hosszú ideig futó műveletre.
Név | Típus | Leírás |
---|---|---|
ID (Azonosító) | sztring | művelet azonosítója |
Href | sztring | URI a művelethez |
Művelet
Hosszú ideig futó műveletet jelöl.
Név | Típus | Leírás |
---|---|---|
OperationId | sztring | A művelet azonosítója |
OperationType | Művelet típusa | A hosszú ideig futó művelet típusa |
CreatedTime | sztring | A művelet létrehozásának időpontja |
LastUpdatedTime | sztring | A művelet legutóbbi frissítésének időpontja |
Állapot | Művelet állapota | A művelet futási idejének állapotát jelöli |
Készültségi szint | Egész szám | A művelet által elvégzett munka százalékos aránya |
Források | sztring[] |
A művelet által létrehozott vagy módosító erőforrások gyűjteménye |
Az alábbi példakód egy futó újraindexelési művelet.
{
"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
}
Művelet állapota
A hosszú ideig futó művelet futási idejének állapotát jelöli.
Név | Típus | Leírás |
---|---|---|
NotStarted | sztring | A művelet nem indul el |
Futó | sztring | A művelet végrehajtása folyamatban van, és még nem fejeződött be |
Befejeződött | sztring | A művelet sikeresen befejeződött |
Sikertelen | sztring | A művelet egy vagy több hiba észlelése után idő előtt leállt |
Bővített lekérdezéscímke-hiba
Hiba történt egy kiterjesztett lekérdezéscímke-indexelési művelet során.
Név | Típus | Leírás |
---|---|---|
StudyInstanceUid | sztring | Tanulmánypéldány UID azonosítója, ahol indexelési hibák történtek |
SeriesInstanceUid | sztring | Adatsorpéldány UID azonosítója, ahol indexelési hibák történtek |
SopInstanceUid | sztring | Sop-példány UID azonosítója, ahol indexelési hibák történtek |
CreatedTime | sztring | Hiba előfordulásának időpontja (UTC) |
ErrorMessage | sztring | Hibaüzenet |
Az alábbi példakód váratlan értékhossz-hibát tartalmaz egy DICOM-példányon. A hiba a következő időpontban történt: 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."
}
Kiterjesztett lekérdezéscímke hibáinak referenciája
Hivatkozás kiterjesztett lekérdezéscímkék hibáira.
Név | Típus | Leírás |
---|---|---|
Darabszám | Egész szám | A kiterjesztett lekérdezés címkéjén található hibák teljes száma |
Href | sztring | Kiterjesztett lekérdezéscímke-hibák URI-ja |
Művelettípus
Egy hosszú ideig futó művelet típusa.
Név | Típus | Leírás |
---|---|---|
Újraindexelés | sztring | Újraindexelési művelet, amely frissíti a korábban hozzáadott adatok indexeit az új címkék alapján |
Bővített lekérdezéscímke állapota
A kiterjesztett lekérdezéscímke állapota.
Név | Típus | Leírás |
---|---|---|
Hozzáadása | sztring | A kiterjesztett lekérdezéscímke hozzá lett adva, és egy hosszú ideig futó művelet újraindexeli a meglévő DICOM-példányokat |
Kész | sztring | A kiterjesztett lekérdezéscímke készen áll a QIDO-RS-hez |
Törlés | sztring | A kiterjesztett lekérdezéscímke törlése folyamatban van |
Bővített lekérdezéscímkeszint
Annak a DICOM-információs hierarchiának a szintje, amelyre ez a címke vonatkozik.
Név | Típus | Leírás |
---|---|---|
Példány | sztring | A kiterjesztett lekérdezéscímke a példány szintjén releváns |
Adatsorozat | sztring | A kiterjesztett lekérdezéscímke az adatsor szintjén releváns |
Tanulmány | sztring | A kiterjesztett lekérdezéscímke tanulmányi szinten releváns |
Bővített lekérdezéscímke lekérdezési állapota
A kiterjesztett lekérdezéscímke lekérdezési állapota.
Név | Típus | Leírás |
---|---|---|
Disabled (Letiltva) | sztring | A kiterjesztett lekérdezéscímke nem kérdezhető le |
Engedélyezve | sztring | A kiterjesztett lekérdezéscímke lekérdezhető |
Megjegyzés
Az újraindexelési művelet során jelentkező hibák letiltják a QIDO-t a kiterjesztett lekérdezés címkéjén. Az Update Extended Query Tag API-t meghívhatja annak engedélyezéséhez.
Bővített lekérdezéscímke frissítéshez
A bővített lekérdezéscímkét jelöli a frissítéshez.
Név | Típus | Leírás |
---|---|---|
QueryStatus | Bővített lekérdezéscímke lekérdezési állapota | A kiterjesztett lekérdezéscímke lekérdezési állapota |
Bővített lekérdezéscímke hozzáadáshoz
Kiterjesztett lekérdezéscímkét jelöl a hozzáadáshoz.
Name | Kötelező | Típus | Leírás |
---|---|---|---|
Elérési út | True (Igaz) | sztring | A címke elérési útja, amely általában a (0010 0020) csoportazonosítóból és elemazonosítóból PatientId áll, elérési útja 00100020 |
VR | sztring | A címke értékábrázolása. Standard címke esetén nem kötelező, és magáncímkéhez szükséges | |
PrivateCreator | sztring | A magáncímke végrehajtójának azonosító kódja. Csak akkor van beállítva, ha a címke privát címke | |
Level | Igaz | Bővített lekérdezéscímkeszint | Azt a hierarchiát jelöli, amelyben ez a címke releváns. Az egyik tanulmánynak, sorozatnak vagy példánynak kell lennie |
Az 1MicrosoftPC
. kód példa a privát címke (0401 1001) definiálása a példány szintjén lévő SS
értékmegjelenítéssel.
{
"Path": "04011001",
"VR": "SS",
"PrivateCreator": "MicrosoftPC",
"Level": "Instance"
}
A 2. kód példa a standard címkét használja kulcsszóval ManufacturerModelName
, az LO
adatsor szintjén definiált értékreprezentációval.
{
"Path": "ManufacturerModelName",
"VR": "LO",
"Level": "Series"
}
A 3. kód minta a standard címkét (0010 0040) használja, és a vizsgálatok alapján van definiálva. Az értékábrázolást már a DICOM szabvány határozza meg.
{
"Path": "00100040",
"Level": "Study"
}
Összefoglalás
Ez a fogalmi cikk áttekintést nyújtott a DICOM szolgáltatás bővített lekérdezéscímkéje funkcióról.
Következő lépések
A DICOM szolgáltatás üzembe helyezésével kapcsolatos további információkért lásd: