Perfil: Beneficiário

Grupo Familiar

Grupo Familiar
Grupo familiar são beneficiários (titulares, dependentes e agregados) que compõe uma familia o campo que determina esta amarração é o "cod_familia” ou seja todos que necessitam estar no mesmo grupo familiar necessitam estar com este código igual.

Visibilidade x Correlação

Titular: tipoUsuario = T e grauParentesco = 01
- Retorna todos dentro do grupo familiar;
Dependente do tipo cônjuge: tipoUsuario = D e grauParentesco = 02
- Retorna ele mesmo e todos os demais dependentes, excluindo os do tipo Agregado (A);
Dependentes diferentes do tipo cônjuge: tipoUsuario = D e grauParentesco != 02
- Retorna apenas ele mesmo;
Agregados: tipoUsuario = A e grauParentesco > 02
- Retorna apenas ele mesmo;

Objeto “beneficiarios”

Este objeto é condicional;
Se o contrato possuir “tipo” = “beneficiario” este array de objetos torna-se obrigatório ter ao menos um registro com conteúdo válido neste objeto;
Essa estrutura contém os dados de um beneficiário de plano de saúde;
Atente-se as orientações fornecidas pela Mobile Saúde;
Atente-se as orientações de segurança e permissões;
Atente-se aos critérios de preenchimento;
Atente-se aos critérios de objetos e atributos de retorno;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

"beneficiarios": [
    {
      "chaveUnica": "string",
      "integracao": {objeto},
      "dadosPessoais": {objeto},
      "dadosDoContrato": {objeto},
      "dadosDoPlano": {objeto},
      "cartao": {objeto},
      "bloqueio": {objeto},
      "custom": {objeto}
    }
  ]

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. É obrigatório o preenchimento deste campo: Recomendamos o uso do CPF, pois é ÚNICO POR PESSOA, ou seja, 2 pessoas diferentes terão sempre CPFs diferentes. Porém, se a mesma pessoa tiver 2 ou mais planos, ela terá o mesmo CPF nos 2 planos, que é o desejado para este campo.
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”

Objeto “dadosPessoais” que está contido no objeto “beneficiarios”;
Essa estrutura contém os dados pessoais do beneficiário.

"beneficiarios": [
  {
    "dadosPessoais": {
        "nome": "string",
        "dataNascimento": "string",
        "cpf": "string",
        "sexo": {objeto},
        "contato": {objeto},
        "estadoCivil": {objeto}
      }
  }
]

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”

Objeto “sexo” que está contido no objeto “dadosPessoais”;

"beneficiarios": [
  {
    "dadosPessoais": {
        "sexo": {
          "codigo": "string",
          "descricao": "string"
        }
      }
  }  
]

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”

Objeto “contato” que está contido no objeto “dadosPessoais”;

"beneficiarios": [
  {
    "dadosPessoais": {
        "contato": {
          "email": "string",
          "telefoneCelular": "string",
          "telefoneFixo": "string"
        }
    }
  }   
]

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”

Objeto “estadoCivil” que está contido no objeto “dadosPessoais”;

"beneficiarios": [
  {
    "dadosPessoais": {
        "estadoCivil": {
          "codigo": "string",
          "descricao": "string"
        }
    } 
  } 
]

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”

Objeto “dadosDoContrato” que está contido no array de objetos “beneficiarios”;
Essa estrutura contém os dados do contrato do beneficiário.

"beneficiarios": [
  {
    "dadosDoContrato": {
          "numeroContrato": "string"
        }
  }    
]

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

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

Objeto “dadosDoPlano”

Objeto “dadosDoPlano” que está contido no array de objetos “beneficiarios”;
Essa estrutura contém os dados do plano do beneficiário.

"beneficiarios": [
  {
    "dadosDoPlano": {
        "beneficiario": boolean,
        "idPlano": "string",
        "descricao": "string",
        "registroAns": "string",
        "segmentacao": "string",
        "acomodacao": "string",
        "tipoContratacao": "string",
        "regulamentacao": "string",
        "abrangencia": "string",
        "modalidadeCobranca": "string",
        "padraoConforto": "string",
        "participativo": boolean,
        "dataInicioVigenciaPlano": "string",
        "dataFinalCpt": "string",
        "dataInclusao": "string",
        "matricula": "string",
        "matriculaAntiga": "string",
        "matriculaFuncionario": "string",
        "tipoUsuario": {objeto},
        "grauParentesco": {objeto},
        "redeAtendimento": {objeto},
        "carencias": [array-objetos]
      }
  }     
]

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”

Objeto “grauParentesco” que está contido no objeto “dadosDoPlano”;

"beneficiarios": [
  {
    "dadosDoPlano": {
          "grauParentesco": {
            "codigo": "string",
            "descricao": "string"
          }
  }
]

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”

Objeto “tipoUsuario” que está contido no objeto “dadosDoPlano”;

"beneficiarios": [
  {
    "dadosDoPlano": {
          "tipoUsuario": {
            "codigo": "string",
            "descricao": "string"
          }
  }
]

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

Objeto “redeAtendimento” que está contido no objeto “dadosDoPlano”;

"beneficiarios": [
  {
    "dadosDoPlano": {
          "redeAtendimento": {
            "codigo": "string",
            "descricao": "string"
          }
  }
]

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

Objeto “carencia” que está contido no objeto “dadosDoPlano”;
Esta estrutura contém as informações sobre as carências do beneficiãrio para serem impressas no cartão virtual.
As informações enviadas nesta estrutura já devem estar prontas para serem aprestandas apara o beneficiário.

"beneficiarios": [
  {
    "dadosDoPlano": {
          "carencia": [
            {
              "tipoServico": "string",
              "carencia": "string"
            }
          ]
  }
]

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

Objeto “cartao” que está contido no array de objetos “beneficiarios”;
Essa estrutura contém os dados do cartão do beneficiário.

"beneficiarios": [
  {
    "cartao": {
        "modeloCartao": "string",
        "numeroCartao": "string",
        "validade": "string",
        "via": number,
        "numeroCns": "string",
        "apresentaCartaoVirtual": boolean,
        "nomeCartao":"string",
        "nomeSocialCartao":"string",
        "operadoraContratada":"string",
        "convenioAnsContratada":"string",
        "seed":"string",
        "convenioAbrangenciaVerso":"string"
      }
  }
]

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

Objeto “bloqueio” que está contido no array de objetos “beneficiarios”;
Essa estrutura contém os dados do cartão do beneficiário.

"beneficiarios": [
  {
    "bloqueio": {
        "bloqueado": boolean,
        "dataBloqueio": "string",
        "motivo": "string"
      }
  }
]

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

Atributo	Critério	Tipo	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

Objeto “custom” que está contido no array de objetos “beneficiarios”;
Utilize esse objeto para enviar campos que não são suportados pelo layout padrão de atributos (por exemplo, exibir número da matricula funcional de empregado, tipo sanguíneo e etc).
Crie quantas chave / valor forem necessários, desde que obedeçam as premissas descritas no objeto.

"beneficiarios": [
  {
    "custom": 
      {
        "chave": "valor",
        "chave2": "valor2",
        "chave3": "valor3"
      }    
  }
]

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

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

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.

Mosia Omnichannel

Perfil: Beneficiário

Analytics

Grupo Familiar

Objeto “beneficiarios”

Related content