Dokumentation af DICOMweb-tjeneste | PostDICOM

Forudsætninger Introduktion og generel information

Dette dokument giver en omfattende teknisk vejledning til **DICOMweb API**-funktionerne med eksempelmetoder, der anvendes via en C#-eksempelapplikation. Det inkluderer detaljerede forklaringer af alle tilgængelige funktioner, der dækker både **standard DICOMweb-tjenester** (såsom QIDO-RS, WADO-RS og STOW-RS) og **tilpassede DICOMweb API-slutpunkter** udviklet af PostDICOM. Disse funktioner er designet til at blive brugt i opkald på serversiden.

For at bruge PostDICOMs DICOMweb-tjenester skal du først have denne funktion aktiveret på din konto og have gyldige brugeroplysninger. Hvis DICOMweb-adgang endnu ikke er aktiveret for din konto, og du ønsker at integrere din applikation med PostDICOM, bedes du kontakte os for at anmode om aktivering.

Brugernavn: Dette er dine primære login-oplysninger, normalt din e-mailadresse. Det er unikt for din konto og bruges som brugernavn i Basic Authentication.

Adgangskode: Dette er adgangskoden knyttet til din PostDICOM-konto. Den bruges sammen med dit brugernavn under Basic Authentication. For optimal sikkerhed anbefaler vi kraftigt at vælge en stærk adgangskode. Sørg for at have de nødvendige sikkerhedsmekanismer i dit serverkald, så dette brugernavn og denne adgangskode er beskyttet af dig selv.

Du kan administrere din adgangskode og dine sikkerhedsindstillinger via din kontoprofilside, efter du er logget ind på din PostDICOM-konto.

DICOMweb standardtjenester

Gem DICOM-instanser (STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Denne funktion orkestrerer upload af alle .dcm-filer fra en specificeret lokal mappe til DICOMweb-serveren. Den identificerer først alle relevante filer og bruger derefter hjælpemetoder til at konstruere og sende en godkendt multipart/related POST-anmodning for hver fil under overholdelse af STOW-RS-standarden.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
DirectoryPath	string	Den fulde sti til den lokale mappe, der indeholder DICOM-filerne (.dcm), som skal uploades.

Forespørgsel efter DICOM-objekter (QIDO-RS)

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

Denne funktion udfører en forespørgsel efter DICOM-objekter ved hjælp af QIDO-RS-standarden, hvilket muliggør søgninger på undersøgelses-, serie- eller instansniveau. Baseret på den angivne søgeparameter (såsom patient-ID, Study Instance UID eller Series Instance UID) konstruerer den den relevante URL og udfører en godkendt anmodning for at hente matchende resultater fra serveren.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
PatientID	string	Valgfri. Bruges til at identificere patienten og søge efter relaterede undersøgelser.
StudyInstanceUID	string	Valgfri. Bruges til at søge efter en bestemt undersøgelse eller alle serier i den undersøgelse.
SeriesInstanceUID	string	Valgfri. Bruges til at søge efter alle billedinstanser i en bestemt serie.

Hent DICOM-instanser (WADO-RS)

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

Denne funktion giver en interaktiv menu til at hente DICOM-objekter ved hjælp af WADO-RS-standarden. Brugeren vælger et hentningsniveau (Undersøgelse, Serie eller Instans) og angiver den tilsvarende UID. Funktionen foretager derefter en godkendt anmodning og behandler multipart/related-svaret, hvor hver DICOM-del gemmes som en separat .dcm-fil i en nyoprettet lokal mappe.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
StudyInstanceUID	string	Valgfri. En globalt unik identifikator for en DICOM-undersøgelse. Bruges til at hente alle serier og instanser tilknyttet den undersøgelse.
SeriesInstanceUID	string	Valgfri. En globalt unik identifikator for en serie i en DICOM-undersøgelse. Bruges til at hente alle billeder under den serie.
SOPInstanceUID	string	Valgfri. En unik identifikator for en individuel DICOM-billedinstans. Bruges til at hente et specifikt billede ved hjælp af WADO-RS.

Håndtering af deling

Opret delelink

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

Denne funktion genererer et sikkert weblink til at dele en eller flere patientordrer med eksterne brugere. Linket kan adgangskodebeskyttes og valgfrit tillade downloads.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mail) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
PatientOrderInfoList	List	Liste over JSON-strenge, der hver indeholder en "PatientOrderUuid"-nøgle, som identificerer de patientordrer, der skal deles.
ExpireDate	string (YYYY-MM-DD)	Udløbsdato for delelinket. Efter denne dato vil linket blive deaktiveret.
SharePassword	string	Valgfri. Adgangskode krævet for at få adgang til delelinket. Lad stå tom for offentlig adgang.
Downloadable	bool	Valgfri. Bestemmer om DICOM-undersøgelserne kan downloades af modtageren.

