Ir direto para menu de acessibilidade.
Início do conteúdo da página

Web Service - Base Nacional da Assistência Farmacêutica

Perguntas Frequentes

Escrito por Alessandra Bernardes | Publicado: Sexta, 20 de Outubro de 2017, 16h11 | Última atualização em Segunda, 13 de Novembro de 2017, 18h24

O que é o Web Service?

O web service é uma solução utilizada na integração de sistemas e na comunicação entre aplicações. Com essa tecnologia é possível que dados de sistemas desenvolvidos em plataformas diferentes sejam compatíveis.

O objetivo do web service da Base Nacional de Dados de Ações e Serviços da Assistência Farmacêutica no SUS é permitir a interoperabilidade para que Municípios, Estados e Distrito Federal que não utilizam o sistema Hórus possam enviar os dados referentes à posição de estoque, entradas, saídas, dispensações e avaliações, no âmbito dos medicamentos contidos na RENAME para a BNDASAF.


Qual é a lógica do web service?

As requisições serão feitas sob a forma de serviços web (web service), utilizando-se do protocolo HTTPS para transmissão dos dados e SOAP (Simple Object Acess Protocolo) como protocolo de troca de dados entre as aplicações.

Estes serviços estarão descritos sob a forma de um arquivo eletrônico no formato WSDL (web service Description Language) e XSD (XML Schema Definition).


O Ministério da Saúde fornece algum subsídio financeiro aos estados e municípios para o desenvolvimento do web service?

Não. Porém, em contrapartida, o Ministério da Saúde fornece o Sistema Nacional de Gestão da Assistência Farmacêutica – Hórus de forma gratuita para os estados e municípios. A utilização do Hórus em sua plenitude afasta a necessidade de desenvolvimento de web service pelo estado ou município.


Como é feita solicitação de acesso ao web service?

Você pode consultar no tópico “Solicitação de perfil de acesso” do Roteiro de Uso do web service o passo-a-passo para a solicitação de acesso ao web service. Clique aqui para acessar o Roteiro de Uso.


O Ministério da Saúde libera acesso ao web service para empresas privadas?

Não. A liberação de acesso ao ambiente de homologação e produção do web service será liberado somente para pleitos realizados por gestores municipais e estaduais. Caso um município ou estado contrate uma empresa privada para o desenvolvimento do web service, o gestor local deverá solicitar acesso ao web service e posteriormente repassar os dados de acesso a respectiva empresa.


Quais os métodos disponíveis?

Os métodos disponíveis no web service estão estratificados em dois grupos, os assíncronos e síncronos.

Os métodos síncronos deverão ser utilizados para os usuários que queiram enviar os arquivos XML com os dados gerados em tempo real pelo sistema local. Esses métodos permitem que os usuários enviem arquivos com apenas um registro. Já os usuários que desejam enviar arquivos XML com vários registros deverão utilizar os métodos assíncronos.

Os métodos de retificação e exclusão estarão disponíveis para que os estados e municípios retifiquem ou excluam algum registro enviado anteriormente. O método de consultar processamento e inconsistência está disponível apenas para o método assíncrono, haja vista que no método síncrono o web service já retorna no mesmo momento o resultado do processamento.


Como enviar os dados pelo web service de estado ou município com problemas de conectividade de internet?

O envio de dados para o web service não precisa ser necessariamente em tempo real. Os estados e municípios podem enviar os seus dados em lotes contendo os registros de um mês inteiro, e esse envio não precisa ser realizado em um estabelecimento de saúde. Assim, a necessidade de internet fica restrita a somente um momento no mês inteiro e em apenas um computador, quando será enviado o arquivo com os dados do mês anterior completo.


Quais os prazos para envios, consultas, retificações e exclusões?

A transmissão dos arquivos XML por meio do web service poderá ser realizada em tempo real (métodos síncronos) ou em pacotes de dados (métodos assíncronos), da seguinte forma:

I – Método Informar:

