Documentation du service DICOMWeb | PostDICOM

Prerequisites Introduction et informations générales

Ce document fournit un guide technique complet pour DICOMweb API fonctions avec des exemples de méthodes utilisées via un exemple d'application C#. Il comprend des explications détaillées de toutes les fonctions disponibles, couvrant à la fois standard DICOMweb services (comme QIDO-RS, WADO-RS, and STOW-RS) et custom DICOMweb API endpoints développé par PostDicom. Ces fonctions sont conçues pour être utilisées lors d'appels côté serveur.

Pour utiliser les services DicomWeb de PostDicom, cette fonctionnalité doit d'abord être activée pour votre compte et posséder des informations d'identification utilisateur valides. Si l'accès à DICOMWeb n'est pas encore activé pour votre compte et que vous souhaitez intégrer votre application à PostDicom, veuillez nous contacter pour demander l'activation.

User Name: Il s'agit de votre identifiant de connexion principal, généralement votre adresse e-mail. Il est propre à votre compte et est utilisé comme nom d'utilisateur dans l'authentification de base.

Password: Il s'agit du mot de passe associé à votre compte PostDicom. Il est utilisé conjointement avec votre nom d'utilisateur lors de l'authentification de base. Pour une sécurité optimale, nous vous recommandons vivement de choisir un mot de passe sécurisé. Veuillez disposer des mécanismes de sécurité nécessaires lors de votre appel côté serveur afin que ce nom d'utilisateur et ce mot de passe soient protégés par vous-même.

Vous pouvez gérer votre mot de passe et vos paramètres de sécurité via la page de profil de votre compte après vous être connecté à votre compte PostDicom

Services standard DICOMWeb

Stockez les instances DICOM ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Cette fonction orchestre le téléchargement de tous les fichiers .dcm depuis un dossier local spécifié vers le serveur DICOMWeb. Il identifie d'abord tous les fichiers pertinents, puis utilise des méthodes d'assistance pour créer et envoyer une requête POST authentifiée en plusieurs parties ou associée pour chaque fichier, conformément à la norme STOW-RS.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
DirectoryPath	string	Le chemin complet vers le répertoire local contenant les fichiers DICOM (.dcm) à télécharger.

Requête pour les objets DICOM ( QIDO-RS)

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

Cette fonction effectue une requête pour les objets DICOM à l'aide de la norme QIDO-RS, permettant des recherches au niveau de l'étude, de la série ou de l'instance. Sur la base du paramètre de recherche fourni (tel que l'ID du patient, l'UID de l'instance d'étude ou l'UID de l'instance de série), il construit l'URL appropriée et exécute une demande authentifiée pour récupérer les résultats correspondants sur le serveur.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
PatientID	string	Facultatif Utilisé pour identifier le patient et rechercher des études connexes.
StudyInstanceUID	string	Facultatif Utilisé pour rechercher une étude spécifique ou toutes les séries de cette étude.
SeriesInstanceUID	string	Facultatif Utilisé pour rechercher toutes les instances d'images d'une série spécifique.

Récupérez des instances DICOM ( WADO-RS)

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

Cette fonction fournit un menu interactif permettant de récupérer des objets DICOM à l'aide de la norme WADO-RS. L'utilisateur sélectionne un niveau de récupération (étude, série ou instance) et fournit l'UID correspondant. La fonction effectue ensuite une demande authentifiée et traite la réponse multipartie/associée, en enregistrant chaque partie DICOM dans un fichier .dcm distinct dans un répertoire local nouvellement créé.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
StudyInstanceUID	string	Facultatif Identifiant unique au monde pour une étude DICOM. Utilisé pour récupérer toutes les séries et instances associées à cette étude.
SeriesInstanceUID	string	Facultatif Identifiant unique au monde pour une série au sein d'une étude DICOM. Utilisé pour récupérer toutes les images de cette série.
SOPInstanceUID	string	Facultatif Identifiant unique pour une instance d'image DICOM individuelle. Permet de récupérer une image spécifique à l'aide de WADO-RS.

Gestion du partage

Créer un lien de partage

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

Cette fonction génère un lien Web sécurisé pour partager une ou plusieurs commandes de patients avec des utilisateurs externes. Le lien peut être protégé par mot de passe et autoriser éventuellement les téléchargements.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe du compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
PatientOrderInfoList	List	Liste de chaînes JSON, chacune contenant une clé « PatientOrderUUID », identifiant les commandes des patients à partager.
ExpireDate	string (YYYY-MM-DD)	Date d'expiration du lien de partage. Après cette date, le lien sera désactivé.
SharePassword	string	Facultatif Mot de passe requis pour accéder au lien de partage. Laissez ce champ vide pour l'accès public.
Downloadable	bool	Facultatif Détermine si les études DICOM sont téléchargeables par le destinataire.

