DiComWeb-palvelun dokumentaatio | PostDiCom

Prerequisites Johdanto & Yleistä tietoa

Tämä asiakirja tarjoaa kattavan teknisen oppaan DICOMweb API funktioita, joissa on esimerkkimenetelmiä, joita käytetään C# -esimerkkisovelluksen kautta. Se sisältää yksityiskohtaiset selitykset kaikista käytettävissä olevista toiminnoista, jotka kattavat molemmat standard DICOMweb services (kuten QIDO-RS, WADO-RS, and STOW-RS) ja custom DICOMweb API endpoints Kehittäjä PostDicom. Nämä toiminnot on suunniteltu käytettäväksi palvelinpuolen puheluissa.

Jotta voit käyttää PostDicomin DiComWeb-palveluita, sinun on ensin otettava tämä ominaisuus käyttöön tililläsi ja sinulla on oltava kelvolliset käyttäjätunnukset. Jos DicomWeb-käyttöoikeutta ei ole vielä aktivoitu tilillesi ja haluat integroida sovelluksesi PostDicomiin, ota meihin yhteyttä pyytääksesi aktivointia.

User Name: Tämä on ensisijainen kirjautumistunnuksesi, yleensä sähköpostiosoitteesi. Se on ainutlaatuinen tilillesi ja sitä käytetään käyttäjänimenä perustodennuksessa.

Password: Tämä on PostDiCom-tiliisi liittyvä salasana. Sitä käytetään yhdessä käyttäjänimesi kanssa perustodennuksen aikana. Optimaalisen turvallisuuden takaamiseksi suosittelemme vahvan salasanan valitsemista. Pidä tarvittavat turvamekanismit palvelinpuoleisessa puhelussa, jotta tämä käyttäjätunnus ja salasana ovat itse suojattuja.

Voit hallita salasanaasi ja suojausasetuksiasi tilisi profiilisivulla, kun olet kirjautunut PostDicom-tilillesi

DicomWeb-vakiopalvelut

DICOM-esiintymien tallentaminen ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Tämä toiminto järjestää kaikkien DCM-tiedostojen lataamisen määritetystä paikallisesta kansiosta DicomWeb-palvelimelle. Se tunnistaa ensin kaikki asiaankuuluvat tiedostot ja käyttää sitten apumenetelmiä todennetun moniosaisen/siihen liittyvän POST-pyynnön rakentamiseen ja lähettämiseen kullekin tiedostolle noudattaen STOW-RS-standardia.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
DirectoryPath	string	Täydellinen polku paikalliseen hakemistoon, joka sisältää ladattavat DICOM (.dcm) -tiedostot.

DICOM-objektien kysely ( QIDO-RS)

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

Tämä toiminto suorittaa DICOM-objektien kyselyn QIDO-RS-standardin avulla, jolloin haut voidaan suorittaa tutkimus-, sarja- tai esiintymistasolla. Annetun hakuparametrin (kuten potilastunnus, tutkimusilmentymän UID tai sarjan ilmentymän UID) perusteella se muodostaa sopivan URL-osoitteen ja suorittaa todennetun pyynnön vastaavien tulosten hakemiseksi palvelimelta.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
PatientID	string	Valinnainen. Käytetään potilaan tunnistamiseen ja siihen liittyvien tutkimusten etsimiseen.
StudyInstanceUID	string	Valinnainen. Käytetään etsimään tiettyä tutkimusta tai kaikkia kyseisen tutkimuksen sarjoja.
SeriesInstanceUID	string	Valinnainen. Käytetään etsimään kaikkia kuvan esiintymiä tietyssä sarjassa.

Hae DICOM-esiintymiä ( WADO-RS)

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

Tämä toiminto tarjoaa interaktiivisen valikon DICOM-objektien hakemiseen WADO-RS-standardin avulla. 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 moniosaisen/siihen liittyvän vastauksen tallentamalla jokaisen DICOM-osan erilliseen.dcm-tiedostona äskettäin luotuun paikalliseen hakemistoon.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
StudyInstanceUID	string	Valinnainen. Globaali yksilöllinen tunniste DICOM-tutkimukselle. Käytetään kaikkien tutkimukseen liittyvien sarjojen ja esiintymien hakemiseen.
SeriesInstanceUID	string	Valinnainen. Maailmanlaajuisesti yksilöllinen tunniste sarjalle DICOM-tutkimuksessa. Käytetään kaikkien kyseisen sarjan kuvien hakemiseen.
SOPInstanceUID	string	Valinnainen. Yksilöllinen tunniste yksittäiselle DICOM-kuva-esiintymälle. Käytetään tietyn kuvan hakemiseen WADO-RS: llä.

Jakamisen hallinta

Luo jakolinkki

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

