Dokumentation för DicomWeb Service | PostDiCOM

Prerequisites Introduktion & Allmän information

Detta dokument ger en omfattande teknisk guide för DICOMweb API funktioner med exempelmetoder som används genom ett C# exempelprogram. Den innehåller detaljerade förklaringar av alla tillgängliga funktioner, som täcker båda standard DICOMweb services (Såsom QIDO-RS, WADO-RS, and STOW-RS) och custom DICOMweb API endpoints Utvecklad av PostDicom. Dessa funktioner är utformade för att användas i samtal på serversidan.

För att kunna använda PostDicoms DiComWeb-tjänster måste du först ha den här funktionen aktiverad för ditt konto och ha giltiga användaruppgifter. Om DiComWeb-åtkomst ännu inte är aktiverad för ditt konto och du vill integrera din applikation med PostDiCom, vänligen kontakta oss för att begära aktivering.

User Name: Detta är din primära inloggningsuppgifter, vanligtvis din e-postadress. Det är unikt för ditt konto och används som användarnamn i Grundläggande autentisering.

Password: Detta är lösenordet som är kopplat till ditt PostDicom-konto. Det används tillsammans med ditt användarnamn under grundläggande autentisering. För optimal säkerhet rekommenderar vi starkt att du väljer ett starkt lösenord. Ha nödvändiga säkerhetsmekanismer på ditt serversidanrop så att ditt användarnamn och lösenord skyddas av dig själv.

Du kan hantera ditt lösenord och säkerhetsinställningar via din kontoprofilsida efter att du loggat in på ditt PostDicom-konto

DicomWeb Standardtjänster

Lagra DICOM-instanser ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Den här funktionen orkestrerar uppladdningen av alla.dcm-filer från en angiven lokal mapp till DiComWeb-servern. Den identifierar först alla relevanta filer och använder sedan hjälpmetoder för att konstruera och skicka en autentiserad multipart/relaterad POST-begäran för varje fil, som följer STOW-RS-standarden.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
DirectoryPath	string	Den fullständiga sökvägen till den lokala katalogen som innehåller DICOM-filer (.dcm) som ska laddas upp.

Fråga efter DICOM-objekt ( QIDO-RS)

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

Den här funktionen utför en fråga för DICOM-objekt med QIDO-RS-standarden, vilket möjliggör sökningar på studie-, serie- eller instansnivå. Baserat på den angivna sökparametern (t.ex. Patient-ID, UID för studieinstans eller serieinstans UID) konstruerar den lämplig URL och kör en autentiserad begäran om att hämta matchande resultat från servern.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
PatientID	string	Valfritt. Används för att identifiera patienten och söka efter relaterade studier.
StudyInstanceUID	string	Valfritt. Används för att söka efter en specifik studie eller alla serier inom den studien.
SeriesInstanceUID	string	Valfritt. Används för att söka efter alla bildinstanser inom en specifik serie.

Hämta DICOM-instanser ( WADO-RS)

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

Denna funktion tillhandahåller en interaktiv meny för att hämta DICOM-objekt med WADO-RS-standarden. Användaren väljer en hämtningsnivå (studie, serie eller instans) och tillhandahåller motsvarande UID. Funktionen gör sedan en autentiserad begäran och behandlar multiparts-/relaterade svar och sparar varje DICOM-del som en separat DCM-fil i en nyskapad lokal katalog.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
StudyInstanceUID	string	Valfritt. En globalt unik identifierare för en DICOM-studie. Används för att hämta alla serier och instanser associerade med den studien.
SeriesInstanceUID	string	Valfritt. En globalt unik identifierare för en serie inom en DICOM-studie. Används för att hämta alla bilder under den serien.
SOPInstanceUID	string	Valfritt. En unik identifierare för en enskild DICOM-bildinstans. Används för att hämta en specifik bild med WADO-RS.

Delningshantering

Skapa delningslänk

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

Denna funktion genererar en säker webblänk för att dela en eller flera patientbeställningar med externa användare. Länken kan vara lösenordsskyddad och eventuellt tillåta nedladdningar.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-post) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet för PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
PatientOrderInfoList	List	Lista över JSON-strängar, var och en innehåller en ”PatientOrderUUID” -nyckel, som identifierar patientbeställningarna som ska delas.
ExpireDate	string (YYYY-MM-DD)	Utgångsdatum för delningslänken. Efter detta datum kommer länken att inaktiveras.
SharePassword	string	Valfritt. Lösenord krävs för att komma åt delningslänken. Lämna tomt för allmänhetens tillgång.
Downloadable	bool	Valfritt. Avgör om DICOM-studierna kan hämtas av mottagaren.