Para o envio de registros em lotes, os pacotes deverão ser transmitidos a cada 30 dias, até o dia 15 do mês subsequente à competência de referência. Já para os registros síncronos, a transmissão deverá ocorrer assim que o registro for gerado no sistema local.
Os dados de posição de estoque deverão ser transmitidos somente uma vez ao mês, com a data do último dia do mês, para os métodos síncronos e assíncronos.

II – Método Retificar ou Excluir:

A retificação ou exclusão dos dados enviados deverá ocorrer até o fim do mês subsequente ao de referência do pacote que contém o erro. Esse prazo é aplicado para o envio de dados assíncronos e síncronos.

III – Método Consultar Inconsistências:

A consulta dos registros inconsistentes estará disponível em um prazo de até 7 dias após o envio do dado para o web service, somente para o envio assíncrono. Para os métodos síncronos, as inconsistências serão apresentadas no momento do processamento do arquivo, não sendo possível realizar consulta posterior.


O que contempla o conjunto de dados pactuado e disposto na Portaria nº 957/GM/MS, de 10 de maio de 2016?

Esses dados são referentes ao conjunto de dados de estoque, entrada, saída, dispensação dos medicamentos e insumos referentes à RENAME, e aos registros das avaliações das solicitações no âmbito do Componente Especializado da Assistência Farmacêutica. Sendo:

Estados e Distrito Federal: envio de dados do anexo III (Componente Especializado da Assistência Farmacêutica)  da RENAME e,

*para os Municípios que realizam dispensação, conforme pactuação na Comissão Intergestores Bipartite (CIB).

Município: envio de dados dos anexos I (Componente Básico da Assistência Farmacêutica), II (Componente Estratégico da Assistência Farmacêutica) e IV (Insumos) da RENAME;

A transmissão dos dados de dispensação dos produtos constantes nos Anexos I, II e IV da RENAME é obrigatória somente para os Municípios habilitados no Eixo Estrutura do QUALIFAR-SUS.


Caso perca o prazo para envio dos dados pelo web service, como posso reenviar retroativamente?

Caso o estado ou município necessite utilizar o web service para a transmissão dos dados fora dos prazos estabelecidos, deverá acessar este link e preencher o formulário para formalizar o pedido. No formulário deverá constar o motivo, descrição do município, estado ou Distrito Federal e qual o período de data que deseja que o web service aceite o envio dos dados (será permitido no máximo 3 dias), bem como anexando um oficio formalizando o pleito.

O Ministério da Saúde irá analisar os motivos e deliberará sobre a abertura de nova janela para transmissão ou não.


O que fazer caso o sistema informatizado da Secretaria Estadual ou Municipal de Saúde não possua todos os dados que são de envio obrigatório para a
BNDASAF?

Nesse caso, a gestão municipal deverá solicitar uma alteração/evolução no sistema do almoxarifado ou da farmácia para que este passe a ter mecanismos de captar todas as informações previstas na BNDASAF, conforme a Portaria nº 957/2016/GM/MS. Uma outra opção, é aderir ao sistema Hórus que já é 100% compatibilizado com a BNDASAF.


Como faço para consultar os dados enviados para a BNDASAF?

A Portaria GM/MS nº 957/2016 determina que o Ministério da Saúde deve disponibilizar um Sistema de Suporte à Decisão (SSD) para que os entes federativos possam realizar consultas aos dados enviados a BNDASAF. O Ministério da Saúde possui o prazo de 90 dias para a disponibilização do SSD a partir da data de liberação do web service em produção.

Esse SSD será desenvolvido pelo Ministério da Saúde utilizando uma ferramenta de Business Intelligence (BI). Esse tipo de ferramenta permite que o gestor realize o monitoramento de processos operacionais e estratégicos de forma simples e rápida, pois tem uma interface amigável para que o usuário consiga aproveitá-la ao máximo.

Esse BI terá dados somente do ambiente de produção da BNDASAF e a sua base será atualizada toda madrugada, ou seja, os usuários somente poderão ver os dados do dia anterior.

