DICOMweb-tjenestedokumentasjon | PostDICOM

Prerequisites Introduksjon og generell informasjon

Dette dokumentet gir en omfattende teknisk veiledning for **DICOMweb API**-funksjonene med eksempelmetoder som brukes gjennom en C#-eksempelapplikasjon. Det inkluderer detaljerte forklaringer av alle tilgjengelige funksjoner, som dekker både **standard DICOMweb-tjenester** (som QIDO-RS, WADO-RS og STOW-RS) og **tilpassede DICOMweb API-endepunkter** utviklet av PostDICOM. Disse funksjonene er designet for å brukes i kall på serversiden.

For å bruke PostDICOMs DICOMweb-tjenester, må du først ha denne funksjonen aktivert for kontoen din og ha gyldig brukerlegitimasjon. Hvis DICOMweb-tilgang ennå ikke er aktivert for kontoen din og du ønsker å integrere applikasjonen din med PostDICOM, vennligst kontakt oss for å be om aktivering.

Brukernavn: Dette er din primære innloggingsinformasjon, vanligvis e-postadressen din. Den er unik for kontoen din og brukes som brukernavn i Basic Authentication.

Passord: Dette er passordet knyttet til din PostDICOM-konto. Det brukes sammen med brukernavnet ditt under Basic Authentication. For optimal sikkerhet anbefaler vi sterkt å velge et sterkt passord. Sørg for å ha nødvendige sikkerhetsmekanismer på serversiden slik at dette brukernavnet og passordet er beskyttet av deg selv.

Du kan administrere passordet og sikkerhetsinnstillingene dine via kontoprofilsiden etter at du har logget inn på din PostDICOM-konto.

DICOMweb standardtjenester

Lagre DICOM-instanser (STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Denne funksjonen orkestrerer opplastingen av alle .dcm-filer fra en spesifisert lokal mappe til DICOMweb-serveren. Den identifiserer først alle relevante filer, og bruker deretter hjelpemetoder for å konstruere og sende en autentisert multipart/related POST-forespørsel for hver fil, i henhold til STOW-RS-standarden.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
DirectoryPath	string	Hele banen til den lokale katalogen som inneholder DICOM-filene (.dcm) som skal lastes opp.

Søk etter DICOM-objekter (QIDO-RS)

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

Denne funksjonen utfører et søk etter DICOM-objekter ved hjelp av QIDO-RS-standarden, og muliggjør søk på studie-, serie- eller instansnivå. Basert på den oppgitte søkeparameteren (som pasient-ID, Study Instance UID eller Series Instance UID), konstruerer den passende URL og utfører en autentisert forespørsel for å hente samsvarende resultater fra serveren.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
PatientID	string	Valgfritt. Brukes til å identifisere pasienten og søke etter relaterte studier.
StudyInstanceUID	string	Valgfritt. Brukes til å søke etter en spesifikk studie eller alle serier innenfor den studien.
SeriesInstanceUID	string	Valgfritt. Brukes til å søke etter alle bildeinstanser innenfor en spesifikk serie.

Hent DICOM-instanser (WADO-RS)

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

Denne funksjonen gir en interaktiv meny for å hente DICOM-objekter ved hjelp av WADO-RS-standarden. Brukeren velger et hentingsnivå (Studie, Serie eller Instans) og oppgir tilhørende UID. Funksjonen gjør deretter en autentisert forespørsel og behandler multipart/related-responsen, og lagrer hver DICOM-del som en separat .dcm-fil i en nyopprettet lokal katalog.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
StudyInstanceUID	string	Valgfritt. En globalt unik identifikator for en DICOM-studie. Brukes til å hente alle serier og instanser knyttet til den studien.
SeriesInstanceUID	string	Valgfritt. En globalt unik identifikator for en serie innenfor en DICOM-studie. Brukes til å hente alle bilder under den serien.
SOPInstanceUID	string	Valgfritt. En unik identifikator for en individuell DICOM-bildeinstans. Brukes til å hente et spesifikt bilde ved hjelp av WADO-RS.

Delingsadministrasjon

Opprett delingslenke

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

Denne funksjonen genererer en sikker web-lenke for å dele én eller flere pasientbestillinger med eksterne brukere. Lenken kan passordbeskyttes og valgfritt tillate nedlastinger.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-post) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet for PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
PatientOrderInfoList	List	Liste over JSON-strenger, som hver inneholder en "PatientOrderUuid"-nøkkel, som identifiserer pasientbestillingene som skal deles.
ExpireDate	string (YYYY-MM-DD)	Utløpsdato for delingslenken. Etter denne datoen vil lenken bli deaktivert.
SharePassword	string	Valgfritt. Passord som kreves for å få tilgang til delingslenken. La stå tomt for offentlig tilgang.
Downloadable	bool	Valgfritt. Bestemmer om DICOM-studiene skal kunne lastes ned av mottakeren.

