...
Nome Atributo | Tipo Atributo | Obrigatório | Descrição |
|---|---|---|---|
id_registro | Número | Sim | Cada registro da view, deve ter um número único, para diferenciar cada linha de retorno na view, porém nunca serão usados como filtros. |
chave_unica | Texto | Sim | Está chave é a identificação única por beneficiário, é a identificação da Pessoa. Este chave não deve se repetir em nenhuma hipótese, para uma outra Pessoa ou Beneficiário. |
id_operadora | Texto | Sim | Retornar com a identificação da operadora |
matricula | Texto | Sim | Matrícula do beneficiário. Informar a matrícula completa, sem espaços ou caracteres especiais |
matricula_antiga | Texto | Não | 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. |
matricula_funcionario | Texto | Não | Indicar o código da matrícula de funcionário na empresa patrocinadora, caso aplicável. |
nome | Texto | Sim | Nome do beneficiário. |
nome_social | Texto | Não | Informe o nome social do beneficiário. |
sexo | Texto | Sim | Informar o sexo do usuário. M = Masculino / F = Feminino / N = Não se aplica. Apenas maiúsculos |
data_nascimento | Data | Sim | Data de nascimento do beneficiário (yyyy-MM-dd). |
cpf | Texto | Sim | CPF do beneficiário |
celular | Texto | Não | Informar o numero do telefone celular do beneficiário, sem mascara. |
Texto | Não | Email do beneficiário. | |
endereco | Texto | Não | Endereço do beneficiário. |
bairro | Texto | Não | Bairro do beneficiário. |
cep | Texto | Não | Cep do beneficiário. |
cidade | Texto | Sim | Cidade do beneficiário. |
estado | Texto | Sim | Estado do beneficiário. |
complemento | Texto | Não | Complemento de endereço do beneficiário. |
numero_endereco | Texto | Não | Número endereço do beneficiário. |
tipo_usuario | Texto | Sim | Informe o tipo de usuário: T = Titular / D = Dependente . Importante. Só pode existir um (1) usuário no Array de beneficiários com a propriedate tipo_usuario = T por contrato. |
grau_parentesco_id | Texto | Sim | Indicar o ID do grau de parentesco |
descricao_grau_parentesco | Texto | Sim | Descrição do Grau de Parentesco |
data_contratacao | Data | Sim | Data da contratação do plano de saúde. Obrigatório PIN-SS conforme RN 389. Formato (yyyy-MM-dd). |
data_Inicio_cobertura | Data | Sim | Data do início da cobertura contratual do beneficiário no plano privado de assistência à saúde. Obrigatório no cartão devido a RN 389.Formato (yyyy-MM-dd). |
convenio_id | Texto | Sim | Código do plano (produto) do usuário. Este código é fundamental para diferenciação da imagem do cartão, direcionamento (segmentação) de campanhas, mensagens e notícias, além de diversas outras funções no aplicativo e web. |
convenio_descricao | Texto | Sim | Texto descritivo do nome do plano (produto) do beneficiário. Informar o nome comercial junto a ANS. |
convenio_abrangencia | Texto | Não | Texto descritivo do nome do plano (produto) do beneficiário. Informar o nome comercial junto a ANS Obrigatório no cartão devido a RN 389 |
convenio_acomodacao | Texto | Não | Texto descritivo do padrão de acomodação do plano do beneficiário, conforme ANS |
convenio_modalidade_cobranca | Texto | Não | Texto descritivo da modalidade de cobrança do contrato do beneficiário, como por exemplo: Pré-pagamento, Pós-pagamento e etc. |
convenio_padrao_conforto | Texto | Não | Texto descritivo do padrão de conforto do plano (produto) |
convenio_participativo | texto | Não | Campo para informar se o plano (produto) do beneficiário possui coparticipação ou não. Caso tenha retornar “S”, caso não tenha coparticipação retornar “N”. |
convenio_segmentacao | Texto | Não | 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. |
convenio_tipo_pessoa | Texto | Não | Tipo de contrato do plano (produto) do beneficiário Exemplo: Pessoa Física ou Pessoa Jurídica |
convenio_tipo_contrato | Texto | Sim | 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. |
convenio_regulamentacao | Texto | Sim | Informação sobre a regulamentação do plano, entendendo-se por: Regulamentado / adaptado / não regulado. |
cartao_validade | Texto | Não | Informe textos como "Indefinida" ou "31/12/2020", ou "Vencido" |
cartao_via | Número | Não | Indica o numero da via do cartão vigente do beneficiário |
chave_empresa_contratante | Texto | Sim | Código identificador da empresa contratante do plano do beneficiário (nos casos de planos coletivos por adesão ou coletivos empresariais). Observação: este código é fundamental para diferenciação da imagem do cartão, direcionamento (segmentação) de campanhas, mensagens e noticias, além de diversas outras funções no aplicativo e web. |
nome_empresa_contratante | Texto | Sim | Nome da empresa contratante Obrigatório PIN-SS conforme RN 389. |
contrato_empresa_contratante | Texto | Sim | Numero do contrato/apólice. Obrigatório PIN-SS conforme RN 389 |
cod_familia | Texto | Sim | Este atributo define uma código para uma família dentro de um contrato, quando a operadora usa o número do contrato para definir varias pessoas dentro do mesmo, o atributo deve retornar com a mesma numeração do codigo_contrato. |
numero_cns | Texto | Não | Numero do Cartão Nacional de Saúde. Obrigatório no cartão do beneficiário conforme RN 389. |
convenio_ans | Texto | Não | Número de registro do plano do beneficiário na ANS. |
data_final_cpt | Data | Não | 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 padrão (yyyy-MM-dd) |
codigo_contrato | Texto | Sim | Código que identifica de qual contrato esse beneficiário está vinculado. |
tipo | Texto | Sim | Se o contrato é do tipo “beneficiario” ou “profissional_saude“. Sendo que Beneficiário, corresponde a qualquer pessoa e Profissional de Sáude, corresponde a um Beneficiário que trabalha na operadora e é médico atuante. |
rede_atendimento | Texto | Não | Informe o código e a descrição da Rede de Atendimento do beneficiário Observação PTU 5.1: campo obrigatório |
modelo_cartao | Texto | Não | 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 |
telefone | Texto | Não | Telefone de contato, não o celular |