Gerenciar os convênios do paciente

O vínculo entre um paciente e um plano de convênio da clínica, com carteirinha e validade. O id do vínculo é o valor informado em idPacienteConvenio na criação do agendamento (POST /agenda/novo).

  Paciente        +        Plano de convênio da clínica
  (idPaciente)             (idTipoConvenio)
        │                         │
        └──────────┬──────────────┘
                   ▼
            POST /convenio-paciente/associar
                   │
                   ▼
              id do vínculo  =  idPacienteConvenio

Os planos de convênios cadastrados na clínica estão em Planos de convênios.

Operação	Finalidade
GET /convenio-paciente/lista	Listar os convênios de um paciente
POST /convenio-paciente/associar	Criar o vínculo
GET /convenio-paciente/{id}	Obter um vínculo pelo identificador
PUT /convenio-paciente/{id}	Atualizar carteirinha e validade

Listar os convênios de um paciente

curl -G "https://api.clinicanasnuvens.com.br/convenio-paciente/lista" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  --data-urlencode "idPaciente=3"

O idPaciente é obrigatório.

Filtro somenteAtivos. Com somenteAtivos=true, o sistema só retorna os convênios do paciente quando os planos de convênios estiverem ativos na configuração da clínica.

Associar

curl -X POST "https://api.clinicanasnuvens.com.br/convenio-paciente/associar" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  -H "Content-Type: application/json" \
  -d '{
    "idPaciente": 3,
    "idTipoConvenio": 12,
    "carteirinha": "9988776655",
    "dataValidade": "2027-12-31"
  }'

Campos da requisição

Campo	Tipo	Obrigatório	Descrição
idPaciente	Integer	Sim	Paciente que receberá o vínculo
idTipoConvenio	Integer	Sim	Plano de convênio da clínica que será vinculado ao paciente
carteirinha	String	Não	Número da carteirinha do paciente no convênio, com até 50 caracteres
dataValidade	String	Não	Validade da carteirinha, no formato AAAA-MM-DD

Resposta:

{
  "id": 12,
  "idTipoConvenio": 12,
  "nomeTipoConvenio": "Unimed",
  "ativo": true,
  "dataValidade": "2027-12-31",
  "carteirinha": "9988776655"
}

Os campos idPaciente e idTipoConvenio são obrigatórios; a carteirinha e a validade são opcionais na criação.

O id retornado é o idPacienteConvenio utilizado no agendamento.

Convênio já vinculado ao paciente

A associação de um convênio já vinculado ao paciente retorna 400 Bad Request. A verificação considera também os vínculos inativos, que são retornados na listagem sem o somenteAtivos.

O plano de convênio deve pertencer à clínica do token. O vínculo é criado ativo; a troca de convênio é feita com a criação de um novo vínculo.

A associação aceita data retroativa, o que permite registrar um vínculo vencido.

Alterar dados da carteirinha

curl -X PUT "https://api.clinicanasnuvens.com.br/convenio-paciente/12" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  -H "Content-Type: application/json" \
  -d '{ "carteirinha": "1122334455", "dataValidade": "2028-06-30" }'

Resposta:

{
  "id": 12,
  "idTipoConvenio": 12,
  "nomeTipoConvenio": "Unimed",
  "ativo": true,
  "dataValidade": "2028-06-30",
  "carteirinha": "1122334455"
}

A alteração se aplica a dois campos: carteirinha e dataValidade.

Os dois campos são substituídos a cada chamada, portanto a carteirinha omitida tem o valor removido. Para manter um valor atual, envie-o novamente no corpo da requisição.

Na alteração, a dataValidade não aceita data retroativa.

Veja na Referência

Os detalhes de cada operação, campo a campo, estão em Referência › Convênios do paciente.