A API de Exportação dos Dados Assistenciais permite que os sistemas da sua instituição recebam, de forma automatizada, as internações registradas na Plataforma DRG Brasil. Com ela, é possível manter uma base de dados própria sempre atualizada, por exemplo para painéis de indicadores, BI ou integração com outros sistemas internos.
A API oferece duas consultas: a de internações, que retorna os dados assistenciais completos de cada internação, e a de internações excluídas, que informa quais registros foram removidos da Plataforma. O retorno é entregue em formato JSON. O uso da API é feito pela equipe de TI ou de desenvolvimento da instituição.
Como funciona
- O Usuário Administrador da instituição solicita ao Suporte uma credencial do tipo API Dados Assistenciais, pelo e-mail suporte@drgbrasil.com.br.
- O Suporte cria um usuário e uma senha exclusivos para a API e envia a chave de acesso (
x-api-key) vinculada à instituição. - O sistema da instituição se autentica com esse usuário e senha e recebe um token de acesso, que tem validade de 4 horas.
- Com o token e a chave de acesso, o sistema envia as consultas de internações, usando os filtros disponíveis, ou de internações excluídas, informando a data da exclusão.
- A API retorna os registros em páginas de até 100 internações, e o sistema da instituição atualiza sua base de dados.
Importante: a API é somente de exportação. Para enviar internações para a Plataforma, é utilizada outra credencial, do tipo Integração Dados Assistenciais.
Quem faz o quê
A integração envolve a instituição e o Grupo IAG Saúde, cada um com responsabilidades definidas:
| Responsável | O que faz |
|---|---|
| Usuário Administrador da instituição | Solicita formalmente a credencial ao Suporte e consulta as credenciais criadas na Plataforma. |
| Equipe de TI da instituição | Desenvolve e mantém a integração: autenticação, renovação do token, envio das consultas, leitura das páginas de retorno e armazenamento seguro dos dados recebidos. |
| Grupo IAG Saúde (Suporte DRG Brasil) | Cria o usuário, a senha e a chave de acesso, disponibiliza a documentação técnica da API e esclarece dúvidas sobre o uso. |
Observação: após a criação, as credenciais ficam visíveis na Plataforma apenas para o Usuário Administrador da instituição. Guarde o usuário, a senha e a chave de acesso com segurança e não os compartilhe fora da equipe responsável pela integração.
Onde encontrar a documentação técnica
O manual técnico da API traz os endereços de conexão, a estrutura das requisições, os parâmetros de consulta, exemplos de retorno e o dicionário com a descrição de cada campo. A versão mais recente fica disponível em Manuais DRG Brasil e também pode ser solicitada ao Suporte, pelo e-mail suporte@drgbrasil.com.br.
O manual possui versões para o DRG Brasil Global e para o DRG Brasil Refinado. Consulte a versão correspondente à sua instituição e, em caso de dúvida, fale com o Suporte.
Artigos Populares
- Como solicitar uma nova credencial de integração/ importação
- Como acessar as credenciais de integração na plataforma
- Como autenticar na API de Exportação dos Dados Assistenciais
- Quais filtros usar na consulta de internações
- Como consultar internações excluídas
Perguntas Frequentes
A credencial do tipo API Dados Assistenciais, usada para exportação de dados e automações com sistemas externos. A solicitação deve ser feita pelo Usuário Administrador da instituição.
O prazo para criação da credencial é de até 7 dias úteis após o envio da solicitação formal ao Suporte.
Sim. Se a instituição precisar separar acessos por finalidade, o Usuário Administrador pode solicitar mais de uma credencial ao Suporte.
Não. Esta API apenas exporta dados. O envio de internações para a Plataforma utiliza a credencial do tipo Integração Dados Assistenciais.
Este documento e seus anexos são restritos ao(s) destinatário(s) e poderão ser divulgados apenas para pessoas que necessitem dessas informações para a realização de suas atividades.
Se você o recebeu por engano, entre em contato com o remetente imediatamente e apague-o de seus arquivos.
Qualquer uso não autorizado, replicação ou disseminação deste documento, ou parte dele, é proibido. Antes de imprimir, pense no meio ambiente.
Comentários
0 comentário
Por favor, entre para comentar.