...
- Visão Geral
- Exemplo de utilização
- Método guiaAutorizacoes
- Regras de Negocio do Método
- EndPoint
- Método guiaDetalhe
- Regras de Negocio do Método
- EndPoint
- Método guiaPdf
- Regras de Negocio do Método
- EndPoint
- Método guiaStatus
- Regras de Negocio do Método
- EndPoint
- Tela Extrato de Autorizações
- Outras Ações / Ações relacionadas
- Tela Extrato de Autorizações
- Principais Campos e Parâmetros
- Tabelas utilizadas
...
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âmetro | Obrigatório | Tipo | Descrição |
---|
chaveBeneficiario | Sim | Caracter | Chave do Beneficiário (CPF ou Matricula) |
chaveBeneficiarioTipo | Sim | Caracter | Tipo de Login do Beneficiário (CPF ou Matricula) |
multiContract | Sim | Lógico | Utilização de Multi Contratos pelo Beneficiário |
dataInicial | Não | Caracter | Data inicial do extrato de autorizações |
dataFinal | Não | Caracter | Data final do extrato de autorizações |
Bloco de código |
---|
language | c# |
---|
theme | Midnight |
---|
title | Request body |
---|
linenumbers | true |
---|
collapse | true |
---|
|
{
"chaveBeneficiarioTipo": "CPF",
"multiContract": true,
"chaveBeneficiario": "76461633090",
"dataInicial": "2022-01-01",
"dataFinal": "2022-02-04"
} |
...
Bloco de código |
---|
language | c# |
---|
theme | Midnight |
---|
title | Retorno API - Falha |
---|
linenumbers | true |
---|
collapse | true |
---|
|
{
"status": false,
"motivoCritica": "Não existem autorizações a serem visualizadas"
} |
Atributo | Tipo | Descrição |
---|
status | Lógico | True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida |
motivoCritica | Caracter | Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False |
autorizacoes | Array | Lista de objetos de “autorizacao“ |
chaveAutorizacao | Caracter | Chave de Identificação da Guia no sistema (Tabela + | +Operadora + Ano + Mês + Numero) |
beneficiarioMatricula | Caracter | Matricula do Beneficiário (Operadora + Empresa + Matricula + Tipo Registro + Digito) |
beneficiarioNome | Caracter | Nome do Beneficiário |
statusId | Numérico | Código do status, conforme retorno do método guiaStatus. (Status da TISS) |
dataSolicitacao | Caracter | Data da solicitação (Formato: YYYY-MM-DD) |
dataAutorizacao | Caracter | Data da autorização (Formato: YYYY-MM-DD) |
nomePrestador | Caracter | Nome da Rede de Atendimento |
especialidade | Caracter | Descrição da especialidade vinculada |
tipoTratamento | Caracter | Descrição do tipo do tratamento (sendo: CONSULTA, SP/SADT, INTERNACAO, QUIMIOTERAPIA, RADIOTERAPIA, OPME, PRORROGACAO DE INTERNACAO e ODONTOLOGIA) |
numeroPedido | Caracter | Numero da Guia no sistema ( Ano + Mês + Numero) |
senha | Caracter | Senha informada na Guia |
...
Url | Método | Header Content-Type | Descrição |
---|
https://<url>:<porta>/rest/mobileSaude/v1/guiaDetalhe | POST | application/json | Retorna eventos (itens) da guia de autorização |
Parâmetro | Obrigatório | Tipo | Descrição |
---|
chaveAutorizacao | Sim | Caracter | Chave única de identificação da guia de autorização |
Bloco de código |
---|
language | c# |
---|
theme | Midnight |
---|
title | Request body |
---|
linenumbers | true |
---|
collapse | true |
---|
|
{
"chaveAutorizacao": "BEA|000120220200000005"
} |
...
Bloco de código |
---|
language | c# |
---|
theme | Midnight |
---|
title | Retorno API - Falha |
---|
linenumbers | true |
---|
collapse | true |
---|
|
{
"status": false,
"motivoCritica": "Não existem itens a serem visualizados"
} |
Atributo | Tipo | Descrição |
---|
status | Lógico | True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida |
motivoCritica | Caracter | Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False |
itens | Array | Lista de objetos de “itens“ |
itemId | Caracter | Chave única do item da guia de autorização (Operadora + Ano + Mês + Numero + Sequencial) |
procedimento | Caracter | Código do procedimento |
procedimentoDescricao | Caracter | Descrição do procedimento |
statusId | Numérico | Código do status, conforme retorno do método guiaStatus. (Status da TISS) |
quantidadeSolicitada | Numérico | Quantidade solicitada (Numérico com duas casas decimais) |
quantidadeAutorizada | Numérico | Quantidade autorizada pela operadora (Numérico com duas casas decimais) |
dataAutorizacao | Caracter | Data da autorização do procedimento (Formato: YYYY-MM-DD) |
...
Url | Método | Header Content-Type | Descrição |
---|
https://<url>:<porta>/rest/mobileSaude/v1/guiaPdf | POST | application/json | Retorna a guia completa em PDF |
Parâmetro | Obrigatório | Tipo | Descrição |
---|
chaveAutorizacao | Sim | Caracter | Chave única de identificação da guia de autorização |
Bloco de código |
---|
language | c# |
---|
theme | Midnight |
---|
title | Request body |
---|
linenumbers | true |
---|
collapse | true |
---|
|
{
"chaveAutorizacao": "BEA|000120220200000005"
} |
...
Bloco de código |
---|
language | c# |
---|
theme | Midnight |
---|
title | Retorno API - Falha |
---|
linenumbers | true |
---|
collapse | true |
---|
|
{
"status": false,
"motivoCritica": "Não foi possível gerar o PDF da Guia"
} |
Atributo | Tipo | Descrição |
---|
status | Lógico | True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida |
motivoCritica | Caracter | Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False |
binario | Caracter em base64 | Conteúdo binário do tipo base64, do arquivo PDF da guia a ser impressa |
url | Caracter | URL completo do arquivo PDF informado no cadastro da Operadora |
...
Url | Método | Header Content-Type | Descrição |
---|
https://<url>:<porta>/rest/mobileSaude/v1/guiaStatus | POST | application/json | Retorna os status de autorização |
Não é necessário enviar parâmetros para este método.
Bloco de código |
---|
language | c# |
---|
theme | Midnight |
---|
title | Request body |
---|
linenumbers | true |
---|
collapse | true |
---|
|
{} |
Bloco de código |
---|
language | c# |
---|
theme | Midnight |
---|
title | API Retorno - Sucesso |
---|
linenumbers | true |
---|
collapse | true |
---|
|
{
"status": true,
"autorizacaoStatus": [
{
"chaveStatus": "1",
"descricao": "Autorizado"
},
{
"chaveStatus": "2",
"descricao": "Em análise"
},
{
"chaveStatus": "3",
"descricao": "Negado"
},
{
"chaveStatus": "4",
"descricao": "Aguardando justificativa técnica do solicitante"
},
{
"chaveStatus": "5",
"descricao": "Aguardando documentação do prestador"
},
{
"chaveStatus": "6",
"descricao": "Solicitação cancelada"
},
{
"chaveStatus": "7",
"descricao": "Autorizado parcialmente"
}
]
} |
Atributo | Tipo | Descrição |
---|
status | Lógico | True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida |
motivoCritica | Caracter | Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False |
autorizacaoStatus | Array | Lista de objetos de “autorizacaoStatus“ |
chaveStatus | Caracter | Código de identificação do status da autorização |
descricao | Caracter | Descrição do status |
...