1.1 - Login

Índice

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

Orientações

Negócio

De acordo com a estrutura de sua empresa, o método de login pode devolver estruturas de login que permitam o acesso a alguns perfis de usuário:

  • Login de beneficiário;

  • Login de profissional de saúde;

  • Login de beneficiário + profissional de saúde (quando um profissional de saúde também é um beneficiário de plano de saúde);

 

Estrutura sugerida para o retorno do perfil do Beneficiário

  • Retorna os seus dados + dados dos dependentes;

  • Retorna os seus dados + os demais dependentes (não retorna os dados do titular);

  • Retorna apenas os dados do beneficiário logado;

  • Quando o usuário for um titular;

  • Quando o usuário for o cônjuge;

  • Quando for outro tipo de dependente (filho, filha, etc);

  • Dica: retorne apenas dados que possam ser exibidos. Se um beneficiário da família estiver, por exemplo,  bloqueado ou impedido de utilizar o plano, não devolva-o no retorno do endpoint.

 

Perfil do profissional de saúde

Caso seu sistema identifique que o usuário logado também é um profissional de saúde, o método deve retornar a estrutura dedicada aos profissionais de saúde;

 

Recomendações gerais

  • O endpoint de login deve validar todas as suas regras de negócio, permitindo acesso apenas a usuários autorizados;

  • O endpoint deverá retornar o usuário que fez login, e de acordo com o perfil, poderá enviar ainda mais informações;

  • Quando o perfil for exclusivamente  profissional de saúde, não é necessário retornar a estrutura de beneficiário;

  • Quando o perfil for exclusivamente beneficiário, não é necessário retornar a estrutura de profissional de saúde;

  • Quando o perfil for beneficiário e  profissional de saúde, retornar todas as estruturas descritas no layout;

  • Caso o usuário autenticado possua mais de um contrato, esses devem ser descritos no item Contratos e o array de beneficiário e de profissional de saúde deve conter as informações de todos os contratos;

    • Ex.: Beneficiário possui um plano de saúde com um filho dependente e um plano odontológico sem dependentes. Os dois contratos precisam estar descritos no array Contratos e o array Família vai conter 3 objetos (dois do plano de saúde e um do plano odontológico). Essa mesma lógica se aplica à estrutura do profissional de saúde;

Retornar ao índice

 

Segurança e permissões

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

 

Grupo Familiar

 

Multi-contrato

Método de login

Endpoint

Endpoint

Método

Header Content-Type

Descrição

Endpoint

Método

Header Content-Type

Descrição

exemplo.com/login

POST

application/json

Endpoint de login

 

Parâmetros de entrada

Parâmetro

Obrigatório

Tipo

Descrição

Parâmetro

Obrigatório

Tipo

Descrição

login

M

String

ID de identificação do usuário do app. Sugerimos que o login seja o CPF do usuário.

senha

M

String

Senha de acesso informada pelo usuário no momento do login.
Observação sobre criptografia: caso seja necessário criptografar a senha, sugerimos fornecer um acesso via HTTPS ao invés de usar algoritmos próprios.

 

Exemplo request

url: https://www.operadoradesaude.com.br/mobilesaude/login Body: { "login": "<login>", "senha": "<senha>" }

 

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

Está indicado abaixo a estrutura de retorno do seu método login. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

seguranca

OP

Objeto seguranca

Lista parâmetros que devem ser enviados no header dos demais endpoints de integração do sistema para garantir que o beneficiário está autenticado no sistema.

Preencher com o objeto do tipo "seguranca". Se não for utilizar não informar, ou informar com o valor "NULL"

usuarioLogado

M

Objeto usuarioLogado

Usuário que efetuou login

Objeto precisa ter sua estrutura completamente preenchida.

beneficiarios

C

Array de objetos "beneficiarios"

Array que contém todos os beneficiários vinculados ao login

Se contrato possuir tipo = "beneficiario", obrigatório ter a menos 1 registro com conteúdo válido. Caso contrário, não enviar o atributo ou preencher com o valor NULL