Dela patientorder med URL

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

Denna funktion genererar en delbar URL för utvalda patientbeställningar med ytterligare åtkomstkontrollalternativ som nedladdningstillstånd och lösenordsskydd.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-post) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet för PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
OrderUuidList	List	Lista över UUID som identifierar patientbeställningar som ska delas.
ExpireDate	string (YYYY-MM-DD)	Datum efter vilket delningslänken blir inaktiv.
SharePassword	string	Valfritt. Lösenord krävs för att komma åt den delade länken.
UserCanDownloadStudies	bool	Valfritt. Om värdet är sant kan mottagaren ladda ner studierna.

Mapp- och orderhantering

Skapa mapp

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

Den här funktionen används för att skapa en ny mapp (en virtuell behållare) inom PostDicom-kontot för att hjälpa till att organisera patientbeställningar.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
FolderName	string	Obligatorisk. Det synliga namnet på den nya mappen.
FolderDescription	string	Valfritt. En textbeskrivning för mappen.
ParentFolderUuid	string	Valfritt. UUID för en befintlig mapp för att skapa den nya mappen inuti den.

Sök i mapp

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

Den här funktionen hittar befintliga mappar baserat på sökkriterier. Det kan valfritt inkludera listan över patientbeställningar i varje hittad mapp.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
ParentFolderUuid	string	Valfritt. En mapp UUID för att begränsa sökningen till dess underordnade.
FolderName	string	Valfritt. Ett fullständigt eller delvis namn att söka efter.
GetOrdersInFolder	bool	Valfritt. Om ”sant” kommer svaret att innehålla en lista över patientbeställningar för varje mapp som hittats.

Dela mapp med URL

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

Denna funktion genererar en säker, delbar URL för en hel mapp och dess innehåll. Det möjliggör omfattande åtkomstkontroll genom att ställa in en anpassad titel, beskrivning, ett lösenord, ett utgångsdatum och ange om innehållet kan laddas ner av mottagaren.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
FolderUuid	string	Obligatorisk. Den unika identifieraren (UUID) för mappen som ska delas.
SharePassword	string	Valfritt. Ett lösenord för att skydda den delade länken. Om den lämnas tom kommer länken att vara tillgänglig för allmänheten.
ShareTitle	string	Valfritt. En anpassad titel för den delade mappsidan, synlig för mottagaren.
ShareDescription	string	Valfritt. En beskrivning som visas på sidan med delad mapp.
ExpireDate	string (YYYY-MM-DD)	Valfritt. Det datum då delningslänken automatiskt blir inaktiv.
UserCanDownloadStudies	bool	Valfritt. Om ”sant” kan mottagarna ladda ner patientbeställningarna i mappen.

Lägg till order i mapp

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

Den här funktionen skapar en koppling mellan en befintlig patientorder och en befintlig mapp. Detta är ett organisationsverktyg; det flyttar inte eller kopierar data.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
PatientOrderUuid	string	Obligatorisk. UUID för patientordern som ska placeras i en mapp.
FolderUuidList	List	Obligatorisk. En lista som innehåller målmappens UUID.

Arbetsflöde och tilldelning

Tilldela order till användare

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

Denna funktion är ett centralt arbetsflödesverktyg. Det tilldelar en patientorder till en enskild användare, vilket innebär att den här användaren nu är ansvarig för en uppgift relaterad till den beställningen (t.ex. rapportering).

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
PatientOrderUuid	string	Obligatorisk. UUID för patientordern som kräver åtgärd.
AssignedUserUuid	string	Obligatorisk. UUID för den specifika användaren som kommer att tilldelas ansvar.

Tilldela order till användargrupp

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

I likhet med att tilldela en enda användare tilldelar den här funktionen en patientorder till en hel grupp, vilket möjliggör teambaserade arbetsflöden där alla gruppmedlemmar kan hantera uppgiften.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
PatientOrderUuid	string	Obligatorisk. UUID för patientordningen som ska tilldelas gruppen.
AssignedUserGroupUuid	string	Obligatorisk. UUID för den användargrupp som ska tilldelas ordern.

Patientbeställningens livscykel och datahämtning

Skapa patientorder

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

Denna funktion skapar en ny patientorder för att schemalägga och hantera bildstudier inom systemet. Obligatoriska parametrar måste tillhandahållas för framgångsrik skapande.

