DICOMweb-palvelun dokumentaatio | PostDICOM

Prerequisites Johdanto ja yleistä tietoa

Tämä asiakirja tarjoaa kattavan teknisen oppaan DICOMweb API -toiminnoille sekä esimerkkimenetelmiä, joita käytetään C#-esimerkkisovelluksessa. Se sisältää yksityiskohtaiset selitykset kaikista käytettävissä olevista toiminnoista, kattaen sekä standardinmukaiset DICOMweb-palvelut (kuten QIDO-RS, WADO-RS ja STOW-RS) että PostDICOM kehittämät mukautetut DICOMweb API -päätepisteet. Nämä toiminnot on suunniteltu käytettäväksi palvelinpuolen kutsuissa.

Jotta voit käyttää PostDICOM DICOMweb-palveluita, sinulla on ensin oltava tämä ominaisuus käytössä tililläsi ja sinulla on oltava voimassa olevat käyttäjätunnukset. Jos DICOMweb-käyttöoikeutta ei ole vielä aktivoitu tilillesi ja haluat integroida sovelluksesi PostDICOMiin, ota meihin yhteyttä aktivoinnin pyytämiseksi.

Käyttäjätunnus (User Name): Tämä on ensisijainen kirjautumistunnuksesi, yleensä sähköpostiosoitteesi. Se on tilikohtainen ja sitä käytetään käyttäjätunnuksena Basic Authentication -todennuksessa.

Salasana (Password): Tämä on PostDICOM-tiliisi liittyvä salasana. Sitä käytetään yhdessä käyttäjätunnuksesi kanssa Basic Authentication -todennuksessa. Optimaalisen turvallisuuden takaamiseksi suosittelemme vahvan salasanan valitsemista. Varmista, että palvelinpuolen kutsussasi on tarvittavat turvamekanismit, jotta tämä käyttäjätunnus ja salasana pysyvät suojattuina.

Voit hallita salasanasi ja turvallisuusasetuksiasi tiliprofiilisivullasi kirjauduttuasi sisään PostDICOM-tilillesi.

Standardinmukaiset DICOMweb-palvelut

Tallenna DICOM-instanssit (STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Tämä toiminto hallinnoi kaikkien .dcm-tiedostojen lataamista määritetystä paikallisesta kansiosta DICOMweb-palvelimelle. Se tunnistaa ensin kaikki asiaankuuluvat tiedostot ja käyttää sitten apumenetelmiä rakentaakseen ja lähettääkseen todennetun multipart/related POST-pyynnön jokaiselle tiedostolle noudattaen STOW-RS-standardia.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
DirectoryPath	string	Koko polku paikalliseen hakemistoon, joka sisältää ladattavat DICOM-tiedostot (.dcm).

Kysely DICOM-objekteille (QIDO-RS)

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

Tämä toiminto suorittaa kyselyn DICOM-objekteille käyttäen QIDO-RS-standardia, mahdollistaen haut Tutkimus-, Sarja- tai Instanssi-tasolla. Annetun hakuparametrin (kuten potilastunniste, tutkimuksen instanssi-UID tai sarjan instanssi-UID) perusteella se rakentaa asianmukaisen URL-osoitteen ja suorittaa todennetun pyynnön vastaavien tulosten hakemiseksi palvelimelta.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
PatientID	string	Valinnainen. Käytetään potilaan tunnistamiseen ja liittyvien tutkimusten hakemiseen.
StudyInstanceUID	string	Valinnainen. Käytetään tietyn tutkimuksen tai kaikkien kyseisen tutkimuksen sarjojen hakemiseen.
SeriesInstanceUID	string	Valinnainen. Käytetään kaikkien kuva-instanssien hakemiseen tietystä sarjasta.

Nouda DICOM-instanssit (WADO-RS)

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

Tämä toiminto tarjoaa interaktiivisen valikon DICOM-objektien noutamiseen WADO-RS-standardia käyttäen. Käyttäjä valitsee noutotason (Tutkimus, Sarja tai Instanssi) ja antaa vastaavan UID:n. Tämän jälkeen toiminto tekee todennetun pyynnön ja käsittelee multipart/related-vastauksen tallentaen jokaisen DICOM-osan erillisenä .dcm-tiedostona uuteen paikalliseen hakemistoon.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
StudyInstanceUID	string	Valinnainen. Globaalisti yksilöllinen tunniste DICOM-tutkimukselle. Käytetään kaikkien kyseiseen tutkimukseen liittyvien sarjojen ja instanssien noutamiseen.
SeriesInstanceUID	string	Valinnainen. Globaalisti yksilöllinen tunniste sarjalle DICOM-tutkimuksen sisällä. Käytetään kaikkien kyseisen sarjan kuvien noutamiseen.
SOPInstanceUID	string	Valinnainen. Yksilöllinen tunniste yksittäiselle DICOM-kuvainstanssille. Käytetään tietyn kuvan noutamiseen WADO-RS:n avulla.

Jaon hallinta

Luo jakolinkki

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

Tämä toiminto luo turvallisen verkkolinkin yhden tai useamman potilastilauksen jakamiseksi ulkoisille käyttäjille. Linkki voidaan suojata salasanalla, ja lataaminen voidaan valinnaisesti sallia.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköposti). (alustuksesta)
Password	string	PostDICOM-tilin salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
PatientOrderInfoList	List	Lista JSON-merkkijonoja, joista jokainen sisältää "PatientOrderUuid"-avaimen, joka tunnistaa jaettavat potilastilaukset.
ExpireDate	string (VVVV-KK-PP)	Jakolinkin vanhenemispäivä. Tämän päivämäärän jälkeen linkki poistetaan käytöstä.
SharePassword	string	Valinnainen. Jakolinkin käyttämiseen vaadittava salasana. Jätä tyhjäksi julkista pääsyä varten.
Downloadable	bool	Valinnainen. Määrittää, voiko vastaanottaja ladata DICOM-tutkimukset.

