1.5 - Elegibilidade

Índice

1 Índice
2 Orientações
3 Integrando no painel
4 Segurança e permissões
5 Critérios de preenchimento
6 Objetos e atributos de retorno
7 Método - Elegibilidade
- 7.1 Endpoint
- 7.2 Parâmetros de entrada
- 7.3 Exemplo request
- 7.4 Descrição dos objetos e atributos de retorno - Sucesso
  - 7.4.1 Exemplo retorno API - sucesso
  - 7.4.2 Descrição dos objetos e atributos de retorno - falha
  - 7.4.3 Exemplo retorno API - falha

Só são suportadas integrações no padrão REST.

Orientações

Neste endpoint o usuário seleciona um dos contatos disponibilizados pelo cliente para realizar o processo de confirmação de identidade.
Os critérios de elegibilidade de pacientes são o conjunto de informações que possibilitam a verificação se o paciente pode receber certos tratamentos, de acordo com seu contrato de plano de saúde. Para selecionar as pessoas que serão elegíveis, deve-se definir os critérios de elegibilidade.

Integrando no painel

Segurança e permissões

Tokens de segurança ou autenticação

A Mobile Saúde descreve nesta documentação o formato de adoção obrigatória quando sua empresa desejar utilizar TOKENS de segurança.

O formato suportado pela aplicação está descrito no objeto SEGURANÇA, e sua empresa deve necessariamente implementa-lo conforme descrito quando desejar utilizar essa camada adicional de segurança.

Não serão suportadas outras formas de transacionar TOKENs de segurança, como por exemplo tokens de autenticação na URL da requisição, entre outros.

Caso tenha dúvidas, ou deseje maiores esclarecimentos, entre em contato com o gestor de projeto encarregado de sua implantação, para atendimento às questões ANTES DE DESENVOLVER SUA API.

Critérios de preenchimento

Abreviação	Nome	Descrição

Abreviação	Nome	Descrição
M	Mandatório	O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado.
C	Condicional	O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.
OP	Opcional	Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array

Objetos e atributos de retorno

Método - Elegibilidade

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
exemplo.com/elegibilidade	POST	application/json	Endpoint de elegibilidade

Parâmetros de entrada

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
chave_unica	M	String	ID de identificação do usuário do app. Sugerimos que o login seja o CPF do usuário.

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/elegibilidade

Body:
{
  "chaveUnica": "<chave_unica>"
}

Descrição dos objetos e atributos de retorno - Sucesso

Exemplo retorno API - sucesso

