curl "BASE_URL/external_api.php/v1/patients?q=Adail%20Nicolau%20Linhares" \
  -H "Authorization: Bearer SEU_TOKEN"

O parâmetro q busca por nome. Se tiver números, também busca em CPF e CNS.

curl "BASE_URL/external_api.php/v1/patients/123/record?consultations_limit=10&lab_results_limit=30" \
  -H "Authorization: Bearer SEU_TOKEN"

Retorna linhas de cuidado, condições, medicamentos, exames-chave, resultados laboratoriais, pedidos, consultas/anotações SOAP, sinais vitais e documentos do paciente.

{
  "care_lines": [],
  "conditions": [],
  "medications": [],
  "key_exams": [],
  "lab_results": [],
  "exam_requests": [],
  "consultations": [],
  "documents": [],
  "limits": {}
}

Campos calculados automaticamente no GET /v1/patients e GET /v1/patients/{id} para montar coortes como sem consulta há 12 meses, HbA1c vencida/acima de 7 e sem exames recentes, sem buscar o /record completo de cada paciente.

curl -X POST "BASE_URL/external_api.php/v1/patients" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 0dd9b3e6-a444-4f47-b6d5-f35d4ecb0a37" \
  -d '{
    "source": "sistema_externo",
    "external_id": "pac-123",
    "name": "Maria da Silva",
    "cpf": "52998224725",
    "birth_date": "1970-01-01",
    "phone": "11999999999",
    "is_dm": true
  }'

curl -X POST "BASE_URL/external_api.php/v1/exams" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 8da28349-40a8-4215-b98f-03f674145f3c" \
  -d '{
    "source": "laboratorio_x",
    "external_id": "lab-987",
    "patient_cpf": "52998224725",
    "exam_type": "hba1c",
    "exam_name": "Hemoglobina glicada",
    "result_value": "7.2",
    "result_unit": "%",
    "collected_at": "2026-06-01"
  }'

Guarde o horário da última carga e envie em since na próxima. Evita varrer tudo de novo.

curl "BASE_URL/external_api.php/v1/lab-results?since=2026-07-01T00:00:00Z&per_page=200" \
  -H "Authorization: Bearer SEU_TOKEN"

As datas saem em ISO 8601 com fuso (2026-07-24T21:05:48+02:00). Guarde o updated_at mais recente que recebeu e use-o como próximo since.

O sistema acompanha um script pronto: tools/export_all.php. Ele varre todos os recursos com cursor, grava um arquivo NDJSON por recurso (um registro por linha) e gera um manifest.json com as contagens, para você conferir que recebeu tudo. Só depende de PHP com cURL.

php tools/export_all.php \
  --base=BASE_URL/external_api.php/v1 \
  --token=SEU_TOKEN \
  --out=./export

Saída:

  locations                   7 registro(s)
  care-lines                  8 registro(s)
  patients                  383 registro(s)
  consultations             489 registro(s)
  vitals                    441 registro(s)
  conditions                612 registro(s)
  medications              1154 registro(s)
  lab-results              2402 registro(s)
  ...
Concluido: 6659 registro(s) em 14 recurso(s).

Os recursos saem na ordem em que devem ser importados: locais e pacientes primeiro, porque os demais referenciam patient_id. Se a contagem exportada divergir do total informado pelo servidor, o script avisa e termina com erro — não dá migração por concluída em silêncio.

Para cargas seguintes, some --since=2026-07-01T00:00:00Z e só o que mudou é baixado. O script respeita Retry-After automaticamente se atingir o limite de requisições.

Os metadados vêm em JSON; o arquivo sai em rota separada, com Content-Type real e nome sugerido. Um anexo digitalizado pode ter várias páginas — page_count informa quantas, e ?page=N escolhe qual.

curl -o exame.jpg \
  "BASE_URL/external_api.php/v1/attachments/14/content?page=1" \
  -H "Authorization: Bearer SEU_TOKEN"

Baixando todos a partir do attachments.ndjson gerado pela exportação:

while read -r LINHA; do
  ID=$(php -r '$d=json_decode(fgets(STDIN),true); echo $d["id"];' <<< "$LINHA")
  PAGS=$(php -r '$d=json_decode(fgets(STDIN),true); echo max(1,(int)$d["page_count"]);' <<< "$LINHA")
  for P in $(seq 1 "$PAGS"); do
    curl -s -o "anexo_${ID}_${P}.bin" \
      "BASE_URL/external_api.php/v1/attachments/$ID/content?page=$P" \
      -H "Authorization: Bearer SEU_TOKEN"
  done
done < export/attachments.ndjson

Os campos raw_text, typed_raw_text, ambient_raw_text e ambient_transcript guardam o texto bruto digitado pelo médico e a transcrição do áudio ambiente do consultório. São o dado mais sensível do sistema e não saem com patients:read — nem em /v1/consultations, nem em /record.

Quando existem mas não vieram, a resposta declara isso:

{
  "id": 481,
  "subjective": "Paciente refere melhora da dispneia...",
  "clinical_notes_available": true,
  "clinical_notes_scope": "clinical_notes:read"
}

O SOAP (subjective, objective, assessment, plan) continua saindo com patients:read — é o registro clínico em si. Para liberar o relato bruto, crie um token com o escopo clinical_notes:read no formulário acima.

Padrão de 120 requisições por minuto por token, ajustável por cliente. Toda resposta traz X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset.

Toda resposta 200 de GET traz ETag. Reenviando em If-None-Match, a API responde 304 sem corpo quando nada mudou:

curl -i "BASE_URL/external_api.php/v1/patients?per_page=50" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H 'If-None-Match: "a1b2c3d4..."'