Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Visão Geral
  2. Exemplo de utilização
    1. Método guiaAutorizacoes
      1. Regras de Negocio do Método
      2. EndPoint
      3. Parâmetros de Entrada do Método

      4. Exemplo

      5. Estrutura de Retorno

    2. Método guiaDetalhe
      1. Regras de Negocio do Método
      2. EndPoint
      3. Parâmetros de Entrada do Método

      4. Exemplo

      5. Estrutura de Retorno

    3. Método guiaPdf
      1. Regras de Negocio do Método
      2. EndPoint
      3. Parâmetros de Entrada do Método

      4. Exemplo

      5. Estrutura de Retorno

    4. Método guiaStatus
      1. Regras de Negocio do Método
      2. EndPoint
      3. Parâmetros de Entrada do Método

      4. Exemplo

      5. Estrutura de Retorno

  3. Tela Extrato de Autorizações
    1. Outras Ações / Ações relacionadas
  4. Tela Extrato de Autorizações
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas

...

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaAutorizacoesPOSTapplication/jsonRetorna uma lista com as guias de autorização

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveBeneficiarioSimCaracterChave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipoSimCaracterTipo de Login do Beneficiário (CPF ou Matricula)
multiContractSimLógicoUtilização de Multi Contratos pelo Beneficiário
dataInicialNãoCaracterData inicial do extrato de autorizações
dataFinalNãoCaracterData final do extrato de autorizações

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": true,
    "chaveBeneficiario": "76461633090",
    "dataInicial": "2022-01-01",
    "dataFinal": "2022-02-04"
}

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não existem autorizações a serem visualizadas"
}

Estrutura de Retorno

AtributoTipoDescrição
statusLógico

True: Indica que a requisição foi bem-sucedida

False: Indica que a requisição foi mal sucedida

motivoCriticaCaracterMotivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
autorizacoesArrayLista de objetos de “autorizacao“
chaveAutorizacaoCaracterChave de Identificação da Guia no sistema (Tabela + | +Operadora + Ano + Mês + Numero)
beneficiarioMatriculaCaracterMatricula do Beneficiário (Operadora + Empresa + Matricula + Tipo Registro + Digito)
beneficiarioNomeCaracterNome do Beneficiário
statusIdNuméricoCódigo do status, conforme retorno do método guiaStatus. (Status da TISS)
dataSolicitacaoCaracterData da solicitação (Formato: YYYY-MM-DD)
dataAutorizacaoCaracterData da autorização (Formato: YYYY-MM-DD)
nomePrestadorCaracterNome da Rede de Atendimento
especialidadeCaracterDescrição da especialidade vinculada
tipoTratamentoCaracter

Descrição do tipo do tratamento (sendo: CONSULTA, SP/SADT, INTERNACAO, QUIMIOTERAPIA,

RADIOTERAPIA, OPME, PRORROGACAO DE INTERNACAO e ODONTOLOGIA)

numeroPedido CaracterNumero da Guia no sistema ( Ano + Mês + Numero)
senhaCaracterSenha informada na Guia

...

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaDetalhePOSTapplication/jsonRetorna eventos (itens) da guia de autorização

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveAutorizacaoSimCaracterChave única de identificação da guia de autorização

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveAutorizacao": "BEA|000120220200000005"
}

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não existem itens a serem visualizados"
}

Estrutura de Retorno

AtributoTipoDescrição
statusLógico

True: Indica que a requisição foi bem-sucedida

False: Indica que a requisição foi mal sucedida

motivoCriticaCaracterMotivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
itensArrayLista de objetos de “itens“
itemIdCaracterChave única do item da guia de autorização (Operadora + Ano + Mês + Numero + Sequencial)
procedimentoCaracterCódigo do procedimento
procedimentoDescricaoCaracterDescrição do procedimento
statusIdNuméricoCódigo do status, conforme retorno do método guiaStatus. (Status da TISS)
quantidadeSolicitadaNuméricoQuantidade solicitada (Numérico com duas casas decimais)
quantidadeAutorizadaNuméricoQuantidade autorizada pela operadora (Numérico com duas casas decimais)
dataAutorizacaoCaracterData da autorização do procedimento (Formato: YYYY-MM-DD)

...

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaPdfPOSTapplication/jsonRetorna a guia completa em PDF

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveAutorizacaoSimCaracterChave única de identificação da guia de autorização

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveAutorizacao": "BEA|000120220200000005"
}

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não foi possível gerar o PDF da Guia"
}

Estrutura de Retorno

AtributoTipoDescrição
statusLógico

True: Indica que a requisição foi bem-sucedida

False: Indica que a requisição foi mal sucedida

motivoCriticaCaracter Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
binarioCaracter em base64Conteúdo binário do tipo base64, do arquivo PDF da guia a ser impressa
urlCaracterURL completo do arquivo PDF informado no cadastro da Operadora

...

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaStatusPOSTapplication/jsonRetorna os status de autorização

Parâmetros de Entrada do Método

Não é necessário enviar parâmetros para este método.

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{}
Bloco de código
languagec#
themeMidnight
titleAPI Retorno - Sucesso
linenumberstrue
collapsetrue
{
    "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"
        }
    ]
}

Estrutura de Retorno

AtributoTipoDescrição
statusLógico

True: Indica que a requisição foi bem-sucedida

False: Indica que a requisição foi mal sucedida

motivoCriticaCaracter Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
autorizacaoStatusArrayLista de objetos de “autorizacaoStatus“
chaveStatusCaracterCódigo de identificação do status da autorização
descricaoCaracterDescrição do status

...