DICOMweb-dokumentation

ForudsætningerIntroduktion og generel information

Dette dokument giver en omfattende teknisk vejledning til DICOMweb API-funktionerne med eksempelmetoder, der bruges via en C#-eksempelapplikation. Det indeholder 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 brugerdefinerede 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 for 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 din primære login-information, normalt din e-mailadresse. Den er unik for din konto og bruges som brugernavn i Basic Authentication.

Adgangskode: Dette er adgangskoden tilknyttet din PostDICOM-konto. Den bruges sammen med dit brugernavn under Basic Authentication. Af hensyn til optimal sikkerhed anbefaler vi kraftigt at vælge en stærk adgangskode. Sørg for at have de nødvendige sikkerhedsmekanismer i dit serveropkald, 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.

DICOMwebDICOMweb 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, hvorefter den bruger hjælpemetoder til at konstruere og sende en godkendt multipart/related POST-anmodning for hver fil i overensstemmelse med STOW-RS-standarden.

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

Søg efter DICOM-objekter (QIDO-RS)

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

Denne funktion udfører en søgning efter DICOM-objekter ved hjælp af QIDO-RS-standarden, hvilket muliggør søgninger på Undersøgelses-, Serie- eller Instans-niveau. 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 om at hente matchende resultater fra serveren.

Krævede parametre Datatype Beskrivelse
UserName string Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password string Adgangskoden tilknyttet 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 specifik undersøgelse eller alle serier inden for denne undersøgelse.
SeriesInstanceUID string Valgfri. Bruges til at søge efter alle billedinstanser inden for en specifik serie.

Hent DICOM-instanser (WADO-RS)

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

Denne funktion tilbyder 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 det tilsvarende UID. Funktionen foretager derefter en godkendt anmodning og behandler multipart/related-svaret, og gemmer hver DICOM-del som en separat .dcm-fil i en nyoprettet lokal mappe.

Krævede parametre Datatype Beskrivelse
UserName string Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password string Adgangskoden tilknyttet 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 forbundet med denne undersøgelse.
SeriesInstanceUID string Valgfri. En globalt unik identifikator for en serie inden for en DICOM-undersøgelse. Bruges til at hente alle billeder under denne 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.

DelDelingsadministration

Opret delingslink

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

Denne funktion genererer et sikkert weblink til deling af en eller flere patientordrer med eksterne brugere. Linket kan være adgangskodebeskyttet og eventuelt tillade downloads.

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 (ÅÅÅÅ-MM-DD) Udløbsdato for delingslinket. Efter denne dato vil linket blive deaktiveret.
SharePassword string Valgfri. Adgangskode krævet for at få adgang til delingslinket. Efterlad tomt 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 delelig URL for udvalgte patientordrer med yderligere adgangskontrolmuligheder, såsom downloadtilladelse og adgangskodebeskyttelse.

Krævede parametre Datatype Beskrivelse
UserName string Brugernavnet (e-mail) på 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, der skal deles.
ExpireDate string (ÅÅÅÅ-MM-DD) Dato, hvorefter delingslinket bliver inaktivt.
SharePassword string Valgfri. Adgangskode krævet for at få adgang til det delte link.
UserCanDownloadStudies bool Valgfri. Hvis sat til sandt (true), kan modtageren downloade undersøgelserne.

MappeMappe- og ordrehåndtering

Opret mappe

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

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

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

Søg efter mappe

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

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

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

Del mappe med URL

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

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

Krævede parametre Datatype Beskrivelse
UserName string Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password string Adgangskoden tilknyttet PostDICOM-kontoen. (fra initialisering)
WebAddress string API'ens basis-URL. (fra initialisering)
FolderUuid string Krævet. Den unikke identifikator (UUID) for den mappe, der skal deles.
SharePassword string Valgfri. En adgangskode til at beskytte det delte link. Hvis det efterlades 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 (ÅÅÅÅ-MM-DD) Valgfri. Datoen for, hvornår delingslinket automatisk bliver inaktivt.
UserCanDownloadStudies bool Valgfri. Hvis `true`, kan modtagere downloade de patientordrer, der er indeholdt i mappen.

Tilføj ordre til mappe

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

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

Krævede parametre Datatype Beskrivelse
UserName string Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password string Adgangskoden tilknyttet PostDICOM-kontoen. (fra initialisering)
WebAddress string API'ens basis-URL. (fra initialisering)
PatientOrderUuid string Krævet. UUID'et for patientordren, der skal placeres i en mappe.
FolderUuidList List Krævet. En liste, der indeholder UUID'et for destinationsmappen.

