Documentação do serviço DICOMWeb | PostDiCom

Prerequisites Introdução e informações gerais

Este documento fornece um guia técnico abrangente para DICOMweb API funções com métodos de exemplo que são usados por meio de um aplicativo de exemplo em C#. Inclui explicações detalhadas de todas as funções disponíveis, abrangendo ambas standard DICOMweb services (como QIDO-RS, WADO-RS, and STOW-RS) e custom DICOMweb API endpoints desenvolvido pela PostDicom. Essas funções foram projetadas para serem usadas em chamadas do lado do servidor.

Para usar os serviços DICOMWeb da PostDicom, você deve primeiro ter esse recurso habilitado para sua conta e possuir credenciais de usuário válidas. Se o acesso ao DICOMWeb ainda não estiver ativado para sua conta e você desejar integrar seu aplicativo ao PostDicom, entre em contato conosco para solicitar a ativação.

User Name: Essa é sua credencial de login principal, geralmente seu endereço de e-mail. É exclusivo da sua conta e usado como nome de usuário na Autenticação Básica.

Password: Essa é a senha associada à sua conta PostDicom. Ele é usado em conjunto com seu nome de usuário durante a Autenticação Básica. Para uma segurança ideal, é altamente recomendável escolher uma senha forte. Tenha os mecanismos de segurança necessários em sua chamada do lado do servidor para que esse nome de usuário e senha sejam protegidos por você mesmo.

Você pode gerenciar suas configurações de senha e segurança por meio da página de perfil da sua conta depois de fazer login na sua conta PostDi.com.

Serviços padrão DICOMWeb

Armazene instâncias DICOM ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Essa função orquestra o upload de todos os arquivos.dcm de uma pasta local especificada para o servidor DICOMWeb. Primeiro, ele identifica todos os arquivos relevantes e, em seguida, usa métodos auxiliares para construir e enviar uma solicitação POST autenticada com várias partes/relacionada para cada arquivo, seguindo o padrão STOW-RS.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
DirectoryPath	string	O caminho completo para o diretório local contendo os arquivos DICOM (.dcm) a serem carregados.

Consulta para objetos DICOM ( QIDO-RS)

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

Essa função executa uma consulta para objetos DICOM usando o padrão QIDO-RS, permitindo pesquisas no nível de Estudo, Série ou Instância. Com base no parâmetro de pesquisa fornecido (como ID do paciente, UID da instância de estudo ou UID da instância de série), ele constrói a URL apropriada e executa uma solicitação autenticada para recuperar os resultados correspondentes do servidor.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
PatientID	string	Opcional. Usado para identificar o paciente e pesquisar estudos relacionados.
StudyInstanceUID	string	Opcional. Usado para pesquisar um estudo específico ou todas as séries desse estudo.
SeriesInstanceUID	string	Opcional. Usado para pesquisar todas as instâncias de imagem em uma série específica.

Recuperar instâncias DICOM ( WADO-RS)

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

Essa função fornece um menu interativo para recuperar objetos DICOM usando o padrão WADO-RS. O usuário seleciona um nível de recuperação (estudo, série ou instância) e fornece o UID correspondente. Em seguida, a função faz uma solicitação autenticada e processa a resposta multiparte/relacionada, salvando cada peça DICOM como um arquivo.dcm separado em um diretório local recém-criado.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
StudyInstanceUID	string	Opcional. Um identificador global exclusivo para um estudo DICOM. Usado para recuperar todas as séries e instâncias associadas a esse estudo.
SeriesInstanceUID	string	Opcional. Um identificador global exclusivo para uma série em um estudo DICOM. Usado para recuperar todas as imagens dessa série.
SOPInstanceUID	string	Opcional. Um identificador exclusivo para uma instância de imagem DICOM individual. Usado para recuperar uma imagem específica usando o WADO-RS.

Gerenciamento de compartilhamento

Criar link de compartilhamento

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

Essa função gera um link seguro para compartilhar um ou mais pedidos de pacientes com usuários externos. O link pode ser protegido por senha e, opcionalmente, permitir downloads.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha da conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
PatientOrderInfoList	List	Lista de strings JSON, cada uma contendo uma chave “patientOrderUUID”, identificando os pedidos dos pacientes a serem compartilhados.
ExpireDate	string (YYYY-MM-DD)	Data de expiração do link de compartilhamento. Após essa data, o link será desativado.
SharePassword	string	Opcional. É necessária uma senha para acessar o link de compartilhamento. Deixe em branco para acesso público.
Downloadable	bool	Opcional. Determina se os estudos DICOM podem ser baixados pelo destinatário.

