DICOMweb Service-Dokumentation | PostDicom

Prerequisites Einführung und allgemeine Informationen

Dieses Dokument enthält einen umfassenden technischen Leitfaden für DICOMweb API Funktionen mit Beispielmethoden, die in einer C#-Beispielanwendung verwendet werden. Es enthält detaillierte Erklärungen aller verfügbaren Funktionen und deckt beide ab standard DICOMweb services (wie QIDO-RS, WADO-RS, and STOW-RS) und custom DICOMweb API endpoints entwickelt von PostDicom. Diese Funktionen sind für die Verwendung bei serverseitigen Aufrufen konzipiert.

Um die DICOMweb-Dienste von PostDicom nutzen zu können, müssen Sie diese Funktion zunächst für Ihr Konto aktiviert haben und gültige Benutzerdaten besitzen. Wenn der DICOMweb-Zugang für Ihr Konto noch nicht aktiviert ist und Sie Ihre Anwendung in PostDicom integrieren möchten, kontaktieren Sie uns bitte, um die Aktivierung anzufordern.

User Name: Dies ist Ihre primäre Anmeldeinformationen, in der Regel Ihre E-Mail-Adresse. Es ist einzigartig für Ihr Konto und wird als Benutzername in der Standardauthentifizierung verwendet.

Password: Dies ist das Passwort, das mit Ihrem PostDicom-Konto verknüpft ist. Es wird in Verbindung mit Ihrem Benutzernamen bei der Standardauthentifizierung verwendet. Für optimale Sicherheit empfehlen wir dringend, ein sicheres Passwort zu wählen. Bitte stellen Sie bei Ihrem serverseitigen Aufruf die notwendigen Sicherheitsmechanismen bereit, damit dieser Benutzername und dieses Passwort von Ihnen selbst geschützt sind.

Sie können Ihr Passwort und Ihre Sicherheitseinstellungen über Ihre Kontoprofilseite verwalten, nachdem Sie sich bei Ihrem PostDicom-Konto angemeldet haben

DICOMweb Standarddienste

DICOM-Instanzen speichern ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Diese Funktion orchestriert das Hochladen aller DCM-Dateien aus einem angegebenen lokalen Ordner auf den DICOMWeb-Server. Sie identifiziert zunächst alle relevanten Dateien und verwendet dann Hilfsmethoden, um für jede Datei eine authentifizierte mehrteilige oder verwandte POST-Anfrage zu erstellen und zu senden, die dem STOW-RS-Standard entspricht.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
DirectoryPath	string	Der vollständige Pfad zum lokalen Verzeichnis, das die hochzuladenden DICOM-Dateien (.dcm) enthält.

Abfrage nach DICOM-Objekten ( QIDO-RS)

QidoSearch(UserName, Password, WebAddress, PatientID, StudyInstanceUID, SeriesInstanceUID)

Diese Funktion führt eine Abfrage nach DICOM-Objekten mithilfe des QIDO-RS-Standards durch und ermöglicht Suchen auf Studien-, Serien- oder Instanzebene. Basierend auf dem bereitgestellten Suchparameter (wie Patienten-ID, Studieninstanz-UID oder Serieninstanz-UID) erstellt sie die entsprechende URL und führt eine authentifizierte Anfrage aus, um übereinstimmende Ergebnisse vom Server abzurufen.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
PatientID	string	fakultativ Wird verwendet, um den Patienten zu identifizieren und nach verwandten Studien zu suchen.
StudyInstanceUID	string	fakultativ Wird verwendet, um nach einer bestimmten Studie oder allen Serien innerhalb dieser Studie zu suchen.
SeriesInstanceUID	string	fakultativ Wird verwendet, um nach allen Bildinstanzen innerhalb einer bestimmten Serie zu suchen.

DICOM-Instanzen abrufen ( WADO-RS)

RetrieveImagesUsingWadoRs(UserName, Password, WebAddress, StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID)

