DICOMweb-dokumentasjon

ForutsetningerIntroduksjon og generell informasjon

Dette dokumentet gir en omfattende teknisk veiledning for DICOMweb API-funksjonene med eksempelmetoder som brukes via en C#-eksempelapplikasjon. Det inkluderer detaljerte forklaringer av alle tilgjengelige funksjoner, og 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 server-side-kall.

For å bruke PostDICOMs DICOMweb-tjenester, må du først ha denne funksjonen aktivert for kontoen din og ha gyldig brukerinformasjon. 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 påloggingsinformasjon, vanligvis din e-postadresse. 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 på det sterkeste å velge et sterkt passord. Sørg for at du har nødvendige sikkerhetsmekanismer for server-side-kall, slik at dette brukernavnet og passordet er beskyttet av deg selv.

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

DICOMwebStandard DICOMweb-tjenester

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 samsvar med 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 Base-URL-en til API-et. (fra initialisering)
DirectoryPath string Den fullstendige banen til den lokale mappen 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 bruk av QIDO-RS-standarden, noe som muliggjør søk på studie-, serie- eller instansnivå. Basert på den oppgitte søkeparameteren (som Pasient-ID, Studieinstans-UID eller Serieinstans-UID), konstruerer den riktig 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 Base-URL-en til API-et. (fra initialisering)
PatientID string Valgfritt. Brukes til å identifisere pasienten og søke etter relaterte undersøkelser.
StudyInstanceUID string Valgfritt. Brukes til å søke etter en spesifikk undersøkelse eller alle serier innenfor denne undersøkelsen.
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 tilbyr en interaktiv meny for å hente DICOM-objekter ved bruk av WADO-RS-standarden. Brukeren velger et hentingsnivå (Studie, Serie eller Instans) og oppgir tilsvarende 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 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 Base-URL-en til API-et. (fra initialisering)
StudyInstanceUID string Valgfritt. En globalt unik identifikator for en DICOM-undersøkelse. Brukes til å hente alle serier og instanser knyttet til denne undersøkelsen.
SeriesInstanceUID string Valgfritt. En globalt unik identifikator for en serie innenfor en DICOM-undersøkelse. Brukes til å hente alle bilder under denne serien.
SOPInstanceUID string Valgfritt. En unik identifikator for en individuell DICOM-bildeinstans. Brukes til å hente et spesifikt bilde ved bruk av WADO-RS.

DelAdministrasjon av deling

Opprett delingslenke

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