Partager la commande du patient avec l'URL

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

Cette fonction génère une URL partageable pour les commandes de patients sélectionnées avec des options de contrôle d'accès supplémentaires telles que l'autorisation de téléchargement et la protection par mot de passe.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe du compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
OrderUuidList	List	Liste des UUID identifiant les commandes des patients à partager.
ExpireDate	string (YYYY-MM-DD)	Date après laquelle le lien de partage devient inactif.
SharePassword	string	Facultatif Mot de passe requis pour accéder au lien partagé.
UserCanDownloadStudies	bool	Facultatif Si ce paramètre est défini sur true, le destinataire peut télécharger les études.

Gestion des dossiers et des commandes

Créer un dossier

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

Cette fonction est utilisée pour créer un nouveau dossier (un conteneur virtuel) dans le compte PostDicom afin de faciliter l'organisation des commandes des patients.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
FolderName	string	Obligatoire. Le nom visible du nouveau dossier.
FolderDescription	string	Facultatif Description textuelle du dossier.
ParentFolderUuid	string	Facultatif L'UUID d'un dossier existant pour créer le nouveau dossier qu'il contient.

Dossier de recherche

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

Cette fonction recherche les dossiers existants en fonction de critères de recherche. Il peut éventuellement inclure la liste des commandes des patients dans chaque dossier trouvé.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
ParentFolderUuid	string	Facultatif Un UUID de dossier pour limiter la recherche à ses enfants.
FolderName	string	Facultatif Nom complet ou partiel à rechercher.
GetOrdersInFolder	bool	Facultatif Si « vrai », la réponse inclura une liste des commandes des patients pour chaque dossier trouvé.

Partager un dossier avec une URL

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

Cette fonction génère une URL sécurisée et partageable pour un dossier entier et son contenu. Il permet un contrôle d'accès complet en définissant un titre personnalisé, une description, un mot de passe, une date d'expiration et en spécifiant si le contenu peut être téléchargé par le destinataire.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
FolderUuid	string	Obligatoire. L'identifiant unique (UUID) du dossier à partager.
SharePassword	string	Facultatif Un mot de passe pour protéger le lien partagé. S'il est laissé vide, le lien sera accessible au public.
ShareTitle	string	Facultatif Titre personnalisé pour la page du dossier partagé, visible par le destinataire.
ShareDescription	string	Facultatif Description affichée sur la page du dossier partagé.
ExpireDate	string (YYYY-MM-DD)	Facultatif Date à laquelle le lien de partage deviendra automatiquement inactif.
UserCanDownloadStudies	bool	Facultatif Si « vrai », les destinataires peuvent télécharger les ordonnances des patients contenues dans le dossier.

Ajouter la commande au dossier

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

Cette fonction crée une association entre une commande de patient existante et un dossier existant. Il s'agit d'un outil d'organisation ; il ne déplace ni ne copie les données.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
PatientOrderUuid	string	Obligatoire. L'UUID de la commande du patient à placer dans un dossier.
FolderUuidList	List	Obligatoire. Liste contenant l'UUID du dossier de destination.

Flux de travail et affectation

Attribuer la commande à l'utilisateur

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

Cette fonction est un outil de flux de travail essentiel. Il attribue une commande d'un patient à un utilisateur individuel, ce qui signifie que cet utilisateur est désormais responsable d'une tâche liée à cette commande (par exemple, les rapports).

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
PatientOrderUuid	string	Obligatoire. L'UUID de la commande du patient qui nécessite une action.
AssignedUserUuid	string	Obligatoire. L'UUID de l'utilisateur spécifique auquel la responsabilité sera attribuée.

Attribuer une commande à un groupe d'utilisateurs

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

Semblable à l'attribution à un seul utilisateur, cette fonction attribue une commande de patient à un groupe entier, permettant ainsi des flux de travail en équipe où n'importe quel membre du groupe peut gérer la tâche.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
PatientOrderUuid	string	Obligatoire. L'UUID de la commande du patient à attribuer au groupe.
AssignedUserGroupUuid	string	Obligatoire. L'UUID du groupe d'utilisateurs auquel la commande doit être attribuée.

Cycle de vie des commandes des patients et récupération des données

Créer une commande pour un patient

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

Cette fonction crée une nouvelle commande de patient pour planifier et gérer les études d'imagerie au sein du système. Les paramètres requis doivent être fournis pour que la création soit réussie.

