Documentación del servicio DICOMWeb | PostDicom

Prerequisites Introducción e información general

Este documento proporciona una guía técnica completa para DICOMweb API funciones con métodos de ejemplo que se utilizan en una aplicación de ejemplo en C#. Incluye explicaciones detalladas de todas las funciones disponibles, que abarcan ambas standard DICOMweb services (por ejemplo QIDO-RS, WADO-RS, and STOW-RS) y custom DICOMweb API endpoints desarrollado por PostDicom. Estas funciones están diseñadas para usarse en llamadas del lado del servidor.

Para utilizar los servicios DICOMweb de PostDICOM, primero debe tener esta función habilitada en su cuenta y poseer credenciales de usuario válidas. Si el acceso a DICOMweb aún no está activado para su cuenta y desea integrar su aplicación con PostDicom, póngase en contacto con nosotros para solicitar la activación.

User Name: Esta es su credencial de inicio de sesión principal, normalmente su dirección de correo electrónico. Es exclusiva de su cuenta y se utiliza como nombre de usuario en la autenticación básica.

Password: Esta es la contraseña asociada a su cuenta PostDicom. Se usa junto con su nombre de usuario durante la autenticación básica. Para una seguridad óptima, le recomendamos encarecidamente que elija una contraseña segura. Tenga en cuenta los mecanismos de seguridad necesarios en su servidor para proteger este nombre de usuario y contraseña.

Puedes gestionar tu contraseña y tu configuración de seguridad a través de la página de perfil de tu cuenta después de iniciar sesión en tu cuenta de PostDi.com.

Servicios estándar de DICOMweb

Almacene instancias DICOM ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Esta función organiza la carga de todos los archivos.dcm desde una carpeta local específica al servidor DICOMWeb. En primer lugar, identifica todos los archivos relevantes y, a continuación, utiliza métodos auxiliares para crear y enviar una solicitud POST autenticada multiparte o relacionada para cada archivo, de conformidad con el estándar STOW-RS.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
DirectoryPath	string	La ruta completa al directorio local que contiene los archivos DICOM (.dcm) que se van a cargar.

Consulta de objetos DICOM ( QIDO-RS)

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

Esta función realiza una consulta de objetos DICOM mediante el estándar QIDO-RS, lo que permite realizar búsquedas a nivel de estudio, serie o instancia. En función del parámetro de búsqueda proporcionado (como el identificador del paciente, el UID de la instancia de estudio o el UID de la instancia de serie), construye la URL adecuada y ejecuta una solicitud autenticada para recuperar los resultados coincidentes del servidor.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
PatientID	string	Opcional. Se usa para identificar al paciente y buscar estudios relacionados.
StudyInstanceUID	string	Opcional. Se usa para buscar un estudio específico o todas las series de ese estudio.
SeriesInstanceUID	string	Opcional. Se usa para buscar todas las instancias de imágenes de una serie específica.

Recuperar instancias DICOM ( WADO-RS)

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

Esta función proporciona un menú interactivo para recuperar objetos DICOM mediante el estándar WADO-RS. El usuario selecciona un nivel de recuperación (estudio, serie o instancia) y proporciona el UID correspondiente. A continuación, la función realiza una solicitud autenticada y procesa la respuesta multiparte o relacionada, guardando cada parte del DICOM como un archivo.dcm independiente en un directorio local recién creado.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
StudyInstanceUID	string	Opcional. Un identificador único a nivel mundial para un estudio DICOM. Se utiliza para recuperar todas las series e instancias asociadas a ese estudio.
SeriesInstanceUID	string	Opcional. Un identificador único a nivel mundial para una serie de un estudio DICOM. Se utiliza para recuperar todas las imágenes de esa serie.
SOPInstanceUID	string	Opcional. Un identificador único para una instancia de imagen DICOM individual. Se utiliza para recuperar una imagen específica mediante WADO-RS.

Administración de recursos compartidos

Crear enlace para compartir

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

Esta función genera un enlace web seguro para compartir uno o más pedidos de pacientes con usuarios externos. El enlace puede estar protegido con contraseña y, de forma opcional, permitir descargas.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña de la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
PatientOrderInfoList	List	Lista de cadenas JSON, cada una de las cuales contiene una clave «patientOrderUUID», que identifica las órdenes de los pacientes que se van a compartir.
ExpireDate	string (YYYY-MM-DD)	Fecha de caducidad del enlace para compartir. Después de esta fecha, el enlace se desactivará.
SharePassword	string	Opcional. Se requiere una contraseña para acceder al enlace para compartir. Déjelo vacío para el acceso público.
Downloadable	bool	Opcional. Determina si el destinatario puede descargar los estudios DICOM.