profissionaisSaude

C

Array de objetos "profissionalSaude"

Array que contém todos os profissionais de saúde vinculados ao login.



Se contrato possuir tipo = "profissionalSaude", obrigatório ter a menos 1 registro com conteúdo válido. Caso contrário, não enviar o atributo ou preencher com o valor NULL

contratos

M

Array de objetos "contrato"

Indique ao menos um contrato que está vinculado ao login.

Deve-se ter no mínimo 1 ocorrência válida, que tenha relação com um elemento do array "beneficiario" ou "profissionalSaude"

segmentacao

OP

Array de objetos "segmentacao”

 

 

mosia

OP

Objeto "mosia"

Identifique os atributos que permitem ao usuário do aplicativo ser corretamente encaminhado para o atendente do MOSIA.

Preencher quando possuir o produto Mosia. Caso não tenha o produto contratado, não enviar o atributo ou preencher com o valor NULL

agenteRelacionamento

OP

Array de objetos "agenteRelacionamento"

Indique os dados de atendentes que estarão disponíveis para serem visualizados como "contatos de atentes de atendimento". 

Preencher o array com objetos do tipo "agenteRelacionamento". Se não tiver nenhum contato desse tipo, não enviar o atributo ou preencher com o valor NULL

 

Objeto “seguranca”

Atributo

Critério

Tipo 

Descrição 

Regra de preenchimento

Atributo

Critério

Tipo 

Descrição 

Regra de preenchimento

auth

M

Array de objetos “auth”

Lista parâmetros que devem ser enviados no header dos demais endpoints de integração do sistema para garantir que o beneficiário está autenticado no sistema.

Objeto auth valido

 

Objeto “auth” 