Assim que o desenvolvimento do SSD esteja finalizado, os municípios e estados que já possuem acesso ao web service serão informados sobre a disponibilização do SSD.


Como contratar uma empresa de TI para desenvolver o web service?

Primeiramente, antes de contratar uma empresa de TI o gestor deverá verificar se a própria equipe de informática da sua secretaria de saúde possui meios de desenvolver o web service. Caso não seja possível, o Ministério da Saúde elaborou um documento com algumas instruções para que os gestores municipais e estaduais possam observar no momento da contratação de uma empresa de TI para desenvolver o web service. Clique aqui para acessar o site com o documento.


Como devem ser enviados os dados de posição de estoque para a BNDASAF?

Os dados de posição de estoque devem ser enviados somente uma vez por mês para a BNDASAF. Nesse envio deve constar a posição de estoque do último dia do mês de cada estabelecimento de saúde. Assim, esses dados devem ser enviados no primeiro envio do mês subsequente à competência de referência.


Como posso saber se um XML enviado foi recebido pelo web service?

Caso o envio tenha sido realizado por um método síncrono e não haja inconsistência, o web service irá retornar ao usuário um código de protocolo e a data e horário de recebimento do XML, no momento de recebimento do arquivo. Em caso de inconsistência, o web service retornará ao usuário os erros do XML, também no momento de recebimento do arquivo.

Para o envio utilizando método assíncrono, o web service retornará ao usuário o código de protocolo e a data e horário de recebimento do XML, independente do XML enviado possuir ou não inconsistência.


Como consultar as inconsistências de um XML (protocolo) enviado ao web service?

A consulta de inconsistência somente está disponível para os XML enviados pelos métodos assíncronos e poderá ser realizada por meio do método “consultarInconsistencias”. Já para os envios realizados pelos métodos síncronos, o web service realiza a validação das inconsistências no momento do recebimento do XML e retorna as inconsistências no mesmo momento, não havendo possibilidade de realizar uma consulta posterior. Contudo, antes de realizar a consulta de inconsistência, o usuário deverá consultar se o XML já foi processado pelo web service, por meio do método “consultarResultadoProcessamento”. Caso o XML não tenha sido processado, o resultado da consulta de inconsistência poderá apresentar um resultado falso negativo.


Qual o tempo máximo que o web service irá processar os arquivos enviados?

Para os XML enviados pelos métodos síncronos, ao receber os XML o web service já irá processá-los. Para os XML enviados pelos métodos assíncronos, o web service irá gerar uma fila de processamento desses arquivos, não havendo um tempo máximo pra realizar o processamento.


Enviei um dado incorreto para o web service, como devo proceder para adequá-lo?

O usuário deverá realizar a retificação do dado por meio dos métodos de retificação, obedecendo o prazo limite de retificação, que é até o fim do mês subsequente ao de referência do protocolo que contém o erro. Somente será possível realizar a retificação dos registros que não apresentaram inconsistência.


Qual o tamanho máximo de arquivos que o web service irá aceitar?

O web service aceita arquivos XML de no máximo 4 mb, não havendo restrição de número de registros dentro do limite de 4 mb.


Onde estão descritos os campos do web service?

No site do Ministério da Saúde estão disponíveis para download os arquivos XSD e WSDL, bem como o Roteiro de Uso que contém o dicionário de dados do web service. Clique aqui para acessar o site.


O que fazer caso um município ou estado possua alguma apresentação de medicamento da RENAME que o Ministério da Saúde não possui um código de produto para o web service?

Nesse caso, o estado ou município deverá acessar esse link e preencher o formulário com a descrição completa do medicamento e o número de registro na ANVISA.


É possível excluir ou retificar somente um registro XML ou é necessário excluir todo o protocolo e enviá-lo novamente?

O web service permite que o usuário possa realizar a exclusão ou retificação de somente um ou mais registros dentro de um protocolo. Para isso, basta informar o campo de preenchimento não obrigatório “coRegistro” para que o web service possa apagar ou retificar somente esses registros.


Qual o significado das mensagens de inconsistência do web service?

