Skip to main content

GET Prévia da Junção de Cadastros

Compara dois cadastros e mostra o que mudaria ao juntá-los, sem gravar nada: qual cadastro ficaria, o que há em cada um, o que difere campo a campo, impedimentos e avisos.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão read_patients.


Endpoint​

GET https://api-dev.imagemais.com.br/api/patients/merge/preview

Parâmetros de Query​

NomeTipoObrigatórioValores válidosDescrição
anumber✅inteiro, mínimo 1Um dos cadastros
bnumber✅inteiro, mínimo 1O outro cadastro
keepnumber❌inteiro, mínimo 1; deve ser a ou bCadastro que fica. Sem ele, vale a sugestão (suggestedTargetId)

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/patients/merge/preview?a=118&b=205' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"targetId": 118,
"sourceId": 205,
"suggestedTargetId": 118,
"target": {
"id": 118,
"name": "Nome Exemplo",
"cpf": "12345678900",
"rg": null,
"dateBirth": "1990-01-01T00:00:00.000Z",
"gender": "F",
"contact": {
"phone": "11999999999",
"secondary_phone": null,
"email": null
},
"address": null,
"createdAt": "2025-03-10T12:00:00.000Z",
"records": {
"appointments": 4,
"consultations": 2,
"budgets": 1,
"triages": 0
},
"futureAppointments": 1
},
"source": {
"id": 205,
"name": "NOME EXEMPLO",
"cpf": "12345678900",
"rg": null,
"dateBirth": "1990-01-01T00:00:00.000Z",
"gender": "F",
"contact": null,
"address": null,
"createdAt": "2026-11-02T12:00:00.000Z",
"records": {
"appointments": 1,
"consultations": 0,
"budgets": 0,
"triages": 0
},
"futureAppointments": 0
},
"fields": [
{
"field": "name",
"status": "same",
"side": "target"
},
{
"field": "phone",
"status": "only_target",
"side": "target"
}
],
"blocks": [],
"warnings": [
"Os dois têm agendamento em 15/12/2026."
]
}

O cadastro que fica é o target; o source é o absorvido. A sugestão prefere o cadastro com CPF válido, depois o com mais registros, depois o mais antigo. Em fields, status é empty, same, different, only_source ou only_target, e side indica de qual cadastro o valor seguirá (source ou target). Os campos comparados são name, cpf, dateBirth, gender, rg, phone, secondary_phone, email e address. records conta, por tabela, os registros do paciente. Se blocks não estiver vazio, a junção não pode ser feita (ver Juntar Cadastros).

400 Requisição inválida​

Mensagens possíveis, além das de validação de a, b e keep:

  • Escolha dois cadastros diferentes
  • O cadastro que fica precisa ser um dos dois
{
"message": "Escolha dois cadastros diferentes",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

404 Não encontrado​

{
"message": "Paciente #205 não encontrado",
"error": "Not Found",
"statusCode": 404
}