Dokumentation för DICOMweb-tjänster | PostDICOM

Prerequisites Introduktion & Allmän information

Detta dokument tillhandahåller en omfattande teknisk guide för DICOMweb API-funktioner med exempelmetoder som används via en C#-exempelapplikation. Det inkluderar detaljerade förklaringar av alla tillgängliga funktioner, som täcker både standardiserade DICOMweb-tjänster (såsom QIDO-RS, WADO-RS och STOW-RS) och anpassade DICOMweb API-slutpunkter utvecklade av PostDICOM. Dessa funktioner är utformade för att användas i anrop på serversidan.

För att använda PostDICOMs DICOMweb-tjänster måste du först ha denna funktion aktiverad för ditt konto och inneha giltiga användaruppgifter. Om DICOMweb-åtkomst inte är aktiverat för ditt konto än och du vill integrera din applikation med PostDICOM, vänligen kontakta oss för att begära aktivering.

Användarnamn: Detta är din primära inloggningsuppgift, vanligtvis din e-postadress. Det är unikt för ditt konto och används som användarnamn vid grundläggande autentisering (Basic Authentication).

Lösenord: 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. Vänligen ha nödvändiga säkerhetsmekanismer på din serversida så att detta användarnamn och lösenord skyddas av dig själv.

Du kan hantera ditt lösenord och dina säkerhetsinställningar via din profilssida efter att du har loggat in på ditt PostDICOM-konto

DICOMweb Standardtjänster

Lagra DICOM-instanser (STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Denna funktion samordnar 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/related POST-begäran för varje fil, i enlighet med STOW-RS-standarden.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
DirectoryPath	string	Den fullständiga sökvägen till den lokala katalogen som innehåller de DICOM-filer (.dcm) som ska laddas upp.

Sök efter DICOM-objekt (QIDO-RS)

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

Denna funktion utför en sökning efter DICOM-objekt med hjälp av QIDO-RS-standarden, vilket möjliggör sökningar på studie-, serie- eller instansnivå. Baserat på den angivna sökparametern (såsom patient-ID, studieinstans-UID eller serieinstans-UID), konstruerar den lämplig URL och utför en autentiserad begäran för att hämta matchande resultat från servern.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
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 hjälp av WADO-RS-standarden. Användaren väljer en hämtningsnivå (Studie, Serie eller Instans) och anger motsvarande UID. Funktionen gör sedan en autentiserad begäran och behandlar multipart/related-svaret genom att spara varje DICOM-del som en separat .dcm-fil i en nyskapad lokal katalog.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
StudyInstanceUID	string	Valfritt. En globalt unik identifierare för en DICOM-studie. Används för att hämta alla serier och instanser kopplade till 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.

Hantering av delning

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 patientordrar med externa användare. Länken kan lösenordsskyddas och valfritt tillåta nedladdningar.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-post) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet för PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
PatientOrderInfoList	List	Lista över JSON-strängar, där var och en innehåller en "PatientOrderUuid"-nyckel som identifierar de patientordrar 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 som krävs för att komma åt delningslänken. Lämna tomt för offentlig åtkomst.
Downloadable	bool	Valfritt. Avgör om DICOM-studierna är nedladdningsbara av mottagaren.

Dela patientorder med URL

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

Denna funktion genererar en delbar URL för valda patientordrar med ytterligare alternativ för åtkomstkontroll såsom nedladdningstillstånd och lösenordsskydd.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-post) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet för PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
OrderUuidList	List	Lista över UUID:n som identifierar patientordrar som ska delas.
ExpireDate	string (YYYY-MM-DD)	Datum efter vilket delningslänken blir inaktiv.
SharePassword	string	Valfritt. Lösenord som krävs för att komma åt den delade länken.
UserCanDownloadStudies	bool	Valfritt. Om satt till true, kan mottagaren ladda ner studierna.

Mapp- & Orderhantering

Skapa mapp

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

Denna funktion används för att skapa en ny mapp (en virtuell behållare) inom PostDICOM-kontot för att hjälpa till att organisera patientordrar.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
FolderName	string	Obligatoriskt. Det synliga namnet för 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 mapp

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

Denna funktion hittar befintliga mappar baserat på sökkriterier. Den kan valfritt inkludera listan över patientordrar inom varje hittad mapp.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
ParentFolderUuid	string	Valfritt. Ett mapp-UUID för att begränsa sökningen till dess undermappar.
FolderName	string	Valfritt. Ett fullständigt eller partiellt namn att söka efter.
GetOrdersInFolder	bool	Valfritt. Om `true` kommer svaret att inkludera en lista över patientordrar för varje mapp som hittas.

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. Den möjliggör omfattande åtkomstkontroll genom att ställa in en anpassad rubrik, beskrivning, ett lösenord, ett utgångsdatum och specificera om innehållet kan laddas ner av mottagaren.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
FolderUuid	string	Obligatoriskt. 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 det lämnas tomt kommer länken att vara offentligt tillgänglig.
ShareTitle	string	Valfritt. En anpassad rubrik för den delade mappsidan, synlig för mottagaren.
ShareDescription	string	Valfritt. En beskrivning som visas på den delade mappsidan.
ExpireDate	string (YYYY-MM-DD)	Valfritt. Datumet då delningslänken automatiskt blir inaktiv.
UserCanDownloadStudies	bool	Valfritt. Om `true` kan mottagare ladda ner patientordrarna som finns i mappen.