Jaa potilastilaus URL-osoitteella

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

Tämä toiminto luo jaettavan URL-osoitteen valituille potilastilauksille lisäkäyttöoikeusasetuksilla, kuten latausluvalla ja salasanasuojauksella.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköposti). (alustuksesta)
Password	string	PostDICOM-tilin salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
OrderUuidList	List	Lista jaettavien potilastilausten UUID-tunnisteista.
ExpireDate	string (VVVV-KK-PP)	Päivämäärä, jonka jälkeen jakolinkki muuttuu passiiviseksi.
SharePassword	string	Valinnainen. Jaetun linkin käyttämiseen vaadittava salasana.
UserCanDownloadStudies	bool	Valinnainen. Jos asetettu arvoon true, vastaanottaja voi ladata tutkimukset.

Kansioiden ja tilausten hallinta

Luo kansio

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

Tätä toimintoa käytetään uuden kansion (virtuaalisen säilön) luomiseen PostDICOM-tilille potilastilausten organisoinnin helpottamiseksi.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
FolderName	string	Pakollinen. Uuden kansion näkyvä nimi.
FolderDescription	string	Valinnainen. Kansion tekstikuvaus.
ParentFolderUuid	string	Valinnainen. Olemassa olevan kansion UUID, jotta uusi kansio voidaan luoda sen sisälle.

Etsi kansio

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

Tämä toiminto etsii olemassa olevia kansioita hakukriteerien perusteella. Se voi valinnaisesti sisällyttää luettelon kunkin löydetyn kansion sisältämistä potilastilauksista.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
ParentFolderUuid	string	Valinnainen. Kansion UUID haun rajaamiseksi sen alikansioihin.
FolderName	string	Valinnainen. Etsittävä nimi kokonaan tai osittain.
GetOrdersInFolder	bool	Valinnainen. Jos `true`, vastaus sisältää luettelon potilastilauksista kullekin löydetylle kansiolle.

Jaa kansio URL-osoitteella

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