Diese Funktion bietet ein interaktives Menü zum Abrufen von DICOM-Objekten mithilfe des WADO-RS-Standards. Der Benutzer wählt eine Abrufebene (Studie, Serie oder Instanz) aus und gibt die entsprechende UID an. Die Funktion stellt dann eine authentifizierte Anfrage und verarbeitet die mehrteilige bzw. verwandte Antwort, wobei jeder DICOM-Teil als separate DCM-Datei in einem neu erstellten lokalen Verzeichnis gespeichert wird.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
StudyInstanceUID	string	fakultativ Eine weltweit eindeutige Kennung für eine DICOM-Studie. Wird verwendet, um alle Serien und Instanzen abzurufen, die mit dieser Studie verknüpft sind.
SeriesInstanceUID	string	fakultativ Eine weltweit eindeutige Kennung für eine Reihe innerhalb einer DICOM-Studie. Wird verwendet, um alle Bilder dieser Serie abzurufen.
SOPInstanceUID	string	fakultativ Eine eindeutige Kennung für eine einzelne DICOM-Image-Instanz. Wird verwendet, um ein bestimmtes Bild mit WADO-RS abzurufen.

Verwaltung teilen

Link zum Teilen erstellen

CreateShareLink(UserName, Password, WebAddress, PatientOrderInfoList, ExpireDate, SharePassword, Downloadable)

Diese Funktion generiert einen sicheren Weblink, um eine oder mehrere Patientenbestellungen mit externen Benutzern zu teilen. Der Link kann passwortgeschützt sein und optional Downloads ermöglichen.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das Passwort für das PostDicom-Konto. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
PatientOrderInfoList	List	Liste von JSON-Zeichenketten, die jeweils einen „patientOrderUUID“ -Schlüssel enthalten, der die Patientenbestellungen identifiziert, die geteilt werden sollen.
ExpireDate	string (YYYY-MM-DD)	Ablaufdatum für den Link zum Teilen. Nach diesem Datum wird der Link deaktiviert.
SharePassword	string	fakultativ Für den Zugriff auf den Link zum Teilen ist ein Passwort erforderlich. Für den öffentlichen Zugriff leer lassen.
Downloadable	bool	fakultativ Legt fest, ob die DICOM-Studien vom Empfänger heruntergeladen werden können.

Patientenbestellung mit URL teilen

SharePatientOrderWithUrl(UserName, Password, WebAddress, OrderUuidList, ExpireDate, SharePassword, UserCanDownloadStudies)

Diese Funktion generiert eine gemeinsam nutzbare URL für ausgewählte Patientenbestellungen mit zusätzlichen Zugriffskontrolloptionen wie Download-Erlaubnis und Passwortschutz.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail) des PostDicom-Kontos. (aus der Initialisierung)
Password	string	Das Passwort für das PostDicom-Konto. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
OrderUuidList	List	Liste von UUIDs, die Patientenbestellungen identifizieren, die geteilt werden sollen.
ExpireDate	string (YYYY-MM-DD)	Datum, nach dem der Link zum Teilen inaktiv wird.
SharePassword	string	fakultativ Für den Zugriff auf den geteilten Link ist ein Passwort erforderlich.
UserCanDownloadStudies	bool	fakultativ Wenn der Wert auf „true“ gesetzt ist, kann der Empfänger die Studien herunterladen.

Ordner- und Auftragsverwaltung

Ordner erstellen

CreateFolder(UserName, Password, WebAddress, FolderName, FolderDescription, ParentFolderUuid)

Diese Funktion wird verwendet, um einen neuen Ordner (einen virtuellen Container) innerhalb des PostDicom-Kontos zu erstellen, der die Organisation von Patientenbestellungen erleichtert.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
FolderName	string	Erforderlich. Der sichtbare Name für den neuen Ordner.
FolderDescription	string	fakultativ Eine Textbeschreibung für den Ordner.
ParentFolderUuid	string	fakultativ Die UUID eines vorhandenen Ordners, in dem der neue Ordner erstellt werden soll.

