Dokumentation til DicomWeb Service | PostDiCom

Prerequisites Introduktion & Generel information

Dette dokument indeholder en omfattende teknisk vejledning til DICOMweb API funktioner med eksempelmetoder, der bruges gennem et C# eksempelprogram. Den indeholder detaljerede forklaringer på alle tilgængelige funktioner, der dækker begge standard DICOMweb services (såsom QIDO-RS, WADO-RS, and STOW-RS) og custom DICOMweb API endpoints Udviklet af PostDicom. Disse funktioner er designet til at blive brugt i opkald på serversiden.

Hvis du vil 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.

User Name: Dette er din primære login-legitimation, normalt din e-mail-adresse. Det er unikt for din konto og bruges som brugernavn i Grundlæggende godkendelse.

Password: Dette er adgangskoden, der er knyttet til din PostDiCom-konto. Det bruges sammen med dit brugernavn under grundlæggende godkendelse. For optimal sikkerhed anbefaler vi kraftigt at vælge en stærk adgangskode. Hav de nødvendige sikkerhedsmekanismer på dit serversideopkald, så dette brugernavn og adgangskode er beskyttet af dig selv.

Du kan administrere din adgangskode og sikkerhedsindstillinger via din kontoprofilside, når du logger ind på din PostDicom-konto

DicomWeb Standardtjenester

Gem DICOM-forekomster ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Denne funktion orkestrerer upload af alle.dcm-filer fra en bestemt 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/relateret POST-anmodning for hver fil, der overholder STOW-RS-standarden.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
DirectoryPath	string	Den fulde sti til den lokale mappe, der indeholder de DICOM (.dcm) filer, der skal uploades.

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

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