Comparta el pedido del paciente con la URL

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

Esta función genera una URL que se puede compartir para los pedidos de pacientes seleccionados con opciones de control de acceso adicionales, como el permiso de descarga y la protección con contraseña.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña de la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
OrderUuidList	List	Lista de UUID que identifican las órdenes de los pacientes que se compartirán.
ExpireDate	string (YYYY-MM-DD)	Fecha a partir de la cual el enlace para compartir pasa a estar inactivo.
SharePassword	string	Opcional. Se requiere una contraseña para acceder al enlace compartido.
UserCanDownloadStudies	bool	Opcional. Si se establece en verdadero, el destinatario puede descargar los estudios.

Gestión de carpetas y pedidos

Crear carpeta

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

Esta función se usa para crear una nueva carpeta (un contenedor virtual) dentro de la cuenta PostDicom para ayudar a organizar los pedidos de los pacientes.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
FolderName	string	Necesario. El nombre visible de la nueva carpeta.
FolderDescription	string	Opcional. Descripción textual de la carpeta.
ParentFolderUuid	string	Opcional. El UUID de una carpeta existente para crear la nueva carpeta dentro de ella.

Carpeta de búsqueda

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

Esta función busca las carpetas existentes en función de los criterios de búsqueda. Opcionalmente, puede incluir la lista de pedidos de pacientes en cada carpeta encontrada.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
ParentFolderUuid	string	Opcional. Un UUID de carpeta para restringir la búsqueda a sus elementos secundarios.
FolderName	string	Opcional. Un nombre completo o parcial para buscar.
GetOrdersInFolder	bool	Opcional. Si es «verdadero», la respuesta incluirá una lista de los pedidos de los pacientes para cada carpeta encontrada.

Compartir carpeta con URL

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

Esta función genera una URL segura y compartible para toda una carpeta y su contenido. Permite un control de acceso completo al establecer un título, una descripción, una contraseña y una fecha de caducidad personalizados y especificar si el destinatario puede descargar el contenido.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
FolderUuid	string	Necesario. El identificador único (UUID) de la carpeta que se va a compartir.
SharePassword	string	Opcional. Una contraseña para proteger el enlace compartido. Si se deja vacío, el enlace será de acceso público.
ShareTitle	string	Opcional. Un título personalizado para la página de la carpeta compartida, visible para el destinatario.
ShareDescription	string	Opcional. Una descripción que se muestra en la página de la carpeta compartida.
ExpireDate	string (YYYY-MM-DD)	Opcional. La fecha en la que el enlace para compartir pasará a estar inactivo automáticamente.
UserCanDownloadStudies	bool	Opcional. Si es «verdadero», los destinatarios pueden descargar los pedidos de los pacientes que figuran en la carpeta.

Añadir orden a la carpeta

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

Esta función crea una asociación entre un pedido de paciente existente y una carpeta existente. Se trata de una herramienta organizativa; no mueve ni copia datos.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
PatientOrderUuid	string	Necesario. El UUID de la orden del paciente que se colocará en una carpeta.
FolderUuidList	List	Necesario. Una lista que contiene el UUID de la carpeta de destino.

Flujo de trabajo y asignación

Asignar pedido al usuario

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

Esta función es una herramienta básica de flujo de trabajo. Asigna una orden de paciente a un usuario individual, lo que significa que este usuario ahora es responsable de una tarea relacionada con esa orden (por ejemplo, informar).

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
PatientOrderUuid	string	Necesario. El UUID del pedido del paciente que requiere una acción.
AssignedUserUuid	string	Necesario. El UUID del usuario específico al que se le asignará la responsabilidad.

Asignar orden a un grupo de usuarios

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

Al igual que la asignación a un solo usuario, esta función asigna una orden de paciente a todo un grupo, lo que permite flujos de trabajo en equipo en los que cualquier miembro del grupo puede gestionar la tarea.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
PatientOrderUuid	string	Necesario. El UUID de la orden del paciente que se asignará al grupo.
AssignedUserGroupUuid	string	Necesario. El UUID del grupo de usuarios al que se va a asignar el pedido.

Ciclo de vida de los pedidos de pacientes y recuperación de datos

Crear pedido de paciente

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

Esta función crea una nueva orden de paciente para programar y gestionar los estudios de diagnóstico por imágenes dentro del sistema. Se deben proporcionar los parámetros necesarios para que la creación se realice correctamente.