Ordner durchsuchen

SearchFolder(UserName, Password, WebAddress, ParentFolderUuid, FolderName, GetOrdersInFolder)

Diese Funktion findet vorhandene Ordner anhand von Suchkriterien. Sie kann optional die Liste der Patientenbestellungen in jedem gefundenen Ordner enthalten.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
ParentFolderUuid	string	fakultativ Eine Ordner-UUID, um die Suche auf die untergeordneten Ordner zu beschränken.
FolderName	string	fakultativ Ein vollständiger oder teilweiser Name, nach dem gesucht werden soll.
GetOrdersInFolder	bool	fakultativ Wenn `true` angegeben ist, enthält die Antwort eine Liste der Patientenbestellungen für jeden gefundenen Ordner.

Ordner mit URL teilen

ShareFolderWithUrl(UserName, Password, WebAddress, FolderUuid, SharePassword, ShareTitle, ShareDescription, ExpireDate, UserCanDownloadStudies)

Diese Funktion generiert eine sichere, gemeinsam nutzbare URL für einen gesamten Ordner und seinen Inhalt. Sie ermöglicht eine umfassende Zugriffskontrolle, indem ein benutzerdefinierter Titel, eine Beschreibung, ein Passwort und ein Ablaufdatum festgelegt werden und angegeben wird, ob der Inhalt vom Empfänger heruntergeladen werden kann.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
FolderUuid	string	Erforderlich. Die eindeutige Kennung (UUID) des Ordners, der geteilt werden soll.
SharePassword	string	fakultativ Ein Passwort zum Schutz des geteilten Links. Wenn das Feld leer gelassen wird, ist der Link öffentlich zugänglich.
ShareTitle	string	fakultativ Ein benutzerdefinierter Titel für die Seite mit geteilten Ordnern, der für den Empfänger sichtbar ist.
ShareDescription	string	fakultativ Eine Beschreibung, die auf der Seite „Freigegebener Ordner“ angezeigt wird.
ExpireDate	string (YYYY-MM-DD)	fakultativ Das Datum, an dem der Link zum Teilen automatisch inaktiv wird.
UserCanDownloadStudies	bool	fakultativ Wenn `true` gesetzt ist, können die Empfänger die im Ordner enthaltenen Patientenbestellungen herunterladen.

Bestellung zum Ordner hinzufügen

AddOrderToFolder(UserName, Password, WebAddress, PatientOrderUuid, FolderUuidList)

Diese Funktion erstellt eine Verknüpfung zwischen einer vorhandenen Patientenbestellung und einem vorhandenen Ordner. Dies ist ein Organisationstool; es werden keine Daten verschoben oder kopiert.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
PatientOrderUuid	string	Erforderlich. Die UUID der Patientenbestellung, die in einen Ordner gelegt werden soll.
FolderUuidList	List	Erforderlich. Eine Liste, die die UUID des Zielordners enthält.

Arbeitsablauf und Zuweisung

Bestellung dem Benutzer zuweisen

AssignOrderToUser(UserName, Password, WebAddress, PatientOrderUuid, AssignedUserUuid)

Diese Funktion ist ein zentrales Workflow-Tool. Sie weist eine Patientenbestellung einem einzelnen Benutzer zu, was bedeutet, dass dieser Benutzer nun für eine Aufgabe im Zusammenhang mit dieser Bestellung verantwortlich ist (z. B. Berichterstattung).

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
PatientOrderUuid	string	Erforderlich. Die UUID der Patientenbestellung, für die eine Aktion erforderlich ist.
AssignedUserUuid	string	Erforderlich. Die UUID des spezifischen Benutzers, dem die Verantwortung zugewiesen wird.

Reihenfolge der Benutzergruppe zuweisen

