Dokumentacja usługi DicomWeb | PostDiCom

Prerequisites Wprowadzenie i informacje ogólne

Niniejszy dokument zawiera obszerny przewodnik techniczny dla DICOMweb API funkcje z przykładowymi metodami, które są używane za pomocą przykładowej aplikacji C#. Zawiera szczegółowe wyjaśnienia wszystkich dostępnych funkcji, obejmujące oba standard DICOMweb services (takie jak QIDO-RS, WADO-RS, and STOW-RS) i custom DICOMweb API endpoints opracowany przez PostDiCom. Funkcje te są przeznaczone do użytku w połączeniach po stronie serwera.

Aby korzystać z usług DicomWeb PostDiCom, musisz najpierw włączyć tę funkcję na swoim koncie i posiadać prawidłowe dane uwierzytelniające użytkownika. Jeśli dostęp do DicomWeb nie jest jeszcze aktywowany dla Twojego konta i chcesz zintegrować swoją aplikację z PostDicom, skontaktuj się z nami, aby poprosić o aktywację.

User Name: To jest Twoje główne poświadczenia logowania, zwykle Twój adres e-mail. Jest unikalny dla Twojego konta i używany jako nazwa użytkownika w Uwierzytelnianiu podstawowym.

Password: To jest hasło powiązane z Twoim kontem PostDicom. Jest używany w połączeniu z Twoją nazwą użytkownika podczas uwierzytelniania podstawowego. Dla optymalnego bezpieczeństwa zdecydowanie zalecamy wybranie silnego hasła. Prosimy o posiadanie niezbędnych mechanizmów bezpieczeństwa na telefonie po stronie serwera, aby ta nazwa użytkownika i hasło były chronione przez Ciebie.

Możesz zarządzać hasłem i ustawieniami zabezpieczeń za pośrednictwem strony profilu konta po zalogowaniu się na swoje konto PostDicom

Usługi standardowe DicomWeb

Przechowuj instancje DICOM ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Funkcja ta organizuje przesyłanie wszystkich plików.dcm z określonego folderu lokalnego do serwera DicomWeb. Najpierw identyfikuje wszystkie istotne pliki, a następnie wykorzystuje metody pomocnicze do konstruowania i wysłania uwierzytelnionego wieloczęściowy/powiązanego żądania POST dla każdego pliku, zgodnie ze standardem STOW-RS.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
DirectoryPath	string	Pełna ścieżka do katalogu lokalnego zawierającego pliki DICOM (.dcm), które mają zostać przesłane.

Zapytanie o obiekty DICOM ( QIDO-RS)

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

Funkcja ta wykonuje zapytanie dla obiektów DICOM przy użyciu standardu QIDO-RS, umożliwiając wyszukiwanie na poziomie badania, serii lub instancji. Na podstawie podanego parametru wyszukiwania (takiego jak identyfikator pacjenta, UID instancji badania lub UID instancji serii) konstruuje odpowiedni adres URL i wykonuje uwierzytelnione żądanie, aby pobrać pasujące wyniki z serwera.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
PatientID	string	Opcjonalnie. Służy do identyfikacji pacjenta i wyszukiwania powiązanych badań.
StudyInstanceUID	string	Opcjonalnie. Służy do wyszukiwania konkretnego badania lub wszystkich serii w tym badaniu.
SeriesInstanceUID	string	Opcjonalnie. Służy do wyszukiwania wszystkich instancji obrazu w określonej serii.

Pobierz instancje DICOM ( WADO-RS)

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

Funkcja ta udostępnia interaktywne menu umożliwiające pobieranie obiektów DICOM przy użyciu standardu WADO-RS. Użytkownik wybiera poziom pobierania (badanie, seria lub instancja) i podaje odpowiedni identyfikator UID. Funkcja następnie tworzy uwierzytelnione żądanie i przetwarza odpowiedź wieloczęściową/powiązaną, zapisując każdą część DICOM jako osobny plik.dcm w nowo utworzonym katalogu lokalnym.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
StudyInstanceUID	string	Opcjonalnie. Unikalny globalnie identyfikator dla badania DICOM. Służy do pobierania wszystkich serii i wystąpień związanych z tym badaniem.
SeriesInstanceUID	string	Opcjonalnie. Unikalny globalnie identyfikator serii w ramach badania DICOM. Służy do pobierania wszystkich obrazów z tej serii.
SOPInstanceUID	string	Opcjonalnie. Unikalny identyfikator dla pojedynczej instancji obrazu DICOM. Służy do pobierania określonego obrazu za pomocą WADO-RS.

Zarządzanie udostępnianiem

Utwórz łącze udostępniania

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

