Documentation du service DICOMweb | PostDICOM

Prerequisites Introduction et Informations Générales

Ce document fournit un guide technique complet pour les fonctions de l'**API DICOMweb** avec des exemples de méthodes utilisées via une application exemple en C#. Il inclut des explications détaillées de toutes les fonctions disponibles, couvrant à la fois les **services DICOMweb standard** (tels que QIDO-RS, WADO-RS et STOW-RS) et les **points de terminaison de l'API DICOMweb personnalisés** développés par PostDICOM. Ces fonctions sont conçues pour être utilisées dans des appels côté serveur.

Pour utiliser les services DICOMweb de PostDICOM, vous devez d'abord activer cette fonctionnalité pour votre compte et posséder des identifiants utilisateur valides. Si l'accès DICOMweb n'est pas encore activé pour votre compte et que vous souhaitez intégrer votre application avec PostDICOM, veuillez nous contacter pour demander l'activation.

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

Mot de passe : 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 fort. Veuillez mettre en place les mécanismes de sécurité nécessaires de votre côté serveur afin que ce nom d'utilisateur et ce mot de passe soient protégés.

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 votre connexion à votre compte PostDICOM.

Services Standard DICOMweb

Stocker des Instances DICOM (STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Cette fonction orchestre le téléchargement de tous les fichiers .dcm d'un dossier local spécifié vers le serveur DICOMweb. Elle identifie d'abord tous les fichiers pertinents, puis utilise des méthodes auxiliaires pour construire et envoyer une requête POST multipart/related authentifiée pour chaque fichier, conformément à la norme STOW-RS.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
DirectoryPath	string	Le chemin complet vers le répertoire local contenant les fichiers DICOM (.dcm) à télécharger.

Interroger des Objets DICOM (QIDO-RS)

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

Cette fonction effectue une requête pour des objets DICOM en utilisant la norme QIDO-RS, permettant des recherches au niveau de l'Étude, de la Série ou de l'Instance. En fonction du paramètre de recherche fourni (tel que l'ID Patient, le Study Instance UID ou le Series Instance UID), elle construit l'URL appropriée et exécute une requête authentifiée pour récupérer les résultats correspondants depuis le serveur.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
PatientID	string	Optionnel. Utilisé pour identifier le patient et rechercher les études associées.
StudyInstanceUID	string	Optionnel. Utilisé pour rechercher une étude spécifique ou toutes les séries au sein de cette étude.
SeriesInstanceUID	string	Optionnel. Utilisé pour rechercher toutes les instances d'image au sein d'une série spécifique.

Récupérer des Instances DICOM (WADO-RS)

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

Cette fonction fournit un menu interactif pour récupérer des objets DICOM en utilisant 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 requête authentifiée et traite la réponse multipart/related, sauvegardant chaque partie DICOM comme un fichier .dcm séparé dans un répertoire local nouvellement créé.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
StudyInstanceUID	string	Optionnel. Un identifiant unique mondial pour une étude DICOM. Utilisé pour récupérer toutes les séries et instances associées à cette étude.
SeriesInstanceUID	string	Optionnel. Un identifiant unique mondial pour une série au sein d'une étude DICOM. Utilisé pour récupérer toutes les images sous cette série.
SOPInstanceUID	string	Optionnel. Un identifiant unique pour une instance d'image DICOM individuelle. Utilisé pour récupérer une image spécifique avec 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 patients avec des utilisateurs externes. Le lien peut être protégé par mot de passe et permettre optionnellement le téléchargement.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe pour le compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
PatientOrderInfoList	List	Liste de chaînes JSON, chacune contenant une clé "PatientOrderUuid", identifiant les commandes patients à partager.
ExpireDate	string (YYYY-MM-DD)	Date d'expiration pour le lien de partage. Après cette date, le lien sera désactivé.
SharePassword	string	Optionnel. Mot de passe requis pour accéder au lien de partage. Laissez vide pour un accès public.
Downloadable	bool	Optionnel. Détermine si les études DICOM sont téléchargeables par le destinataire.

Partager une Commande Patient via URL

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

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

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (e-mail) du compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe pour le compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
OrderUuidList	List	Liste des UUID identifiant les commandes patients à partager.
ExpireDate	string (YYYY-MM-DD)	Date après laquelle le lien de partage devient inactif.
SharePassword	string	Optionnel. Mot de passe requis pour accéder au lien partagé.
UserCanDownloadStudies	bool	Optionnel. Si défini sur vrai (true), le destinataire peut télécharger les études.

Gestion des Dossiers et 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) au sein du compte PostDICOM pour aider à organiser les commandes patients.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
FolderName	string	Requis. Le nom visible pour le nouveau dossier.
FolderDescription	string	Optionnel. Une description textuelle pour le dossier.
ParentFolderUuid	string	Optionnel. L'UUID d'un dossier existant pour créer le nouveau dossier à l'intérieur de celui-ci.

Rechercher un Dossier

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

Cette fonction trouve des dossiers existants basés sur des critères de recherche. Elle peut optionnellement inclure la liste des commandes patients au sein de chaque dossier trouvé.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
ParentFolderUuid	string	Optionnel. Un UUID de dossier pour restreindre la recherche à ses enfants.
FolderName	string	Optionnel. Un nom complet ou partiel à rechercher.
GetOrdersInFolder	bool	Optionnel. Si `true`, la réponse inclura une liste des commandes patients pour chaque dossier trouvé.

Partager un Dossier via 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. Elle 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.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
FolderUuid	string	Requis. L'identifiant unique (UUID) du dossier à partager.
SharePassword	string	Optionnel. Un mot de passe pour protéger le lien partagé. Si laissé vide, le lien sera accessible publiquement.
ShareTitle	string	Optionnel. Un titre personnalisé pour la page du dossier partagé, visible par le destinataire.
ShareDescription	string	Optionnel. Une description affichée sur la page du dossier partagé.
ExpireDate	string (YYYY-MM-DD)	Optionnel. La date à laquelle le lien de partage deviendra automatiquement inactif.
UserCanDownloadStudies	bool	Optionnel. Si `true`, les destinataires peuvent télécharger les commandes patients contenues dans le dossier.

Ajouter une Commande au Dossier

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

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

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
PatientOrderUuid	string	Requis. L'UUID de la commande patient à placer dans un dossier.
FolderUuidList	List	Requis. Une liste contenant l'UUID du dossier de destination.

Workflow & Assignation

Assigner la Commande à un Utilisateur

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

Cette fonction est un outil central de workflow. Elle assigne une commande patient à un utilisateur individuel, signifiant que cet utilisateur est désormais responsable d'une tâche liée à cette commande (par exemple, la rédaction d'un rapport).

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
PatientOrderUuid	string	Requis. L'UUID de la commande patient nécessitant une action.
AssignedUserUuid	string	Requis. L'UUID de l'utilisateur spécifique à qui la responsabilité sera assignée.

