Histórico da Página
...
- Visão Geral
- Exemplo de utilização
- Tela XXX
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela XXX
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
01. VISÃO GERAL
Este documento tem como objetivo orientar a utilização da API Extrato de Autorizações para utilizar na integração do TOTVS Saúde Planos Linha Protheus com a Mobile Saúde, onde será disponibilizado ao beneficiário a relação das suas autorizações, por status, e possibilitar a visualização dos itens da guia e imprimir a guia completa em PDF.
A API utilizará o padrão REST.
02. EXEMPLO DE UTILIZAÇÃO
Lista de métodos utilizados na API:
- guiaAutorizacoes: retorna uma lista com todos os protocolos de autorização do beneficiário e do seu grupo familiar, conforme regra de negócio da sua operadora.
- guiaDetalhe: retorna eventos (itens) da guia de autorização (método opcional)
- guiaPdf: retorna a URL ou a string BASE64 do arquivo PDF da guia completa.
- guiaStatus: retorna a tabela de domínio dos status de autorização, para que possamos montar as legendas da listagem.
A autenticação dos métodos listados abaixo é realizado através da Api /token, onde será retornado a chave e token a ser adicionado no header de cada método.
Método guiaAutorizacoes
Este método irá retornar a lista com todas as solicitações de autorização do usuário, conforme layout que será descrito abaixo. Este método deve retornar o cabeçalho da autorização.
Regras de Negocio do Método
Quando o beneficiário solicitado for o titular, será retornado as suas autorizações e de todo o grupo familiar.
Quando o beneficiário solicitado for um dependente, será retornado apenas as suas próprias autorizações.
Endpoint
Url | Método | Header Content-Type | Descrição |
---|---|---|---|
https://<url>:<porta>/rest/mobileSaude/v1/guiaAutorizacoes | POST | application/json | Retorna uma lista com as guias de autorização |
Parâmetros de Entrada do Método
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
chaveBeneficiario | Sim | String | Chave do Beneficiário (CPF ou Matricula) |
chaveBeneficiarioTipo | Sim | String | Tipo de Login do Beneficiário(CPF ou Matricula) |
multiContract | Sim | Boolean | Utilização de Multi Contratos pelo Beneficiário |
dataInicial | Não | String | Data inicial do extrato de autorizações |
dataFinal | Não | String | Data final do extrato de autorizações |
Exemplo
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "chaveBeneficiarioTipo": "CPF", "multiContract": true, "chaveBeneficiario": "76461633090", "dataInicial": "2022-01-01", "dataFinal": "2022-02-04" } |
Se os parâmetros Data Inicial e Final não forem informados, será retornado uma lista de autorizações de acordo com a quantidade de meses no campo BA0_MSGUIA (Campo do tipo numérico), caso o campo não seja encontrado na base de dados, será utilizado o período de verificação dos últimos 12 meses.
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "status": true, "autorizacoes": [ { "dataAutorizacao": "2022-02-04", "tipoTratamento": "SP/SADT", "numeroPedido": "20220200000005", "dataSolicitacao": "2022-02-04", "senha ": "", "beneficiarioMatricula": "00011007000001012", "nomePrestador": "HOSPITAL BOM CLIMA", "statusId": 3, "beneficiarioNome": "CATELYN STARK", "especialidade": "CLINICA MEDICA", "chaveAutorizacao": "BEA|000120220200000005" }, { "dataAutorizacao": "2022-01-24", "tipoTratamento": "QUIMIOTERAPIA", "numeroPedido": "20220200000002", "dataSolicitacao": "2022-02-03", "senha ": "", "beneficiarioMatricula": "00011007000001012", "nomePrestador": "HOSPITAL BOM CLIMA", "statusId": 1, "beneficiarioNome": "CATELYN STARK", "especialidade": "CLINICA MEDICA", "chaveAutorizacao": "B4A|000120220200000002" }, { "dataAutorizacao": "2022-01-24", "tipoTratamento": "RADIOTERAPIA", "numeroPedido": "20220200000003", "dataSolicitacao": "2022-02-03", "senha ": "", "beneficiarioMatricula": "00011007000001012", "nomePrestador": "HOSPITAL BOM CLIMA", "statusId": 1, "beneficiarioNome": "CATELYN STARK", "especialidade": "CLINICA MEDICA", "chaveAutorizacao": "B4A|000120220200000003" }, { "dataAutorizacao": "2022-02-03", "tipoTratamento": "CONSULTA", "numeroPedido": "20220200000001", "dataSolicitacao": "2022-02-03", "senha ": "", "beneficiarioMatricula": "00011007000001012", "nomePrestador": "HOSPITAL BOM CLIMA", "statusId": 6, "beneficiarioNome": "CATELYN STARK", "especialidade": "CLINICA MEDICA", "chaveAutorizacao": "BEA|000120220200000001" }, { "dataAutorizacao": "2022-01-24", "tipoTratamento": "OPME", "numeroPedido": "20220100000004", "dataSolicitacao": "2022-01-24", "senha ": "", "beneficiarioMatricula": "00011007000001012", "nomePrestador": "HOSPITAL BOM CLIMA", "statusId": 1, "beneficiarioNome": "CATELYN STARK", "especialidade": "CLINICA MEDICA", "chaveAutorizacao": "B4A|000120220100000004" }, { "dataAutorizacao": "2022-01-24", "tipoTratamento": "PRORROGACAO DE INTERNACAO", "numeroPedido": "20220100000005", "dataSolicitacao": "2022-01-24", "senha ": "", "beneficiarioMatricula": "00011007000001012", "nomePrestador": "HOSPITAL BOM CLIMA", "statusId": 1, "beneficiarioNome": "CATELYN STARK", "especialidade": "CLINICA MEDICA", "chaveAutorizacao": "B4Q|000120220100000005" }, { "dataAutorizacao": "2022-01-24", "tipoTratamento": "INTERNACAO", "numeroPedido": "20220100000001", "dataSolicitacao": "2022-01-24", "senha ": "9289259502119996", "beneficiarioMatricula": "00011007000001012", "nomePrestador": "HOSPITAL BOM CLIMA", "statusId": 1, "beneficiarioNome": "CATELYN STARK", "especialidade": "CLINICA MEDICA", "chaveAutorizacao": "BE4|000120220100000001" }, { "dataAutorizacao": "2022-01-24", "tipoTratamento": "SP/SADT", "numeroPedido": "20220100000002", "dataSolicitacao": "2022-01-24", "senha ": "", "beneficiarioMatricula": "00019875000001011", "nomePrestador": "HOSPITAL BOM CLIMA", "statusId": 1, "beneficiarioNome": "CATELYN STARK", "especialidade": "CLINICA MEDICA", "chaveAutorizacao": "BEA|000120220100000002" }, { "dataAutorizacao": "2022-01-24", "tipoTratamento": "SP/SADT", "numeroPedido": "20220100000003", "dataSolicitacao": "2022-01-24", "senha ": "", "beneficiarioMatricula": "00011007000001012", "nomePrestador": "HOSPITAL BOM CLIMA", "statusId": 1, "beneficiarioNome": "CATELYN STARK", "especialidade": "CLINICA MEDICA", "chaveAutorizacao": "BEA|000120220100000003" } ] } |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "status": false, "motivoCritica": "Não existem autorizações a serem visualizadas" } |
Método guiaDetalhe
Este método irá retornar os detalhes (itens) de uma guia de autorização
Regras de Negocio do Método
Quando o beneficiário solicitado for o titular, será retornado as suas autorizações e de todo o grupo familiar.
Quando o beneficiário solicitado for um dependente, será retornado apenas as suas próprias autorizações.
Endpoint
Url | Método | Header Content-Type | Descrição |
---|---|---|---|
https://<url>:<porta>/rest/mobileSaude/v1/guiaAutorizacoes | POST | application/json | Retorna uma lista com as guias de autorização |
Parâmetros de Entrada do Método
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
chaveAutorizacao | Sim | String | Chave única de identificação da guia de autorização |
Exemplo
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "chaveAutorizacao": "BEA|000120220200000005" } |
...
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "status": false, "motivoCritica": "Não existem itens a serem visualizados" } |
Veja um exemplo de como o a comunicação com a API é feita na prática:
03. TELA XXXXX
Outras Ações / Ações relacionadas
...