AssignOrderToUserGroup(UserName, Password, WebAddress, PatientOrderUuid, AssignedUserGroupUuid)

Ähnlich wie bei der Zuweisung an einen einzelnen Benutzer weist diese Funktion eine Patientenbestellung einer ganzen Gruppe zu und ermöglicht so teambasierte Arbeitsabläufe, bei denen jedes Gruppenmitglied die Aufgabe erledigen kann.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
PatientOrderUuid	string	Erforderlich. Die UUID der Patientenbestellung, die der Gruppe zugewiesen werden soll.
AssignedUserGroupUuid	string	Erforderlich. Die UUID der Benutzergruppe, der die Bestellung zugewiesen werden soll.

Lebenszyklus von Patientenbestellungen und Datenabruf

Patientenbestellung erstellen

CreatePatientOrder(UserName, Password, WebAddress, InstitutionUuid, PatientName, PatientId, OtherPatientId, PatientSex, PatientBirthdate, Modality, StudyDescription, AccessionNumber, PatientComplaints, OrderScheduledDatetime, RequestedProcedureId, RequestedProcedureDescription, RequestingPhysician, ReferringPhysiciansName, ScheduledEquipmentUuid)

Diese Funktion erstellt eine neue Patientenbestellung zur Planung und Verwaltung von Bildgebungsstudien innerhalb des Systems. Für eine erfolgreiche Erstellung müssen die erforderlichen Parameter angegeben werden.

Required Parameters	Data Type	Beschreibung
InstitutionUuid	string	Erforderlich. UUID der Institution, in der die Patientenbestellung erstellt wird.
PatientName	string	Erforderlich. Vollständiger Name des Patienten.
PatientId	string	Erforderlich. Die eindeutige Kennung des Patienten, z. B. eine nationale ID oder MRN.
PatientBirthdate	string (YYYY-MM-DD)	Erforderlich. Geburtsdatum des Patienten im ISO-Format.
Modality	string	Erforderlich. Modalitätstyp wie CT, MR, US usw.
OtherPatientId	string	fakultativ Eine zusätzliche Kennung für den Patienten, falls zutreffend.
PatientSex	string	fakultativ Geschlecht des Patienten (z. B. M, F, O).
StudyDescription	string	fakultativ Beschreibung der in Auftrag gegebenen Bildgebungsstudie.
AccessionNumber	string	fakultativ Falls zutreffend, eindeutige Zugangsnummer für die Bestellung.
PatientComplaints	string	fakultativ Text, der die Beschwerden oder Symptome des Patienten beschreibt.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	fakultativ Das geplante Startdatum und die Uhrzeit des Vorgangs.
RequestedProcedureId	string	fakultativ Bezeichner für das angeforderte Verfahren.
RequestedProcedureDescription	string	fakultativ Beschreibung des angeforderten Verfahrens.
RequestingPhysician	string	fakultativ Name des Arztes, der die Studie angefordert hat.
ReferringPhysiciansName	string	fakultativ Name des überweisenden Arztes, falls dieser von dem Namen des Antragstellers abweicht.
ScheduledEquipmentUuid	string	fakultativ UUID des Bildgebungsgeräts, das für das geplante Verfahren verwendet werden soll.

Eigenschaften von Patientenbestellungen abrufen

GetPatientOrderProperties(UserName, Password, WebAddress, PatientOrderInstitutionUuid, PatientOrderUuid)

Diese Funktion ruft den kompletten Eigenschaftensatz für eine einzelne, spezifische Patientenbestellung ab.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
PatientOrderInstitutionUuid	string	Erforderlich. Die UUID der Institution, zu der die Bestellung gehört.
PatientOrderUuid	string	Erforderlich. Die UUID der spezifischen Patientenbestellung, die abgerufen werden soll.

Nach Patientenbestellungen suchen

