Dokumentacja Usług DICOMweb | PostDICOM

Prerequisites Wprowadzenie i informacje ogólne

Niniejszy dokument stanowi kompleksowy przewodnik techniczny dla funkcji API DICOMweb z przykładowymi metodami wykorzystywanymi w aplikacji przykładowej C#. Zawiera szczegółowe wyjaśnienia wszystkich dostępnych funkcji, obejmujące zarówno standardowe usługi DICOMweb (takie jak metody QIDO-RS, WADO-RS i STOW-RS), jak i niestandardowe punkty końcowe API DICOMweb opracowane przez PostDICOM. Funkcje te są przeznaczone do użycia w wywołaniach po stronie serwera.

Aby korzystać z usług DICOMweb PostDICOM, muszą mieć Państwo najpierw włączoną tę funkcję na swoim koncie i posiadać ważne dane uwierzytelniające użytkownika. Jeśli dostęp do DICOMweb nie jest jeszcze aktywny na Państwa koncie, a chcą Państwo zintegrować swoją aplikację z PostDICOM, prosimy o kontakt z nami w celu zgłoszenia prośby o aktywację.

Nazwa użytkownika: Są to Państwa podstawowe dane logowania, zazwyczaj adres e-mail. Jest unikalny dla Państwa konta i używany jako nazwa użytkownika w uwierzytelnianiu podstawowym (Basic Authentication).

Hasło: Jest to hasło powiązane z Państwa kontem PostDICOM. Jest używane w połączeniu z nazwą użytkownika podczas uwierzytelniania podstawowego. Dla optymalnego bezpieczeństwa zdecydowanie zalecamy wybór silnego hasła. Prosimy o zapewnienie niezbędnych mechanizmów bezpieczeństwa po stronie serwera, aby nazwa użytkownika i hasło były przez Państwa chronione.

Mogą Państwo zarządzać swoim hasłem i ustawieniami bezpieczeństwa na stronie profilu konta po zalogowaniu się do konta PostDICOM

Standardowe Usługi DICOMweb

