DICOMweb-dokumentaatio

PrerequisitesJohdanto ja yleistietoa

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

Käyttääksesi PostDICOMin DICOMweb-palveluita, tämän ominaisuuden on oltava ensin otettuna käyttöön 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 PostDICOMin kanssa, ota meihin yhteyttä aktivoinnin pyytämiseksi.

Käyttäjänimi: Tämä on ensisijainen kirjautumistunnuksesi, yleensä sähköpostiosoitteesi. Se on tilikohtainen ja sitä käytetään käyttäjänimenä Basic-todennuksessa.

Salasana: Tämä on PostDICOM-tiliisi liitetty salasana. Sitä käytetään yhdessä käyttäjänimesi kanssa Basic-todennuksessa. Optimaalisen turvallisuuden takaamiseksi suosittelemme vahvan salasanan valitsemista. Varmista tarvittavat tietoturvamekanismit palvelinpuolen kutsussasi, jotta käyttäjänimi ja salasana ovat suojattuina.

Voit hallita salasanaasi ja suojausasetuksiasi tilisi profiilisivulta sen jälkeen, kun olet kirjautunut sisään PostDICOM-tilillesi.

DICOMwebDICOMweb-standardipalvelut

Tallenna DICOM-instansseja (STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Tämä toiminto ohjaa kaikkien .dcm-tiedostojen lataamista määritetystä paikallisesta kansiosta DICOMweb-palvelimelle. Se tunnistaa ensin kaikki olennaiset 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änimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty salasana. (alustuksesta)
WebAddress string API:n perus-URL-osoite. (alustuksesta)
DirectoryPath string Ladattavien DICOM (.dcm) -tiedostojen sisältävän paikallisen hakemiston koko polku.

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, mikä mahdollistaa haut tutkimus-, sarja- tai instanssitasolla. Annetun hakuparametrin (kuten potilastunnus, tutkimuksen instanssin UID tai sarjan instanssin UID) perusteella se muodostaa asianmukaisen URL-osoitteen ja suorittaa todennetun pyynnön vastaavien tulosten hakemiseksi palvelimelta.

Pakolliset parametrit Tietotyyppi Kuvaus
UserName string PostDICOM-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty salasana. (alustuksesta)
WebAddress string API:n perus-URL-osoite. (alustuksesta)
PatientID string Valinnainen. Käytetään potilaan tunnistamiseen ja asiaan liittyvien tutkimusten etsimiseen.
StudyInstanceUID string Valinnainen. Käytetään tietyn tutkimuksen tai kaikkien kyseisen tutkimuksen sarjojen etsimiseen.
SeriesInstanceUID string Valinnainen. Käytetään kaikkien kuvainstanssien etsimiseen tietyssä sarjassa.

Hae DICOM-instansseja (WADO-RS)

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

Tämä toiminto tarjoaa interaktiivisen valikon DICOM-objektien hakemiseksi WADO-RS-standardia käyttäen. Käyttäjä valitsee hakutason (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 juuri luotuun paikalliseen hakemistoon.

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

ShareJakamisen 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 se voi valinnaisesti sallia lataukset.

Pakolliset parametrit Tietotyyppi Kuvaus
UserName string PostDICOM-tilin käyttäjänimi (sähköposti). (alustuksesta)
Password string PostDICOM-tilin salasana. (alustuksesta)
WebAddress string API:n perus-URL-osoite. (alustuksesta)
PatientOrderInfoList List<string> Luettelo JSON-merkkijonoista, joista jokainen sisältää "PatientOrderUuid"-avaimen, joka yksilöi jaettavat potilastilaukset.
ExpireDate string (YYYY-MM-DD) 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 käyttöoikeutta 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, joissa on ylimääräisiä pääsynhallintavaihtoehtoja, kuten latauslupa ja salasanasuojaus.

Pakolliset parametrit Tietotyyppi Kuvaus
UserName string PostDICOM-tilin käyttäjänimi (sähköposti). (alustuksesta)
Password string PostDICOM-tilin salasana. (alustuksesta)
WebAddress string API:n perus-URL-osoite. (alustuksesta)
OrderUuidList List<string> Luettelo UUID:istä, jotka yksilöivät jaettavat potilastilaukset.
ExpireDate string (YYYY-MM-DD) Päivämäärä, jonka jälkeen jakolinkki muuttuu passiiviseksi.
SharePassword string Valinnainen. Jaetun linkin käyttämiseen vaadittava salasana.
UserCanDownloadStudies bool Valinnainen. Jos asetus on tosi (true), vastaanottaja voi ladata tutkimukset.

FolderKansioiden ja tilausten hallinta

Luo kansio

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

Tätä toimintoa käytetään uuden kansion (virtuaalisen säiliön) luomiseen PostDICOM-tilille potilastilausten järjestämiseksi.

Pakolliset parametrit Tietotyyppi Kuvaus
UserName string PostDICOM-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty 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 uuden kansion luomiseksi sen sisään.

Etsi kansio

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

Tämä toiminto etsii olemassa olevia kansioita hakuehtojen perusteella. Se voi valinnaisesti sisällyttää luettelon potilastilauksista kuhunkin löydettyyn kansioon.

Pakolliset parametrit Tietotyyppi Kuvaus
UserName string PostDICOM-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty salasana. (alustuksesta)
WebAddress string API:n perus-URL-osoite. (alustuksesta)
ParentFolderUuid string Valinnainen. Kansion UUID haun rajaamiseksi sen alikansioihin.
FolderName string Valinnainen. Koko nimi tai osittainen nimi etsintää varten.
GetOrdersInFolder bool Valinnainen. Jos asetus on tosi (`true`), vastaus sisältää luettelon potilastilauksista jokaiselle 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 pääsynhallinnan asettamalla mukautetun otsikon, kuvauksen, salasanan ja vanhenemispäivän sekä määrittämällä, voiko vastaanottaja ladata sisällön.

Pakolliset parametrit Tietotyyppi Kuvaus
UserName string PostDICOM-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty 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 se jätetään tyhjäksi, linkki on julkisesti saatavilla.
ShareTitle string Valinnainen. Mukautettu otsikko jaetun kansion sivulle, joka näkyy vastaanottajalle.
ShareDescription string Valinnainen. Jaetun kansion sivulla näytettävä kuvaus.
ExpireDate string (YYYY-MM-DD) Valinnainen. Päivämäärä, jolloin jakolinkki muuttuu automaattisesti passiiviseksi.
UserCanDownloadStudies bool Valinnainen. Jos asetus on tosi (`true`), vastaanottajat voivat ladata kansiossa olevat 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 tietoja.

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

WorkflowTyönkulku ja jako

Osoita tilaus käyttäjälle

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

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

Pakolliset parametrit Tietotyyppi Kuvaus
UserName string PostDICOM-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty 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 osoitetaan.

Osoita tilaus käyttäjäryhmälle

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

Samalla tavalla kuin yksittäiselle käyttäjälle osoittaminen, tämä toiminto osoittaa potilastilauksen koko ryhmälle, mikä mahdollistaa 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änimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty salasana. (alustuksesta)
WebAddress string API:n perus-URL-osoite. (alustuksesta)
PatientOrderUuid string Pakollinen. Ryhmälle osoitettavan potilastilauksen UUID.
AssignedUserGroupUuid string Pakollinen. Sen käyttäjäryhmän UUID, jolle tilaus osoitetaan.

Patient OrderPotilastilauksen 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 ajoittamista ja hallintaa varten järjestelmässä. Onnistunut luominen edellyttää pakollisten parametrien antamista.

Pakolliset parametrit Tietotyyppi Kuvaus
InstitutionUuid string Pakollinen. Sen laitoksen UUID, johon potilastilausta luodaan.
PatientName string Pakollinen. Potilaan koko nimi.
PatientId string Pakollinen. Potilaan yksilöllinen tunniste, kuten henkilötunnus tai potilasnumero (MRN).
PatientBirthdate string (YYYY-MM-DD) Pakollinen. Potilaan syntymäaika ISO-muodossa.
Modality string Pakollinen. Modaliteetin tyyppi, kuten TT, MK, UÄ jne.
OtherPatientId string Valinnainen. Potilaan lisätunniste, jos sovellettavissa.
PatientSex string Valinnainen. Potilaan sukupuoli (esim. M, F, O).
StudyDescription string Valinnainen. Tilattavan kuvantamistutkimuksen kuvaus.
AccessionNumber string Valinnainen. Tilauksen yksilöllinen tilausnumero (Accession Number), jos sovellettavissa.
PatientComplaints string Valinnainen. Teksti, joka kuvaa potilaan vaivoja tai oireita.
OrderScheduledDatetime string (YYYY-MM-DD 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ä lääkäri.
ScheduledEquipmentUuid string Valinnainen. Suunnitellussa toimenpiteessä käytettävän kuvantamislaitteen UUID.

Hae potilastilauksen ominaisuudet

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

Tämä toiminto hakee yksittäisen, tietyn potilastilauksen täydelliset ominaisuudet.

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

Etsi potilastilauksia

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

Tämä toiminto hakee luettelon potilastilauksista perustuen hakusuodattimien yhdistelmään, kuten potilaan nimi, tunniste, modaliteetti sekä tutkimus- tai syntymäaika. Se mahdollistaa edistyneet hakutoiminnot laitoksille, jotka hallinnoivat useita tilauksia.

Pakolliset parametrit Tietotyyppi Kuvaus
UserName string PostDICOM-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty salasana. (alustuksesta)
WebAddress string API:n perus-URL-osoite. (alustuksesta)
InstitutionUuidList List<string> Luettelo UUID:istä, jotka yksilöivät laitokset, joista potilastilauksia etsitään.
PatientName string Valinnainen. Suodata potilaan koko nimen mukaan.
PatientId string Valinnainen. Suodata potilaan yksilöllisen tunnisteen mukaan.
OtherPatientId string Valinnainen. Potilaan toissijainen tunniste, jos saatavilla.
AccessionNumber string Valinnainen. Suodata tutkimukselle määritetyn tilausnumeron mukaan.
ModalityList List<string> Luettelo modaliteeteista (esim. TT, MK, UÄ) hakutulosten suodattamiseksi.
StudyDateFrom string (YYYY-MM-DD) Valinnainen. Tutkimuksen päivämäärävälin alkamispäivä tulosten suodattamiseksi.
StudyDateTo string (YYYY-MM-DD) Valinnainen. Tutkimuksen päivämäärävälin päättymispäivä tulosten suodattamiseksi.
PatientBirthdateFrom string (YYYY-MM-DD) Valinnainen. Potilaan syntymäaikavälin alkamispäivä potilaiden suodattamiseksi iän perusteella.
PatientBirthdateTo string (YYYY-MM-DD) Valinnainen. Potilaan syntymäaikavälin päättymispäivä potilaiden suodattamiseksi iän perusteella.

Poista potilastilaus

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

Tämä toiminto poistaa potilastilauksen pysyvästi järjestelmästä. 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änimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty salasana. (alustuksesta)
WebAddress string API:n perus-URL-osoite. (alustuksesta)
PatientOrderInstitutionUuid string Pakollinen. Laitoksen UUID, joka omistaa potilastilauksen. Varmistaa, että poistossa käytetään oikeaa kontekstia.
PatientOrderUuid string Pakollinen. Poistettavan potilastilauksen UUID. Tämä yksilöi tilauksen järjestelmässä.

Dicom TagHae 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änimi (sähköpostiosoite). (alustuksesta)
Password string PostDICOM-tiliin liitetty salasana. (alustuksesta)
WebAddress string API:n perus-URL-osoite. (alustuksesta)
PatientOrderInstitutionUuid string Pakollinen. 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<string> Valinnainen. Luettelo haettavista DICOM-tunnisteiden tunnuksista (ID).