Documentazione del servizio DiCOMWeb | PostDICOM

Prerequisites Introduzione e informazioni generali

Questo documento fornisce una guida tecnica completa per DICOMweb API funziona con metodi di esempio utilizzati tramite un'applicazione di esempio C#. Include spiegazioni dettagliate di tutte le funzioni disponibili, che coprono entrambe standard DICOMweb services (ad esempio QIDO-RS, WADO-RS, and STOW-RS) e custom DICOMweb API endpoints sviluppato da PostDiCOM. Queste funzioni sono progettate per essere utilizzate nelle chiamate lato server.

Per utilizzare i servizi DiCOMWeb di PostDicom, devi prima avere questa funzione abilitata per il tuo account e possedere credenziali utente valide. Se l'accesso a DiCOMWeb non è ancora attivato per il tuo account e desideri integrare la tua applicazione con PostDICOM, contattaci per richiedere l'attivazione.

User Name: Questa è la tua credenziale di accesso principale, in genere il tuo indirizzo email. È univoca per il tuo account e viene utilizzata come nome utente nell'autenticazione di base.

Password: Questa è la password associata al tuo account PostDICOM. Viene utilizzata insieme al nome utente durante l'autenticazione di base. Per una sicurezza ottimale, consigliamo vivamente di scegliere una password sicura. Vi preghiamo di dotarvi dei necessari meccanismi di sicurezza sul vostro server, in modo che il nome utente e la password siano protetti da voi stessi.

Puoi gestire la password e le impostazioni di sicurezza tramite la pagina del profilo del tuo account dopo aver effettuato l'accesso al tuo account PostDICOM

Servizi standard DICOMWeb

Archivia istanze DICOM ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Questa funzione orchestra il caricamento di tutti i file .dcm da una cartella locale specificata sul server DICOMWeb. Identifica innanzitutto tutti i file pertinenti, quindi utilizza metodi di supporto per creare e inviare una richiesta POST autenticata multiparte/correlata per ogni file, in conformità allo standard STOW-RS.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
DirectoryPath	string	Il percorso completo della directory locale contenente i file DICOM (.dcm) da caricare.

Interrogazione per oggetti DICOM ( QIDO-RS)

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

Questa funzione esegue un'interrogazione per oggetti DICOM utilizzando lo standard QIDO-RS, abilitando le ricerche a livello di studio, serie o istanza. In base al parametro di ricerca fornito (come Patient ID, Study Instance UID o Series Instance UID), costruisce l'URL appropriato ed esegue una richiesta autenticata per recuperare i risultati corrispondenti dal server.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
PatientID	string	Facoltativo Utilizzato per identificare il paziente e cercare studi correlati.
StudyInstanceUID	string	Facoltativo Utilizzato per cercare uno studio specifico o tutte le serie all'interno di quello studio.
SeriesInstanceUID	string	Facoltativo Utilizzato per cercare tutte le istanze di immagini all'interno di una serie specifica.

Recupera istanze DICOM ( WADO-RS)

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

Questa funzione fornisce un menu interattivo per recuperare oggetti DICOM utilizzando lo standard WADO-RS. L'utente seleziona un livello di recupero (Studio, Serie o Istanza) e fornisce l'UID corrispondente. La funzione effettua quindi una richiesta autenticata ed elabora la risposta multiparte/correlata, salvando ogni parte DICOM come file .dcm separato in una directory locale appena creata.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
StudyInstanceUID	string	Facoltativo Un identificatore univoco globale per uno studio DICOM. Utilizzato per recuperare tutte le serie e le istanze associate a tale studio.
SeriesInstanceUID	string	Facoltativo Un identificatore univoco globale per una serie all'interno di uno studio DICOM. Utilizzato per recuperare tutte le immagini di quella serie.
SOPInstanceUID	string	Facoltativo Un identificatore univoco per una singola istanza di immagine DICOM. Utilizzato per recuperare un'immagine specifica utilizzando WADO-RS.

Gestione della condivisione

Crea link di condivisione

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

Questa funzione genera un link web sicuro per condividere uno o più ordini dei pazienti con utenti esterni. Il link può essere protetto da password e, facoltativamente, consentire il download.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password per l'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
PatientOrderInfoList	List	Elenco di stringhe JSON, ciascuna contenente una chiave «PatientOrderUUID», che identifica gli ordini dei pazienti da condividere.
ExpireDate	string (YYYY-MM-DD)	Data di scadenza del link di condivisione. Dopo questa data, il link verrà disabilitato.
SharePassword	string	Facoltativo È richiesta la password per accedere al link di condivisione. Lascia vuoto per l'accesso pubblico.
Downloadable	bool	Facoltativo Determina se gli studi DICOM sono scaricabili dal destinatario.

Condividi l'ordine del paziente con l'URL

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

