DICOM-Dienst-API v2 Änderungen
Dieses Referenzhandbuch enthält eine Zusammenfassung der Änderungen in der V2-API des DICOM-Diensts®. Informationen zum vollständigen Funktionsumfang in v2 finden Sie in der DICOM-Konformitätserklärung v2.
Zusammenfassung der Änderungen in v2
Store
Lenient validation of optional attributes
In früheren Versionen schlägt eine Store-Anforderung fehl, wenn eine der erforderlichen oder durchsuchbaren Attribute die Überprüfung fehlschlägt. Ab v2 schlägt die Anforderung nur fehl, wenn die überprüfung der erforderlichen Attribute fehlschlägt.
Fehler bei der Überprüfung von Attributen, die von der API nicht erforderlich sind, führt dazu, dass die Datei mit einer Warnung in der Antwort gespeichert wird. Warnungen führen zu einem HTTP-Rückgabecode, 202 Accepted
und die Antwortnutzlast enthält das WarningReason
Tag (0008, 1196
).
Es wird eine Warnung zu jedem Fehlerhaften Attribut pro Instanz angezeigt. Wenn eine Sequenz ein Attribut enthält, bei dem die Überprüfung fehlschlägt oder mehrere Probleme mit einem einzelnen Attribut auftreten, wird nur der erste fehlerhafte Attributgrund angegeben.
Es gibt einige wichtige Verhaltensweisen für optionale Attribute, die bei der Überprüfung fehlschlagen:
- Sucht nach dem Attribut, bei dem die Überprüfung fehlgeschlagen ist, gibt die Studie/Datenreihe/Instanz zurück, wenn der Wert auf eine der wenigen hier genannten Methoden korrigiert wird.
- Die Attribute werden beim Abrufen von Metadaten über WADO-Endpunkte
/metadata
nicht zurückgegeben.
Beim Abrufen einer Studie/Serie/Instanz werden immer die ursprünglichen Binärdateien mit den ursprünglichen Attributen zurückgegeben, auch wenn diese Attribute nicht überprüft wurden.
Wenn ein Attribut mit Nullen aufgefüllt wird, wird das Attribut bei Durchsuchbarem indiziert und wie in dicom+json-Metadaten gespeichert. Es wird keine Überprüfungswarnung bereitgestellt.
Gerätehandle
Unterstützung für den Abruf von Einzelframes
Der Abruf einzelner Frames wird durch Hinzufügen des folgenden Accept
Headers unterstützt:
application/octet-stream; transfer-syntax=*
Suche
Suchergebnisse können für erweiterte Abfragetags mit Überprüfungswarnungen unvollständig sein.
Wenn ein erweitertes Abfragetag Fehler in der v1-API aufweist und für v2 fortgesetzt wird, da mindestens eine der vorhandenen Instanzen einen Tagwert aufweist, der nicht indiziert werden konnte, dann werden nachfolgende Suchabfragen, die das erweiterte Abfragetag enthalten, wie in der Dokumentation beschrieben zurückgegebenerroneous-dicom-attributes
. Tags (auch als Attribute bezeichnet) mit Validierungswarnungen von STOW-RS sind jedoch nicht in diesem Header enthalten. Wenn eine Speicheranforderung zu Überprüfungswarnungen für durchsuchbare Attribute zum Zeitpunkt der Speicherung der Instanz führt, werden diese Attribute möglicherweise nicht zum Suchen nach der gespeicherten Instanz verwendet. Alle durchsuchbaren Attribute , die bei der Überprüfung fehlgeschlagen sind, können jedoch Ergebnisse zurückgeben, wenn die Werte von Instanzen in derselben Studie/Datenreihe überschrieben werden, die nach dem fehlgeschlagenen Attribut gespeichert werden, oder wenn die Werte bereits von einer vorherigen Instanz ordnungsgemäß gespeichert wurden. Wenn die Attributwerte nicht überschrieben werden, werden keine Suchergebnisse erzeugt.
Ein Attribut kann wie folgt korrigiert werden:
- Löschen der gespeicherten Instanz und Hochladen einer neuen Instanz mit korrigierten Daten
- Hochladen einer neuen Instanz in derselben Studie/Serie mit korrigierten Daten
Weniger Attribute "Study", "Series" und "Instance" werden standardmäßig zurückgegeben.
Der standardmäßig zurückgegebene Satz von Attributen wurde reduziert, um die Leistung zu verbessern. Weitere Informationen finden Sie in der Suchantwortdokumentation .
Attribute, die neu zu Standardtags hinzugefügt wurden.
Tagebene | Tag | Attributname |
---|---|---|
Studieren | (0008, 1030) | StudyDescription |
Reihen | (0008, 1090) | ManufacturerModelName |
Attribute, die aus Standardtags entfernt wurden.
Tagebene | Tag | Attributname |
---|---|---|
Studieren | (0008, 0005) | SpecificCharacterSet |
Studieren | (0008, 0030) | StudyTime |
Studieren | (0008, 0056) | InstanceAvailability |
Studieren | (0008, 0201) | TimezoneOffsetFromUTC |
Studieren | (0010, 0040) | PatientSex |
Studieren | (0020, 0010) | StudyID |
Reihen | (0008, 0005) | SpecificCharacterSet |
Reihen | (0008, 0201) | TimezoneOffsetFromUTC |
Reihen | (0008, 103E) | SeriesDescription |
Reihen | (0040, 0245) | PerformedProcedureStepStartTime |
Reihen | (0040, 0275) | RequestAttributesSequence |
Instanz | (0008, 0005) | SpecificCharacterSet |
Instanz | (0008, 0016) | SOPClassUID |
Instanz | (0008, 0056) | InstanceAvailability |
Instanz | (0008, 0201) | TimezoneOffsetFromUTC |
Instanz | (0020, 0013) | InstanceNumber |
Instanz | (0028, 0010) | Zeilen |
Instanz | (0028, 0011) | Spalten |
Instanz | (0028, 0100) | BitsAllocated |
Instanz | (0028, 0008) | NumberOfFrames |
Alle entfernten Tags sind Teil zusätzlicher Tags, die zurückgegeben werden, wenn sie abgefragt werden includefield = all
.
Null-Auffüllungsattribute können mit oder ohne Abstand gesucht werden
Wenn ein Attribut mit NULL-Abstand gespeichert wurde, kann es mit oder ohne den NULL-Abstand in der URI-Codierung gesucht werden. Die abgerufenen Ergebnisse beziehen sich auf Attribute, die sowohl mit als auch ohne Nullabstand gespeichert werden.
Vorgänge
Der completed
Status wurde umbenannt in succeeded
Um die REST-API-Richtlinien von Microsoft auszurichten, wurde der completed
Status umbenannt in succeeded
.
Änderungsfeed
"Feed ändern" akzeptiert jetzt einen Zeitraum
Die Änderungsfeed-API akzeptiert jetzt optionale startTime
Und endTime
Parameter, um den Bereich der Ergebnisse zu unterstützen. Änderungen innerhalb eines Zeitraums können weiterhin mithilfe der vorhandenen offset
Parameter limit
und Parameter paginiert werden. Der Offset ist relativ zu dem zeitfenster, das durch startTime
und .endTime
Beispielsweise würde der fünfte Änderungsfeedeintrag ab dem 24.07.2023 um 09:00 Uhr UTC die Abfragezeichenfolge ?startTime=2023-07-24T09:00:00Z&offset=5
verwenden.
Für v2 wird empfohlen, immer einen Zeitraum einzuschließen, um die Leistung zu verbessern.
Hinweis
DICOM® ist die eingetragene Marke des National Electrical Manufacturers Association für seine Standards-Publikationen über die digitale Kommunikation medizinischer Informationen.