Tämä toiminto luo suojatun verkkolinkin yhden tai useamman potilastilauksen jakamiseksi ulkoisten käyttäjien kanssa. Linkki voidaan suojata salasanalla ja valinnaisesti sallia lataukset.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDicom-tilin käyttäjänimi (sähköposti). (alustuksesta)
Password	string	PostDicom-tilin salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
PatientOrderInfoList	List	Luettelo JSON-merkkijonoista, joista jokainen sisältää ”PatientOrderUUID” -avaimen, joka tunnistaa jaettavat potilastilaukset.
ExpireDate	string (YYYY-MM-DD)	Jakolinkin viimeinen voimassaolopäivä. Tämän päivämäärän jälkeen linkki poistetaan käytöstä.
SharePassword	string	Valinnainen. Salasana vaaditaan jakolinkin käyttämiseen. Jätä tyhjäksi yleisölle.
Downloadable	bool	Valinnainen. Määrittää, onko vastaanottaja ladattavissa DICOM-tutkimukset.

Jaa potilastilaus URL-osoitteella

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

Tämä toiminto luo jaettavan URL-osoitteen valituille potilastilauksille lisäpääsynvalvontavaihtoehdoilla, kuten latausluvalla ja salasanasuojauksella.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDicom-tilin käyttäjänimi (sähköposti). (alustuksesta)
Password	string	PostDicom-tilin salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
OrderUuidList	List	Luettelo jaettavista potilastilauksista tunnistavista UUID-tunnuksista.
ExpireDate	string (YYYY-MM-DD)	Päivämäärä, jonka jälkeen jakolinkki muuttuu passiiviseksi.
SharePassword	string	Valinnainen. Jaetun linkin käyttämiseen vaaditaan salasana.
UserCanDownloadStudies	bool	Valinnainen. Jos arvo on tosi, vastaanottaja voi ladata opinnot.

Kansioiden ja tilausten hallinta

Luo kansio

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

Tätä toimintoa käytetään uuden kansion (virtuaalisäiliön) luomiseen PostDicom-tilille potilastilausten järjestämisen helpottamiseksi.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
FolderName	string	Vaaditaan. Uuden kansion näkyvä nimi.
FolderDescription	string	Valinnainen. Kansion tekstikuvaus.
ParentFolderUuid	string	Valinnainen. Olemassa olevan kansion UUID uuden kansion luomiseksi sen sisälle.

Hakukansio

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

Tämä toiminto etsii olemassa olevat kansiot hakuehtojen perusteella. Se voi valinnaisesti sisältää luettelon potilastilauksista jokaisessa löydetyssä kansiossa.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
ParentFolderUuid	string	Valinnainen. Kansion UUID, joka rajoittaa haun sen alkeisille.
FolderName	string	Valinnainen. Täydellinen tai osittainen nimi haettavaksi.
GetOrdersInFolder	bool	Valinnainen. Jos ”totta”, 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 kulunvalvonnan asettamalla mukautetun otsikon, kuvauksen, salasanan, vanhentumispäivän ja määrittämällä, voiko vastaanottaja ladata sisällön.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
FolderUuid	string	Vaaditaan. Jaettavan kansion yksilöllinen tunniste (UUID).
SharePassword	string	Valinnainen. Salasana jaetun linkin suojaamiseksi. Jos linkki jätetään tyhjäksi, linkki on julkisesti saatavilla.
ShareTitle	string	Valinnainen. Jaetun kansion sivun mukautettu otsikko, joka näkyy vastaanottajalle.
ShareDescription	string	Valinnainen. Jaetun kansion sivulla näkyy kuvaus.
ExpireDate	string (YYYY-MM-DD)	Valinnainen. Päivämäärä, jolloin jakolinkki muuttuu automaattisesti passiiviseksi.
UserCanDownloadStudies	bool	Valinnainen. Jos ”totta”, vastaanottajat voivat ladata kansioon sisältyvä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 organisaatiotyökalu; se ei siirrä tai kopioi tietoja.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
PatientOrderUuid	string	Vaaditaan. Potilasmääräyksen UUID sijoitetaan kansioon.
FolderUuidList	List	Vaaditaan. Luettelo, joka sisältää kohdekansion UUID-tunnuksen.

Työnkulku ja tehtävä

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

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

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

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
PatientOrderUuid	string	Vaaditaan. Potilastilauksen UUID, joka vaatii toimintaa.
AssignedUserUuid	string	Vaaditaan. Tietyn käyttäjän UUID, jolle annetaan vastuu.

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

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

Samoin kuin yhdelle käyttäjälle määrittäminen, tämä toiminto määrittää potilastilauksen koko ryhmälle, mikä mahdollistaa ryhmäpohjaiset työnkulut, joissa kuka tahansa ryhmän jäsen voi hoitaa tehtävän.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
PatientOrderUuid	string	Vaaditaan. Ryhmälle määritettävän potilasjärjestyksen UUID.
AssignedUserGroupUuid	string	Vaaditaan. Järjestykselle määritetyn käyttäjäryhmän UUID.

Potilastilauksen elinkaari ja tiedonhaku

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 potilasjärjestyksen järjestelmän kuvantamistutkimusten ajoittamiseen ja hallintaan. Tarvittavat parametrit on annettava onnistuneelle luomiselle.