Assigner la Commande à un Groupe d'Utilisateurs

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

Similaire à l'assignation à un utilisateur unique, cette fonction assigne une commande patient à un groupe entier, permettant des workflows d'équipe où n'importe quel membre du groupe peut traiter la tâche.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
PatientOrderUuid	string	Requis. L'UUID de la commande patient à assigner au groupe.
AssignedUserGroupUuid	string	Requis. L'UUID du groupe d'utilisateurs à qui la commande sera assignée.

Cycle de Vie de la Commande Patient & Récupération de Données

Créer une Commande 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 patient pour planifier et gérer des études d'imagerie au sein du système. Les paramètres requis doivent être fournis pour une création réussie.

Paramètres Requis	Type de Données	Description
InstitutionUuid	string	Requis. UUID de l'institution où la commande patient est créée.
PatientName	string	Requis. Nom complet du patient.
PatientId	string	Requis. Identifiant unique du patient tel qu'un ID national ou un IPP (Identifiant Permanent du Patient).
PatientBirthdate	string (YYYY-MM-DD)	Requis. Date de naissance du patient au format ISO.
Modality	string	Requis. Type de modalité telle que CT, MR, US, etc.
OtherPatientId	string	Optionnel. Un identifiant supplémentaire pour le patient, le cas échéant.
PatientSex	string	Optionnel. Sexe du patient (ex : M, F, O).
StudyDescription	string	Optionnel. Description de l'étude d'imagerie commandée.
AccessionNumber	string	Optionnel. Numéro d'accession unique pour la commande, le cas échéant.
PatientComplaints	string	Optionnel. Texte décrivant les plaintes ou symptômes du patient.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Optionnel. La date et l'heure prévues pour le début de la procédure.
RequestedProcedureId	string	Optionnel. Identifiant pour la procédure demandée.
RequestedProcedureDescription	string	Optionnel. Description de la procédure demandée.
RequestingPhysician	string	Optionnel. Nom du médecin qui a demandé l'étude.
ReferringPhysiciansName	string	Optionnel. Nom du médecin référent, s'il diffère du médecin demandeur.
ScheduledEquipmentUuid	string	Optionnel. UUID de l'équipement d'imagerie à utiliser pour la procédure planifiée.

