Zmiany interfejsu API usługi DICOM w wersji 2
Ten przewodnik informacyjny zawiera podsumowanie zmian w interfejsie API wersji 2 usługi DICOM®. Aby wyświetlić pełny zestaw funkcji w wersji 2, zobacz instrukcję zgodności DICOM w wersji 2.
Podsumowanie zmian w wersji 2
Przechowuj
Łagodna walidacja opcjonalnych atrybutów
W poprzednich wersjach żądanie sklepu kończy się niepowodzeniem, jeśli którykolwiek z wymaganych lub możliwych do wyszukania atrybutów zakończy się niepowodzeniem. Począwszy od wersji 2, żądanie kończy się niepowodzeniem tylko wtedy, gdy wymagane atrybuty kończą się niepowodzeniem.
Niepowodzenie walidacji atrybutów, które nie są wymagane przez interfejs API, powoduje, że plik jest przechowywany z ostrzeżeniem w odpowiedzi. Ostrzeżenia powodują zwrócenie kodu HTTP polecenia 202 Accepted , a ładunek odpowiedzi zawiera WarningReason tag (0008, 1196).
Zostanie wyświetlone ostrzeżenie dotyczące każdego atrybutu kończącego się niepowodzeniem na wystąpienie. Jeśli sekwencja zawiera atrybut, który kończy się niepowodzeniem weryfikacji lub gdy istnieje wiele problemów z pojedynczym atrybutem, zostanie zanotowany tylko pierwszy błąd przyczyny atrybutu.
Istnieją pewne istotne zachowania atrybutów opcjonalnych, które kończą się niepowodzeniem weryfikacji:
- Wyszukuje atrybut, który zakończył się niepowodzeniem walidacji, zwraca analizę/serię/wystąpienie, jeśli wartość jest poprawiona na jeden z kilku sposobów wymienionych tutaj.
- Atrybuty nie są zwracane podczas pobierania metadanych za pośrednictwem punktów końcowych WADO
/metadata.
Pobieranie badania/serii/wystąpienia zawsze zwraca oryginalne pliki binarne z oryginalnymi atrybutami, nawet jeśli te atrybuty nie powiodły się weryfikacji.
Jeśli atrybut jest wypełniony wartościami null, atrybut jest indeksowany podczas wyszukiwania i jest przechowywany w metadanych dicom+json. Nie podano ostrzeżenia o walidacji.
Retrieve
Obsługa pobierania pojedynczej ramki
Pobieranie pojedynczej ramki jest obsługiwane przez dodanie następującego Accept nagłówka:
application/octet-stream; transfer-syntax=*
Search
Wyniki wyszukiwania mogą być niekompletne w przypadku rozszerzonych tagów zapytań z ostrzeżeniami dotyczącymi walidacji
W interfejsie API w wersji 1 i w wersji 2, jeśli rozszerzony tag zapytania zawiera jakiekolwiek błędy, ponieważ co najmniej jedno z istniejących wystąpień ma wartość tagu, której nie można indeksować, kolejne zapytania wyszukiwania zawierające tag zapytania rozszerzonego zwracają erroneous-dicom-attributes się zgodnie z opisem w dokumentacji. Jednak tagi (znane również jako atrybuty) z ostrzeżeniami walidacji z STOW-RS nie są uwzględnione w tym nagłówku. Jeśli żądanie magazynu spowoduje wyświetlenie ostrzeżeń dotyczących sprawdzania poprawności atrybutów z możliwością wyszukiwania w momencie przechowywania wystąpienia, te atrybuty mogą nie być używane do wyszukiwania przechowywanego wystąpienia. Jednak wszystkie atrybuty z możliwością wyszukiwania, które zakończyły się niepowodzeniem, będą mogły zwracać wyniki, jeśli wartości są zastępowane przez wystąpienia w tej samej serii/badaniu, które są przechowywane po awarii lub jeśli wartości są już poprawnie przechowywane przez poprzednie wystąpienie. Jeśli wartości atrybutów nie zostaną zastąpione, nie będą one generować żadnych wyników wyszukiwania.
Atrybut można poprawić w następujący sposób:
- Usuwanie przechowywanego wystąpienia i przekazywanie nowego wystąpienia z poprawionymi danymi
- Przekaż nowe wystąpienie w tej samej analizie/serii z poprawionymi danymi
Domyślnie zwracana jest mniejsza liczba atrybutów badania, serii i wystąpienia
Zestaw atrybutów zwracanych domyślnie został zmniejszony w celu zwiększenia wydajności. Zapoznaj się ze szczegółową listą w dokumentacji odpowiedzi na wyszukiwanie.
Atrybuty dodane nowo do tagów domyślnych.
| Poziom tagu | Tag | Nazwa atrybutu |
|---|---|---|
| Studiować | (0008, 1030) | StudyDescription |
| Seria | (0008, 1090) | ManufacturerModelName |
Atrybuty usunięte z tagów domyślnych.
| Poziom tagu | Tag | Nazwa atrybutu |
|---|---|---|
| Studiować | (0008, 0005) | SpecificCharacterSet |
| Studiować | (0008, 0030) | StudyTime |
| Studiować | (0008, 0056) | InstanceAvailability |
| Studiować | (0008, 0201) | TimezoneOffsetFromUTC |
| Studiować | (0010, 0040) | PatientSex |
| Studiować | (0020, 0010) | Identyfikator badania |
| Seria | (0008, 0005) | SpecificCharacterSet |
| Seria | (0008, 0201) | TimezoneOffsetFromUTC |
| Seria | (0008, 103E) | SeriesDescription |
| Seria | (0040, 0245) | PerformedProcedureStepStartTime |
| Seria | (0040, 0275) | RequestAttributesSequence |
| Wystąpienie | (0008, 0005) | SpecificCharacterSet |
| Wystąpienie | (0008, 0016) | SOPClassUID |
| Wystąpienie | (0008, 0056) | InstanceAvailability |
| Wystąpienie | (0008, 0201) | TimezoneOffsetFromUTC |
| Wystąpienie | (0020, 0013) | Numer wystąpienia |
| Wystąpienie | (0028, 0010) | Wiersze |
| Wystąpienie | (0028, 0011) | Kolumny |
| Wystąpienie | (0028, 0100) | BityPrzydzielone |
| Wystąpienie | (0028, 0008) | NumberOfFrames |
Wszystkie usunięte tagi są częścią dodatkowych tagów, które zostaną zwrócone podczas wykonywania zapytania za pomocą polecenia includefield = all.
Atrybuty wypełnione o wartości null można wyszukiwać z dopełnieniem lub bez
Gdy atrybut był przechowywany przy użyciu wypełnienia o wartości null, można go wyszukać z dopełnieniem wartości null lub bez niego w kodowaniu identyfikatora URI. Pobrane wyniki są przeznaczone dla atrybutów przechowywanych zarówno z dopełnianiem wartości null, jak i bez.
Operacje
Nazwa completed stanu została zmieniona na succeeded
Aby dostosować się do wytycznych dotyczących interfejsu API REST firmy Microsoft, completed nazwa stanu została zmieniona na succeeded.
Zestawienie zmian
Zestawienie zmian akceptuje teraz zakres czasu
Interfejs API zestawienia zmian akceptuje teraz parametry opcjonalne startTime i endTime ułatwiające określanie zakresu wyników. Zmiany w zakresie czasu mogą być nadal podzielone na strony przy użyciu istniejących offset parametrów i limit . Przesunięcie jest względne względem przedziału czasu zdefiniowanego przez startTime wartości i endTime. Na przykład piąty wpis zestawienia zmian rozpoczynający się od 24.07.2023 o 09:00 czasu UTC użyje ciągu ?startTime=2023-07-24T09:00:00Z&offset=5zapytania .
W przypadku wersji 2 zaleca się zawsze uwzględnienie zakresu czasu w celu zwiększenia wydajności.
Uwaga
DICOM® jest zastrzeżonym znakiem towarowym National Electrical Manufacturers Association for its Standards publikacji odnoszących się do cyfrowej komunikacji informacji medycznych.