Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Dica
Bloco de código
{
  "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"
  },
  "dadosDoContrato": {
    "numeroContrato": "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

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

 

 

dadosContrato

M

Objeto "dadosDoContrato"

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"

...