Denne funktion udfører en forespørgsel til DICOM-objekter ved hjælp af QIDO-RS-standarden, hvilket muliggør søgninger på studie-, serie- eller forekomstniveau. Baseret på den angivne søgeparameter (f.eks. Patient-id, Study Instance UID eller Series Instance UID) konstruerer den den relevante URL-adresse og udfører en godkendt anmodning om at hente matchende resultater fra serveren.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (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 inden for den undersøgelse.
SeriesInstanceUID	string	Valgfri. Bruges til at søge efter alle billedforekomster inden for en bestemt serie.

Hent DICOM-forekomster ( 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 (Study, Series eller Instance) og angiver det tilsvarende UID. Funktionen foretager derefter en godkendt anmodning og behandler multiparts-/relaterede svar og gemmer hver DICOM-del som en separat DCM-fil i en nyoprettet lokal mappe.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
StudyInstanceUID	string	Valgfri. En globalt entydig identifikator for en DICOM-undersøgelse. Bruges til at hente alle serier og forekomster, der er forbundet med den undersøgelse.
SeriesInstanceUID	string	Valgfri. En globalt entydig identifikator for en serie inden for en DICOM-undersøgelse. Bruges til at hente alle billeder under den serie.
SOPInstanceUID	string	Valgfri. En entydig identifikator for en individuel DICOM-billedforekomst. Bruges til at hente et specifikt billede ved hjælp af WADO-RS.

Delingsstyring

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 beskyttes med adgangskode og eventuelt tillade downloads.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
PatientOrderInfoList	List	Liste over JSON-strenge, der hver indeholder en „PatientOrderUUID“ -nøgle, der identificerer de patientordrer, der skal deles.
ExpireDate	string (YYYY-MM-DD)	Udløbsdato for delingslinket. Efter denne dato vil linket blive deaktiveret.
SharePassword	string	Valgfri. Adgangskode kræves for at få adgang til delingslinket. Lad det stå 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 delbar URL til udvalgte patientordrer med yderligere adgangskontrolmuligheder såsom downloadtilladelse og adgangskodebeskyttelse.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail) på PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
OrderUuidList	List	Liste over UUID'er, der identificerer patientordrer, der skal deles.
ExpireDate	string (YYYY-MM-DD)	Dato, hvorefter delingslinket bliver inaktivt.
SharePassword	string	Valgfri. Adgangskode kræves for at få adgang til det delte link.
UserCanDownloadStudies	bool	Valgfri. Hvis indstillet til true, kan modtageren downloade undersøgelserne.

Håndtering af mapper og ordrer

Opret mappe

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

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

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
FolderName	string	Påkrævet. Det synlige navn på den nye mappe.
FolderDescription	string	Valgfri. En tekstbeskrivelse for mappen.
ParentFolderUuid	string	Valgfri. UUID for en eksisterende mappe for at oprette den nye mappe inde i den.

Søgemappe

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

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

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
ParentFolderUuid	string	Valgfri. En mappe UUID for at begrænse søgningen til dens underordnede.
FolderName	string	Valgfri. Et helt eller delvist navn at søge efter.
GetOrdersInFolder	bool	Valgfri. Hvis „sandt“, vil svaret indeholde en liste over patientordrer for hver fundne mappe.

Del mappe med URL

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

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

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
FolderUuid	string	Påkrævet. Den entydige identifikator (UUID) for den mappe, der skal deles.
SharePassword	string	Valgfri. En adgangskode til beskyttelse af det delte link. Hvis linket er tomt, vil linket være offentligt tilgængeligt.
ShareTitle	string	Valgfri. En brugerdefineret titel til siden med delte mapper, der er synlig for modtageren.
ShareDescription	string	Valgfri. En beskrivelse, der vises på siden med delte mapper.
ExpireDate	string (YYYY-MM-DD)	Valgfri. Den dato, hvor delingslinket automatisk bliver inaktivt.
UserCanDownloadStudies	bool	Valgfri. Hvis „sandt“, kan modtagerne downloade patientordrerne indeholdt 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.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
PatientOrderUuid	string	Påkrævet. UUID for patientordren, der skal placeres i en mappe.
FolderUuidList	List	Påkrævet. En liste, der indeholder destinationsmappens UUID.

Arbejdsgang og tildeling

Tildel ordre til bruger

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

Denne funktion er et kerneværktøj til arbejdsgangen. Det tildeler en patientordre til en individuel bruger, hvilket betyder, at denne bruger nu er ansvarlig for en opgave relateret til denne ordre (f.eks. rapportering).

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
PatientOrderUuid	string	Påkrævet. UUID for patientordren, der kræver handling.
AssignedUserUuid	string	Påkrævet. UUID for den specifikke bruger, der vil blive tildelt ansvar.

Tildel rækkefølge til brugergruppe

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

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

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
PatientOrderUuid	string	Påkrævet. UUID for patientordren, der skal tildeles gruppen.
AssignedUserGroupUuid	string	Påkrævet. UUID for den brugergruppe, der skal tildeles ordren.

Patientordrelivscyklus og dataindhentning

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 billeddannelsesundersøgelser i systemet. Nødvendige parametre skal tilvejebringes for vellykket oprettelse.

Required Parameters	Data Type	Beskrivelse
InstitutionUuid	string	Påkrævet. UUID for den institution, hvor patientordren oprettes.
PatientName	string	Påkrævet. Patientens fulde navn.
PatientId	string	Påkrævet. Patientens entydige identifikator såsom et nationalt ID 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 billeddannelsesundersøgelse, der bestilles.
AccessionNumber	string	Valgfri. Unikt tilmeldingsnummer 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 klokkeslæt for proceduren.
RequestedProcedureId	string	Valgfri. Identifikator for den anmodede procedure.
RequestedProcedureDescription	string	Valgfri. Beskrivelse af den ønskede procedure.
RequestingPhysician	string	Valgfri. Navn på den læge, der anmodede om undersøgelsen.
ReferringPhysiciansName	string	Valgfri. Navn på den henvisende læge, hvis forskellig fra anmodningen.
ScheduledEquipmentUuid	string	Valgfri. UUID for det billedbehandlingsudstyr, der skal anvendes til den planlagte procedure.

Hent egenskaber for patientordre

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

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

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrævet. UUID for den institution, 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 studie- eller fødselsdatoer. Det muliggør avanceret søgefunktionalitet for institutioner, der administrerer flere ordrer.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
InstitutionUuidList	List	Liste over UUID'er, der identificerer institutionerne til 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 tiltrædelsesnummer tildelt undersøgelsen.
ModalityList	List	Liste over modaliteter (f.eks. CT, MR, USA) for at filtrere søgeresultaterne.
StudyDateFrom	string (YYYY-MM-DD)	Valgfri. Startdato for undersøgelsesdatointervallet for filtrering af resultater.
StudyDateTo	string (YYYY-MM-DD)	Valgfri. Slutdato for undersøgelsesdatointervallet for filtrering af resultater.
PatientBirthdateFrom	string (YYYY-MM-DD)	Valgfri. Startdato for patientens fødselsdatointerval for at filtrere patienter efter alder.
PatientBirthdateTo	string (YYYY-MM-DD)	Valgfri. Slutdato for patientens fø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 institutionens UUID og den specifikke patientordre UUID for at sikre nøjagtighed og forhindre utilsigtet sletning.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrævet. UUID for den institution, 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 rækkefølgen i systemet.

Hent Dicom Tag-indhold

Hent DICOM-tagindhold

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

Denne funktion henter værdierne for specifikke DICOM-tags fra de billeder, der er knyttet til en patientordre.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brugernavnet (e-mail-adressen) for PostDiCom-kontoen. (fra initialisering)
Password	string	Adgangskoden, der er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	API's basisURL-adresse. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrævet. UUID for den institution, hvor ordren er hjemmehørende.
PatientOrderUuid	string	Påkrævet. UUID for ordren, der indeholder billederne.
PatientSeriesUuid	string	Valgfri. Hvis angivet, læses tags kun fra denne specifikke serie.
DicomTagIdList	List	Valgfri. En liste over DICOM-tag-id'er, der skal hentes.