Skip to main content
Los pacientes son las personas sobre las que tratan tus sesiones de scribe. Crea un paciente una vez y reutiliza su id público estable (sp_...) en todas las consultas, en lugar de reenviar los campos de identidad cada vez. Los campos de identidad (name, idCountry, idType, idValue) son los mismos que usa set-consultation-context y siguen las mismas reglas de validación — consulta Documentos aceptados por país.
Los pacientes están acotados por el rol de tu clave API: una clave de médico solo ve sus propios pacientes; una clave institucional ve a todos los pacientes de su institución. Nunca necesitas pasar un id de cuenta o institución — el alcance se aplica en el servidor.

Crear un paciente

POST /v1/patients requiere name, idCountry, idType e idValue. El idType debe ser válido para el idCountry dado (p. ej., CC con idCountry: BR devuelve 400).
Respuesta:
Guarda el id (sp_...) — es estable y reutilizable. Crear un paciente con un documento de identidad que ya existe devuelve el paciente existente en lugar de un duplicado.

Listar pacientes

GET /v1/patients devuelve los pacientes visibles para tu clave, del más reciente al más antiguo. Pagina con page (base 1) y limit (1–50, por defecto 20).
Respuesta:
total y totalPages solo se calculan en la primera página — son null en las páginas siguientes para evitar un escaneo completo en cada clic. Usa hasMore para paginar de forma fiable; es preciso en todas las páginas.

Consultar un paciente

GET /v1/patients/{patient_id} busca un único paciente por su id público (sp_...). Devuelve 404 si ningún paciente con ese id es visible para tu clave.
Respuesta:
idCountry, idType e idValue pueden ser null para pacientes creados fuera de esta API que no llevan identificación.