Required Parameters	Data Type	Descriptif
InstitutionUuid	string	Obligatoire. UUID de l'établissement dans lequel la commande du patient est créée.
PatientName	string	Obligatoire. Nom complet du patient.
PatientId	string	Obligatoire. Identifiant unique du patient, tel qu'une carte d'identité nationale ou un MRN.
PatientBirthdate	string (YYYY-MM-DD)	Obligatoire. Date de naissance du patient au format ISO.
Modality	string	Obligatoire. Type de modalité tel que CT, MR, États-Unis, etc.
OtherPatientId	string	Facultatif Un identifiant supplémentaire pour le patient, le cas échéant.
PatientSex	string	Facultatif Sexe du patient (par exemple, M, F, O).
StudyDescription	string	Facultatif Description de l'étude d'imagerie commandée.
AccessionNumber	string	Facultatif Numéro d'accès unique pour la commande, le cas échéant.
PatientComplaints	string	Facultatif Texte décrivant les plaintes ou les symptômes du patient.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Facultatif Date et heure de début prévues de la procédure.
RequestedProcedureId	string	Facultatif Identifiant de la procédure demandée.
RequestedProcedureDescription	string	Facultatif Description de la procédure demandée.
RequestingPhysician	string	Facultatif Nom du médecin qui a demandé l'étude.
ReferringPhysiciansName	string	Facultatif Nom du médecin référent, s'il est différent de celui qui a demandé.
ScheduledEquipmentUuid	string	Facultatif UUID de l'équipement d'imagerie à utiliser pour la procédure planifiée.

Obtenir les propriétés des commandes des patients

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

Cette fonction récupère l'ensemble complet des propriétés pour une seule commande de patient spécifique.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
PatientOrderInstitutionUuid	string	Obligatoire. L'UUID de l'institution à laquelle appartient la commande.
PatientOrderUuid	string	Obligatoire. L'UUID de l'ordre spécifique du patient à récupérer.

Rechercher des ordonnances destinées aux patients

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

Cette fonction extrait une liste des ordonnances des patients en fonction d'une combinaison de filtres de recherche tels que le nom, l'identifiant, la modalité et les dates d'étude ou de naissance du patient. Il permet une fonctionnalité de recherche avancée pour les institutions qui gèrent plusieurs commandes.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
InstitutionUuidList	List	Liste des UUID identifiant les institutions dans lesquelles rechercher les ordonnances des patients.
PatientName	string	Facultatif Filtrer par nom complet du patient.
PatientId	string	Facultatif Filtrer par identifiant unique du patient.
OtherPatientId	string	Facultatif Identifiant secondaire du patient, s'il est disponible.
AccessionNumber	string	Facultatif Filtrer par numéro d'accès attribué à l'étude.
ModalityList	List	Liste des modalités (CT, MR, États-Unis, par exemple) permettant de filtrer les résultats de recherche.
StudyDateFrom	string (YYYY-MM-DD)	Facultatif Date de début de la plage de dates de l'étude pour le filtrage des résultats.
StudyDateTo	string (YYYY-MM-DD)	Facultatif Date de fin de la plage de dates de l'étude pour le filtrage des résultats.
PatientBirthdateFrom	string (YYYY-MM-DD)	Facultatif Date de début de la plage de dates de naissance des patients pour filtrer les patients par âge.
PatientBirthdateTo	string (YYYY-MM-DD)	Facultatif Date de fin de la plage de dates de naissance des patients pour filtrer les patients par âge.

Supprimer la commande du patient

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

Cette fonction supprime définitivement une commande du patient du système. Il nécessite à la fois l'UUID de l'établissement et l'UUID de la commande spécifique du patient pour garantir l'exactitude et empêcher toute suppression accidentelle.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
PatientOrderInstitutionUuid	string	Obligatoire. UUID de l'établissement propriétaire de la commande du patient. Garantit que le contexte correct est utilisé pour la suppression.
PatientOrderUuid	string	Obligatoire. UUID de la commande spécifique du patient à supprimer. Cela permet d'identifier de manière unique la commande dans le système.

Obtenir le contenu des balises Dicom

Obtenir le contenu des balises DICOM

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

Cette fonction extrait les valeurs de balises DICOM spécifiques à partir des images associées à la commande d'un patient.

Required Parameters	Data Type	Descriptif
UserName	string	Le nom d'utilisateur (adresse e-mail) du compte PostDicom. (à partir de l'initialisation)
Password	string	Le mot de passe associé au compte PostDicom. (à partir de l'initialisation)
WebAddress	string	URL de base de l'API. (à partir de l'initialisation)
PatientOrderInstitutionUuid	string	Obligatoire. L'UUID de l'institution où réside la commande.
PatientOrderUuid	string	Obligatoire. L'UUID de la commande contenant les images.
PatientSeriesUuid	string	Facultatif Si elles sont fournies, les balises ne seront lues que pour cette série spécifique.
DicomTagIdList	List	Facultatif Liste des identifiants de balises DICOM à récupérer.