Perfil: Cooperado

Objeto “cooperado”

Este objeto é condicional;
Essa estrutura contém os dados básicos de um profissional de saúde 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;

{
  "nome": "string",
  "titulo": "string",
  "chaveUnica": "string",
  "integracao": {
    "chaveIntegracaoPerfil": "string"
  },
  "cpf": "string",
  "dataNascimento": "string",
  "dadosConselho": {
    "numero": "string",
    "sigla": "string",
    "estado": "string"
  },
  "sexo": {
    "codigo": "string",
    "descricao": "string"
  },
  "contato": {
    "email": "string",
    "telefoneCelular": "string",
    "telefoneFixo": "string"
  },
  "especialidades": [array-objetos],
  "locaisAtendimento": [array-objetos],,
  "custom": {
    "minha_chave_customizada": "string",
    "minha_chave_customizada_2": "string",
    "minha_chave_customizada_3": "string"
  }
}

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
titulo
chaveUnica	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.
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.
cpf	M	String	CPF do profissional de saúde. Apenas números, sem máscara	Somente números. 11 posições.
dataNascimento	M	String	Data de nascimento do profissional de saúde	Formato: YYYY-MM-DD
dadosConselho	M	objeto	dados do conselho	Somente números
sexo	M	Objeto
contato	M	Objeto "contato"
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.
locaisAtendimento	OP	Array de objeto "localAtendimento"
custom	OP	Objeto "custom"

Objeto “dadosConselho”

Estrutura que contém todo os dados do conselho do cooperado

  "dadosConselho": {
    "numero": "string",
    "sigla": "string",
    "estado": "string"
  },

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
numero	M	String	numero do conselho	Somente números
sigla	M	String	sigla do conselho	Tamanho máximo 8 posições
estado	M	String	estado do conselho	Tamanho máximo 2 posições

Objeto “sexo”

Objeto “sexo” do perfil de cooperado;

{
  "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 “dadosDoContrato”

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

{
  "dadosDoContrato": {
        "numeroContrato": "string"
      }
}

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
numeroContrato	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“

Objeto “contato”

Objeto “contato” que está contido no objeto “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 “especialidades”

Estrutura que contém todas as especialidades que o usuário logado está vinculado.

{
    "especialidades": [
      {
        "cboEspecialidadeId": "string",
        "cboEspecialidadeDescricao": "string"
      }
    ]
  }

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 “localAtendimento”

Estrutura que contém todas as especialidades que o usuário logado está vinculado.

{
    "locaisAtendimento": [
      {
        "descricao": "string",
        "id": "string"
        "endereco":[array-objetos],
        "contatos":[array-objetos],
      }
    ]
  }

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
descricao	M	String	Código CBO, ou código equivalente.	Formato: Texto livre.
id	M	String	Descrição para ser apresentada ao usuário da solução.	Formato: Texto livre.
endereco	OP	Array de objetos do tipo “endereco"
contatos	OP	Array de objetos do tipo “contatoLocalAtendimento"

Objeto “endereco”

Objeto “endereco” que está contido no objeto “localAtendimento”;

{
  "locaisAtendimento": [
    {
      "endereco": {
        "endereco": "rua 1",
        "numero": "1",
        "complemento": "apto 1",
        "bairro": "bairro 1",
        "cidade": "vitoria",
        "estado": "ES",
        "latitude": "121212.1212",
        "longitude": "12232323.223"
      },
    }
  ],
}

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

Atributo	Critério	Tipo
endereco	OP	String
numero	OP	String
complemento	OP	String
bairro	OP	String
cidade	OP	String
estado	OP	String
latitude	OP	String
longitude	OP	String

Objeto “contatoLocalAtendimento”

Objeto “contatoLocalAtendimento” que está contido no objeto “localAtendimento”;

{
  "locaisAtendimento": [
      "contatos": [
        {
          "tipo": "1",
          "titulo": "Telefone ",
          "valor": "27 99292-9292"
        },
        {
          "tipo": "2",
          "titulo": "E-mail ",
          "valor": "email@email.com.br"
        }
      ]
    }
  ]
}

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

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

tipo

M

String

indique o tipo de contato com base no enum

Opcoes

1 = “telefone"

2 = “email"

3 = “celular"

titulo

M

String

valor

M

String

Objeto custom

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.

{
  "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
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.

{
  "nome": "Derlandy Belchior",
  "titulo": "Dr",
  "chaveUnica": "63718245",
  "dataNascimento": "1985-01-01",
  "dadosConselho": {
    "numero": "63718245",
    "sigla": "CRM",
    "estado": "ES"
  },
  "sexo": {
    "codigo": "F",
    "descricao": "Feminino"
  },
  "dadosDoContrato": {
    "numeroContrato": "99991"
  },
  "contato": {
    "email": "geraldo@mobilesaude.com.br",
    "telefoneCelular": "27999826284",
    "telefoneFixo": "2733778899"
  },
  "especialidades": [
    {
      "codigoCboEspecialidade": "2.2.5.1.20",
      "descricaoCboEspecialidade": "Cardiologia"
    },
    {
      "codigoCboEspecialidade": "2.2.5.1.20",
      "descricaoCboEspecialidade": "Radiologia"
    }
  ],
  "locaisAtendimento": [
    {
      "descricao": "CIAS",
      "id": "19919",
      "endereco": {
        "endereco": "rua 1",
        "numero": "1",
        "complemento": "apto 1",
        "bairro": "bairro 1",
        "cidade": "vitoria",
        "estado": "ES",
        "latitude": "121212.1212",
        "longitude": "12232323.223"
      },
      "contatos": [
        {
          "tipo": "1",
          "titulo": "Telefone ",
          "valor": "27 99292-9292"
        },
        {
          "tipo": "2",
          "titulo": "E-mail ",
          "valor": "email@email.com.br"
        }
      ]
    }
  ],
  "custom": {
    "minha_chave_customizada": "Meu valor customizado",
    "minha_chave_customizada_2": "Meu valor customizado 2",
    "minha_chave_customizada_3": "Meu valor customizado 3"
  },
  "integracao": {
    "chaveIntegracaoPerfil": 123
  }
}

Mosia Omnichannel

Perfil: Cooperado

Analytics

Objeto “cooperado”

Related content