Compartilhe o pedido do paciente com URL

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

Essa função gera um URL compartilhável para pedidos de pacientes selecionados com opções adicionais de controle de acesso, como permissão de download e proteção por senha.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha da conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
OrderUuidList	List	Lista de UUIDs identificando pedidos de pacientes a serem compartilhados.
ExpireDate	string (YYYY-MM-DD)	Data após a qual o link de compartilhamento se torna inativo.
SharePassword	string	Opcional. É necessária uma senha para acessar o link compartilhado.
UserCanDownloadStudies	bool	Opcional. Se definido como verdadeiro, o destinatário pode baixar os estudos.

Gerenciamento de pastas e pedidos

Criar pasta

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

Essa função é usada para criar uma nova pasta (um contêiner virtual) na conta PostDicom para ajudar a organizar os pedidos dos pacientes.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
FolderName	string	Obrigatório. O nome visível da nova pasta.
FolderDescription	string	Opcional. Uma descrição em texto para a pasta.
ParentFolderUuid	string	Opcional. O UUID de uma pasta existente para criar a nova pasta dentro dela.

Pasta de pesquisa

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

Essa função localiza pastas existentes com base nos critérios de pesquisa. Opcionalmente, ele pode incluir a lista de pedidos de pacientes em cada pasta encontrada.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
ParentFolderUuid	string	Opcional. Um UUID de pasta para restringir a pesquisa a seus filhos.
FolderName	string	Opcional. Um nome completo ou parcial para pesquisar.
GetOrdersInFolder	bool	Opcional. Se “verdadeiro”, a resposta incluirá uma lista de pedidos de pacientes para cada pasta encontrada.

Compartilhar pasta com URL

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

Essa função gera uma URL segura e compartilhável para uma pasta inteira e seu conteúdo. Ele permite um controle de acesso abrangente, definindo um título personalizado, uma descrição, uma senha, uma data de validade e especificando se o conteúdo pode ser baixado pelo destinatário.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
FolderUuid	string	Obrigatório. O identificador exclusivo (UUID) da pasta a ser compartilhada.
SharePassword	string	Opcional. Uma senha para proteger o link compartilhado. Se deixado vazio, o link estará acessível ao público.
ShareTitle	string	Opcional. Um título personalizado para a página da pasta compartilhada, visível para o destinatário.
ShareDescription	string	Opcional. Uma descrição exibida na página da pasta compartilhada.
ExpireDate	string (YYYY-MM-DD)	Opcional. A data em que o link de compartilhamento ficará automaticamente inativo.
UserCanDownloadStudies	bool	Opcional. Se “verdadeiro”, os destinatários podem baixar os pedidos dos pacientes contidos na pasta.

Adicionar pedido à pasta

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

Essa função cria uma associação entre um pedido de paciente existente e uma pasta existente. Essa é uma ferramenta organizacional; ela não move nem copia dados.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
PatientOrderUuid	string	Obrigatório. O UUID do pedido do paciente a ser colocado em uma pasta.
FolderUuidList	List	Obrigatório. Uma lista contendo o UUID da pasta de destino.

Fluxo de trabalho e atribuição

Atribuir pedido ao usuário

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

Essa função é a principal ferramenta de fluxo de trabalho. Ele atribui um pedido de paciente a um usuário individual, significando que esse usuário agora é responsável por uma tarefa relacionada a esse pedido (por exemplo, relatórios).

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
PatientOrderUuid	string	Obrigatório. O UUID do pedido do paciente que requer ação.
AssignedUserUuid	string	Obrigatório. O UUID do usuário específico ao qual será atribuída a responsabilidade.

Atribuir pedido ao grupo de usuários

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

Semelhante à atribuição a um único usuário, essa função atribui um pedido de paciente a um grupo inteiro, permitindo fluxos de trabalho baseados em equipe em que qualquer membro do grupo pode lidar com a tarefa.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
PatientOrderUuid	string	Obrigatório. O UUID do pedido do paciente a ser atribuído ao grupo.
AssignedUserGroupUuid	string	Obrigatório. O UUID do grupo de usuários ao qual será atribuído o pedido.

Ciclo de vida do pedido do paciente e recuperação de dados

Criar pedido de paciente

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

Essa função cria um novo pedido de pacientes para agendar e gerenciar estudos de imagem dentro do sistema. Os parâmetros necessários devem ser fornecidos para uma criação bem-sucedida.