Required Parameters	Data Type	Descripción
InstitutionUuid	string	Necesario. UUID de la institución en la que se está creando la orden del paciente.
PatientName	string	Necesario. Nombre completo del paciente.
PatientId	string	Necesario. Identificador único del paciente, como un documento nacional de identidad o un MRN.
PatientBirthdate	string (YYYY-MM-DD)	Necesario. Fecha de nacimiento del paciente en formato ISO.
Modality	string	Necesario. Tipo de modalidad como CT, MR, US, etc.
OtherPatientId	string	Opcional. Un identificador adicional para el paciente, si corresponde.
PatientSex	string	Opcional. Sexo del paciente (p. ej., M, F, O).
StudyDescription	string	Opcional. Descripción del estudio de diagnóstico por imágenes que se solicita.
AccessionNumber	string	Opcional. Número de acceso único para el pedido, si corresponde.
PatientComplaints	string	Opcional. Texto en el que se describen las quejas o los síntomas del paciente.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Opcional. La fecha y hora de inicio programadas del procedimiento.
RequestedProcedureId	string	Opcional. Identificador del procedimiento solicitado.
RequestedProcedureDescription	string	Opcional. Descripción del procedimiento solicitado.
RequestingPhysician	string	Opcional. Nombre del médico que solicitó el estudio.
ReferringPhysiciansName	string	Opcional. Nombre del médico remitente, si es diferente del médico solicitante.
ScheduledEquipmentUuid	string	Opcional. UUID del equipo de diagnóstico por imágenes que se utilizará para el procedimiento programado.

Obtenga propiedades de pedidos de pacientes

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

Esta función recupera el conjunto completo de propiedades para un pedido de paciente único y específico.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
PatientOrderInstitutionUuid	string	Necesario. El UUID de la institución a la que pertenece el pedido.
PatientOrderUuid	string	Necesario. El UUID de la orden específica del paciente que se va a recuperar.

Búsqueda de pedidos de pacientes

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

Esta función recupera una lista de los pedidos de los pacientes en función de una combinación de filtros de búsqueda, como el nombre del paciente, la identificación, la modalidad y las fechas de estudio o nacimiento. Permite la funcionalidad de búsqueda avanzada para las instituciones que gestionan varios pedidos.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
InstitutionUuidList	List	Lista de UUID que identifican las instituciones para buscar pedidos de pacientes.
PatientName	string	Opcional. Filtrar por el nombre completo del paciente.
PatientId	string	Opcional. Filtrar por identificador único del paciente.
OtherPatientId	string	Opcional. Identificador secundario del paciente, si está disponible.
AccessionNumber	string	Opcional. Filtre por número de acceso asignado al estudio.
ModalityList	List	Lista de modalidades (por ejemplo, CT, MR, US) para filtrar los resultados de la búsqueda.
StudyDateFrom	string (YYYY-MM-DD)	Opcional. Fecha de inicio del intervalo de fechas del estudio para filtrar los resultados.
StudyDateTo	string (YYYY-MM-DD)	Opcional. Fecha de finalización del intervalo de fechas del estudio para filtrar los resultados.
PatientBirthdateFrom	string (YYYY-MM-DD)	Opcional. Fecha de inicio del rango de fechas de nacimiento del paciente para filtrar a los pacientes por edad.
PatientBirthdateTo	string (YYYY-MM-DD)	Opcional. Fecha de finalización del rango de fechas de nacimiento del paciente para filtrar a los pacientes por edad.

Eliminar el pedido del paciente

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

Esta función elimina permanentemente el pedido de un paciente del sistema. Requiere tanto el UUID de la institución como el UUID específico de la orden del paciente para garantizar la precisión y evitar la eliminación accidental.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
PatientOrderInstitutionUuid	string	Necesario. UUID de la institución propietaria de la orden del paciente. Garantiza que se utilice el contexto correcto para la eliminación.
PatientOrderUuid	string	Necesario. UUID de la orden específica del paciente que se va a eliminar. Esto identifica de forma exclusiva el pedido en el sistema.

Obtenga contenido de etiquetas Dicom

Obtenga contenido de etiquetas DICOM

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

Esta función recupera los valores de etiquetas DICOM específicas de las imágenes asociadas a la orden de un paciente.

Required Parameters	Data Type	Descripción
UserName	string	El nombre de usuario (dirección de correo electrónico) de la cuenta PostDicom. (desde la inicialización)
Password	string	La contraseña asociada a la cuenta PostDicom. (desde la inicialización)
WebAddress	string	La URL base de la API. (desde la inicialización)
PatientOrderInstitutionUuid	string	Necesario. El UUID de la institución en la que reside el pedido.
PatientOrderUuid	string	Necesario. El UUID del pedido que contiene las imágenes.
PatientSeriesUuid	string	Opcional. Si se proporcionan, solo se leerán las etiquetas de esta serie específica.
DicomTagIdList	List	Opcional. Una lista de los ID de etiquetas DICOM que se van a recuperar.