Questa funzione genera un URL condivisibile per gli ordini dei pazienti selezionati con opzioni di controllo degli accessi aggiuntive come l'autorizzazione al download e la protezione con password.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (email) dell'account PostDICOM. (dall'inizializzazione)
Password	string	La password per l'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
OrderUuidList	List	Elenco degli UUID che identificano gli ordini dei pazienti da condividere.
ExpireDate	string (YYYY-MM-DD)	Data dopo la quale il link di condivisione diventa inattivo.
SharePassword	string	Facoltativo Password richiesta per accedere al link condiviso.
UserCanDownloadStudies	bool	Facoltativo Se impostato su true, il destinatario può scaricare gli studi.

Gestione delle cartelle e degli ordini

Crea cartella

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

Questa funzione viene utilizzata per creare una nuova cartella (un contenitore virtuale) all'interno dell'account PostDICOM per aiutare a organizzare gli ordini dei pazienti.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
FolderName	string	Obbligatorio. Il nome visibile della nuova cartella.
FolderDescription	string	Facoltativo Una descrizione testuale per la cartella.
ParentFolderUuid	string	Facoltativo L'UUID di una cartella esistente per creare la nuova cartella al suo interno.

Cartella di ricerca

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

Questa funzione trova le cartelle esistenti in base a criteri di ricerca. Può opzionalmente includere l'elenco degli ordini dei pazienti all'interno di ciascuna cartella trovata.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
ParentFolderUuid	string	Facoltativo Un UUID di cartella per limitare la ricerca ai suoi figli.
FolderName	string	Facoltativo Un nome completo o parziale da cercare.
GetOrdersInFolder	bool	Facoltativo Se è vero, la risposta includerà un elenco degli ordini dei pazienti per ogni cartella trovata.

Condividi cartella con URL

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

Questa funzione genera un URL sicuro e condivisibile per un'intera cartella e il suo contenuto. Consente un controllo completo degli accessi impostando un titolo personalizzato, una descrizione, una password, una data di scadenza e specificando se i contenuti possono essere scaricati dal destinatario.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
FolderUuid	string	Obbligatorio. L'identificatore univoco (UUID) della cartella da condividere.
SharePassword	string	Facoltativo Una password per proteggere il link condiviso. Se lasciato vuoto, il link sarà accessibile al pubblico.
ShareTitle	string	Facoltativo Un titolo personalizzato per la pagina della cartella condivisa, visibile al destinatario.
ShareDescription	string	Facoltativo Una descrizione visualizzata nella pagina della cartella condivisa.
ExpireDate	string (YYYY-MM-DD)	Facoltativo La data in cui il link di condivisione diventerà automaticamente inattivo.
UserCanDownloadStudies	bool	Facoltativo Se è vero, i destinatari possono scaricare gli ordini dei pazienti contenuti nella cartella.

Aggiungi ordine alla cartella

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

Questa funzione crea un'associazione tra un ordine del paziente esistente e una cartella esistente. Si tratta di uno strumento organizzativo; non sposta o copia dati.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
PatientOrderUuid	string	Obbligatorio. L'UUID dell'ordine del paziente da inserire in una cartella.
FolderUuidList	List	Obbligatorio. Un elenco contenente l'UUID della cartella di destinazione.

Flusso di lavoro e assegnazione

Assegna ordine all'utente

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

Questa funzione è uno strumento fondamentale per il flusso di lavoro. Assegna l'ordine di un paziente a un singolo utente, il che significa che quest'utente è ora responsabile di un'attività correlata a tale ordine (ad esempio, la segnalazione).

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
PatientOrderUuid	string	Obbligatorio. L'UUID dell'ordine del paziente che richiede un'azione.
AssignedUserUuid	string	Obbligatorio. L'UUID dell'utente specifico a cui verrà assegnata la responsabilità.

Assegna ordine al gruppo di utenti

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

Analogamente all'assegnazione a un singolo utente, questa funzione assegna un ordine di paziente a un intero gruppo, abilitando flussi di lavoro basati sul team in cui qualsiasi membro del gruppo può gestire l'attività.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
PatientOrderUuid	string	Obbligatorio. L'UUID dell'ordine del paziente da assegnare al gruppo.
AssignedUserGroupUuid	string	Obbligatorio. L'UUID del gruppo di utenti a cui assegnare l'ordine.

Ciclo di vita degli ordini dei pazienti e recupero dei dati

Crea un ordine per il paziente

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

Questa funzione crea un nuovo ordine del paziente per pianificare e gestire gli studi di imaging all'interno del sistema. I parametri richiesti devono essere forniti per una corretta creazione.

Required Parameters	Data Type	Descrizione
InstitutionUuid	string	Obbligatorio. UUID dell'istituto in cui viene creato l'ordine del paziente.
PatientName	string	Obbligatorio. Nome completo del paziente.
PatientId	string	Obbligatorio. Identificatore univoco del paziente, ad esempio un ID nazionale o un MRN.
PatientBirthdate	string (YYYY-MM-DD)	Obbligatorio. Data di nascita del paziente in formato ISO.
Modality	string	Obbligatorio. Tipo di modalità come CT, MR, US, ecc.
OtherPatientId	string	Facoltativo Un identificatore aggiuntivo per il paziente, se applicabile.
PatientSex	string	Facoltativo Sesso del paziente (ad esempio, M, F, O).
StudyDescription	string	Facoltativo Descrizione dello studio di imaging ordinato.
AccessionNumber	string	Facoltativo Numero di accesso univoco per l'ordine, se applicabile.
PatientComplaints	string	Facoltativo Testo che descrive i reclami o i sintomi del paziente.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Facoltativo La data e l'ora di inizio programmate della procedura.
RequestedProcedureId	string	Facoltativo Identificatore della procedura richiesta.
RequestedProcedureDescription	string	Facoltativo Descrizione della procedura richiesta.
RequestingPhysician	string	Facoltativo Nome del medico che ha richiesto lo studio.
ReferringPhysiciansName	string	Facoltativo Nome del medico curante, se diverso da quello richiesto.
ScheduledEquipmentUuid	string	Facoltativo UUID dell'apparecchiatura di imaging da utilizzare per la procedura programmata.

Ottieni le proprietà degli ordini per i pazienti

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

Questa funzione recupera il set completo di proprietà per un singolo ordine specifico del paziente.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
PatientOrderInstitutionUuid	string	Obbligatorio. L'UUID dell'istituto a cui appartiene l'ordine.
PatientOrderUuid	string	Obbligatorio. L'UUID dell'ordine specifico del paziente da recuperare.

Cerca gli ordini dei pazienti

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

Questa funzione recupera un elenco di ordini dei pazienti in base a una combinazione di filtri di ricerca come nome del paziente, ID, modalità e date di studio o di nascita. Consente una funzionalità di ricerca avanzata per gli istituti che gestiscono più ordini.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
InstitutionUuidList	List	Elenco degli UUID che identificano le istituzioni in cui cercare gli ordini dei pazienti.
PatientName	string	Facoltativo Filtra per nome completo del paziente.
PatientId	string	Facoltativo Filtra in base all'identificatore univoco del paziente.
OtherPatientId	string	Facoltativo Identificatore secondario del paziente, se disponibile.
AccessionNumber	string	Facoltativo Filtra per numero di accesso assegnato allo studio.
ModalityList	List	Elenco delle modalità (ad es. CT, MR, US) per filtrare i risultati della ricerca.
StudyDateFrom	string (YYYY-MM-DD)	Facoltativo Data di inizio dell'intervallo di date dello studio per il filtraggio dei risultati.
StudyDateTo	string (YYYY-MM-DD)	Facoltativo Data di fine dell'intervallo di date dello studio per il filtraggio dei risultati.
PatientBirthdateFrom	string (YYYY-MM-DD)	Facoltativo Intervallo di date di inizio della data di nascita del paziente per filtrare i pazienti per età.
PatientBirthdateTo	string (YYYY-MM-DD)	Facoltativo Intervallo di date di fine della data di nascita del paziente per filtrare i pazienti per età.

Elimina l'ordine del paziente

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

Questa funzione elimina definitivamente l'ordine di un paziente dal sistema. Richiede sia l'UUID dell'istituto che l'UUID specifico dell'ordine del paziente per garantire l'accuratezza e prevenire la cancellazione accidentale.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
PatientOrderInstitutionUuid	string	Obbligatorio. UUID dell'istituto proprietario dell'ordine del paziente. Assicura che per l'eliminazione venga utilizzato il contesto corretto.
PatientOrderUuid	string	Obbligatorio. UUID dell'ordine specifico del paziente da eliminare. Questo identifica in modo univoco l'ordine nel sistema.

Ottieni il contenuto del tag Dicom

Ottieni il contenuto dei tag DICOM

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

Questa funzione recupera i valori di specifici tag DICOM dalle immagini associate all'ordine di un paziente.

Required Parameters	Data Type	Descrizione
UserName	string	Il nome utente (indirizzo email) per l'account PostDICOM. (dall'inizializzazione)
Password	string	La password associata all'account PostDICOM. (dall'inizializzazione)
WebAddress	string	L'URL di base dell'API. (dall'inizializzazione)
PatientOrderInstitutionUuid	string	Obbligatorio. L'UUID dell'istituto in cui risiede l'ordine.
PatientOrderUuid	string	Obbligatorio. L'UUID dell'ordine contenente le immagini.
PatientSeriesUuid	string	Facoltativo Se forniti, i tag verranno letti solo da questa serie specifica.
DicomTagIdList	List	Facoltativo Un elenco di ID tag DICOM da recuperare.