Required Parameters	Data Type	Beskrivning
InstitutionUuid	string	Obligatorisk. UUID för den institution där patientordern skapas.
PatientName	string	Obligatorisk. Patientens fullständiga namn.
PatientId	string	Obligatorisk. Patientens unika identifierare såsom nationellt ID eller MRN.
PatientBirthdate	string (YYYY-MM-DD)	Obligatorisk. Patientens födelsedatum i ISO-format.
Modality	string	Obligatorisk. Modalitetstyp som CT, MR, USA, etc.
OtherPatientId	string	Valfritt. En ytterligare identifierare för patienten, om tillämpligt.
PatientSex	string	Valfritt. Patientens kön (t.ex. M, F, O).
StudyDescription	string	Valfritt. Beskrivning av bildstudien som beställs.
AccessionNumber	string	Valfritt. Unikt anslutningsnummer för beställningen, om tillämpligt.
PatientComplaints	string	Valfritt. Text som beskriver patientens klagomål eller symtom.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Valfritt. Det schemalagda startdatumet och tiden för förfarandet.
RequestedProcedureId	string	Valfritt. Identifikationsnummer för det begärda förfarandet.
RequestedProcedureDescription	string	Valfritt. Beskrivning av det begärda förfarandet.
RequestingPhysician	string	Valfritt. Namn på den läkare som begärde studien.
ReferringPhysiciansName	string	Valfritt. Namn på den hänvisande läkaren, om det skiljer sig från begäran.
ScheduledEquipmentUuid	string	Valfritt. UUID för den bildutrustning som ska användas för det schemalagda förfarandet.

Hämta egenskaper för patientorder

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

Denna funktion hämtar hela uppsättningen egenskaper för en enda, specifik patientordning.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
PatientOrderInstitutionUuid	string	Obligatorisk. UUID för den institution som ordern tillhör.
PatientOrderUuid	string	Obligatorisk. UUID för den specifika patientordern som ska hämtas.

Sök efter patientbeställningar

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

Denna funktion hämtar en lista över patientbeställningar baserat på en kombination av sökfilter som patientnamn, ID, modalitet, och studie- eller födelsedatum. Det möjliggör avancerad sökfunktion för institutioner som hanterar flera beställningar.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
InstitutionUuidList	List	Lista över UUID som identifierar institutionerna för att söka efter patientbeställningar.
PatientName	string	Valfritt. Filtrera efter patientens fullständiga namn.
PatientId	string	Valfritt. Filtrera efter patientens unika identifierare.
OtherPatientId	string	Valfritt. Sekundär identifierare för patienten, om tillgänglig.
AccessionNumber	string	Valfritt. Filtrera efter anslutningsnummer som tilldelats studien.
ModalityList	List	Lista över modaliteter (t.ex. CT, MR, USA) för att filtrera sökresultaten.
StudyDateFrom	string (YYYY-MM-DD)	Valfritt. Startdatum för studiens datumintervall för filtrering av resultat.
StudyDateTo	string (YYYY-MM-DD)	Valfritt. Slutdatum för studiens datumintervall för filtrering av resultat.
PatientBirthdateFrom	string (YYYY-MM-DD)	Valfritt. Startdatum för patientens födelsedatumintervall för att filtrera patienter efter ålder.
PatientBirthdateTo	string (YYYY-MM-DD)	Valfritt. Slutdatum för patientens födelsedatumintervall för att filtrera patienter efter ålder.

Ta bort patientorder

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

Den här funktionen raderar permanent en patientorder från systemet. Det kräver både institutionens UUID och den specifika patientbeställningen UUID för att säkerställa noggrannhet och förhindra oavsiktlig radering.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
PatientOrderInstitutionUuid	string	Obligatorisk. UUID för den institution som äger patientordern. Säkerställer att rätt sammanhang används för borttagning.
PatientOrderUuid	string	Obligatorisk. UUID för den specifika patientorder som ska raderas. Detta identifierar unikt ordningen i systemet.

Skaffa Dicom-tagginnehåll

Skaffa DICOM-tagginnehåll

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

Den här funktionen hämtar värdena för specifika DICOM-taggar från de bilder som är associerade med en patientorder.

Required Parameters	Data Type	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDiCom-kontot. (från initialisering)
Password	string	Lösenordet som är kopplat till PostDicom-kontot. (från initialisering)
WebAddress	string	API:s basadress. (från initialisering)
PatientOrderInstitutionUuid	string	Obligatorisk. UUID för den institution där ordern är belägen.
PatientOrderUuid	string	Obligatorisk. UUID för ordern som innehåller bilderna.
PatientSeriesUuid	string	Valfritt. Om det tillhandahålls kommer taggar endast att läsas från denna specifika serie.
DicomTagIdList	List	Valfritt. En lista över DICOM-tagg-ID:n som ska hämtas.