Required Parameters	Data Type	Kuvaus
InstitutionUuid	string	Vaaditaan. Sen laitoksen UUID, jossa potilastilaus luodaan.
PatientName	string	Vaaditaan. Potilaan täydellinen nimi.
PatientId	string	Vaaditaan. Potilaan yksilöllinen tunniste, kuten kansallinen tunnus tai MRN.
PatientBirthdate	string (YYYY-MM-DD)	Vaaditaan. Potilaan syntymäaika ISO-muodossa.
Modality	string	Vaaditaan. Modaalityyppi, kuten CT, MR, US jne.
OtherPatientId	string	Valinnainen. Potilaan lisätunniste tarvittaessa.
PatientSex	string	Valinnainen. Potilaan sukupuoli (esim. M, F, O).
StudyDescription	string	Valinnainen. Kuvaus tilattavasta kuvantamistutkimuksesta.
AccessionNumber	string	Valinnainen. Tilauksen yksilöllinen liittymisnumero, jos sellainen on.
PatientComplaints	string	Valinnainen. Teksti, joka kuvaa potilaan valituksia tai oireita.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Valinnainen. Menettelyn suunniteltu alkamispäivä ja -aika.
RequestedProcedureId	string	Valinnainen. Pyydetyn menettelyn tunniste.
RequestedProcedureDescription	string	Valinnainen. Kuvaus pyydetystä menettelystä.
RequestingPhysician	string	Valinnainen. Tutkimusta pyytäneen lääkärin nimi.
ReferringPhysiciansName	string	Valinnainen. Lähettävän lääkärin nimi, jos se eroaa pyynnöstä.
ScheduledEquipmentUuid	string	Valinnainen. Suunniteltuun toimenpiteeseen käytettävän kuvantamislaitteen UUID.

Potilastilauksen ominaisuuksien hankkiminen

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

Tämä toiminto hakee koko ominaisuusjoukon yksittäiselle potilastilaukselle.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
PatientOrderInstitutionUuid	string	Vaaditaan. Sen laitoksen UUID-tunnus, johon tilaus kuuluu.
PatientOrderUuid	string	Vaaditaan. Noudettavan potilaan määräyksen UUID.

Potilastilausten etsiminen

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

Tämä toiminto hakee luettelon potilastilauksista, jotka perustuvat hakusuodattimien yhdistelmään, kuten potilaan nimi, tunnus, modaliteetti, ja tutkimus- tai syntymäajat. Se mahdollistaa tarkennetun hakutoiminnon laitoksille, jotka hallitsevat useita tilauksia.

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
InstitutionUuidList	List	Luettelo UUID-tunnuksista, jotka tunnistavat laitokset potilastilausten etsimiseksi.
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 annetun liittymisnumeron mukaan.
ModalityList	List	Luettelo tavoista (esim. CT, MR, US) hakutulosten suodattamiseksi.
StudyDateFrom	string (YYYY-MM-DD)	Valinnainen. Tutkimusajanjakson aloituspäivä tulosten suodattamiseksi.
StudyDateTo	string (YYYY-MM-DD)	Valinnainen. Tutkimusajanjakson päättymispäivä tulosten suodattamiseksi.
PatientBirthdateFrom	string (YYYY-MM-DD)	Valinnainen. Potilaan syntymäaika-alueen aloituspäivämäärä potilaiden suodattamiseksi iän mukaan.
PatientBirthdateTo	string (YYYY-MM-DD)	Valinnainen. Potilaan syntymäaika-alueen päättymispäivämäärä potilaiden suodattamiseksi iän mukaan.

Potilastilauksen poistaminen

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

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

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
PatientOrderInstitutionUuid	string	Vaaditaan. Potilastilauksen omistavan laitoksen UUID. Varmistaa, että poistamiseen käytetään oikeaa kontekstia.
PatientOrderUuid	string	Vaaditaan. Poistettavan potilasjärjestyksen UUID. Tämä yksilöi yksiselitteisesti järjestelmän järjestyksen.

Hanki Dicom Tag -sisältö

Hanki DICOM-tunnistesisältö

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

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

Required Parameters	Data Type	Kuvaus
UserName	string	PostDiCom-tilin käyttäjänimi (sähköpostiosoite). (alustuksesta)
Password	string	PostDicom-tiliin liittyvä salasana. (alustuksesta)
WebAddress	string	Sovellusliittymän perusURL-osoite. (alustuksesta)
PatientOrderInstitutionUuid	string	Vaaditaan. Sen laitoksen UUID, jossa tilaus sijaitsee.
PatientOrderUuid	string	Vaaditaan. Kuvat sisältävän tilauksen UUID.
PatientSeriesUuid	string	Valinnainen. Jos niitä tarjotaan, tunnisteet luetaan vain tästä tietystä sarjasta.
DicomTagIdList	List	Valinnainen. Luettelo haettavista DICOM-tunnistetunnuksista.