Documentation DICOMweb

PrérequisIntroduction 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 d'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 d'API DICOMweb personnalisés développés par PostDICOM. Ces fonctions sont conçues pour être utilisées dans les appels côté serveur.

Pour utiliser les services DICOMweb de PostDICOM, cette fonctionnalité doit d'abord être activée pour votre compte et vous devez posséder des identifiants d'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.

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 sur votre appel côté serveur afin que ce nom d'utilisateur et ce mot de passe soient protégés par vos soins.

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.

DICOMwebServices 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 depuis un dossier local spécifié vers le serveur DICOMweb. Elle identifie d'abord tous les fichiers pertinents, puis utilise des méthodes d'assistance 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 d'accès complet au répertoire local contenant les fichiers DICOM (.dcm) à télécharger.

Rechercher des objets DICOM (QIDO-RS)

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

Cette fonction effectue une recherche d'objets DICOM à l'aide de la norme QIDO-RS, permettant des recherches au niveau de l'examen (Study), de la série (Series) ou de l'instance. En fonction du paramètre de recherche fourni (tel que l'ID du patient, l'UID d'instance d'examen ou l'UID d'instance de série), elle construit l'URL appropriée et exécute une requête authentifiée pour récupérer les résultats correspondants du 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 Facultatif. Utilisé pour identifier le patient et rechercher les examens associés.
StudyInstanceUID string Facultatif. Utilisé pour rechercher un examen spécifique ou toutes les séries au sein de cet examen.
SeriesInstanceUID string Facultatif. Utilisé pour rechercher toutes les instances d'images 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 à l'aide de la norme WADO-RS. L'utilisateur sélectionne un niveau de récupération (Examen, 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, en enregistrant chaque partie DICOM sous forme de fichier .dcm distinct 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 Facultatif. Un identifiant unique au niveau mondial pour un examen DICOM. Utilisé pour récupérer toutes les séries et instances associées à cet examen.
SeriesInstanceUID string Facultatif. Un identifiant unique au niveau mondial pour une série au sein d'un examen DICOM. Utilisé pour récupérer toutes les images de cette série.
SOPInstanceUID string Facultatif. Un identifiant unique pour une instance d'image DICOM individuelle. Utilisé pour récupérer une image spécifique via WADO-RS.

PartagerGestion 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 demandes d'examens de patients avec des utilisateurs externes. Le lien peut être protégé par mot de passe et autoriser de manière facultative les téléchargements.

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, contenant chacune une clé "PatientOrderUuid", identifiant les demandes d'examens de patients à partager.
ExpireDate string (AAAA-MM-JJ) 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 vide pour un accès public.
Downloadable bool Facultatif. Détermine si les examens DICOM peuvent être téléchargés par le destinataire.

Partager la demande d'examen du patient avec une URL

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

Cette fonction génère une URL partageable pour les demandes d'examens 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.

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 d'UUID identifiant les demandes d'examens de patients à partager.
ExpireDate string (AAAA-MM-JJ) 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. S'il est défini sur true, le destinataire peut télécharger les examens.

DossierGestion des dossiers et des demandes d'examens

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 demandes d'examens des 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 du nouveau dossier.
FolderDescription string Facultatif. Une description textuelle pour le dossier.
ParentFolderUuid string Facultatif. L'UUID d'un dossier existant pour y créer le nouveau dossier.

Rechercher un dossier

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

Cette fonction trouve des dossiers existants en fonction de critères de recherche. Elle peut éventuellement inclure la liste des demandes d'examens de patients dans 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 Facultatif. L'UUID d'un dossier pour limiter la recherche à ses enfants.
FolderName string Facultatif. Un nom complet ou partiel à rechercher.
GetOrdersInFolder bool Facultatif. Si `true`, la réponse inclura une liste des demandes d'examens de 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. 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 Facultatif. Un mot de passe pour protéger le lien partagé. S'il est laissé vide, le lien sera accessible publiquement.
ShareTitle string Facultatif. Un titre personnalisé pour la page du dossier partagé, visible par le destinataire.
ShareDescription string Facultatif. Une description affichée sur la page du dossier partagé.
ExpireDate string (AAAA-MM-JJ) Facultatif. La date à laquelle le lien de partage deviendra automatiquement inactif.
UserCanDownloadStudies bool Facultatif. Si `true`, les destinataires peuvent télécharger les demandes d'examens des patients contenues dans le dossier.

Ajouter une demande d'examen au dossier

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

Cette fonction crée une association entre une demande d'examen 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.

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 demande d'examen du patient à placer dans un dossier.
FolderUuidList List Requis. Une liste contenant l'UUID du dossier de destination.

Flux de travailFlux de travail et affectation

Affecter la demande d'examen à un utilisateur

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