Del pasientbestilling med URL

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

Denne funksjonen genererer en delbar URL for utvalgte pasientbestillinger med ekstra alternativer for tilgangskontroll, som nedlastingstillatelse og passordbeskyttelse.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-post) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet for PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
OrderUuidList	List	Liste over UUID-er som identifiserer pasientbestillinger som skal deles.
ExpireDate	string (YYYY-MM-DD)	Dato for når delingslenken blir inaktiv.
SharePassword	string	Valgfritt. Passord som kreves for å få tilgang til den delte lenken.
UserCanDownloadStudies	bool	Valgfritt. Hvis satt til sann, kan mottakeren laste ned studiene.

Mappe- og bestillingsadministrasjon

Opprett mappe

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

Denne funksjonen brukes til å opprette en ny mappe (en virtuell beholder) inne i PostDICOM-kontoen for å bidra til å organisere pasientbestillinger.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
FolderName	string	Påkrevd. Det synlige navnet for den nye mappen.
FolderDescription	string	Valgfritt. En tekstbeskrivelse for mappen.
ParentFolderUuid	string	Valgfritt. UUID for en eksisterende mappe for å opprette den nye mappen inne i den.

Søk i mappe

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

Denne funksjonen finner eksisterende mapper basert på søkekriterier. Den kan valgfritt inkludere listen over pasientbestillinger inne i hver funnet mappe.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
ParentFolderUuid	string	Valgfritt. En mappe-UUID for å begrense søket til dens undermapper.
FolderName	string	Valgfritt. Et fullstendig eller delvis navn å søke etter.
GetOrdersInFolder	bool	Valgfritt. Hvis `true`, vil responsen inkludere en liste over pasientbestillinger for hver funnet mappe.

Del mappe med URL

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

Denne funksjonen genererer en sikker, delbar URL for en hel mappe og dens innhold. Den gir mulighet for omfattende tilgangskontroll ved å sette en egendefinert tittel, beskrivelse, et passord, en utløpsdato, og spesifisere om innholdet kan lastes ned av mottakeren.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
FolderUuid	string	Påkrevd. Den unike identifikatoren (UUID) for mappen som skal deles.
SharePassword	string	Valgfritt. Et passord for å beskytte den delte lenken. Hvis tomt, vil lenken være offentlig tilgjengelig.
ShareTitle	string	Valgfritt. En egendefinert tittel for siden med den delte mappen, synlig for mottakeren.
ShareDescription	string	Valgfritt. En beskrivelse som vises på siden med den delte mappen.
ExpireDate	string (YYYY-MM-DD)	Valgfritt. Datoen for når delingslenken automatisk blir inaktiv.
UserCanDownloadStudies	bool	Valgfritt. Hvis `true`, kan mottakere laste ned pasientbestillingene som mappen inneholder.

Legg til bestilling i mappe

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

Denne funksjonen oppretter en kobling mellom en eksisterende pasientbestilling og en eksisterende mappe. Dette er et organisatorisk verktøy; det verken flytter eller kopierer data.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
PatientOrderUuid	string	Påkrevd. UUID for pasientbestillingen som skal plasseres i en mappe.
FolderUuidList	List	Påkrevd. En liste som inneholder UUID for målmappen.

Arbeidsflyt og tildeling

Tildel bestilling til bruker

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

Denne funksjonen er et kjerneverktøy for arbeidsflyt. Den tildeler en pasientbestilling til en individuell bruker, og signaliserer at denne brukeren nå er ansvarlig for en oppgave knyttet til den bestillingen (f.eks. rapportering).

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
PatientOrderUuid	string	Påkrevd. UUID for pasientbestillingen som krever handling.
AssignedUserUuid	string	Påkrevd. UUID for den spesifikke brukeren som skal tildeles ansvar.

Tildel bestilling til brukergruppe

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

I likhet med tildeling til en enkelt bruker, tildeler denne funksjonen en pasientbestilling til en hel gruppe, og muliggjør teambaserte arbeidsflyter der ethvert gruppemedlem kan håndtere oppgaven.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
PatientOrderUuid	string	Påkrevd. UUID for pasientbestillingen som skal tildeles gruppen.
AssignedUserGroupUuid	string	Påkrevd. UUID for brukergruppen som skal tildeles bestillingen.

Livssyklus for pasientbestilling og datahenting

Opprett pasientbestilling

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

Denne funksjonen oppretter en ny pasientbestilling for å planlegge og administrere bildestudier i systemet. Påkrevde parametere må oppgis for vellykket opprettelse.

