Introduktion & Allmän information
Detta dokument utgör en omfattande teknisk guide för DICOMweb API-funktionerna med exempelmetoder som används genom en C#-exempelapplikation. Den innehåller detaljerade förklaringar av alla tillgängliga funktioner, och täcker både standard DICOMweb-tjänster (som QIDO-RS, WADO-RS och STOW-RS) och anpassade DICOMweb API-ändpunkter 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 ha giltiga användaruppgifter. Om DICOMweb-åtkomst ännu inte är aktiverat för ditt konto 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 Basic Authentication (grundläggande autentisering).
Lösenord: Detta är lösenordet kopplat till ditt PostDICOM-konto. Det används tillsammans med ditt användarnamn vid grundläggande autentisering. För optimal säkerhet rekommenderar vi starkt att du väljer ett starkt lösenord. Se till att ha nödvändiga säkerhetsmekanismer i dina anrop på serversidan så att detta användarnamn och lösenord skyddas av dig.
Du kan hantera ditt lösenord och dina säkerhetsinställningar via din kontoprofilsida efter att du har loggat in på ditt PostDICOM-konto.
Lagra DICOM-instanser (STOW-RS)
Denna funktion hanterar 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 initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| DirectoryPath | string | Den fullständiga sökvägen till den lokala katalogen som innehåller DICOM-filerna (.dcm) som ska laddas upp. |
Sök efter DICOM-objekt (QIDO-RS)
Denna funktion utför en sökning efter DICOM-objekt med hjälp av QIDO-RS-standarden, vilket möjliggör sökningar på undersöknings- (Study), serie- (Series) eller instansnivå (Instance). Baserat på den angivna sökparametern (såsom Patient ID, Study Instance UID eller Series Instance UID) konstruerar den rätt 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 initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| PatientID | string | Valfritt. Används för att identifiera patienten och söka efter relaterade undersökningar. |
| StudyInstanceUID | string | Valfritt. Används för att söka efter en specifik undersökning eller alla serier inom den undersökningen. |
| SeriesInstanceUID | string | Valfritt. Används för att söka efter alla bildinstanser inom en specifik serie. |
Hämta DICOM-instanser (WADO-RS)
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å (undersökning, serie eller instans) och anger motsvarande UID. Funktionen gör sedan en autentiserad begäran och behandlar multipart/related-svaret och sparar varje DICOM-del som en separat .dcm-fil till en nyskapad lokal katalog.
| Obligatoriska parametrar | Datatyp | Beskrivning |
| UserName | string | Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| StudyInstanceUID | string | Valfritt. En globalt unik identifierare för en DICOM-undersökning. Används för att hämta alla serier och instanser associerade med den undersökningen. |
| SeriesInstanceUID | string | Valfritt. En globalt unik identifierare för en serie inom en DICOM-undersökning. 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. |
Skapa delningslänk
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 initialiseringen) |
| Password | string | Lösenordet för PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| PatientOrderInfoList | List |
En lista med JSON-strängar, som var och en innehåller en nyckel "PatientOrderUuid", vilken 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. Bestämmer om DICOM-undersökningarna kan laddas ner av mottagaren. |
Dela patientundersökning med URL
Denna funktion genererar en delningsbar URL för valda patientordrar med ytterligare alternativ för åtkomstkontroll, såsom tillåtelse för nedladdning och lösenordsskydd.
| Obligatoriska parametrar | Datatyp | Beskrivning |
| UserName | string | Användarnamnet (e-post) för PostDICOM-kontot. (från initialiseringen) |
| Password | string | Lösenordet för PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| OrderUuidList | List |
En lista med UUID som identifierar de 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 sant (true), kan mottagaren ladda ner undersökningarna. |
Skapa mapp
Denna funktion används för att skapa en ny mapp (en virtuell behållare) i 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 initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| FolderName | string | Obligatoriskt. Det synliga namnet på den nya mappen. |
| FolderDescription | string | Valfritt. En textbeskrivning av mappen. |
| ParentFolderUuid | string | Valfritt. UUID för en befintlig mapp, om den nya mappen ska skapas i den. |
Sök mapp
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 initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| ParentFolderUuid | string | Valfritt. Ett mapp-UUID för att begränsa sökningen till dess underordnade mappar. |
| FolderName | string | Valfritt. Ett fullständigt namn eller ett delnamn att söka efter. |
| GetOrdersInFolder | bool | Valfritt. Om satt till `true`, kommer svaret att inkludera en lista med patientordrar för varje mapp som hittas. |
Dela mapp med URL
Denna funktion genererar en säker, delningsbar URL för en hel mapp och dess innehåll. Den möjliggör omfattande åtkomstkontroll genom att låta dig ange en anpassad titel, en beskrivning, ett lösenord, ett utgångsdatum samt 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 initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| 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 blir länken offentligt tillgänglig. |
| ShareTitle | string | Valfritt. En anpassad titel för sidan med den delade mappen, synlig för mottagaren. |
| ShareDescription | string | Valfritt. En beskrivning som visas på sidan med den delade mappen. |
| ExpireDate | string (YYYY-MM-DD) | Valfritt. Datumet då delningslänken automatiskt blir inaktiv. |
| UserCanDownloadStudies | bool | Valfritt. Om satt till `true`, kan mottagaren ladda ner patientordrarna i mappen. |
Lägg till patientorder i mapp
Denna funktion skapar en koppling mellan en befintlig patientorder och en befintlig mapp. Detta är ett organisatoriskt verktyg; det flyttar eller kopierar inte data.
| Obligatoriska parametrar | Datatyp | Beskrivning |
| UserName | string | Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| PatientOrderUuid | string | Obligatoriskt. UUID för patientordern som ska placeras i en mapp. |
| FolderUuidList | List |
Obligatoriskt. En lista som innehåller UUID för målmappen. |
Tilldela patientorder till användare
Denna funktion är ett centralt verktyg för arbetsflöden. 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 initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| PatientOrderUuid | string | Obligatoriskt. UUID för patientordern som kräver åtgärd. |
| AssignedUserUuid | string | Obligatoriskt. UUID för den specifika användare som kommer att tilldelas ansvaret. |
Tilldela patientorder till användargrupp
I likhet med 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 initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| PatientOrderUuid | string | Obligatoriskt. UUID för patientordern som ska tilldelas gruppen. |
| AssignedUserGroupUuid | string | Obligatoriskt. UUID för den användargrupp som ska tilldelas patientordern. |
Skapa patientorder
Denna funktion skapar en ny patientorder för att boka in och hantera bilddiagnostiska undersökningar i systemet. Obligatoriska parametrar måste tillhandahållas för att skapandet ska lyckas.
| Obligatoriska parametrar | Datatyp | Beskrivning |
| InstitutionUuid | string | Obligatoriskt. UUID för den institution där patientordern skapas. |
| PatientName | string | Obligatoriskt. Patientens fullständiga namn. |
| PatientId | string | Obligatoriskt. Patientens unika identifierare, såsom ett nationellt ID-nummer eller MRN. |
| PatientBirthdate | string (YYYY-MM-DD) | Obligatoriskt. Patientens födelsedatum i ISO-format. |
| Modality | string | Obligatoriskt. Modalitetstyp, såsom CT, MR, US osv. |
| 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 den beställda bildundersökningen. |
| AccessionNumber | string | Valfritt. Unikt accessionsnummer (Accession Number) för undersökningen, om tillämpligt. |
| PatientComplaints | string | Valfritt. Text som beskriver patientens besvär eller symtom. |
| OrderScheduledDatetime | string (YYYY-MM-DD HH:MM) | Valfritt. Det inbokade 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. Namnet på den läkare som beställt undersökningen. |
| ReferringPhysiciansName | string | Valfritt. Namnet på den remitterande läkaren, om annorlunda än beställaren. |
| ScheduledEquipmentUuid | string | Valfritt. UUID för den bildutrustning som ska användas för den inbokade proceduren. |
Hämta egenskaper för patientorder
Denna funktion hämtar hela uppsättningen av egenskaper för en specifik patientorder.
| Obligatoriska parametrar | Datatyp | Beskrivning |
| UserName | string | Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| PatientOrderInstitutionUuid | string | Obligatoriskt. UUID för den institution som patientordern tillhör. |
| PatientOrderUuid | string | Obligatoriskt. UUID för den specifika patientorder som ska hämtas. |
Sök efter patientordrar
Denna funktion hämtar en lista med patientordrar baserat på en kombination av sökfilter som patientnamn, ID, modalitet och undersöknings- eller födelsedatum. Det möjliggör avancerade sökfunktioner för institutioner som hanterar många undersökningar.
| Obligatoriska parametrar | Datatyp | Beskrivning |
| UserName | string | Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| InstitutionUuidList | List |
Lista över UUID som identifierar de institutioner du vill söka i efter patientordrar. |
| PatientName | string | Valfritt. Filtrera på patientens fullständiga namn. |
| PatientId | string | Valfritt. Filtrera på patientens unika identifierare. |
| OtherPatientId | string | Valfritt. Sekundär identifierare för patienten, om tillgänglig. |
| AccessionNumber | string | Valfritt. Filtrera på accessionsnummer tilldelat till undersökningen. |
| 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 datumintervall avseende undersökningar för att filtrera resultat. |
| StudyDateTo | string (YYYY-MM-DD) | Valfritt. Slutdatum för datumintervall avseende undersökningar för att filtrera resultat. |
| PatientBirthdateFrom | string (YYYY-MM-DD) | Valfritt. Startdatum för datumintervall avseende patientens födelsedatum för att filtrera patienter efter ålder. |
| PatientBirthdateTo | string (YYYY-MM-DD) | Valfritt. Slutdatum för datumintervall avseende patientens födelsedatum för att filtrera patienter efter ålder. |
Radera patientorder
Denna funktion raderar en patientorder permanent från systemet. Den kräver både institutionens UUID och det specifika patientorder-UUID:et för att säkerställa precision och förhindra oavsiktlig radering.
| Obligatoriska parametrar | Datatyp | Beskrivning |
| UserName | string | Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| PatientOrderInstitutionUuid | string | Obligatoriskt. UUID för den institution som äger patientordern. Säkerställer att rätt kontext används vid radering. |
| PatientOrderUuid | string | Obligatoriskt. UUID för den specifika patientorder som ska raderas. Detta identifierar ordern unikt i systemet. |
Hämta innehåll för DICOM-taggHämta innehåll för DICOM-tagg
Denna funktion hämtar värdena för specifika DICOM-taggar från de bilder som är associerade med en patientorder.
| Obligatoriska parametrar | Datatyp | Beskrivning |
| UserName | string | Användarnamnet (e-postadressen) för PostDICOM-kontot. (från initialiseringen) |
| Password | string | Lösenordet kopplat till PostDICOM-kontot. (från initialiseringen) |
| WebAddress | string | Bas-URL för API:et. (från initialiseringen) |
| PatientOrderInstitutionUuid | string | Obligatoriskt. UUID för den institution där undersökningen 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 med DICOM-tagg-ID:n att hämta. |