Cette fonction est un outil de flux de travail central. Elle affecte une demande d'examen de patient à un utilisateur individuel, signifiant que cet utilisateur est désormais responsable d'une tâche liée à cette demande d'examen (ex: compte rendu interactif).

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 demande d'examen du patient qui nécessite une action.
AssignedUserUuid string Requis. L'UUID de l'utilisateur spécifique qui sera assigné à cette responsabilité.

Affecter la demande d'examen à un groupe d'utilisateurs

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

Similaire à l'affectation à un seul utilisateur, cette fonction affecte une demande d'examen de patient à un groupe entier, permettant des flux de travail basés sur l'équipe où tout membre du groupe peut prendre en charge 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 demande d'examen du patient à affecter au groupe.
AssignedUserGroupUuid string Requis. L'UUID du groupe d'utilisateurs auquel affecter la demande d'examen.

Demande d'examen du patientCycle de vie des demandes d'examens des patients et récupération des données

Créer une demande d'examen 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 demande d'examen de patient pour planifier et gérer les examens 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. L'UUID de l'institution où la demande d'examen du patient est créée.
PatientName string Requis. Le nom complet du patient.
PatientId string Requis. L'identifiant unique du patient, tel qu'un numéro d'identification national ou un IPP (Identifiant Permanent du Patient).
PatientBirthdate string (AAAA-MM-JJ) Requis. Date de naissance du patient au format ISO.
Modality string Requis. Type de modalité tel que TDM, IRM, US, etc.
OtherPatientId string Facultatif. Un identifiant supplémentaire pour le patient, le cas échéant.
PatientSex string Facultatif. Sexe du patient (par ex., M, F, O).
StudyDescription string Facultatif. Description de l'examen d'imagerie demandé.
AccessionNumber string Facultatif. Numéro d'accession unique pour la demande d'examen, le cas échéant.
PatientComplaints string Facultatif. Texte décrivant les plaintes ou symptômes du patient.
OrderScheduledDatetime string (AAAA-MM-JJ HH:MM) Facultatif. La date et l'heure de début prévues pour la procédure.
RequestedProcedureId string Facultatif. Identifiant pour la procédure demandée.
RequestedProcedureDescription string Facultatif. Description de la procédure demandée.
RequestingPhysician string Facultatif. Nom du médecin ayant demandé l'examen.
ReferringPhysiciansName string Facultatif. Nom du médecin référent, s'il est différent du médecin demandeur.
ScheduledEquipmentUuid string Facultatif. UUID de l'équipement d'imagerie à utiliser pour la procédure programmée.

Obtenir les propriétés de la demande d'examen du patient

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

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

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 demande d'examen.
PatientOrderUuid string Requis. L'UUID de la demande d'examen spécifique du patient à récupérer.

Rechercher des demandes d'examens de patients

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

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

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 des demandes d'examens de patients.
PatientName string Facultatif. Filtrer par le nom complet du patient.
PatientId string Facultatif. Filtrer par l'identifiant unique du patient.
OtherPatientId string Facultatif. Identifiant secondaire pour le patient, si disponible.
AccessionNumber string Facultatif. Filtrer par le numéro d'accession assigné à l'examen.
ModalityList List Liste des modalités (ex. TDM, IRM, US) pour filtrer les résultats de recherche.
StudyDateFrom string (AAAA-MM-JJ) Facultatif. Date de début de la plage de dates d'examen pour filtrer les résultats.
StudyDateTo string (AAAA-MM-JJ) Facultatif. Date de fin de la plage de dates d'examen pour filtrer les résultats.
PatientBirthdateFrom string (AAAA-MM-JJ) Facultatif. Date de début de la plage de date de naissance du patient pour filtrer les patients par âge.
PatientBirthdateTo string (AAAA-MM-JJ) Facultatif. Date de fin de la plage de date de naissance du patient pour filtrer les patients par âge.

Supprimer une demande d'examen de patient

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

Cette fonction supprime définitivement une demande d'examen de patient du système. Elle nécessite à la fois l'UUID de l'institution et l'UUID de la demande d'examen spécifique du patient pour garantir l'exactitude et éviter toute 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 demande d'examen du patient. Garantit que le contexte correct est utilisé pour la suppression.
PatientOrderUuid string Requis. UUID de la demande d'examen spécifique du patient à supprimer. Cela identifie de manière unique la demande d'examen dans le système.

Balise DicomObtenir le contenu de la balise DICOM

Obtenir le contenu de la balise DICOM

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

Cette fonction récupère les valeurs des balises DICOM spécifiques à partir des images associées à une demande d'examen de 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ù se trouve la demande d'examen.
PatientOrderUuid string Requis. L'UUID de la demande d'examen contenant les images.
PatientSeriesUuid string Facultatif. S'il est fourni, les balises ne seront lues que pour cette série spécifique.
DicomTagIdList List Facultatif. Une liste d'ID de balises DICOM à récupérer.