...
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. | |||
chave_unica | Número | Sim | Chave única do titular, ou, dependente, caso o Titular esteja logado, deve apresentar a chave do seus dependentes. | |||
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 | |||
matriculaAntigamatricula_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. | |||
matriculaFuncionariomatricula_funcionario | Texto | Não | Indicar o código da matrícula de funcionário na empresa patrocinadora, caso aplicável.nomeTitular | |||
Texto | Sim | Informe o nome do titular. | emailTitularnome_social | Texto | Não | Informe o e-mail do titular. |
cpfTitular | Texto | Sim | Informe o CPF do titular. | |||
nomeSocial | Texto | Não | Informe o nome social do beneficiário. | |||
sexo | Texto | Sim | Informar o sexo do usuário. | |||
dataNascimentodata_nascimento | TextoData | Sim | Data de nascimento do beneficiário (yyyy-mmMM-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. | |||
numeroEndereconumero_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 / A = Agregado. Importante. Só pode existir um (1) usuário no Array de beneficiários com a propriedate tipo_usuario = T por contrato. | |||
grauParentescoIdgrau_parentesco_id | Texto | Sim | Indicar o ID do grau de parentesco | |||
grauParentescoDescricaodescricao_grau_parentesco | Texto | Sim | Descrição do Grau de Parentesco | |||
dataContratacaodata_contratacao | TextoData | Sim | Data da contratação do plano de saúde. Obrigatório PIN-SS conforme RN 389. | dataInicioCobertura | TextoFormato (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. | |||
convenioDescricaoconvenio_descricao | Texto | Sim | Texto descritivo do nome do plano (produto) do beneficiário. Informar o nome comercial junto a ANS. | |||
convenioAbrangenciaconvenio_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 | |||
convenioAbrangenciaVerso | Texto | Não | Texto descritivo da abrangência contido no verso do cartão do PTU 5.1. Não tem efeito para operadoras fora do sistema Unimed | |||
convenioAcomodacaoconvenio_acomodacao | Texto | Não | Texto descritivo do padrão de acomodação do plano do beneficiário, conforme ANS | |||
convenioModalidadeCobrancaconvenio_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. | |||
convenioPadraoConfortoconvenio_padrao_conforto | Texto | Não | Texto descritivo do padrão de conforto do plano (produto) | |||
convenioParticipativoconvenio_participativo | boolean/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”. | |||
convenioSegmentacao | 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. | |||
convenioTipoPessoa | Texto | Não | Tipo de contrato do plano (produto) do beneficiário Exemplo: Pessoa Física ou Pessoa Jurídica | |||
convenioTipoContrato | 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. | |||
convenioRegulamentacao | Texto | Sim | Informação sobre a regulamentação do plano, entendendo-se por: Regulamentado / adaptado / não regulado. | |||
cartaoValidade | Texto | Não | Informe textos como "Indefinida" ou "31/12/2020", ou "Vencido" | |||
cartaoVia | Texto | Não | Indica o numero da via do cartão vigente do beneficiário | |||
chaveEmpresaContratante | 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. | |||
nomeEmpresaContratante | 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. | |||
numeroCns | Texto | Não | Numero do Cartão Nacional de Saúde. Obrigatório no cartão do beneficiário conforme RN 389. | |||
convenioAns | Texto | Não | Número de registro do plano do beneficiário na ANS. | |||
dataFinalCpt | Texto | 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. | |||
codigo_contrato | Texto | Sim | Código que identifica de qual contrato esse usuário está vinculado. | |||
redeAtendimento | 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 | |||
modeloCartao | 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 |