Påkrevde parametere	Datatype	Beskrivelse
InstitutionUuid	string	Påkrevd. UUID for institusjonen der pasientbestillingen opprettes.
PatientName	string	Påkrevd. Pasientens fulle navn.
PatientId	string	Påkrevd. Pasientens unike identifikator, for eksempel et nasjonalt ID-nummer eller MRN.
PatientBirthdate	string (YYYY-MM-DD)	Påkrevd. Pasientens fødselsdato i ISO-format.
Modality	string	Påkrevd. Modalitetstype som CT, MR, UL osv.
OtherPatientId	string	Valgfritt. En ekstra identifikator for pasienten, hvis aktuelt.
PatientSex	string	Valgfritt. Pasientens kjønn (f.eks. M, F, O).
StudyDescription	string	Valgfritt. Beskrivelse av bildeundersøkelsen som bestilles.
AccessionNumber	string	Valgfritt. Unikt accession-nummer for bestillingen, hvis aktuelt.
PatientComplaints	string	Valgfritt. Tekst som beskriver pasientens plager eller symptomer.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Valgfritt. Den planlagte startdatoen og klokkeslettet for prosedyren.
RequestedProcedureId	string	Valgfritt. Identifikator for den forespurte prosedyren.
RequestedProcedureDescription	string	Valgfritt. Beskrivelse av den forespurte prosedyren.
RequestingPhysician	string	Valgfritt. Navnet på legen som rekvirerte studien.
ReferringPhysiciansName	string	Valgfritt. Navnet på henvisende lege, hvis annerledes enn rekvirerende.
ScheduledEquipmentUuid	string	Valgfritt. UUID for bildeutstyret som skal brukes til den planlagte prosedyren.

Hent egenskaper for pasientbestilling

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

Denne funksjonen henter det komplette settet med egenskaper for en enkelt, spesifikk pasientbestilling.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrevd. UUID for institusjonen som bestillingen tilhører.
PatientOrderUuid	string	Påkrevd. UUID for den spesifikke pasientbestillingen som skal hentes.

Søk etter pasientbestillinger

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

Denne funksjonen henter en liste over pasientbestillinger basert på en kombinasjon av søkefiltre som pasientnavn, ID, modalitet og studie- eller fødselsdatoer. Den muliggjør avansert søkefunksjonalitet for institusjoner som administrerer flere bestillinger.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
InstitutionUuidList	List	Liste over UUID-er som identifiserer institusjonene det skal søkes etter pasientbestillinger i.
PatientName	string	Valgfritt. Filtrer på pasientens fulle navn.
PatientId	string	Valgfritt. Filtrer på pasientens unike identifikator.
OtherPatientId	string	Valgfritt. Sekundær identifikator for pasienten, hvis tilgjengelig.
AccessionNumber	string	Valgfritt. Filtrer etter accession-nummer tildelt studien.
ModalityList	List	Liste over modaliteter (f.eks. CT, MR, UL) for å filtrere søkeresultatene.
StudyDateFrom	string (YYYY-MM-DD)	Valgfritt. Startdato for studiedato-intervallet for filtrering av resultater.
StudyDateTo	string (YYYY-MM-DD)	Valgfritt. Sluttdato for studiedato-intervallet for filtrering av resultater.
PatientBirthdateFrom	string (YYYY-MM-DD)	Valgfritt. Startdato for pasientens fødselsdato-intervall for å filtrere pasienter etter alder.
PatientBirthdateTo	string (YYYY-MM-DD)	Valgfritt. Sluttdato for pasientens fødselsdato-intervall for å filtrere pasienter etter alder.

Slett pasientbestilling

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

Denne funksjonen sletter en pasientbestilling permanent fra systemet. Den krever både institusjonens UUID og den spesifikke pasientbestillingens UUID for å sikre nøyaktighet og forhindre utilsiktet sletting.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrevd. UUID for institusjonen som eier pasientbestillingen. Sikrer at riktig kontekst brukes for sletting.
PatientOrderUuid	string	Påkrevd. UUID for den spesifikke pasientbestillingen som skal slettes. Dette identifiserer bestillingen unikt i systemet.

Hent innhold i DICOM-tag

Hent innhold i DICOM-tag

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

Denne funksjonen henter verdiene til spesifikke DICOM-tags fra bildene knyttet til en pasientbestilling.

Påkrevde parametere	Datatype	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDICOM-kontoen. (fra initialisering)
Password	string	Passordet knyttet til PostDICOM-kontoen. (fra initialisering)
WebAddress	string	Basis-URL for API-et. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrevd. UUID for institusjonen der bestillingen ligger.
PatientOrderUuid	string	Påkrevd. UUID for bestillingen som inneholder bildene.
PatientSeriesUuid	string	Valgfritt. Hvis oppgitt, vil tags bare bli lest fra denne spesifikke serien.
DicomTagIdList	List	Valgfritt. En liste over DICOM Tag ID-er som skal hentes.