Pular para conteúdo
Postman

Pacientes

Pacientes concedem acesso individual ao App MediQuo via SDK. São vinculados a um cliente e a um plano.

GET /patients

Retorna a lista paginada de pacientes.

Parâmetros da Query

Nome Tipo Obrigatório Descrição
page integer não Número da página (padrão: 0)
size integer não Itens por página (padrão: 20)
sort string não Ordenação (ex: name,asc)
index string não Filtro de busca

Cabeçalhos

Header Valor
Authorization Bearer {token}
Accept application/hal+json

Exemplo de Requisição

Bash
curl -X GET "https://api-portal.mediquo.com.br/patients?page=0&size=20" \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Respostas

Código Descrição
200 Lista paginada de pacientes
401 Token inválido ou expirado
403 Sem permissão

GET /patients/{id}

Retorna os dados de um paciente específico.

Parâmetros do Path

Nome Tipo Obrigatório Descrição
id integer sim ID do paciente

Cabeçalhos

Header Valor
Authorization Bearer {token}
Accept application/hal+json

Exemplo de Requisição

Bash
curl -X GET https://api-portal.mediquo.com.br/patients/1 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Respostas

Código Descrição
200 Dados do paciente
401 Token inválido ou expirado
403 Sem permissão
404 Paciente não encontrado

POST /patients

Cria um novo paciente vinculado a um cliente e plano.

Cabeçalhos

Header Valor
Authorization Bearer {token}
Content-Type application/json
Accept application/hal+json

Corpo da Requisição

Campo Tipo Obrigatório Descrição
documentNumber string sim CPF do paciente (somente números)
name string sim Nome do paciente
clientId integer sim ID do cliente
planId integer sim ID do plano
origin string sim Solicite o valor à MediQuo.
email string não E-mail do paciente
phone string não Telefone com DDD (ex: 11999999999)
gender string não MALE ou FEMALE
birthDate string não Data de nascimento (ISO 8601)

O valor de origin deve ser solicitado à MediQuo antes da integração. Sem ele, a requisição retorna erro.

Exemplo de Requisição

Bash
curl -X POST https://api-portal.mediquo.com.br/patients \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "documentNumber": "12345678901",
    "name": "João Silva",
    "clientId": 1,
    "planId": 1,
    "origin": "{valor_definido_pela_mediquo}",
    "email": "joao.silva@email.com",
    "phone": "11999999999",
    "gender": "MALE",
    "birthDate": "1990-05-15T00:00:00.000Z"
  }'

Resposta de Sucesso: 200 OK

JSON
{
  "id": 1,
  "tenant": "partner-tenant",
  "active": true,
  "documentNumber": "12345678901",
  "name": "João Silva",
  "email": "joao.silva@email.com",
  "phone": "11999999999",
  "clientId": 1,
  "planId": 1,
  "gender": "MALE",
  "birthDate": "1990-05-15T00:00:00.000Z",
  "origin": "HUB",
  "createdAt": "2025-01-27T10:00:00.000Z",
  "updatedAt": "2025-01-27T10:00:00.000Z"
}

Campos da Resposta

Campo Tipo Descrição
id integer ID único do paciente
tenant string Identificador do tenant
active boolean Indica se o paciente está ativo
documentNumber string CPF do paciente
name string Nome do paciente
email string E-mail do paciente
phone string Telefone do paciente
clientId integer ID do cliente associado
planId integer ID do plano associado
gender string Gênero
birthDate string Data de nascimento
origin string Canal de origem

Respostas de Erro

Código Descrição
400 Campos obrigatórios ausentes ou inválidos
401 Token inválido ou expirado
403 Sem permissão
404 Cliente ou plano não encontrado
409 Já existe um paciente com esse CPF

PUT /patients/{id}

Atualiza os dados de um paciente.

Parâmetros do Path

Nome Tipo Obrigatório Descrição
id integer sim ID do paciente

Cabeçalhos

Header Valor
Authorization Bearer {token}
Content-Type application/json
Accept application/hal+json

Corpo da Requisição

Campo Tipo Obrigatório Descrição
documentNumber string sim CPF do paciente
name string sim Nome do paciente
clientId integer sim ID do cliente
planId integer sim ID do plano
origin string sim Solicite o valor à MediQuo.
email string não E-mail do paciente
phone string não Telefone com DDD
gender string não MALE ou FEMALE
birthDate string não Data de nascimento (ISO 8601)

Exemplo de Requisição

Bash
curl -X PUT https://api-portal.mediquo.com.br/patients/1 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "documentNumber": "12345678901",
    "name": "João Silva Santos",
    "clientId": 1,
    "planId": 1,
    "origin": "{valor_definido_pela_mediquo}",
    "email": "joao.novo@email.com",
    "phone": "11888888888"
  }'

Respostas

Código Descrição
200 Paciente atualizado. Retorna o objeto completo
400 Requisição inválida
401 Token inválido ou expirado
403 Sem permissão
404 Paciente não encontrado

PUT /patients/activate/{id}

Ativa um paciente pelo ID.

Parâmetros do Path

Nome Tipo Obrigatório Descrição
id integer sim ID do paciente

Cabeçalhos

Header Valor
Authorization Bearer {token}
Accept application/hal+json

Exemplo de Requisição

Bash
curl -X PUT https://api-portal.mediquo.com.br/patients/activate/1 \
  -H "Authorization: Bearer {seu_token}"

Respostas

Código Descrição
200 true
401 Token inválido ou expirado
403 Sem permissão
404 Paciente não encontrado

PUT /patients/deactivate/{id}

Desativa um paciente pelo ID.

Parâmetros do Path

Nome Tipo Obrigatório Descrição
id integer sim ID do paciente

Cabeçalhos

Header Valor
Authorization Bearer {token}
Accept application/hal+json

Exemplo de Requisição

Bash
curl -X PUT https://api-portal.mediquo.com.br/patients/deactivate/1 \
  -H "Authorization: Bearer {seu_token}"

Respostas

Código Descrição
200 true
401 Token inválido ou expirado
403 Sem permissão
404 Paciente não encontrado