Przechowywanie instancji DICOM (STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Funkcja ta koordynuje przesyłanie wszystkich plików .dcm z określonego folderu lokalnego na serwer DICOMweb. Najpierw identyfikuje wszystkie odpowiednie pliki, a następnie używa metod pomocniczych do skonstruowania i wysłania uwierzytelnionego żądania POST multipart/related dla każdego pliku, zgodnie ze standardem STOW-RS.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
DirectoryPath	string	Pełna ścieżka do katalogu lokalnego zawierającego pliki DICOM (.dcm) do przesłania.

Zapytanie o obiekty DICOM (QIDO-RS)

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

Ta funkcja wykonuje zapytanie o obiekty DICOM przy użyciu standardu QIDO-RS, umożliwiając wyszukiwanie na poziomie badania (Study), serii (Series) lub instancji (Instance). Na podstawie dostarczonego parametru wyszukiwania (takiego jak ID pacjenta, UID instancji badania lub UID instancji serii), konstruuje odpowiedni adres URL i wykonuje uwierzytelnione żądanie, aby pobrać pasujące wyniki z serwera.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
PatientID	string	Opcjonalne. Służy do identyfikacji pacjenta i wyszukiwania powiązanych badań.
StudyInstanceUID	string	Opcjonalne. Służy do wyszukiwania konkretnego badania lub wszystkich serii w ramach tego badania.
SeriesInstanceUID	string	Opcjonalne. Służy do wyszukiwania wszystkich instancji obrazów w ramach określonej serii.

Pobieranie instancji DICOM (WADO-RS)

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

Ta funkcja udostępnia interaktywne menu do pobierania obiektów DICOM przy użyciu standardu WADO-RS. Użytkownik wybiera poziom pobierania (Badanie, Seria lub Instancja) i podaje odpowiedni identyfikator UID. Następnie funkcja wykonuje uwierzytelnione żądanie i przetwarza odpowiedź multipart/related, zapisując każdą część DICOM jako oddzielny plik .dcm w nowo utworzonym katalogu lokalnym.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
StudyInstanceUID	string	Opcjonalne. Globalnie unikalny identyfikator badania DICOM. Służy do pobierania wszystkich serii i instancji powiązanych z tym badaniem.
SeriesInstanceUID	string	Opcjonalne. Globalnie unikalny identyfikator serii w ramach badania DICOM. Służy do pobierania wszystkich obrazów z tej serii.
SOPInstanceUID	string	Opcjonalne. Unikalny identyfikator pojedynczej instancji obrazu DICOM. Służy do pobierania konkretnego obrazu przy użyciu WADO-RS.

Zarządzanie Udostępnianiem

Utwórz link udostępniania

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

Funkcja ta generuje bezpieczny link internetowy do udostępniania jednego lub więcej zleceń pacjentów użytkownikom zewnętrznym. Link może być chroniony hasłem i opcjonalnie umożliwiać pobieranie.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło do konta PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
PatientOrderInfoList	List	Lista ciągów JSON, z których każdy zawiera klucz "PatientOrderUuid", identyfikująca zlecenia pacjentów do udostępnienia.
ExpireDate	string (YYYY-MM-DD)	Data wygaśnięcia linku udostępniania. Po tej dacie link zostanie wyłączony.
SharePassword	string	Opcjonalne. Hasło wymagane do uzyskania dostępu do linku udostępniania. Pozostaw puste dla dostępu publicznego.
Downloadable	bool	Opcjonalne. Określa, czy badania DICOM mogą być pobierane przez odbiorcę.

Udostępnij zlecenie pacjenta za pomocą adresu URL

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

Funkcja ta generuje link do udostępniania wybranych zleceń pacjentów z dodatkowymi opcjami kontroli dostępu, takimi jak pozwolenie na pobieranie i ochrona hasłem.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło do konta PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
OrderUuidList	List	Lista UUID identyfikująca zlecenia pacjentów do udostępnienia.
ExpireDate	string (YYYY-MM-DD)	Data, po której link udostępniania staje się nieaktywny.
SharePassword	string	Opcjonalne. Hasło wymagane do uzyskania dostępu do udostępnionego linku.
UserCanDownloadStudies	bool	Opcjonalne. Jeśli ustawione na true, odbiorca może pobrać badania.

Zarządzanie Folderami i Zleceniami

Utwórz folder

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

Funkcja ta służy do tworzenia nowego folderu (wirtualnego kontenera) w koncie PostDICOM w celu ułatwienia organizacji zleceń pacjentów.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
FolderName	string	Wymagane. Widoczna nazwa nowego folderu.
FolderDescription	string	Opcjonalne. Opis tekstowy folderu.
ParentFolderUuid	string	Opcjonalne. UUID istniejącego folderu, aby utworzyć w nim nowy folder.

Wyszukaj folder

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

Funkcja ta znajduje istniejące foldery na podstawie kryteriów wyszukiwania. Może opcjonalnie dołączyć listę zleceń pacjentów w każdym znalezionym folderze.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
ParentFolderUuid	string	Opcjonalne. UUID folderu w celu ograniczenia wyszukiwania do jego elementów podrzędnych.
FolderName	string	Opcjonalne. Pełna lub częściowa nazwa do wyszukania.
GetOrdersInFolder	bool	Opcjonalne. Jeśli `true`, odpowiedź będzie zawierać listę zleceń pacjentów dla każdego znalezionego folderu.

Udostępnij folder za pomocą adresu URL

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

Funkcja ta generuje bezpieczny, możliwy do udostępnienia adres URL dla całego folderu i jego zawartości. Pozwala na kompleksową kontrolę dostępu poprzez ustawienie niestandardowego tytułu, opisu, hasła, daty wygaśnięcia oraz określenie, czy zawartość może być pobierana przez odbiorcę.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
FolderUuid	string	Wymagane. Unikalny identyfikator (UUID) folderu, który ma zostać udostępniony.
SharePassword	string	Opcjonalne. Hasło chroniące udostępniony link. Jeśli pozostanie puste, link będzie dostępny publicznie.
ShareTitle	string	Opcjonalne. Niestandardowy tytuł strony udostępnionego folderu, widoczny dla odbiorcy.
ShareDescription	string	Opcjonalne. Opis wyświetlany na stronie udostępnionego folderu.
ExpireDate	string (YYYY-MM-DD)	Opcjonalne. Data, w której link udostępniania automatycznie stanie się nieaktywny.
UserCanDownloadStudies	bool	Opcjonalne. Jeśli `true`, odbiorcy mogą pobrać zlecenia pacjentów zawarte w folderze.

Dodaj zlecenie do folderu

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

Ta funkcja tworzy powiązanie między istniejącym zleceniem pacjenta a istniejącym folderem. Jest to narzędzie organizacyjne; nie przenosi ani nie kopiuje danych.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
PatientOrderUuid	string	Wymagane. UUID zlecenia pacjenta, które ma zostać umieszczone w folderze.
FolderUuidList	List	Wymagane. Lista zawierająca UUID folderu docelowego.

Przepływ pracy i przypisywanie zadań

Przypisz zlecenie do użytkownika

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

Funkcja ta jest podstawowym narzędziem przepływu pracy (workflow). Przypisuje ona zlecenie pacjenta do konkretnego użytkownika, oznaczając, że użytkownik ten jest teraz odpowiedzialny za zadanie związane z tym zleceniem (np. opisanie badania).

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
PatientOrderUuid	string	Wymagane. UUID zlecenia pacjenta, które wymaga działania.
AssignedUserUuid	string	Wymagane. UUID konkretnego użytkownika, któremu zostanie przypisana odpowiedzialność.

Przypisz zlecenie do grupy użytkowników

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

Podobnie jak w przypadku przypisywania do pojedynczego użytkownika, funkcja ta przypisuje zlecenie pacjenta do całej grupy, umożliwiając zespołowe przepływy pracy, w których każdy członek grupy może zająć się zadaniem.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
PatientOrderUuid	string	Wymagane. UUID zlecenia pacjenta, które ma zostać przypisane do grupy.
AssignedUserGroupUuid	string	Wymagane. UUID grupy użytkowników, której ma zostać przypisane zlecenie.

Cykl Życia Zlecenia Pacjenta i Pobieranie Danych

Utwórz zlecenie pacjenta

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

Funkcja ta tworzy nowe zlecenie pacjenta w celu zaplanowania i zarządzania badaniami obrazowymi w systemie. Aby utworzenie powiodło się, należy podać wymagane parametry.

Wymagane parametry	Typ danych	Opis
InstitutionUuid	string	Wymagane. UUID instytucji, w której tworzone jest zlecenie pacjenta.
PatientName	string	Wymagane. Pełne imię i nazwisko pacjenta.
PatientId	string	Wymagane. Unikalny identyfikator pacjenta, taki jak numer PESEL lub MRN.
PatientBirthdate	string (YYYY-MM-DD)	Wymagane. Data urodzenia pacjenta w formacie ISO.
Modality	string	Wymagane. Typ modalności, np. CT, MR, US itp.
OtherPatientId	string	Opcjonalne. Dodatkowy identyfikator pacjenta, jeśli dotyczy.
PatientSex	string	Opcjonalne. Płeć pacjenta (np. M, F, O).
StudyDescription	string	Opcjonalne. Opis zlecanego badania obrazowego.
AccessionNumber	string	Opcjonalne. Unikalny numer dostępu dla zlecenia, jeśli dotyczy.
PatientComplaints	string	Opcjonalne. Tekst opisujący dolegliwości lub objawy pacjenta.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Opcjonalne. Zaplanowana data i godzina rozpoczęcia procedury.
RequestedProcedureId	string	Opcjonalne. Identyfikator żądanej procedury.
RequestedProcedureDescription	string	Opcjonalne. Opis żądanej procedury.
RequestingPhysician	string	Opcjonalne. Nazwisko lekarza zlecającego badanie.
ReferringPhysiciansName	string	Opcjonalne. Nazwisko lekarza kierującego, jeśli jest inny niż zlecający.
ScheduledEquipmentUuid	string	Opcjonalne. UUID sprzętu do obrazowania, który ma zostać użyty do zaplanowanej procedury.

Pobierz właściwości zlecenia pacjenta

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

Funkcja ta pobiera kompletny zestaw właściwości dla pojedynczego, konkretnego zlecenia pacjenta.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
PatientOrderInstitutionUuid	string	Wymagane. UUID instytucji, do której należy zlecenie.
PatientOrderUuid	string	Wymagane. UUID konkretnego zlecenia pacjenta do pobrania.

Wyszukaj zlecenia pacjentów

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

Funkcja ta pobiera listę zleceń pacjentów na podstawie kombinacji filtrów wyszukiwania, takich jak imię i nazwisko pacjenta, ID, modalność oraz daty badania lub urodzenia. Umożliwia zaawansowane wyszukiwanie dla instytucji zarządzających wieloma zleceniami.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
InstitutionUuidList	List	Lista UUID identyfikująca instytucje, w których mają być wyszukiwane zlecenia pacjentów.
PatientName	string	Opcjonalne. Filtrowanie według pełnego imienia i nazwiska pacjenta.
PatientId	string	Opcjonalne. Filtrowanie według unikalnego identyfikatora pacjenta.
OtherPatientId	string	Opcjonalne. Drugi identyfikator pacjenta, jeśli jest dostępny.
AccessionNumber	string	Opcjonalne. Filtrowanie według numeru dostępu przypisanego do badania.
ModalityList	List	Lista modalności (np. CT, MR, US) do filtrowania wyników wyszukiwania.
StudyDateFrom	string (YYYY-MM-DD)	Opcjonalne. Data początkowa zakresu dat badania do filtrowania wyników.
StudyDateTo	string (YYYY-MM-DD)	Opcjonalne. Data końcowa zakresu dat badania do filtrowania wyników.
PatientBirthdateFrom	string (YYYY-MM-DD)	Opcjonalne. Data początkowa zakresu dat urodzenia pacjenta do filtrowania pacjentów według wieku.
PatientBirthdateTo	string (YYYY-MM-DD)	Opcjonalne. Data końcowa zakresu dat urodzenia pacjenta do filtrowania pacjentów według wieku.

Usuń zlecenie pacjenta

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

Funkcja ta trwale usuwa zlecenie pacjenta z systemu. Wymaga podania zarówno UUID instytucji, jak i UUID konkretnego zlecenia pacjenta, aby zapewnić dokładność i zapobiec przypadkowemu usunięciu.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
PatientOrderInstitutionUuid	string	Wymagane. UUID instytucji, która jest właścicielem zlecenia pacjenta. Zapewnia, że do usunięcia używany jest poprawny kontekst.
PatientOrderUuid	string	Wymagane. UUID konkretnego zlecenia pacjenta, które ma zostać usunięte. Unikalnie identyfikuje zlecenie w systemie.

Pobierz zawartość tagu DICOM

Pobierz zawartość tagu DICOM

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

Funkcja ta pobiera wartości określonych tagów DICOM z obrazów powiązanych ze zleceniem pacjenta.

Wymagane parametry	Typ danych	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDICOM. (z inicjalizacji)
Password	string	Hasło powiązane z kontem PostDICOM. (z inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (z inicjalizacji)
PatientOrderInstitutionUuid	string	Wymagane. UUID instytucji, w której znajduje się zlecenie.
PatientOrderUuid	string	Wymagane. UUID zlecenia zawierającego obrazy.
PatientSeriesUuid	string	Opcjonalne. Jeśli podano, tagi będą odczytywane tylko z tej konkretnej serii.
DicomTagIdList	List	Opcjonalne. Lista identyfikatorów tagów DICOM do pobrania.