Introdução e Informações Gerais
Este documento fornece um guia técnico abrangente para as funções da API DICOMweb com exemplos de métodos utilizados através de uma aplicação de exemplo em C#. Inclui explicações detalhadas de todas as funções disponíveis, abrangendo tanto os serviços padrão DICOMweb (como QIDO-RS, WADO-RS e STOW-RS) quanto as funções API DICOMweb personalizadas desenvolvidas pela PostDICOM. Estas funções foram concebidas para serem utilizadas em chamadas do lado do servidor.
Para utilizar os serviços DICOMweb do PostDICOM, deve primeiro ter este recurso ativado na sua conta e possuir credenciais de utilizador válidas. Caso o acesso DICOMweb ainda não esteja ativado para a sua conta e deseje integrar a sua aplicação com a PostDICOM, por favor contacte-nos para solicitar a ativação.
Nome de Utilizador: Esta é a sua principal credencial de login, geralmente o seu endereço de e-mail. É único na sua conta e é usado como nome de utilizador na Autenticação Básica.
Senha: Esta é a senha associada à sua conta PostDICOM. É utilizada em conjunto com o seu nome de utilizador durante a Autenticação Básica. Para a segurança ideal, recomendamos vivamente a escolha de uma senha forte. Por favor, assegure os mecanismos de segurança necessários na sua chamada do lado do servidor para que este nome de utilizador e a senha estejam devidamente protegidos.
Pode gerir as suas definições de segurança e a sua senha através da página de perfil da sua conta depois de fazer o login na sua conta PostDICOM.
Armazenar Instâncias DICOM (STOW-RS)
Esta função orquestra o upload de todos os ficheiros .dcm de uma pasta local especificada para o servidor DICOMweb. Primeiro identifica todos os ficheiros relevantes e, em seguida, utiliza métodos auxiliares para construir e enviar um pedido POST multipart/related autenticado para cada ficheiro, respeitando a norma STOW-RS.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 a diretoria local que contém os ficheiros DICOM (.dcm) a carregar. |
Consultar Objetos DICOM (QIDO-RS)
Esta função executa uma consulta a objetos DICOM através do padrão QIDO-RS, permitindo pesquisas a nível do Estudo, da Série ou da Instância. Com base no parâmetro de pesquisa fornecido (como Patient ID, Study Instance UID ou Series Instance UID), ela constrói a URL apropriada e executa um pedido autenticado para recuperar os resultados correspondentes do servidor.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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. Utilizado para identificar o paciente e pesquisar estudos relacionados. |
| StudyInstanceUID | string | Opcional. Utilizado para procurar um estudo específico ou todas as séries dentro desse estudo. |
| SeriesInstanceUID | string | Opcional. Utilizado para procurar todas as instâncias de imagem numa série específica. |
Recuperar Instâncias DICOM (WADO-RS)
Esta função fornece um menu interativo para recuperar objetos DICOM usando o padrão WADO-RS. O utilizador seleciona o nível de recuperação (Estudo, Série ou Instância) e fornece o UID correspondente. A função faz, então, um pedido autenticado e processa a resposta multipart/related, guardando cada parte DICOM como um ficheiro .dcm separado numa diretoria local recém-criada.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 globalmente exclusivo para um estudo DICOM. Usado para recuperar todas as séries e instâncias associadas a esse estudo. |
| SeriesInstanceUID | string | Opcional. Um identificador globalmente exclusivo para uma série dentro de 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 WADO-RS. |
Criar Link de Compartilhamento
Esta função gera um link da web seguro para compartilhar um ou mais pedidos de paciente com utilizadores externos. O link pode ser protegido por senha e, opcionalmente, permitir downloads.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (e-mail) para a 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 de paciente a serem compartilhados. |
| ExpireDate | string (AAAA-MM-DD) | Data de expiração do link de compartilhamento. Após esta data, o link será desativado. |
| SharePassword | string | Opcional. Senha necessária para aceder ao link. Deixe vazio para acesso público. |
| Downloadable | bool | Opcional. Determina se os estudos DICOM podem ser descarregados pelo destinatário. |
Compartilhar Pedido do Paciente com URL
Esta função gera uma URL compartilhável para pedidos de pacientes selecionados com opções adicionais de controle de acesso, tais como permissão de download e proteção por senha.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (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 que identificam os pedidos de paciente a serem compartilhados. |
| ExpireDate | string (AAAA-MM-DD) | Data após a qual o link de compartilhamento fica inativo. |
| SharePassword | string | Opcional. Senha exigida para aceder ao link compartilhado. |
| UserCanDownloadStudies | bool | Opcional. Se definido como true, o destinatário pode descarregar os estudos. |
Criar Pasta
Esta função é usada para criar uma nova pasta (um recipiente virtual) dentro da conta PostDICOM para ajudar na organização de pedidos de pacientes.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 para a nova pasta. |
| FolderDescription | string | Opcional. Uma descrição de texto para a pasta. |
| ParentFolderUuid | string | Opcional. O UUID de uma pasta existente para criar a nova pasta no seu interior. |
Pesquisar Pasta
Esta função procura pastas existentes com base em critérios de pesquisa. Pode incluir, opcionalmente, a lista de pedidos do paciente contidos em cada pasta encontrada.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 aos seus filhos. |
| FolderName | string | Opcional. Um nome completo ou parcial para pesquisar. |
| GetOrdersInFolder | bool | Opcional. Se for `true`, a resposta incluirá uma lista de pedidos do paciente para cada pasta encontrada. |
Compartilhar Pasta com URL
Esta função gera uma URL segura e compartilhável para uma pasta inteira e os seus conteúdos. Permite um controlo de acesso abrangente ao definir um título personalizado, uma descrição, uma senha, uma data de expiração, e especificar se o conteúdo pode ser descarregado pelo destinatário.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 deixada em branco, o link será publicamente acessível. |
| 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 (AAAA-MM-DD) | Opcional. A data em que o link de compartilhamento se tornará automaticamente inativo. |
| UserCanDownloadStudies | bool | Opcional. Se for `true`, os destinatários poderão descarregar os pedidos dos pacientes contidos na pasta. |
Adicionar Pedido à Pasta
Esta função cria uma associação entre um pedido de paciente existente e uma pasta existente. Trata-se de uma ferramenta organizacional; não move nem copia dados.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 de paciente que se pretende colocar numa pasta. |
| FolderUuidList | List |
Obrigatório. Uma lista que contém o UUID da pasta de destino. |
Atribuir Pedido a Utilizador
Esta função é uma ferramenta central no fluxo de trabalho. Ela atribui um pedido de paciente a um utilizador individual, sinalizando que este utilizador é agora responsável por uma tarefa relacionada com aquele pedido (ex.: elaboração de relatório).
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 de paciente que requer ação. |
| AssignedUserUuid | string | Obrigatório. O UUID do utilizador específico que ficará encarregue da responsabilidade. |
Atribuir Pedido a Grupo de Utilizadores
De forma semelhante à atribuição a um utilizador único, esta função atribui um pedido de paciente a um grupo inteiro, possibilitando fluxos de trabalho em equipa onde qualquer membro do grupo pode tratar da tarefa.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 de paciente a ser atribuído ao grupo. |
| AssignedUserGroupUuid | string | Obrigatório. O UUID do grupo de utilizadores ao qual será atribuído o pedido. |
Criar Pedido de Paciente
Esta função cria um novo pedido de paciente para agendar e gerir estudos de imagem dentro do sistema. Os parâmetros obrigatórios devem ser fornecidos para uma criação bem-sucedida.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| InstitutionUuid | string | Obrigatório. UUID da instituição onde o pedido do paciente está a ser criado. |
| PatientName | string | Obrigatório. Nome completo do paciente. |
| PatientId | string | Obrigatório. Identificador exclusivo do paciente, como um número de identificação nacional ou processo clínico. |
| PatientBirthdate | string (AAAA-MM-DD) | Obrigatório. Data de nascimento do paciente em 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 (ex., M, F, O). |
| StudyDescription | string | Opcional. Descrição do estudo de imagem que está a ser pedido. |
| AccessionNumber | string | Opcional. Número de acesso exclusivo para o pedido, se aplicável. |
| PatientComplaints | string | Opcional. Texto a descrever as queixas ou os sintomas do paciente. |
| OrderScheduledDatetime | string (AAAA-MM-DD HH:MM) | Opcional. A data e hora de início programadas para o procedimento. |
| RequestedProcedureId | string | Opcional. Identificador para o 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 de encaminhamento, caso seja diferente do solicitante. |
| ScheduledEquipmentUuid | string | Opcional. UUID do equipamento de imagem a ser utilizado para o procedimento agendado. |
Obter Propriedades do Pedido de Paciente
Esta função recupera o conjunto completo de propriedades para um único e específico pedido de paciente.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 pertence o pedido. |
| PatientOrderUuid | string | Obrigatório. O UUID do pedido de paciente específico a ser recuperado. |
Pesquisar Pedidos de Pacientes
Esta função recupera uma lista de pedidos de pacientes com base numa combinação de filtros de pesquisa tais como nome do paciente, ID, modalidade, e datas do estudo ou de nascimento. Ela permite funcionalidades de pesquisa avançadas para instituições que gerem múltiplos pedidos.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 por pedidos de pacientes. |
| PatientName | string | Opcional. Filtrar por nome completo do paciente. |
| PatientId | string | Opcional. Filtrar pelo identificador exclusivo do paciente. |
| OtherPatientId | string | Opcional. Identificador secundário para o paciente, se disponível. |
| AccessionNumber | string | Opcional. Filtrar pelo número de acesso atribuído ao estudo. |
| ModalityList | List |
Lista de modalidades (ex., CT, MR, US) para filtrar os resultados da pesquisa. |
| StudyDateFrom | string (AAAA-MM-DD) | Opcional. Data de início do intervalo de datas do estudo para filtrar os resultados. |
| StudyDateTo | string (AAAA-MM-DD) | Opcional. Data de fim do intervalo de datas do estudo para filtrar os resultados. |
| PatientBirthdateFrom | string (AAAA-MM-DD) | Opcional. Data de início do intervalo da data de nascimento para filtrar pacientes por idade. |
| PatientBirthdateTo | string (AAAA-MM-DD) | Opcional. Data de fim do intervalo da data de nascimento para filtrar pacientes por idade. |
Apagar Pedido de Paciente
Esta função elimina permanentemente um pedido de paciente do sistema. Ela exige tanto o UUID da instituição quanto o UUID específico do pedido de paciente, de forma a garantir precisão e evitar exclusões acidentais.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 de paciente. Garante que o contexto correto é utilizado para exclusão. |
| PatientOrderUuid | string | Obrigatório. UUID do pedido específico de paciente a ser excluído. Isto identifica unicamente o pedido no sistema. |
Obter Conteúdo da Tag DICOMObter Conteúdo da Tag DICOM
Esta função recupera os valores de tags DICOM específicas a partir das imagens associadas a um pedido de paciente.
| Parâmetros Obrigatórios | Tipo de Dados | Descrição |
| UserName | string | O nome de utilizador (endereço de e-mail) para a 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 onde reside o pedido. |
| PatientOrderUuid | string | Obrigatório. O UUID do pedido que contém as imagens. |
| PatientSeriesUuid | string | Opcional. Se fornecido, as tags só serão lidas desta série específica. |
| DicomTagIdList | List |
Opcional. Uma lista de IDs de Tag DICOM para recuperar. |