Denne funksjonen genererer en sikker nettlenke for å dele en eller flere pasientrekvisisjoner 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 Base-URL-en til API-et. (fra initialisering)
PatientOrderInfoList List Liste over JSON-strenger, der hver inneholder en "PatientOrderUuid"-nøkkel som identifiserer pasientrekvisisjonene som skal deles.
ExpireDate string (ÅÅÅÅ-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 hvorvidt DICOM-undersøkelsene kan lastes ned av mottakeren.

Del pasientrekvisisjon med URL

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

Denne funksjonen genererer en delbar URL for utvalgte pasientrekvisisjoner med ekstra alternativer for tilgangskontroll, for eksempel 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 Base-URL-en til API-et. (fra initialisering)
OrderUuidList List Liste over UUID-er som identifiserer pasientrekvisisjoner som skal deles.
ExpireDate string (ÅÅÅÅ-MM-DD) Datoen da delingslenken blir inaktiv.
SharePassword string Valgfritt. Passord som kreves for å få tilgang til den delte lenken.
UserCanDownloadStudies bool Valgfritt. Hvis satt til true, kan mottakeren laste ned undersøkelsene.

MappeMappe- og rekvisisjonsadministrasjon

Opprett mappe

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

Denne funksjonen brukes til å opprette en ny mappe (en virtuell beholder) i PostDICOM-kontoen for å hjelpe til med å organisere pasientrekvisisjoner.

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 Base-URL-en til API-et. (fra initialisering)
FolderName string Påkrevd. Det synlige navnet på den nye mappen.
FolderDescription string Valgfritt. En tekstbeskrivelse for mappen.
ParentFolderUuid string Valgfritt. UUID-en til en eksisterende mappe for å opprette den nye mappen i den.

Søk etter mappe

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

Denne funksjonen finner eksisterende mapper basert på søkekriterier. Den kan valgfritt inkludere listen over pasientrekvisisjoner 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 Base-URL-en til 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 pasientrekvisisjoner for hver mappe som blir funnet.

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 Base-URL-en til 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 det står tomt, vil lenken være offentlig tilgjengelig.
ShareTitle string Valgfritt. En egendefinert tittel for den delte mappesiden, synlig for mottakeren.
ShareDescription string Valgfritt. En beskrivelse som vises på den delte mappesiden.
ExpireDate string (ÅÅÅÅ-MM-DD) Valgfritt. Datoen da delingslenken automatisk blir inaktiv.
UserCanDownloadStudies bool Valgfritt. Hvis `true`, kan mottakere laste ned pasientrekvisisjonene som finnes i mappen.

Legg til rekvisisjon i mappe

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

Denne funksjonen oppretter en assosiasjon mellom en eksisterende pasientrekvisisjon og en eksisterende mappe. Dette er et organisasjonsverktøy; det flytter eller kopierer ikke 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 Base-URL-en til API-et. (fra initialisering)
PatientOrderUuid string Påkrevd. UUID-en for pasientrekvisisjonen som skal plasseres i en mappe.
FolderUuidList List Påkrevd. En liste som inneholder UUID-en til målmappen.

ArbeidsflytArbeidsflyt og tildeling

Tildel rekvisisjon til bruker

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

Denne funksjonen er et sentralt verktøy for arbeidsflyt. Den tildeler en pasientrekvisisjon til en individuell bruker, noe som betyr at denne brukeren nå er ansvarlig for en oppgave knyttet til den rekvisisjonen (for eksempel 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 Base-URL-en til API-et. (fra initialisering)
PatientOrderUuid string Påkrevd. UUID-en for pasientrekvisisjonen som krever handling.
AssignedUserUuid string Påkrevd. UUID-en for den spesifikke brukeren som skal tildeles ansvaret.

Tildel rekvisisjon til brukergruppe

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

I likhet med tildeling til en enkelt bruker, tildeler denne funksjonen en pasientrekvisisjon til en hel gruppe. Dette muliggjør teambaserte arbeidsflyter der et hvilket som helst 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 Base-URL-en til API-et. (fra initialisering)
PatientOrderUuid string Påkrevd. UUID-en for pasientrekvisisjonen som skal tildeles gruppen.
AssignedUserGroupUuid string Påkrevd. UUID-en for brukergruppen som skal tildeles rekvisisjonen.

PasientrekvisisjonPasientrekvisisjonens livssyklus og datahenting

Opprett pasientrekvisisjon

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 pasientrekvisisjon for å planlegge og administrere bildeundersøkelser i systemet. Påkrevde parametere må oppgis for vellykket opprettelse.

Påkrevde parametere Datatype Beskrivelse
InstitutionUuid string Påkrevd. UUID for institusjonen der pasientrekvisisjonen opprettes.
PatientName string Påkrevd. Pasientens fulle navn.
PatientId string Påkrevd. Pasientens unike identifikator, for eksempel fødselsnummer eller MRN.
PatientBirthdate string (ÅÅÅÅ-MM-DD) Påkrevd. Pasientens fødselsdato i ISO-format.
Modality string Påkrevd. Modalitetstype som CT, MR, US (ultralyd) osv.
OtherPatientId string Valgfritt. En ekstra identifikator for pasienten, hvis aktuelt.
PatientSex string Valgfritt. Pasientens kjønn (for eksempel M, F, O).
StudyDescription string Valgfritt. Beskrivelse av bildeundersøkelsen som bestilles.
AccessionNumber string Valgfritt. Unikt aksessjonsnummer (Accession Number) for bestillingen, hvis aktuelt.
PatientComplaints string Valgfritt. Tekst som beskriver pasientens plager eller symptomer.
OrderScheduledDatetime string (ÅÅÅÅ-MM-DD TT:MM) Valgfritt. Planlagt startdato og -tidspunkt for prosedyren.
RequestedProcedureId string Valgfritt. Identifikator for den forespurte prosedyren.
RequestedProcedureDescription string Valgfritt. Beskrivelse av den forespurte prosedyren.
RequestingPhysician string Valgfritt. Navn på legen som rekvirerte undersøkelsen.
ReferringPhysiciansName string Valgfritt. Navn på henvisende lege, hvis annerledes enn rekvirerende.
ScheduledEquipmentUuid string Valgfritt. UUID for bildeutstyret som skal brukes til den planlagte prosedyren.

Hent egenskaper for pasientrekvisisjon

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

Denne funksjonen henter det fullstendige settet med egenskaper for en enkelt, spesifikk pasientrekvisisjon.

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 Base-URL-en til API-et. (fra initialisering)
PatientOrderInstitutionUuid string Påkrevd. UUID-en til institusjonen som rekvisisjonen tilhører.
PatientOrderUuid string Påkrevd. UUID-en for den spesifikke pasientrekvisisjonen som skal hentes.

Søk etter pasientrekvisisjoner

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

Denne funksjonen henter en liste over pasientrekvisisjoner basert på en kombinasjon av søkefiltre som pasientnavn, ID, modalitet og studie- eller fødselsdatoer. Det muliggjør avansert søkefunksjonalitet for institusjoner som håndterer flere rekvisisjoner.

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 Base-URL-en til API-et. (fra initialisering)
InstitutionUuidList List Liste over UUID-er som identifiserer institusjonene det skal søkes etter pasientrekvisisjoner 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 på aksessjonsnummer (Accession Number) tildelt undersøkelsen.
ModalityList List Liste over modaliteter (for eksempel CT, MR, US) for å filtrere søkeresultatene.
StudyDateFrom string (ÅÅÅÅ-MM-DD) Valgfritt. Startdato for undersøkelsens datoperiode for filtrering av resultater.
StudyDateTo string (ÅÅÅÅ-MM-DD) Valgfritt. Sluttdato for undersøkelsens datoperiode for filtrering av resultater.
PatientBirthdateFrom string (ÅÅÅÅ-MM-DD) Valgfritt. Startdato for pasientens fødselsdatoperiode for å filtrere pasienter etter alder.
PatientBirthdateTo string (ÅÅÅÅ-MM-DD) Valgfritt. Sluttdato for pasientens fødselsdatoperiode for å filtrere pasienter etter alder.

Slett pasientrekvisisjon

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

Denne funksjonen sletter en pasientrekvisisjon permanent fra systemet. Den krever både institusjonens UUID og den spesifikke pasientrekvisisjonens 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 Base-URL-en til API-et. (fra initialisering)
PatientOrderInstitutionUuid string Påkrevd. UUID for institusjonen som eier pasientrekvisisjonen. Sikrer at riktig kontekst brukes for slettingen.
PatientOrderUuid string Påkrevd. UUID for den spesifikke pasientrekvisisjonen som skal slettes. Dette identifiserer rekvisisjonen unikt i systemet.

Dicom-taggHent innhold for DICOM-tagg

Hent innhold for DICOM-tagg

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

Denne funksjonen henter verdiene til spesifikke DICOM-tagger fra bildene knyttet til en pasientrekvisisjon.

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 Base-URL-en til API-et. (fra initialisering)
PatientOrderInstitutionUuid string Påkrevd. UUID-en for institusjonen der rekvisisjonen befinner seg.
PatientOrderUuid string Påkrevd. UUID-en for rekvisisjonen som inneholder bildene.
PatientSeriesUuid string Valgfritt. Hvis oppgitt, vil tagger kun bli lest fra denne spesifikke serien.
DicomTagIdList List Valgfritt. En liste over DICOM-tagg-ID-er som skal hentes.