{
  "seguranca": {
    "auth": [
      {
        "chave": "Authorization",
        "token": "JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzI5ODQ4MzgsIm5iZiI6MTU3Mjk4NDgzOSwiZXhwIjoxNTczMDI4MDM4LCJkYXRhIjp7ImxvZ2luIjoiZGVybGFuZHlAbW9iaWxlc2F1ZGUuY29tLmJyIn19.dzJOQhSG8pJx-l6WDDgMVszFsKB26PsIjF4rB1TnWrk"
      },
      {
        "chave": "Authorization-Custom",
        "token": "JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzI5ODQ4MzgsIm5iZiI6MTU3Mjk4NDgzOSwiZXhwIjoxNTczMDI4MDM4LCJkYXRhIjp7ImxvZ2luIjoiZGVybGFuZHlAbW9iaWxlc2F1ZGUuY29tLmJyIn19.dzJOQhSG8pJx-l6WDDgMVszFsKB26PsIjF4rB1TnWrk",
        "expiracao": 1574366666921
      }
    ]
  },
  "usuarioLogado": {
    "permissoes": [
      {
        "funcionalidade": "0",
        "acesso": true,
        "mensagemBloqueio": null,
        "ocultar": false,
        "listaUsuario": false
      }
    ],
    "login": "123",
    "chaveUnica": "101012",
    "contato": {
      "email": "geraldo@mobilesaude.com.br",
      "telefoneCelular": "27999826284",
      "telefoneFixo": "2733778899"
    },
    "esquemaCor": "esquema-premium",
    "integracao": {
      "xpto": "voluptatibus",
      "xyz": "quibusdam",
      "abcdef": 9288701
    }
  },
  "beneficiarios": [
    {
      "chaveUnica": "101012",
      "integracao": {
        "xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
      },
      "dadosPessoais": {
        "nome": "Geraldo Felix Junior",
        "dataNascimento": "2017-11-05",
        "cpf": "92188083970",
        "sexo": {
          "codigo": "F",
          "descricao": "Feminino"
        },
        "contato": {
        "email": "geraldo@mobilesaude.com.br",
        "telefoneCelular": "27999826284",
        "telefoneFixo": "2733778899"
        },
        "estadoCivil": {
          "codigo": "C",
          "descricao": "Casado"
        }
      },
      "dadosDoContrato": {
        "numeroContrato": "99991"
      },
      "dadosDoPlano": {
        "beneficiario": true,
        "idPlano": "01",
        "descricao": "Plano Básico",
        "registroAns": "999.999/99-9",
        "segmentacao": "Ambulatorial + Hospitalar com obstetrícia",
        "acomodacao": "Individual",
        "tipoContratacao": "Plano Coletivo Empresarial",
        "regulamentacao": "Plano Regulamentado",
        "abrangencia": "Estadual",
        "modalidadeCobranca": "Pós-pagamento",
        "padraoConforto": "",
        "participativo": false,
        "dataInicioVigenciaPlano": "2012-01-01",
        "dataFinalCpt": "Não há",
        "matricula": "2320170425162943-0",
        "matriculaAntiga": null,
        "matriculaFuncionario": null,
        "tipoUsuario": {
          "codigo": "D",
          "descricao": "Dependente"
        },
        "grauParentesco": {
          "codigo": "01",
          "descricao": "Conjuge"
        },
        "idRedeAtendimento": "123",
        "carencias": [
          {
            "tipoServico": "ES - Atendimentos Ambulatoriais",
            "carencia": "2012-12-31"
          },
          {
            "tipoServico": "ES - Internações e Outros Procedimentos",
            "carencia": "2012-12-31"
          },
          {
            "tipoServico": "ES - Partos a Termo",
            "carencia": "2012-12-31"
          },
          {
            "tipoServico": "ES - Odontologia",
            "carencia": "2012-12-31"
          }
        ]
      },
      "cartao": {
        "modeloCartao": "plano_basico",
        "numeroCartao": "00010002000001000",
        "validade": "2021-02-15",
        "via": 1,
        "numeroCns": "999999999999999",
        "apresentaCartaoVirtual": true
      },
      "bloqueio": {
        "bloqueado": true,
        "dataBloqueio": "2012-01-01",
        "motivo": "desligamento da empresa contratante"
      },
      "custom": [
        {
          "chave": "minha_chave_customizada",
          "valor": "Meu valor customizado"
        }
      ]
    }
  ],
  "profissionaisSaude": [
    {
      "nome": "Derlandy Belchior",
      "chaveProfissionalSaude": "63718245",
      "conselhoRegional": "63718245",
      "siglaConselhoRegional": "CRM",
      "estadoConselhoRegional": "ES",
      "titulo": "Dr",
      "sexo": "M",
      "dataNascimento": "1985-01-01",
      "cpf": "99999999900",
      "celular": "27999826284",
      "especialidades": [
        {
          "cboEspecialidadeId": "2.2.5.1.20",
          "cboEspecialidadeDescricao": "Cardiologia"
        }
      ],
      "codigoContrato": "00100200300400500609",
      "email": "derlandy@mobilesaude.com.br"
    }
  ],
  "contratos": [
    {
      "descricaoContrato": "Plano Básico",
      "numeroContrato": "00100200300400500609",
      "empresaContratante": {
        "codigo": "03",
        "descricao": "Mobile Saúde"
      },
      "tipoPessoa": {
        "codigo": "J",
        "descricao": "Pessoa Jurídica"
      },
      "tipoRelacionamento": {
        "codigo": "3",
        "descricao": "Responsavel financeio"
      },
      "tipoContratante": {
        "codigo": "3",
        "descricao": "Empresa"
      },
      "dataInicioVigenciaContrato": "2012-01-01",
      "dadosTitular": {
        "matricula": "2320170425162943-0",
        "nome": "Derlandy Belchior",
        "email": "derlandy@mobilesaude.com.br",
        "telefone": "8646166114",
        "celular": "27999826284",
        "cpf": "92188083970"
      }
    },
    {
      "descricaoContrato": "Plano Gold Familia",
      "numeroContrato": "00100200300400500608",
      "empresaContratante": {
        "codigo": "03",
        "descricao": "Mobile Saúde"
      },
      "tipoPessoa": {
        "codigo": "J",
        "descricao": "Pessoa Jurídica"
      },
      "tipoRelacionamento": {
        "codigo": "3",
        "descricao": "Responsavel financeio"
      },
      "tipoContratante": {
        "codigo": "3",
        "descricao": "Empresa"
      },
      "dataInicioVigenciaContrato": "2012-01-01",
      "dadosTitular": {
        "matricula": "2320170425162943-0",
        "nome": "Derlandy Belchior",
        "email": "derlandy@mobilesaude.com.br",
        "telefone": "8646166114",
        "celular": "27999826284",
        "cpf": "92188083970"
      }
    },
    {
      "descricaoContrato": "Plano Sênior",
      "numeroContrato": "00100200300400500607",
      "tipoPessoa": {
          "codigo": "F",
          "descricao": "Pessoa Física"
      },
        "empresaContratante": {
        "codigo": "03",
        "descricao": "Mobile Saúde"
      },
        "tipoRelacionamento": {
            "codigo": "3",
            "descricao": "Responsavel financeio"
      },
      "tipoContratante": {
        "codigo": "2",
        "descricao": "Empresa"
      },
      "dataInicioVigenciaContrato": "2012-01-01",
      
      "dadosTitular": {
        "matricula": "2320170425162943-0",
        "nome": "Derlandy Belchior",
        "email": "derlandy@mobilesaude.com.br",
        "telefone": "8646166114",
        "celular": "27999826284",
        "cpf": "92188083970"
      }
    }
  ],
  "segmentacao": [
    {
      "chaveSegmentacao": "Plano",
      "idSegmento": "0101",
      "descricaoSegmento": "Plano básico"
    },
    {
      "chaveSegmentacao": "Tipo de usuário",
      "idSegmento": "T",
      "descricaoSegmento": "Titular"
    }
  ],
  "mosia": {
    "alocacao": {
      "codigoAgente": null,
      "codigoFila": null
    },
    "dadosCustomizados": {
      "nascimento": "20/20/2020",
      "vencimento": "20/20/2020",
      "emissao": "20/20/2020"
    }
  },
  "agenteRelacionamento": {
    "nome": "Salomé Irene Godói Jr.",
    "telefone": "34940972035",
    "whatsapp": "47984672759",
    "email": "carolina.mascarenhas@salas.com.br",
    "linkFoto": "https://randomuser.me/api/portraits/women/17.jpg",
    "tituloApresentacao": "Beneficiário"
  }
}

Descrição dos objetos e atributos de retorno - falha

Objetos e atributos de retorno

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
mensagem	M	String	mensagem para ser exibida para o cliente	texto livre

Exemplo retorno API - falha

{
   "mensagem": "Beneficiário não encontrado",
}