Ao realizar uma consulta de inconsistência, o web service irá retornar o registro que apresentou o erro, o respectivo campo, código de erro, mensagem de erro e valor inserido pelo usuário no campo que apresentou a inconsistência. Caso o usuário possua dificuldade em interpretar a mensagem de erro, o mesmo poderá consultar o Roteiro de Uso para verificar uma explicação mais detalhada sobre cada mensagem de erro que o web service retornar aos usuários. Clique aqui para acessar o site com o Roteiro de Uso.


Como enviar as credenciais de login e senha para o web service?

As informações de login e senha deverão ser enviadas no cabeçalho dos arquivos XML. Essas credenciais são as cadastradas no SCPA - Sistema de Cadastro e Permissão de Acesso.

Como são as credencias de acesso do web service?

As credenciais de acesso dos sistemas externos deverão ser fornecidas seguindo o padrão HTTP BASIC que consiste em envio do header HTTP “Authorization” construído da
seguinte forma:

1 - O usuário e a senha devem ser combinados pelo caractere “:”, ex: joao.silva:123456
2 - A string resultante é codificada na base 64, ex: am9hby5zaWx2YToxMjM0NTY=
3 - O header “Authorization” deverá ser atribuído com o método “Basic”, um espaço em branco e a string codificada, ex: Authorization: Basic am9hby5zaWx2YToxMjM0NTY=


O envio dos dados de quantitativo de medicamentos deve respeitar a menor unidade de fornecimento?

Sim, exceto para alguns itens. Para saber quais são os medicamentos que se enquadram nas exceções basta acessar o Roteiro de Uso, no tópico “Regras de Envio”. Clique aqui para acessar o Roteiro de Uso.


Em caso de envio de XML em que somente alguns registros apresentaram inconsistência, o web service irá gravar na base definitiva os registros que não apresentaram inconsistência ou irá rejeitar todos os registros do XML?

Nesses casos, os registros que não apresentaram inconsistência serão gravados na base definitiva, e os que apresentaram inconsistências ficarão disponíveis para consulta na base temporária de inconsistências por 7 dias.


Trabalho em uma empresa de TI que desenvolveu o web service para vários municípios. Dessa forma, necessito ter uma credencial de acesso no SCPA para cada município que atendo?

Sim, pois o web service possui regras de negócio de segurança que confrontam os dados de cadastro no SCPA com os dados contidos nos XML.


O que fazer caso o prazo de 7 dias de correção das inconsistências tenha vencido e o estado ou município não realizou a adequação dos registros?

Nesses casos, o município ou estado deverá informar esses dados novamente para o web service, utilizando os métodos de informar (ex: informarPosicaoEstoqueEmLote, informarDispensacaoMedicamentoEmLote).


Onde estão disponibilizados os códigos de medicamentos, tipos de estabelecimento de saúde, entradas, saídas e programas de saúde do web service?

No site do web service estão disponíveis para download todos esses códigos em .xls. Clique aqui para acessar o site.


É possível identificar durante a consulta de processamento se os registros enviados possuem inconsistências ou não?

Sim, pois os registros que não apresentaram insistências serão devolvidos no resultado da consulta de processamento. Ao realizar a consulta, alguns campos desses registros serão devolvidos pelo web service, juntamente com o campo “coRegistro”. Já os registros com inconsistências não serão referenciados nessa consulta.


Necessito realizar uma retificação e/ou exclusão de registros já enviados. Onde posso localizar os códigos de registro de um XML já processado?

Para os métodos assíncronos, o usuário deverá consultar o resultado de processamento e consultar as inconsistências do respectivo XML. No método de consultar o resultado de processamento, o usuário terá acesso aos códigos de registros que não apresentaram inconsistência. Já no método de consultar inconsistências o usuário poderá identificar os códigos de registro que apresentaram inconsistência.
Já para os métodos síncronos, o web service sempre irá retornar o código de registro ao processar o XML.


Para mais informações, clique aqui e acesse o roteiro de uso do web service.

registrado em:
Fim do conteúdo da página