Dokumentasjon for DicomWeb Service | PostDiCOM

Prerequisites Introduksjon og generell informasjon

Dette dokumentet gir en omfattende teknisk veiledning for DICOMweb API funksjoner med eksempelmetoder som brukes gjennom en C# eksempelapplikasjon. Den inneholder detaljerte forklaringer på alle tilgjengelige funksjoner, som dekker begge standard DICOMweb services (slik som QIDO-RS, WADO-RS, and STOW-RS) og custom DICOMweb API endpoints Utviklet av PostDicom. Disse funksjonene er designet for å brukes i anrop 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.

User Name: Dette er din primære påloggingsinformasjon, vanligvis e-postadressen din. Det er unikt for kontoen din og brukes som brukernavn i grunnleggende autentisering.

Password: Dette er passordet som er knyttet til PostDicom-kontoen din. Den brukes sammen med brukernavnet ditt under grunnleggende godkjenning. For optimal sikkerhet anbefaler vi sterkt å velge et sterkt passord. Vennligst ha nødvendige sikkerhetsmekanismer på serveranropet ditt slik at dette brukernavnet og passordet er beskyttet av deg selv.

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

DicomWeb Standard-tjenester

Lagre DICOM-forekomster ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Denne funksjonen organiserer opplasting 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/relatert POST-forespørsel for hver fil, i samsvar med STOW-RS-standarden.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
DirectoryPath	string	Den fullstendige banen til den lokale katalogen som inneholder DICOM-filene (.dcm) som skal lastes opp.

Forespørsel etter DICOM-objekter ( QIDO-RS)

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

Denne funksjonen utfører en spørring for DICOM-objekter ved hjelp av QIDO-RS-standarden, og muliggjør søk på studie-, serie- eller forekomstnivå. Basert på den angitte søkeparameteren (for eksempel pasient-ID, UID for studieforekomst eller serieforekomst UID), konstruerer den riktig URL-adresse og utfører en autentisert forespørsel om å hente samsvarende resultater fra serveren.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
PatientID	string	Valgfritt. Brukes til å identifisere pasienten og søke etter relaterte studier.
StudyInstanceUID	string	Valgfritt. Brukes til å søke etter en bestemt studie eller alle serier i den studien.
SeriesInstanceUID	string	Valgfritt. Brukes til å søke etter alle bildeforekomster i en bestemt serie.

Hent DICOM-forekomster ( 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 hentningsnivå (studie, serie eller forekomst) og gir tilsvarende UID. Funksjonen foretar deretter en autentisert forespørsel og behandler multipart/relatert respons, og lagrer hver DICOM-del som en egen DCM-fil i en nylig opprettet lokal katalog.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
StudyInstanceUID	string	Valgfritt. En globalt unik identifikator for en DICOM-studie. Brukes til å hente alle serier og forekomster knyttet til den studien.
SeriesInstanceUID	string	Valgfritt. En globalt unik identifikator for en serie i en DICOM-studie. Brukes til å hente alle bildene under den serien.
SOPInstanceUID	string	Valgfritt. En unik identifikator for en individuell DICOM-bildeforekomst. Brukes til å hente et bestemt bilde ved hjelp av WADO-RS.

Delingsadministrasjon

Opprett delingskobling

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

Denne funksjonen genererer en sikker nettkobling for å dele en eller flere pasientbestillinger med eksterne brukere. Koblingen kan være passordbeskyttet og eventuelt tillate nedlastinger.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-post) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet for PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
PatientOrderInfoList	List	Liste over JSON-strenger, som hver inneholder en «PatientOrderUUID» -nøkkel, som identifiserer pasientordrene som skal deles.
ExpireDate	string (YYYY-MM-DD)	Utløpsdato for delingskoblingen. Etter denne datoen blir lenken deaktivert.
SharePassword	string	Valgfritt. Passord kreves for å få tilgang til delingskoblingen. La stå tomt for offentlig tilgang.
Downloadable	bool	Valgfritt. Bestemmer om DICOM-studiene kan 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 tilgangskontrollalternativer som nedlastingstillatelse og passordbeskyttelse.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-post) til PostDicom-kontoen. (fra initialisering)
Password	string	Passordet for PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
OrderUuidList	List	Liste over UUID-er som identifiserer pasientordrer som skal deles.
ExpireDate	string (YYYY-MM-DD)	Dato etter hvilken delingslenken blir inaktiv.
SharePassword	string	Valgfritt. Passord kreves for å få tilgang til den delte lenken.
UserCanDownloadStudies	bool	Valgfritt. Hvis satt til sant, kan mottakeren laste ned studiene.