Ta funkcja generuje bezpieczne łącze internetowe do udostępniania jednego lub więcej zamówień pacjentów użytkownikom zewnętrznym. Link może być chroniony hasłem i opcjonalnie zezwalać na pobieranie.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło do konta PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
PatientOrderInfoList	List	Lista ciągów JSON, z których każdy zawiera klucz „PatientOrderUUID”, identyfikujący polecenia pacjentów, które mają być udostępniane.
ExpireDate	string (YYYY-MM-DD)	Data wygaśnięcia linku udostępniania. Po tej dacie link zostanie wyłączony.
SharePassword	string	Opcjonalnie. Hasło wymagane do uzyskania dostępu do łącza udostępniania. Pozostaw puste dla publicznego dostępu.
Downloadable	bool	Opcjonalnie. Określa, czy badania DICOM można pobrać przez odbiorcę.

Udostępnij zamówienie pacjenta za pomocą adresu URL

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

Funkcja ta generuje udostępniany adres URL dla wybranych zleceń pacjentów z dodatkowymi opcjami kontroli dostępu, takimi jak uprawnienia do pobierania i ochrona hasłem.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło do konta PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
OrderUuidList	List	Lista UUID identyfikujących polecenia pacjentów, które mają być udostępniane.
ExpireDate	string (YYYY-MM-DD)	Data, po której link udostępniania staje się nieaktywny.
SharePassword	string	Opcjonalnie. Hasło wymagane do uzyskania dostępu do udostępnionego łącza.
UserCanDownloadStudies	bool	Opcjonalnie. Jeśli ustawiono wartość true, odbiorca może pobrać badania.

Zarządzanie folderami i zamówieniami

Utwórz folder

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

Ta funkcja służy do tworzenia nowego folderu (wirtualnego kontenera) na koncie PostDiCom, aby pomóc w organizowaniu zamówień pacjentów.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
FolderName	string	Wymagane. Widoczna nazwa nowego folderu.
FolderDescription	string	Opcjonalnie. Opis tekstowy folderu.
ParentFolderUuid	string	Opcjonalnie. UUID istniejącego folderu, aby utworzyć nowy folder w nim.

Szukaj folderu

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

Ta funkcja wyszukuje istniejące foldery na podstawie kryteriów wyszukiwania. Opcjonalnie może zawierać listę zamówień pacjentów w każdym znalezionym folderze.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
ParentFolderUuid	string	Opcjonalnie. UUID folderu, który ogranicza wyszukiwanie do jego dzieci.
FolderName	string	Opcjonalnie. Pełna lub częściowa nazwa do wyszukania.
GetOrdersInFolder	bool	Opcjonalnie. Jeśli „prawda”, odpowiedź będzie zawierać listę zamówień pacjentów dla każdego znalezionego folderu.

Udostępnij folder za pomocą adresu URL

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

Ta funkcja generuje bezpieczny, udostępniany 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 ważności i określenie, czy zawartość może zostać pobrana przez odbiorcę.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
FolderUuid	string	Wymagane. Unikalny identyfikator (UUID) folderu, który ma być udostępniony.
SharePassword	string	Opcjonalnie. Hasło chroniące udostępniony link. Jeśli pozostanie pusty, link będzie publicznie dostępny.
ShareTitle	string	Opcjonalnie. Niestandardowy tytuł strony folderu udostępnionego, widoczny dla odbiorcy.
ShareDescription	string	Opcjonalnie. Opis wyświetlany na stronie folderu udostępnionego.
ExpireDate	string (YYYY-MM-DD)	Opcjonalnie. Data, w której link udostępniania automatycznie stanie się nieaktywny.
UserCanDownloadStudies	bool	Opcjonalnie. Jeśli „prawda”, odbiorcy mogą pobrać zamówienia pacjenta zawarte w folderze.

Dodaj zamówienie do folderu

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

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

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
PatientOrderUuid	string	Wymagane. UUID polecenia pacjenta do umieszczenia w folderze.
FolderUuidList	List	Wymagane. Lista zawierająca UUID folderu docelowego.

Przepływ pracy i przydzielanie

Przypisz zamówienie do użytkownika

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

Ta funkcja jest podstawowym narzędziem przepływu pracy. Przydziela zlecenie pacjenta indywidualnemu użytkownikowi, co oznacza, że ten użytkownik jest teraz odpowiedzialny za zadanie związane z tym zamówieniem (np. raportowanie).

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
PatientOrderUuid	string	Wymagane. UUID zamówienia pacjenta, który wymaga działania.
AssignedUserUuid	string	Wymagane. UUID konkretnego użytkownika, któremu zostanie przypisana odpowiedzialność.

Przypisywanie zlecenia do grupy użytkowników

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

Podobnie jak przypisywanie do jednego użytkownika, funkcja ta przypisuje kolejność pacjenta do całej grupy, umożliwiając zespołowe przepływy pracy, w których każdy członek grupy może obsłużyć zadanie.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
PatientOrderUuid	string	Wymagane. UUID polecenia pacjenta, który ma zostać przypisany do grupy.
AssignedUserGroupUuid	string	Wymagane. UUID grupy użytkowników, do której należy przypisać zlecenie.

Cykl życia zamówienia pacjenta i pobieranie danych

Utwórz zamówienie pacjenta

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

Ta funkcja tworzy nowy porządek pacjenta do planowania i zarządzania badaniami obrazowymi w systemie. Wymagane parametry muszą być dostarczone do pomyślnego utworzenia.