Lägg till order i mapp

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

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

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
PatientOrderUuid	string	Obligatoriskt. UUID för patientordern som ska placeras i en mapp.
FolderUuidList	List	Obligatoriskt. En lista som innehåller UUID för destinationsmappen.

Arbetsflöde & Tilldelning

Tilldela order till användare

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

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

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
PatientOrderUuid	string	Obligatoriskt. UUID för patientordern som kräver åtgärd.
AssignedUserUuid	string	Obligatoriskt. UUID för den specifika användare som ska tilldelas ansvaret.

Tilldela order till användargrupp

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

Liknande tilldelning till en enskild användare tilldelar denna funktion en patientorder till en hel grupp, vilket möjliggör teambaserade arbetsflöden där vilken gruppmedlem som helst kan hantera uppgiften.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
PatientOrderUuid	string	Obligatoriskt. UUID för patientordern som ska tilldelas gruppen.
AssignedUserGroupUuid	string	Obligatoriskt. UUID för användargruppen som ska tilldelas ordern.

Livscykel för patientorder & 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 bildundersökningar inom systemet. Obligatoriska parametrar måste anges för att skapandet ska lyckas.

Obligatoriska parametrar	Datatyp	Beskrivning
InstitutionUuid	string	Obligatoriskt. UUID för institutionen där patientordern skapas.
PatientName	string	Obligatoriskt. Patientens fullständiga namn.
PatientId	string	Obligatoriskt. Patientens unika identifierare såsom personnummer eller journalnummer (MRN).
PatientBirthdate	string (YYYY-MM-DD)	Obligatoriskt. Patientens födelsedatum i ISO-format.
Modality	string	Obligatoriskt. Modalitetstyp såsom CT, MR, US, 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 bildundersökningen som beställs.
AccessionNumber	string	Valfritt. Unikt accessionsnummer för ordern, om tillämpligt.
PatientComplaints	string	Valfritt. Text som beskriver patientens besvär eller symptom.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Valfritt. Det schemalagda startdatumet och tiden för proceduren.
RequestedProcedureId	string	Valfritt. Identifierare för den begärda proceduren.
RequestedProcedureDescription	string	Valfritt. Beskrivning av den begärda proceduren.
RequestingPhysician	string	Valfritt. Namn på läkaren som beställde undersökningen.
ReferringPhysiciansName	string	Valfritt. Namn på den remitterande läkaren, om annan än beställande.
ScheduledEquipmentUuid	string	Valfritt. UUID för den bildutrustning som ska användas för den schemalagda proceduren.

Hämta egenskaper för patientorder

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

Denna funktion hämtar den fullständiga uppsättningen egenskaper för en enskild, specifik patientorder.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
PatientOrderInstitutionUuid	string	Obligatoriskt. UUID för institutionen som ordern tillhör.
PatientOrderUuid	string	Obligatoriskt. UUID för den specifika patientorder som ska hämtas.

Sök efter patientordrar

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

Denna funktion hämtar en lista över patientordrar baserat på en kombination av sökfilter såsom patientnamn, ID, modalitet samt studie- eller födelsedatum. Den möjliggör avancerad sökfunktionalitet för institutioner som hanterar flera ordrar.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
InstitutionUuidList	List	Lista över UUID:n som identifierar institutionerna där patientordrar ska sökas.
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 accessionsnummer som tilldelats studien.
ModalityList	List	Lista över modaliteter (t.ex. CT, MR, US) för att filtrera sökresultaten.
StudyDateFrom	string (YYYY-MM-DD)	Valfritt. Startdatum för studieintervall vid filtrering av resultat.
StudyDateTo	string (YYYY-MM-DD)	Valfritt. Slutdatum för studieintervall vid 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)

Denna funktion tar permanent bort en patientorder från systemet. Den kräver både institutions-UUID och det specifika UUID:t för patientordern för att säkerställa noggrannhet och förhindra oavsiktlig radering.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
PatientOrderInstitutionUuid	string	Obligatoriskt. UUID för institutionen som äger patientordern. Säkerställer att rätt kontext används för radering.
PatientOrderUuid	string	Obligatoriskt. UUID för den specifika patientorder som ska tas bort. Detta identifierar ordern unikt i systemet.

Hämta innehåll för DICOM-tagg

Hämta innehåll för DICOM-tagg

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

Denna funktion hämtar värdena för specifika DICOM-taggar från bilderna kopplade till en patientorder.

Obligatoriska parametrar	Datatyp	Beskrivning
UserName	string	Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initiering)
Password	string	Lösenordet kopplat till PostDICOM-kontot. (från initiering)
WebAddress	string	Bas-URL för API:et. (från initiering)
PatientOrderInstitutionUuid	string	Obligatoriskt. UUID för institutionen där ordern finns.
PatientOrderUuid	string	Obligatoriskt. UUID för ordern som innehåller bilderna.
PatientSeriesUuid	string	Valfritt. Om angivet, kommer taggar endast att läsas från denna specifika serie.
DicomTagIdList	List	Valfritt. En lista över DICOM-tagg-ID:n att hämta.