ArbejdsgangArbejdsgang og tildeling

Tildel ordre til bruger

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

Denne funktion er et centralt værktøj i arbejdsgangen. Den tildeler en patientordre til en individuel bruger, hvilket angiver, at denne bruger nu er ansvarlig for en opgave relateret til den pågældende ordre (f.eks. rapportering).

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

Tildel ordre til brugergruppe

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

I lighed med 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.

Krævede parametre Datatype Beskrivelse
UserName string Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password string Adgangskoden tilknyttet PostDICOM-kontoen. (fra initialisering)
WebAddress string API'ens basis-URL. (fra initialisering)
PatientOrderUuid string Krævet. UUID'et for patientordren, der skal tildeles til gruppen.
AssignedUserGroupUuid string Krævet. UUID'et for brugergruppen, der skal have ordren tildelt.

PatientordrePatientordres livscyklus 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 til at planlægge og administrere billeddiagnostiske undersøgelser i systemet. Krævede parametre skal angives for en vellykket oprettelse.

Krævede parametre Datatype Beskrivelse
InstitutionUuid string Krævet. UUID for den institution, hvor patientordren oprettes.
PatientName string Krævet. Patientens fulde navn.
PatientId string Krævet. Patientens unikke identifikator såsom et nationalt ID eller MRN.
PatientBirthdate string (ÅÅÅÅ-MM-DD) Krævet. Patientens fødselsdato i ISO-format.
Modality string Krævet. Modalitetstype såsom CT, MR, US osv.
OtherPatientId string Valgfri. En yderligere identifikator for patienten, hvis det er 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 tiltrædelsesnummer (accession number) for ordren, hvis det er relevant.
PatientComplaints string Valgfri. Tekst, der beskriver patientens klager eller symptomer.
OrderScheduledDatetime string (ÅÅÅÅ-MM-DD TT:MM) Valgfri. Den planlagte startdato og -tidspunkt 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 har anmodet om undersøgelsen.
ReferringPhysiciansName string Valgfri. Navnet på den henvisende læge, hvis det er forskelligt fra anmodende læge.
ScheduledEquipmentUuid string Valgfri. UUID for det billeddiagnostiske udstyr, 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.

Krævede parametre Datatype Beskrivelse
UserName string Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password string Adgangskoden tilknyttet PostDICOM-kontoen. (fra initialisering)
WebAddress string API'ens basis-URL. (fra initialisering)
PatientOrderInstitutionUuid string Krævet. UUID for den institution, ordren tilhører.
PatientOrderUuid string 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ødselsdato. Den muliggør avanceret søgefunktionalitet for institutioner, der administrerer flere ordrer.

Krævede parametre Datatype Beskrivelse
UserName string Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password string Adgangskoden tilknyttet PostDICOM-kontoen. (fra initialisering)
WebAddress string API'ens basis-URL. (fra initialisering)
InstitutionUuidList List Liste over UUID'er, der identificerer institutionerne for at søge 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 accessionnummer tildelt undersøgelsen.
ModalityList List Liste over modaliteter (f.eks. CT, MR, US) for at filtrere søgeresultaterne.
StudyDateFrom string (ÅÅÅÅ-MM-DD) Valgfri. Startdato for undersøgelsesdatointervallet til filtrering af resultater.
StudyDateTo string (ÅÅÅÅ-MM-DD) Valgfri. Slutdato for undersøgelsesdatointervallet til filtrering af resultater.
PatientBirthdateFrom string (ÅÅÅÅ-MM-DD) Valgfri. Startdato for patientfødselsdatointerval for at filtrere patienter efter alder.
PatientBirthdateTo string (ÅÅÅÅ-MM-DD) Valgfri. Slutdato for patientfødselsdatointerval for 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'et og det specifikke patientordre-UUID for at sikre nøjagtighed og forhindre utilsigtet sletning.

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

DICOM-tagHent DICOM-tag-indhold

Hent DICOM-tag-indhold

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

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

Krævede parametre Datatype Beskrivelse
UserName string Brugernavnet (e-mailadresse) til PostDICOM-kontoen. (fra initialisering)
Password string Adgangskoden tilknyttet PostDICOM-kontoen. (fra initialisering)
WebAddress string API'ens basis-URL. (fra initialisering)
PatientOrderInstitutionUuid string Krævet. UUID for den institution, hvor ordren ligger.
PatientOrderUuid string 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.