Obtenir les Propriétés de la Commande Patient

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

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

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
PatientOrderInstitutionUuid	string	Requis. L'UUID de l'institution à laquelle appartient la commande.
PatientOrderUuid	string	Requis. L'UUID de la commande patient spécifique à récupérer.

Rechercher des Commandes Patient

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

Cette fonction récupère une liste de commandes patients basée sur une combinaison de filtres de recherche tels que le nom du patient, l'ID, la modalité, et les dates d'étude ou de naissance. Elle permet une fonctionnalité de recherche avancée pour les institutions gérant plusieurs commandes.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
InstitutionUuidList	List	Liste des UUID identifiant les institutions pour rechercher les commandes patients.
PatientName	string	Optionnel. Filtrer par le nom complet du patient.
PatientId	string	Optionnel. Filtrer par l'identifiant unique du patient.
OtherPatientId	string	Optionnel. Identifiant secondaire pour le patient, si disponible.
AccessionNumber	string	Optionnel. Filtrer par le numéro d'accession assigné à l'étude.
ModalityList	List	Liste des modalités (ex : CT, MR, US) pour filtrer les résultats de recherche.
StudyDateFrom	string (YYYY-MM-DD)	Optionnel. Date de début de la plage de dates d'étude pour filtrer les résultats.
StudyDateTo	string (YYYY-MM-DD)	Optionnel. Date de fin de la plage de dates d'étude pour filtrer les résultats.
PatientBirthdateFrom	string (YYYY-MM-DD)	Optionnel. Date de début de la plage de dates de naissance pour filtrer les patients par âge.
PatientBirthdateTo	string (YYYY-MM-DD)	Optionnel. Date de fin de la plage de dates de naissance pour filtrer les patients par âge.

Supprimer une Commande Patient

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

Cette fonction supprime définitivement une commande patient du système. Elle nécessite à la fois l'UUID de l'institution et l'UUID de la commande patient spécifique pour assurer la précision et éviter une suppression accidentelle.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
PatientOrderInstitutionUuid	string	Requis. UUID de l'institution qui possède la commande patient. Assure que le contexte correct est utilisé pour la suppression.
PatientOrderUuid	string	Requis. UUID de la commande patient spécifique à supprimer. Cela identifie de manière unique la commande dans le système.

Obtenir le Contenu d'un Tag DICOM

Obtenir le Contenu d'un Tag DICOM

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

Cette fonction récupère les valeurs de tags DICOM spécifiques à partir des images associées à une commande patient.

Paramètres Requis	Type de Données	Description
UserName	string	Le nom d'utilisateur (adresse e-mail) pour le compte PostDICOM. (depuis l'initialisation)
Password	string	Le mot de passe associé au compte PostDICOM. (depuis l'initialisation)
WebAddress	string	L'URL de base de l'API. (depuis l'initialisation)
PatientOrderInstitutionUuid	string	Requis. L'UUID de l'institution où réside la commande.
PatientOrderUuid	string	Requis. L'UUID de la commande contenant les images.
PatientSeriesUuid	string	Optionnel. Si fourni, les tags seront lus uniquement à partir de cette série spécifique.
DicomTagIdList	List	Optionnel. Une liste d'IDs de tags DICOM à récupérer.