Mappe- og ordreadministrasjon

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 pasientbestillinger.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
FolderName	string	Påkrevd. Det synlige navnet på 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økemappe

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

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

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
ParentFolderUuid	string	Valgfritt. En mappe UUID for å begrense søket til underordnede.
FolderName	string	Valgfritt. Et helt eller delvis navn å søke etter.
GetOrdersInFolder	bool	Valgfritt. Hvis «sant», vil svaret inneholde en liste over pasientbestillinger for hver mappe som er 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. Det gir mulighet for omfattende tilgangskontroll ved å angi en tilpasset tittel, beskrivelse, et passord, en utløpsdato, og spesifisere om innholdet kan lastes ned av mottakeren.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
FolderUuid	string	Påkrevd. Den unike identifikatoren (UUID) for mappen som skal deles.
SharePassword	string	Valgfritt. Et passord for å beskytte den delte koblingen. Hvis den er tom, 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å siden for delt mappe.
ExpireDate	string (YYYY-MM-DD)	Valgfritt. Datoen da delingslenken automatisk blir inaktiv.
UserCanDownloadStudies	bool	Valgfritt. Hvis «sant», kan mottakerne laste ned pasientbestillingene i mappen.

Legg til ordre i mappe

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

Denne funksjonen oppretter en tilknytning mellom en eksisterende pasientordre og en eksisterende mappe. Dette er et organisasjonsverktøy; det flytter ikke eller kopierer data.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
PatientOrderUuid	string	Påkrevd. UUID for pasientordren som skal plasseres i en mappe.
FolderUuidList	List	Påkrevd. En liste som inneholder UUID for målmappen.

Arbeidsflyt og oppgave

Tilordne ordre til bruker

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

Denne funksjonen er et kjerneverktøy for arbeidsflyt. Den tildeler en pasientordre til en individuell bruker, noe som betyr at denne brukeren nå er ansvarlig for en oppgave relatert til den bestillingen (f.eks. rapportering).

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
PatientOrderUuid	string	Påkrevd. UUID for pasientordren som krever handling.
AssignedUserUuid	string	Påkrevd. UUID for den spesifikke brukeren som vil bli tildelt ansvar.

Tilordne rekkefølge til brukergruppe

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

I likhet med å tilordne til en enkelt bruker, tilordner denne funksjonen en pasientordre til en hel gruppe, noe som muliggjør teambaserte arbeidsflyter der ethvert gruppemedlem kan håndtere oppgaven.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
PatientOrderUuid	string	Påkrevd. UUID for pasientordren som skal tilordnes gruppen.
AssignedUserGroupUuid	string	Påkrevd. UUID-en til brukergruppen som skal tilordnes ordren.

Pasientbestillingslivssyklus og datahenting

Opprett pasientordre

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 pasientordre for å planlegge og administrere bildestudier i systemet. Nødvendige parametere må gis for vellykket opprettelse.