Tämä toiminto luo turvallisen, jaettavan URL-osoitteen koko kansiolle ja sen sisällölle. Se mahdollistaa kattavan käytönhallinnan asettamalla mukautetun otsikon, kuvauksen, salasanan, vanhenemispäivän ja määrittämällä, voiko vastaanottaja ladata sisällön.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
FolderUuid	string	Pakollinen. Jaettavan kansion yksilöllinen tunniste (UUID).
SharePassword	string	Valinnainen. Salasana jaetun linkin suojaamiseksi. Jos jätetään tyhjäksi, linkki on julkisesti käytettävissä.
ShareTitle	string	Valinnainen. Jaetun kansion sivun mukautettu otsikko, joka näkyy vastaanottajalle.
ShareDescription	string	Valinnainen. Kuvaus, joka näytetään jaetun kansion sivulla.
ExpireDate	string (VVVV-KK-PP)	Valinnainen. Päivämäärä, jolloin jakolinkki muuttuu automaattisesti passiiviseksi.
UserCanDownloadStudies	bool	Valinnainen. Jos `true`, vastaanottajat voivat ladata kansion sisältämät potilastilaukset.

Lisää tilaus kansioon

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

Tämä toiminto luo yhteyden olemassa olevan potilastilauksen ja olemassa olevan kansion välille. Tämä on organisointityökalu; se ei siirrä tai kopioi dataa.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
PatientOrderUuid	string	Pakollinen. Kansioon sijoitettavan potilastilauksen UUID.
FolderUuidList	List	Pakollinen. Luettelo, joka sisältää kohdekansion UUID:n.

Työnkulku ja määritykset

Määritä tilaus käyttäjälle

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

Tämä toiminto on keskeinen työnkulun työkalu. Se määrittää potilastilauksen yksittäiselle käyttäjälle, mikä tarkoittaa, että kyseinen käyttäjä on nyt vastuussa tilaukseen liittyvästä tehtävästä (esim. raportointi).

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
PatientOrderUuid	string	Pakollinen. Toimenpiteitä vaativan potilastilauksen UUID.
AssignedUserUuid	string	Pakollinen. Sen tietyn käyttäjän UUID, jolle vastuu määritetään.

Määritä tilaus käyttäjäryhmälle

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

Kuten yksittäiselle käyttäjälle määrittämisessä, tämä toiminto määrittää potilastilauksen koko ryhmälle, mahdollistaen tiimipohjaiset työnkulut, joissa kuka tahansa ryhmän jäsen voi hoitaa tehtävän.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
PatientOrderUuid	string	Pakollinen. Ryhmälle määritettävän potilastilauksen UUID.
AssignedUserGroupUuid	string	Pakollinen. Tilauksen vastaanottavan käyttäjäryhmän UUID.

Potilastilauksen elinkaari ja tietojen haku

Luo potilastilaus

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

Tämä toiminto luo uuden potilastilauksen kuvantamistutkimusten aikatauluttamiseksi ja hallitsemiseksi järjestelmässä. Onnistuneen luomisen takaamiseksi pakolliset parametrit on annettava.

Pakolliset parametrit	Tietotyyppi	Kuvaus
InstitutionUuid	string	Pakollinen. Sen laitoksen UUID, jossa potilastilaus luodaan.
PatientName	string	Pakollinen. Potilaan koko nimi.
PatientId	string	Pakollinen. Potilaan yksilöllinen tunniste, kuten henkilötunnus tai MRN.
PatientBirthdate	string (VVVV-KK-PP)	Pakollinen. Potilaan syntymäaika ISO-muodossa.
Modality	string	Pakollinen. Modaliteetin tyyppi, kuten CT, MR, US jne.
OtherPatientId	string	Valinnainen. Potilaan lisätunniste, jos sovellettavissa.
PatientSex	string	Valinnainen. Potilaan sukupuoli (esim. M, F, O).
StudyDescription	string	Valinnainen. Tilatun kuvantamistutkimuksen kuvaus.
AccessionNumber	string	Valinnainen. Tilauksen yksilöllinen tutkimusnumero (Accession Number), jos sovellettavissa.
PatientComplaints	string	Valinnainen. Teksti, joka kuvaa potilaan vaivoja tai oireita.
OrderScheduledDatetime	string (VVVV-KK-PP HH:MM)	Valinnainen. Toimenpiteen ajoitettu alkamispäivä ja -aika.
RequestedProcedureId	string	Valinnainen. Pyydetyn toimenpiteen tunniste.
RequestedProcedureDescription	string	Valinnainen. Pyydetyn toimenpiteen kuvaus.
RequestingPhysician	string	Valinnainen. Tutkimuksen pyytäneen lääkärin nimi.
ReferringPhysiciansName	string	Valinnainen. Lähettävän lääkärin nimi, jos eri kuin pyytävä.
ScheduledEquipmentUuid	string	Valinnainen. Ajoitetussa toimenpiteessä käytettävän kuvantamislaitteen UUID.