GetPatientOrderList(UserName, Password, WebAddress, InstitutionUuidList, PatientName, PatientId, OtherPatientId, AccessionNumber, ModalityList, StudyDateFrom, StudyDateTo, PatientBirthdateFrom, PatientBirthdateTo)

Diese Funktion ruft eine Liste von Patientenbestellungen auf der Grundlage einer Kombination von Suchfiltern wie Patientenname, ID, Modalität und Studien- oder Geburtsdaten ab. Sie ermöglicht eine erweiterte Suchfunktion für Einrichtungen, die mehrere Bestellungen verwalten.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
InstitutionUuidList	List	Liste der UUIDs, die die Einrichtungen identifizieren, die nach Patientenbestellungen suchen.
PatientName	string	fakultativ Filtern Sie nach dem vollständigen Namen des Patienten.
PatientId	string	fakultativ Filtern Sie nach der eindeutigen Kennung des Patienten.
OtherPatientId	string	fakultativ Sekundäre Kennung für den Patienten, falls verfügbar.
AccessionNumber	string	fakultativ Filtern Sie nach der Zugangsnummer, die der Studie zugewiesen wurde.
ModalityList	List	Liste der Modalitäten (z. B. CT, MR, US) zum Filtern der Suchergebnisse.
StudyDateFrom	string (YYYY-MM-DD)	fakultativ Startdatum des Studiendatumsbereichs für die Filterung der Ergebnisse.
StudyDateTo	string (YYYY-MM-DD)	fakultativ Enddatum des Studiendatumsbereichs für die Filterung der Ergebnisse.
PatientBirthdateFrom	string (YYYY-MM-DD)	fakultativ Geben Sie das Startdatum des Geburtsdatums des Patienten ein, um Patienten nach Alter zu filtern.
PatientBirthdateTo	string (YYYY-MM-DD)	fakultativ Bereich für das Enddatum des Geburtsdatums des Patienten, um Patienten nach Alter zu filtern.

Patientenbestellung löschen

DeletePatientOrder(UserName, Password, WebAddress, PatientOrderInstitutionUuid, PatientOrderUuid)

Diese Funktion löscht eine Patientenbestellung dauerhaft aus dem System. Sie erfordert sowohl die UUID der Institution als auch die UUID der spezifischen Patientenbestellung, um die Richtigkeit sicherzustellen und ein versehentliches Löschen zu verhindern.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
PatientOrderInstitutionUuid	string	Erforderlich. UUID der Institution, der die Patientenbestellung gehört. Stellt sicher, dass der richtige Kontext für das Löschen verwendet wird.
PatientOrderUuid	string	Erforderlich. UUID der spezifischen Patientenbestellung, die gelöscht werden soll. Dadurch wird die Bestellung im System eindeutig identifiziert.

Holen Sie sich Dicom-Tag-Inhalte

Inhalt des DICOM-Tags abrufen

GetDicomTagContent(UserName, Password, WebAddress, PatientOrderInstitutionUuid, PatientOrderUuid, PatientSeriesUuid, DicomTagIdList)

Diese Funktion ruft die Werte bestimmter DICOM-Tags aus den Bildern ab, die einer Patientenbestellung zugeordnet sind.

Required Parameters	Data Type	Beschreibung
UserName	string	Der Nutzername (E-Mail-Adresse) für das PostDicom-Konto. (aus der Initialisierung)
Password	string	Das mit dem PostDicom-Konto verknüpfte Passwort. (aus der Initialisierung)
WebAddress	string	Die Basis-URL der API. (aus der Initialisierung)
PatientOrderInstitutionUuid	string	Erforderlich. Die UUID der Institution, in der sich die Bestellung befindet.
PatientOrderUuid	string	Erforderlich. Die UUID der Bestellung, die die Bilder enthält.
PatientSeriesUuid	string	fakultativ Falls angegeben, werden Tags nur aus dieser bestimmten Serie gelesen.
DicomTagIdList	List	fakultativ Eine Liste der abzurufenden DICOM-Tag-IDs.