Required Parameters	Data Type	Beskrivelse
InstitutionUuid	string	Påkrevd. UUID for institusjonen der pasientordren opprettes.
PatientName	string	Påkrevd. Fullt navn på pasienten.
PatientId	string	Påkrevd. Pasientens unike identifikator, for eksempel en nasjonal ID eller MRN.
PatientBirthdate	string (YYYY-MM-DD)	Påkrevd. Pasientens fødselsdato i ISO-format.
Modality	string	Påkrevd. Modalitetstype som CT, MR, USA, etc.
OtherPatientId	string	Valgfritt. En tilleggsidentifikator for pasienten, hvis aktuelt.
PatientSex	string	Valgfritt. Pasientens kjønn (f.eks. M, F, O).
StudyDescription	string	Valgfritt. Beskrivelse av bildestudien som bestilles.
AccessionNumber	string	Valgfritt. Unikt tiltredelsesnummer for bestillingen, hvis aktuelt.
PatientComplaints	string	Valgfritt. Tekst som beskriver pasientens klager 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. Navn på legen som ba om studien.
ReferringPhysiciansName	string	Valgfritt. Navn på den henvisende legen, hvis forskjellig fra forespørsel.
ScheduledEquipmentUuid	string	Valgfritt. UUID for bildeutstyret som skal brukes til den planlagte prosedyren.

Få pasientbestillingsegenskaper

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

Denne funksjonen henter hele settet med egenskaper for en enkelt, spesifikk pasientordre.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrevd. UUID for institusjonen som ordren tilhører.
PatientOrderUuid	string	Påkrevd. UUID for den spesifikke pasientordren 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. Det muliggjør avansert søkefunksjonalitet for institusjoner som administrerer flere bestillinger.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
InstitutionUuidList	List	Liste over UUID-er som identifiserer institusjonene for å søke etter pasientordrer.
PatientName	string	Valgfritt. Filtrer etter pasientens fulle navn.
PatientId	string	Valgfritt. Filtrer etter pasientens unike identifikator.
OtherPatientId	string	Valgfritt. Sekundær identifikator for pasienten, hvis tilgjengelig.
AccessionNumber	string	Valgfritt. Filtrer etter tiltredelsesnummer tildelt studien.
ModalityList	List	Liste over modaliteter (f.eks. CT, MR, USA) for å filtrere søkeresultatene.
StudyDateFrom	string (YYYY-MM-DD)	Valgfritt. Startdato for studiedatoområdet for filtrering av resultater.
StudyDateTo	string (YYYY-MM-DD)	Valgfritt. Sluttdato for studiedatoområdet for filtrering av resultater.
PatientBirthdateFrom	string (YYYY-MM-DD)	Valgfritt. Startdato for pasientens fødselsdatointervall for å filtrere pasienter etter alder.
PatientBirthdateTo	string (YYYY-MM-DD)	Valgfritt. Sluttdato for pasientens fødselsdatointervall for å filtrere pasienter etter alder.

Slett pasientordre

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

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

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrevd. UUID for institusjonen som eier pasientordren. Sikrer at riktig kontekst brukes til sletting.
PatientOrderUuid	string	Påkrevd. UUID for den spesifikke pasientordren som skal slettes. Dette identifiserer unikt rekkefølgen i systemet.

Få Dicom Tag-innhold

Få DICOM-tag-innhold

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

Denne funksjonen henter verdiene til bestemte DICOM-koder fra bildene som er knyttet til en pasientordre.

Required Parameters	Data Type	Beskrivelse
UserName	string	Brukernavnet (e-postadressen) for PostDicom-kontoen. (fra initialisering)
Password	string	Passordet som er knyttet til PostDicom-kontoen. (fra initialisering)
WebAddress	string	Grunnadressen til API-en. (fra initialisering)
PatientOrderInstitutionUuid	string	Påkrevd. UUID for institusjonen der ordren ligger.
PatientOrderUuid	string	Påkrevd. UUID for ordren som inneholder bildene.
PatientSeriesUuid	string	Valgfritt. Hvis angitt, vil koder bare leses fra denne spesifikke serien.
DicomTagIdList	List	Valgfritt. En liste over DICOM-tag-ID-er som skal hentes.