Del patientordre med URL

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

Denne funktion genererer en delbar URL til udvalgte patientordrer med yderligere adgangskontrolmuligheder såsom downloadtilladelse og adgangskodebeskyttelse.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mail) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
OrderUuidList	List	Liste over UUID'er, der identificerer patientordrer, som skal deles.
ExpireDate	string (YYYY-MM-DD)	Dato, hvorefter delelinket bliver inaktivt.
SharePassword	string	Valgfri. Adgangskode krævet for at få adgang til det delte link.
UserCanDownloadStudies	bool	Valgfri. Hvis sat til true, kan modtageren downloade undersøgelserne.

Mappe- og ordrehåndtering

Opret mappe

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

Denne funktion bruges til at oprette en ny mappe (en virtuel beholder) i PostDICOM-kontoen for at hjælpe med at organisere patientordrer.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
FolderName	string	Påkrævet. Det synlige navn på den nye mappe.
FolderDescription	string	Valgfri. En tekstbeskrivelse af mappen.
ParentFolderUuid	string	Valgfri. UUID på en eksisterende mappe for at oprette den nye mappe i den.

Søg i mappe

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

Denne funktion finder eksisterende mapper baseret på søgekriterier. Den kan valgfrit inkludere listen over patientordrer i hver fundet mappe.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
ParentFolderUuid	string	Valgfri. En mappe-UUID for at begrænse søgningen til dens undermapper.
FolderName	string	Valgfri. Et helt eller delvist navn at søge efter.
GetOrdersInFolder	bool	Valgfri. Hvis `true`, vil svaret inkludere en liste over patientordrer for hver mappe, der findes.

Del mappe med URL

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

Denne funktion genererer en sikker, delbar URL til en hel mappe og dens indhold. Det giver mulighed for omfattende adgangskontrol ved at indstille en tilpasset titel, beskrivelse, adgangskode, udløbsdato og specificere, om indholdet kan downloades af modtageren.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
FolderUuid	string	Påkrævet. Den unikke identifikator (UUID) for mappen, der skal deles.
SharePassword	string	Valgfri. En adgangskode til at beskytte det delte link. Hvis tomt, vil linket være offentligt tilgængeligt.
ShareTitle	string	Valgfri. En tilpasset titel til den delte mappeside, synlig for modtageren.
ShareDescription	string	Valgfri. En beskrivelse, der vises på den delte mappeside.
ExpireDate	string (YYYY-MM-DD)	Valgfri. Datoen, hvor delelinket automatisk bliver inaktivt.
UserCanDownloadStudies	bool	Valgfri. Hvis `true`, kan modtagere downloade patientordrerne i mappen.

Tilføj ordre til mappe

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

Denne funktion opretter en tilknytning mellem en eksisterende patientordre og en eksisterende mappe. Dette er et organisatorisk værktøj; det flytter eller kopierer ikke data.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
PatientOrderUuid	string	Påkrævet. UUID for den patientordre, der skal placeres i en mappe.
FolderUuidList	List	Påkrævet. En liste, der indeholder destinationsmappens UUID.

Workflow og tildeling

Tildel ordre til bruger

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

Denne funktion er et centralt workflow-værktøj. Det tildeler en patientordre til en individuel bruger, hvilket angiver, at denne bruger nu er ansvarlig for en opgave relateret til den ordre (f.eks. rapportering).

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
PatientOrderUuid	string	Påkrævet. UUID for den patientordre, der kræver handling.
AssignedUserUuid	string	Påkrævet. UUID for den specifikke bruger, der vil blive tildelt ansvar.

Tildel ordre til brugergruppe

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

Svarende til tildeling til en enkelt bruger tildeler denne funktion en patientordre til en hel gruppe, hvilket muliggør teambaserede arbejdsgange, hvor ethvert gruppemedlem kan håndtere opgaven.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
PatientOrderUuid	string	Påkrævet. UUID for den patientordre, der skal tildeles gruppen.
AssignedUserGroupUuid	string	Påkrævet. UUID for den brugergruppe, der skal tildeles ordren.

Livscyklus for patientordrer og datahentning

Opret patientordre

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

Denne funktion opretter en ny patientordre for at planlægge og administrere billeddiagnostiske undersøgelser i systemet. Påkrævede parametre skal angives for vellykket oprettelse.