Required Parameters	Data Type	Descrição
InstitutionUuid	string	Obrigatório. UUID da instituição onde o pedido do paciente está sendo criado.
PatientName	string	Obrigatório. Nome completo do paciente.
PatientId	string	Obrigatório. Identificador exclusivo do paciente, como identificação nacional ou MRN.
PatientBirthdate	string (YYYY-MM-DD)	Obrigatório. Data de nascimento do paciente no formato ISO.
Modality	string	Obrigatório. Tipo de modalidade, como CT, MR, US, etc.
OtherPatientId	string	Opcional. Um identificador adicional para o paciente, se aplicável.
PatientSex	string	Opcional. Sexo do paciente (por exemplo, M, F, O).
StudyDescription	string	Opcional. Descrição do estudo de imagem que está sendo solicitado.
AccessionNumber	string	Opcional. Número de acesso exclusivo para o pedido, se aplicável.
PatientComplaints	string	Opcional. Texto descrevendo as queixas ou sintomas do paciente.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Opcional. A data e a hora de início programadas do procedimento.
RequestedProcedureId	string	Opcional. Identificador do procedimento solicitado.
RequestedProcedureDescription	string	Opcional. Descrição do procedimento solicitado.
RequestingPhysician	string	Opcional. Nome do médico que solicitou o estudo.
ReferringPhysiciansName	string	Opcional. Nome do médico solicitante, se for diferente do solicitado.
ScheduledEquipmentUuid	string	Opcional. UUID do equipamento de imagem a ser usado para o procedimento agendado.

Obtenha as propriedades do pedido do paciente

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

Essa função recupera o conjunto completo de propriedades de um único pedido específico do paciente.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
PatientOrderInstitutionUuid	string	Obrigatório. O UUID da instituição à qual o pedido pertence.
PatientOrderUuid	string	Obrigatório. O UUID do pedido específico do paciente a ser recuperado.

Pesquisar pedidos de pacientes

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

Essa função recupera uma lista de pedidos de pacientes com base em uma combinação de filtros de pesquisa, como nome do paciente, ID, modalidade e data de estudo ou nascimento. Ele permite a funcionalidade de pesquisa avançada para instituições que gerenciam vários pedidos.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
InstitutionUuidList	List	Lista de UUIDs identificando as instituições para pesquisar pedidos de pacientes.
PatientName	string	Opcional. Filtrar pelo nome completo do paciente.
PatientId	string	Opcional. Filtre pelo identificador exclusivo do paciente.
OtherPatientId	string	Opcional. Identificador secundário do paciente, se disponível.
AccessionNumber	string	Opcional. Filtrar por número de acesso atribuído ao estudo.
ModalityList	List	Lista de modalidades (por exemplo, CT, MR, US) para filtrar os resultados da pesquisa.
StudyDateFrom	string (YYYY-MM-DD)	Opcional. Data de início do intervalo de datas do estudo para filtrar os resultados.
StudyDateTo	string (YYYY-MM-DD)	Opcional. Data de término do intervalo de datas do estudo para filtrar os resultados.
PatientBirthdateFrom	string (YYYY-MM-DD)	Opcional. A data de início do intervalo de datas de nascimento do paciente para filtrar os pacientes por idade.
PatientBirthdateTo	string (YYYY-MM-DD)	Opcional. A data final do intervalo de datas de nascimento do paciente para filtrar os pacientes por idade.

Excluir pedido de paciente

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

Essa função exclui permanentemente um pedido de paciente do sistema. Ele exige o UUID da instituição e o UUID específico do pedido do paciente para garantir a precisão e evitar a exclusão acidental.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
PatientOrderInstitutionUuid	string	Obrigatório. UUID da instituição proprietária do pedido do paciente. Garante que o contexto correto seja usado para exclusão.
PatientOrderUuid	string	Obrigatório. UUID do pedido específico do paciente a ser excluído. Isso identifica exclusivamente o pedido no sistema.

Obtenha o conteúdo da tag Dicom

Obtenha o conteúdo da tag DICOM

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

Essa função recupera os valores de tags DICOM específicas das imagens associadas a um pedido de paciente.

Required Parameters	Data Type	Descrição
UserName	string	O nome de usuário (endereço de e-mail) da conta PostDicom. (da inicialização)
Password	string	A senha associada à conta PostDicom. (da inicialização)
WebAddress	string	O URL base da API. (da inicialização)
PatientOrderInstitutionUuid	string	Obrigatório. O UUID da instituição em que o pedido reside.
PatientOrderUuid	string	Obrigatório. O UUID do pedido contendo as imagens.
PatientSeriesUuid	string	Opcional. Se fornecidas, as tags só serão lidas dessa série específica.
DicomTagIdList	List	Opcional. Uma lista de IDs de tags DICOM a serem recuperadas.