{ "seguranca": { "auth": [Array-objetos] }

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chave

M

String

Nome do parâmetro no header aonde será enviado o valor da propriedade token.

 ASCII (nao permite especiais)

token

M

String

Valor do token que será enviado no header, em caso de tokens no padrão BearerJWTApi-Key etc. enviar o prefixo junto do token. Ex: JWT 123xyz

Formato: Texto livre

expiracao

O

Number

Caso o token tenha data de expiração, deve ser retornado nessa propriedade o timestamp da data na qual o token irá expirar.

Timestamp (em milissegundos)

 

Objeto “usuarioLogado”

"usuarioLogado": { "permissoes": [Array-objetos], "login": "string", "chaveUnica": "string", "contato": {objeto}, "esquemaCor": "String", "integracao": {objeto} },

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

login

M

String

A mesma informação digitada pelo usuário

 

ASCII (nao permite especiais - sem acentos, por exemplo)

chaveUnica

M

String

 Chave de identificação única de pessoa. Não deve se repetir em nenhuma hipótese, para pessoas diferentes.

Importante: caso um mesmo beneficiário esteja presente em mais de um contrato ou em mais de um grupo familiar, a chave única poderá se repetir, desde que seja o MESMO BENEFICIARIO.

 

integracao

M

Objeto

Informações necessárias para realizar a identificação do beneficiário no sistema. Deve existir um objeto idêntico para um dos beneficiários no array "beneficiarios" para que seja feita a identificação de qual usuário está logado.

Não possui regra de preenchimento, pode ser enviada qualquer estrutura desde que seja uma estrutura JSON valida

contato

M

Objeto "contato”

 

 

esquemaCor

OP

String

O aplicativo pode ter uma customização de cores diferente do padrão, caso deseja que um usuário tenha essa customização, bastar criar um esquema de cor no configurador de aplicação definindo um nome para o esquema e cadastrando novas cores. Informe nesse campo o nome do apelido que foi gerado ao criar um novo esquema de cor.

Ex: Ao criar um esquema de cor e definindo um nome de "Esquema Premium", o apelido gerado será "esquema-premium". Informe esse apelido nesse campo.

A string deve ser a mesma que o apelido gerado na opção de esquema de cor no configurador de aplicação, caso tenha definido um esquema de cor que não existe, o aplicativo irá usar as cores padrão.

permissoes

OP

Array de objeto "permissoes"

 

Objetos válidos relacionados às funções do app contratado.

 

Objeto “contato”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

email

OP

String

Indique o email do usuario logado

Email precisa ser válido 

telefoneCelular

OP

String

Indique o telefone celular do usuário logado

 

Tamanho mínimo / máximo 11 posições. Somente números

telefoneFixo

OP

String

Indique o telefone fixo do usuário logado

Tamanho mínimo 10 / máximo 11 posições. Somente números

 

Objeto “integracao”

 

Objeto “permissoes”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

funcionalidade

M

String

Informe o ID da funcionalidade do App. A tabela de Ids de funcionalidade encontra-se no final desta documentação

Funcionalidade deve ter correlação com a tabela no fim desta  documentação

acesso

M

Boolean

Preencher com a chave relacionada aos atributos de "codigoContrato" dos objetos beneficiario e profissionalSaude

 

true/false

mensagemBloqueio

C

String

Preencha com beneficiario ou profissionalSaude

Só pode ter conteúdo quando acesso = false

ocultar

M

Boolean

informe se o ícone da funcionalidade será exibido (false) ou ocultado (true) para este contrato. 

true/false

 

 

Objeto “beneficiarios”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chaveUnica

M

String

Chave de identificação única de pessoa. Não deve se repetir em nenhuma hipótese, para pessoas diferentes.

Importante: caso um mesmo beneficiário esteja presente em mais de um contrato ou em mais de um grupo familiar, a chave única poderá se repetir, desde que seja o MESMO BENEFICIARIO.

 

integracao

M

Objeto

Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema.

Não possui regra de preenchimento, pode ser enviada qualquer estrutura desde que seja um Objeto JSON válido.

dadosPessoais

M

Objeto "dadosPessoais"

 

 

 

dadosDoContrato

M

Objeto "dadosDoContrato"

 

 

dadosDoPlano

M

Objeto "dadosDoPlano"

 

 

cartao

M

Objeto "cartao"

 

 

bloqueio

OP

Objeto "bloqueio"

 

 

custom

OP

Objeto "custom"

 

 

 

Objeto “dadosPessoais”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

nome

M

String

Nome do beneficiário

Não permitir números, nem caracteres especiais. Permitido acentos

sexo

M

Objeto

objeto com codigo e descricao do sexo do beneficiário

 

dataNascimento

M

String

Data de nascimento do beneficiário

Formato: YYYY-MM-DD

contato

M

Objeto contato

 

 

cpf

OP

String

CPF do beneficiário

Somente números. Tamanho mínimo / máximo 11 posições.

estadoCivil

M

Objeto

 

 

nomeMae

OP

String

Nome da mãe do beneficiário

Nome da mãe do beneficiário, será muito bem utilizado em casos que necessitem de elegibilidade, redefinição de senha e etc.

 

Objeto “sexo”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

M = masculino, F = feminino, N = Não se aplica

descricao

 

String

 

“Masculino” , “Feminino” ou “Não se aplica”

 

Objeto “contato”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

email

OP

String

Indique o email do usuario logado

Email precisa ser válido 

telefoneCelular

OP

String

Indique o telefone celular do usuário logado

 

Tamanho mínimo / máximo 11 posições. Somente números

telefoneFixo

OP

String

Indique o telefone fixo do usuário logado

Tamanho mínimo 10 / máximo 11 posições. Somente números

 

Objeto “estadoCivil”

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

C = casado, S = solteiro, V = viúvo, D = divorciado

descricao

 

String

 

“Casado”, “Solteiro”, “Viúvo”, “Divorciado”

 

Objeto “dadosDoContrato”

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

numeroContrato

M

String

 

 

 

Objeto “dadosDoPlano”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

beneficiario

M

Boolean

Indica se o objeto em questão trata de um beneficiário.

TRUE quando for beneficiário. FALSE quando não for beneficiário

idPlano

M

String

 

Formato: Texto livre

descricao

M

String

 

Formato: Texto livre

registroAns

M

String

Número de registro do plano do beneficiário na ANS. 

Formato: Texto livre

segmentacao

M

String

Texto descritivo da segmentação do plano do (produto). Exemplo de segmentação: Ambulatorial + Hospitalar com Obstetrícia. Sugere-se utilizar as segmentações definidas pela ANS, conforme registro de produtos.

Formato: Texto livre.

acomodacao

M

String

Texto descritivo do padrão de acomodação do plano do beneficiário, conforme ANS

Formato: Texto livre.

tipoContratacao

M

String

Informação sobre o tipo de contratação do plano privado de assistência à saúde, conforme RN 195. Individual/Familiar, coletivo por adesão ou coletivo empresarial.

Formato: Texto livre.

regulamentacao

M

String

Informação sobre a regulamentação do plano, entendendo-se por: Regulamentado / adaptado / não regulado.

Formato: Texto livre.

abrangencia

M

String

 

Formato: Texto livre.

modalidadeCobranca

M

String

Texto descritivo da modalidade de cobrança do contrato do beneficiário, como por exemplo: Pré-pagamento, Pós-pagamento e etc.

Formato: Texto livre.

padraoConforto

OP

String

Texto descritivo do padrão de conforto do plano (produto)

Formato: Texto livre.

participativo

OP

Boolean

Campo para informar se o plano (produto) do beneficiário possui coparticipação ou não.

True/False

dataInicioVigenciaPlano

M

String

Campo destinado para a data que o beneficiário iniciou no plano

Formato: YYYY-MM-DD

dataFinalCpt

OP

String

Data final da CPT do cliente, quando houver, no formato String.

Pode-se informar também textos indicativos, de acordo com a necessidade da operadora.

Obrigatório no cartão do beneficiário conforme RN 389.

Formato: Texto livre.

dataInclusao

OP

String

Data de inclusão do beneficiário no plano.

Formato: YYYY-MM-DD
Ex: 1990-08-05

matricula

M

String

Matrícula do beneficiário. Informar a matrícula completa, sem espaços ou caracteres especiais

 

ASCII (nao permite especiais - sem acentos, por exemplo). Será impressa no cartão

matriculaAntiga

OP

String

Matrícula do beneficiário no sistema antigo. Em alguns casos o cliente continua utilizando a matrícula do sistema antigo mesmo após trocar de sistema de gestão, para manter funcionando integrações com outros sistemas legados. Por este motivo é importante termos essa informação.

ASCII (nao permite especiais - sem acentos, por exemplo)

matriculaFuncionario

OP

String

Indicar o código da matrícula de funcionário na empresa patrocinadora, caso aplicável.

ASCII (nao permite especiais - sem acentos, por exemplo)

tipoUsuario

M

Objeto

 

 

grauParentesco

M

Objeto

Código do grau de parentesco do beneficiário em relação ao titular

Indicar o ID do grau de parentesco.

redeAtendimento

OP

Objeto

 

 

carencias

OP

Array de objeto "carencia"

Retorna uma lista de estruturas “carencia” contendo as instruções sobre as carências do usuário. Essa informação só é necessária se houver necessidade de apresentar as carências no cartão virtual.

Caso não exista nenhuma carência, envie o array vazio

'

Objeto “grauParentesco”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

Código do grau de parentesco do beneficiário em relação ao titular. Indicar o ID do grau de parentesco.

descricao

 

String

 

descrição do grau de parentesco

 

Objeto “tipoUsuario”

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

Conteúdo válido:
T = Titular
D = Denpendente
A = Agregado
Apenas maiúsculos.

Importante. Só pode existir um (1) usuário no Array de beneficiários com a propriedate idTipoUsuario = T por contrato

descricao

 

String

 

Descrição do código: Titular, Denpendente, Agregado.

 

Objeto redeAtendimento

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

String

Código da rede de atendimento

Formato: Texto livre.

descricao

M

String

Descrição da rede de atendimento

Formato: Texto livre.

 

Objeto carencia

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

tipoServico

M

String

Texto com o tipo de serviço, exemplo: Consulta, Exames, Internação, Parto...

Formato: Texto livre.

carencia

M

String

 Informar o texto a ser apresentado. O campo tem conteúdo aberto, podendo exibir datas ou texto livre.

Exemplos: 

Vencida

31/12/2015

12 meses

Formato: Texto livre.

 

Objeto cartao

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

modeloCartao

M

String

Indique o layout de cartão que deve ser exibido. O dado aqui deve ser idêntico ao acordado entre sua empresa e a Mobile Saúde, na documentação de layouts de cartões

ASCII (nao permite especiais). Torna-se obrigatório quando o cartão virtual foi contratado.

numeroCartao

M

String

 

 

validade

M

String

Informe a data de validade do cartão

Formato: YYYY-MM-DD

via

M

Number

Indica o numero da via do cartão vigente do beneficiário

Somente números inteiros

numeroCns

M

String

Numero do Cartão Nacional de Saúde. 

Obrigatório no cartão do beneficiário conforme RN 389.

Formato: Texto livre.

Importante: caso não possua a informação, preencher com “NÃO CONSTA”.

apresentaCartaoVirtual

M

Boolean

 

True/False

nomeCartao

OP

String

Nome do beneficiário a ser exibido no cartão

Utilize esse campo para exibir um nome reduzido. Caso não seja informado, o nome do beneficiário será exibido no cartão com base no atributo "nome", dentro do objeto dados pessoais. 

nomeSocialCartao

OP

String

Nome social do beneficiário a ser exibido no cartão

Utilize esse campo para exibir um nome social reduzido. Caso não seja informado, o nome do beneficiário será exibido no cartão com base no atributo "nome", dentro do objeto dados pessoais.

operadoraContratada

OP

String

Informe a operadora contratada.

Formato: Texto livre.

convenioAnsContratada

OP

String

Informe o número de registro ANS da operadora contratada.

Formato: Texto livre.

seed

OP

String

Seed utilizado para gerar o token.

Formato: Texto livre, mas deve ser enviado como BASE32.

IMPORTANTE: A Mobile Saúde recomenda que o conteúdo deste campo SEED seja a matrícula do beneficiário.

Caso sua empresa não utilize o conceito de TOKEN para autorização, não preencha esse atributo.

convenioAbrangenciaVerso

OP

String

Texto descritivo da abrangência contido no verso do cartão

Formato: Texto livre.

 

Objeto bloqueio

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

bloqueado

M

Boolean

 

True/False

dataBloqueio

C

String

 

Obrigatório quando bloqueado = true.
Formato: YYYY-MM-DD

motivo

C

String

 

Obrigatório quando bloqueado = true.
Formato: Texto livre.

 

Objeto custom

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chave

M

String

Nome da propriedade

Formato: Texto livre. Importante: SEMPRE ENVIAR COMO STRING

valor

M

String

Valor da propriedade

Formato: Texto livre. IMPORTANTE: SEMPRE ENVIAR COMO STRING, MESMO QUE O CONTEÚDO SEJA NUMÉRICO, DATA, OU OUTRO FORMATO.

 

 

Objeto “profissionaisSaude”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

nome

M

String

Nome do contrato

Não permite números 

chaveProfissionalSaude

M

String

Chave única de identificação do profissional de saúde no seu sistema de gestão. Este campo será utilizado pelo aplicativo como chave em todas as demais integrações referentes ao perfil de profissional de saúde, como por exemplo: extrato de pagamento, declarações e solicitações. Ele deve ser único por coooperado e não pode se repetir em nenhuma hipótese.

 

Preencher com a chave que será utilizada para integração com demais serviços.

conselhoRegional

M

String

Número no conselho regional

Somente números

siglaConselhoRegional

C

String

Sigla do conselho regional

Se conselhoRegional possuir conteúdo, torna-se obrigatório. Tamanho máximo 8 posições

estadoConselhoRegional

C

String

Estado do conselho regional

Se conselhoRegional possuir conteúdo, torna-se obrigatório. Tamanho máximo 2 posições

titulo

M

String

Tratamento com o profissional, exemplo, Dr. Dra. Etc.



sexo

M

Objeto

 

 

dataNascimento

M

String

Data de nascimento do profissional de saúde

Formato: YYYY-MM-DD

cpf

M

String

CPF do profissional de saúde. Apenas números, sem máscara

Somente números. 11 posições. 



celular

M

String

Número do celular do profissional de saúde

Tamanho mínimo / máximo 11 posições. Somente números

especialidades

M

Array de objeto "especialidade"

Retorna uma lista de estruturas “especialidade“ (definição abaixo), caso o usuário possua mais de um contrato

Ao menos um conteúdo válido.

codigoContrato

M

String

Código que identifica de qual contrato esse usuário está vinculado. 

Este código deve ser o mesmo do campo numeroContrato da estrutura “contratos“

email

M

String

Email do profissional de saúde

Email válido.

 

Objeto “especialidades”

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

cboEspecialidadeId

M

String

Código CBO, ou código equivalente.

Formato: Texto livre.

cboEspecialidadeDescricao

M

String

Descrição para ser apresentada ao usuário da solução. 

Formato: Texto livre.

 

 

Objeto “contratos”

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

descricaoContrato

C

String

 

Formato: Texto livre.

Obrigatório se o tipo for 'beneficiario'.

numeroContrato

M

String

Preencher com a chave relacionada aos atributos de "codigoContrato" dos objetos beneficiario e profissionalSaude.

ASCII (nao permite especiais).

empresaContratante

C

Objeto

 

Formato: Objeto.

Obrigatório se o tipo for 'beneficiario'.

tipoPessoa

C

Objeto

 

Obrigatório se o tipo for 'beneficiario'.

dataInicioVigenciaContrato

C

String

 

Formato: YYYY-MM-DD

Obrigatório se o tipo for 'beneficiario'.

tipoContratante

M

Objeto

preencha de acordo com a tabela ao lado.

 

tipoRelacionamento

M

Objeto

 

Informe o tipo de relacionamento conforme o usuário logado.

dadosTitular

C

Objeto "dadosTitular"

 

Obrigatório se o tipo for 'beneficiario'.

codigoLocalAtendimento

OP

String

Código referente ao local de atendimento

 

 

Objeto “empresaContratante”

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

código da empresa

descricao

 

String

 

nome da empresa

 

Objeto “tipoPessoa”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

Código para o tipo de pessoa (J, F)

descricao

 

String

 

descrição do tipo de pessoa (Jurídica ou física)

 

Objeto “tipoRelacionamento”

Artributo

Critério

Tipo

Descrição

Regra de preenchimento

Artributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

string

 

código do tipo de relacionamento (1, 2, 3)

descricao

 

string

 

Conteúdo válido:
1 = titular
2 = dependente
3 = responsável financeiro

 

Objeto “tipoContratante”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

Código do tipo do contratante (1, 2, 3)

descricao

 

String

 

Conteúdo válido:
1 = beneficiario
2 = profissional de saude
3 = empresa

 

Objeto “dadosTitular”

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

matricula

M

String

Matrícula do titular. Informar a matrícula completa, sem espaços ou caracteres especiais

 

ASCII (nao permite especiais - sem acentos, por exemplo).

nome

M

String

Nome do titular

Formato: Texto livre.

email

OP

String

Email do titular 

Email válido

telefone

OP

String

Indique o telefone do titular

Tamanho mínimo 10 / máximo 11 posições. Somente números

celular

OP

String

Número do celular do titular

Tamanho mínimo / máximo 11 posições. Somente números

cpf

OP

String

CPF do profissional de saúde. Apenas números, sem máscara

Somente números. 11 posições.

 

Objeto “segmentacao”