Påkrævede parametre	Datatype	Beskrivelse
InstitutionUuid	string	Påkrævet. UUID for institutionen, hvor patientordren bliver oprettet.
PatientName	string	Påkrævet. Patientens fulde navn.
PatientId	string	Påkrævet. Patientens unikke identifikator såsom et CPR-nummer eller MRN.
PatientBirthdate	string (YYYY-MM-DD)	Påkrævet. Patientens fødselsdato i ISO-format.
Modality	string	Påkrævet. Modalitetstype såsom CT, MR, US osv.
OtherPatientId	string	Valgfri. En yderligere identifikator for patienten, hvis relevant.
PatientSex	string	Valgfri. Patientens køn (f.eks. M, F, O).
StudyDescription	string	Valgfri. Beskrivelse af den bestilte billeddiagnostiske undersøgelse.
AccessionNumber	string	Valgfri. Unikt accession-nummer for ordren, hvis relevant.
PatientComplaints	string	Valgfri. Tekst, der beskriver patientens klager eller symptomer.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Valgfri. Den planlagte startdato og -tid for proceduren.
RequestedProcedureId	string	Valgfri. Identifikator for den anmodede procedure.
RequestedProcedureDescription	string	Valgfri. Beskrivelse af den anmodede procedure.
RequestingPhysician	string	Valgfri. Navnet på den læge, der anmodede om undersøgelsen.
ReferringPhysiciansName	string	Valgfri. Navnet på den henvisende læge, hvis forskellig fra den anmodende.
ScheduledEquipmentUuid	string	Valgfri. UUID på det billedbehandlingsudstyr, der skal bruges til den planlagte procedure.

Hent egenskaber for patientordre

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

Denne funktion henter det komplette sæt af egenskaber for en enkelt, specifik patientordre.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrævet. UUID for institutionen, som ordren tilhører.
PatientOrderUuid	string	Påkrævet. UUID for den specifikke patientordre, der skal hentes.

Søg efter patientordrer

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

Denne funktion henter en liste over patientordrer baseret på en kombination af søgefiltre såsom patientnavn, ID, modalitet og undersøgelses- eller fødselsdatoer. Det muliggør avanceret søgefunktionalitet for institutioner, der administrerer flere ordrer.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
InstitutionUuidList	List	Liste over UUID'er, der identificerer de institutioner, hvor der skal søges efter patientordrer.
PatientName	string	Valgfri. Filtrer efter patientens fulde navn.
PatientId	string	Valgfri. Filtrer efter patientens unikke identifikator.
OtherPatientId	string	Valgfri. Sekundær identifikator for patienten, hvis tilgængelig.
AccessionNumber	string	Valgfri. Filtrer efter accession-nummer tildelt undersøgelsen.
ModalityList	List	Liste over modaliteter (f.eks. CT, MR, US) til at filtrere søgeresultaterne.
StudyDateFrom	string (YYYY-MM-DD)	Valgfri. Startdato for undersøgelsesdatointerval til filtrering af resultater.
StudyDateTo	string (YYYY-MM-DD)	Valgfri. Slutdato for undersøgelsesdatointerval til filtrering af resultater.
PatientBirthdateFrom	string (YYYY-MM-DD)	Valgfri. Startdato for patientens fødselsdatointerval til at filtrere patienter efter alder.
PatientBirthdateTo	string (YYYY-MM-DD)	Valgfri. Slutdato for patientens fødselsdatointerval til at filtrere patienter efter alder.

Slet patientordre

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

Denne funktion sletter permanent en patientordre fra systemet. Det kræver både institutions-UUID og det specifikke UUID for patientordren for at sikre nøjagtighed og forhindre utilsigtet sletning.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrævet. UUID for institutionen, der ejer patientordren. Sikrer, at den korrekte kontekst bruges til sletning.
PatientOrderUuid	string	Påkrævet. UUID for den specifikke patientordre, der skal slettes. Dette identificerer entydigt ordren i systemet.

Hent indhold af DICOM-tag

Hent indhold af DICOM-tag

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

Denne funktion henter værdierne af specifikke DICOM-tags fra billederne tilknyttet en patientordre.

Påkrævede parametre	Datatype	Beskrivelse
UserName	string	Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password	string	Adgangskoden knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	API'ens basis-URL. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrævet. UUID for institutionen, hvor ordren befinder sig.
PatientOrderUuid	string	Påkrævet. UUID for ordren, der indeholder billederne.
PatientSeriesUuid	string	Valgfri. Hvis angivet, vil tags kun blive læst fra denne specifikke serie.
DicomTagIdList	List	Valgfri. En liste over DICOM Tag-ID'er, der skal hentes.