Required Parameters	Data Type	Opis
InstitutionUuid	string	Wymagane. UUID instytucji, w której tworzone jest zamówienie pacjenta.
PatientName	string	Wymagane. Pełne imię i nazwisko pacjenta.
PatientId	string	Wymagane. Niepowtarzalny identyfikator pacjenta, taki jak krajowy identyfikator lub MRN.
PatientBirthdate	string (YYYY-MM-DD)	Wymagane. Data urodzenia pacjenta w formacie ISO.
Modality	string	Wymagane. Typ modalności, taki jak CT, MR, US itp.
OtherPatientId	string	Opcjonalnie. Dodatkowy identyfikator pacjenta, jeśli dotyczy.
PatientSex	string	Opcjonalnie. Płeć pacjenta (np. M, F, O).
StudyDescription	string	Opcjonalnie. Opis zamawianego badania obrazowego.
AccessionNumber	string	Opcjonalnie. Niepowtarzalny numer akcesyjny zamówienia, jeśli dotyczy.
PatientComplaints	string	Opcjonalnie. Tekst opisujący dolegliwości lub objawy pacjenta.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Opcjonalnie. Planowana data rozpoczęcia i godzina procedury.
RequestedProcedureId	string	Opcjonalnie. Identyfikator żądanej procedury.
RequestedProcedureDescription	string	Opcjonalnie. Opis procedury, której dotyczy wniosek.
RequestingPhysician	string	Opcjonalnie. Imię i nazwisko lekarza, który poprosił o badanie.
ReferringPhysiciansName	string	Opcjonalnie. Imię i nazwisko lekarza kierującego, jeśli różni się od wnioskodawcy.
ScheduledEquipmentUuid	string	Opcjonalnie. UUID sprzętu do obrazowania, który ma być używany do zaplanowanej procedury.

Uzyskaj właściwości zamówienia pacjenta

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

Funkcja ta pobiera pełny zestaw właściwości dla pojedynczej, określonej kolejności pacjenta.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
PatientOrderInstitutionUuid	string	Wymagane. UUID instytucji, do której należy zamówienie.
PatientOrderUuid	string	Wymagane. UUID konkretnego polecenia pacjenta do odzyskania.

Szukaj zamówień pacjentów

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

Ta funkcja pobiera listę zamówień pacjentów na podstawie kombinacji filtrów wyszukiwania, takich jak imię i nazwisko pacjenta, identyfikator, modalność oraz daty badania lub urodzenia. Umożliwia zaawansowane funkcje wyszukiwania dla instytucji zarządzających wieloma zamówieniami.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
InstitutionUuidList	List	Lista UUID identyfikujących instytucje do wyszukiwania zamówień pacjentów.
PatientName	string	Opcjonalnie. Filtruj według pełnego imienia i nazwiska pacjenta.
PatientId	string	Opcjonalnie. Filtruj według unikalnego identyfikatora pacjenta.
OtherPatientId	string	Opcjonalnie. Wtórny identyfikator pacjenta, jeśli jest dostępny.
AccessionNumber	string	Opcjonalnie. Filtruj 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)	Opcjonalnie. Data rozpoczęcia zakresu dat badania w celu filtrowania wyników.
StudyDateTo	string (YYYY-MM-DD)	Opcjonalnie. Data zakończenia zakresu dat badania dla wyników filtrowania.
PatientBirthdateFrom	string (YYYY-MM-DD)	Opcjonalnie. Data rozpoczęcia zakresu dat urodzenia pacjenta w celu filtrowania pacjentów według wieku.
PatientBirthdateTo	string (YYYY-MM-DD)	Opcjonalnie. Data zakończenia zakresu dat urodzenia pacjenta w celu filtrowania pacjentów według wieku.

Usuń kolejność pacjenta

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

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

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
PatientOrderInstitutionUuid	string	Wymagane. UUID instytucji, która jest właścicielem zlecenia pacjenta. Zapewnia, że do usunięcia używany jest właściwy kontekst.
PatientOrderUuid	string	Wymagane. UUID konkretnego zlecenia pacjenta, który ma zostać usunięty. To jednoznacznie identyfikuje kolejność 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 z kolejnością pacjenta.

Required Parameters	Data Type	Opis
UserName	string	Nazwa użytkownika (adres e-mail) konta PostDiCom. (od inicjalizacji)
Password	string	Hasło powiązane z kontem PostDicom. (od inicjalizacji)
WebAddress	string	Podstawowy adres URL interfejsu API. (od inicjalizacji)
PatientOrderInstitutionUuid	string	Wymagane. UUID instytucji, w której znajduje się zamówienie.
PatientOrderUuid	string	Wymagane. UUID zamówienia zawierającego obrazy.
PatientSeriesUuid	string	Opcjonalnie. Jeśli zostaną podane, tagi będą odczytywane tylko z tej konkretnej serii.
DicomTagIdList	List	Opcjonalnie. Lista identyfikatorów znaczników DICOM do pobrania.