Hae potilastilauksen ominaisuudet

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

Tämä toiminto hakee täydelliset ominaisuustiedot yhdelle tietylle potilastilaukselle.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
PatientOrderInstitutionUuid	string	Pakollinen. Sen laitoksen UUID, johon tilaus kuuluu.
PatientOrderUuid	string	Pakollinen. Haettavan potilastilauksen UUID.

Etsi potilastilauksia

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

Tämä toiminto hakee luettelon potilastilauksista hakusuodattimien, kuten potilaan nimen, tunnisteen, modaliteetin sekä tutkimus- tai syntymäpäivämäärien perusteella. Se mahdollistaa edistyneet hakutoiminnot laitoksille, jotka hallinnoivat useita tilauksia.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
InstitutionUuidList	List	Luettelo laitosten UUID-tunnisteista, joista potilastilauksia haetaan.
PatientName	string	Valinnainen. Suodata potilaan koko nimen perusteella.
PatientId	string	Valinnainen. Suodata potilaan yksilöllisen tunnisteen perusteella.
OtherPatientId	string	Valinnainen. Toissijainen tunniste potilaalle, jos saatavilla.
AccessionNumber	string	Valinnainen. Suodata tutkimukselle määritetyn tutkimusnumeron (Accession Number) perusteella.
ModalityList	List	Luettelo modaliteeteista (esim. CT, MR, US), joilla hakutuloksia suodatetaan.
StudyDateFrom	string (VVVV-KK-PP)	Valinnainen. Tutkimuspäivämääräalueen alkamispäivä tulosten suodattamiseksi.
StudyDateTo	string (VVVV-KK-PP)	Valinnainen. Tutkimuspäivämääräalueen päättymispäivä tulosten suodattamiseksi.
PatientBirthdateFrom	string (VVVV-KK-PP)	Valinnainen. Potilaan syntymäpäiväalueen alkamispäivä potilaiden suodattamiseksi iän mukaan.
PatientBirthdateTo	string (VVVV-KK-PP)	Valinnainen. Potilaan syntymäpäiväalueen päättymispäivä potilaiden suodattamiseksi iän mukaan.

Poista potilastilaus

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

Tämä toiminto poistaa potilastilauksen järjestelmästä pysyvästi. Se vaatii sekä laitoksen UUID:n että tietyn potilastilauksen UUID:n tarkkuuden varmistamiseksi ja tahattoman poistamisen estämiseksi.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
PatientOrderInstitutionUuid	string	Pakollinen. Sen laitoksen UUID, joka omistaa potilastilauksen. Varmistaa, että poistamisessa käytetään oikeaa kontekstia.
PatientOrderUuid	string	Pakollinen. Poistettavan potilastilauksen UUID. Tämä tunnistaa tilauksen yksilöllisesti järjestelmässä.

Hae DICOM-tunnisteen sisältö

Hae DICOM-tunnisteen sisältö

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

Tämä toiminto hakee tiettyjen DICOM-tunnisteiden arvot potilastilaukseen liittyvistä kuvista.

Pakolliset parametrit	Tietotyyppi	Kuvaus
UserName	string	PostDICOM-tilin käyttäjätunnus (sähköpostiosoite). (alustuksesta)
Password	string	PostDICOM-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	API:n perus-URL-osoite. (alustuksesta)
PatientOrderInstitutionUuid	string	Pakollinen. Sen laitoksen UUID, jossa tilaus sijaitsee.
PatientOrderUuid	string	Pakollinen. Kuvat sisältävän tilauksen UUID.
PatientSeriesUuid	string	Valinnainen. Jos annettu, tunnisteet luetaan vain tästä tietystä sarjasta.
DicomTagIdList	List	Valinnainen. Luettelo haettavista DICOM-tunnisteista (Tag ID).