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).
internalCode es opcional. Es tu propio identificador para el paciente, único dentro de tu institución. Envíalo al crear y luego consulta el paciente o lista sus sesiones con ese código. Reenviar el mismo documento nacional actualiza el paciente en lugar de duplicarlo. Omitir internalCode mantiene cualquier valor ya guardado.
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).
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. El {patient_id} puede ser el id público (sp_...) o el internalCode que definiste para tu institución. Devuelve 404 si ningún paciente con ese id es visible para tu clave.
idCountry, idType e idValue pueden ser null para pacientes creados fuera de esta API que no llevan identificación.Actualizar un paciente
PATCH /v1/patients/{patient_id} actualiza el name o el internalCode de un paciente, por su id público (sp_...) o internalCode. La identidad nacional (idCountry/idType/idValue) no es editable aquí. Omite un campo para dejarlo sin cambios; envía internalCode como null para borrarlo. Devuelve 404 si ningún paciente con ese id es visible para tu clave, y 409 si el internalCode ya lo usa otro paciente de tu institución.
Eliminar un paciente
DELETE /v1/patients/{patient_id} elimina un paciente por su id público (sp_...) o internalCode. Úsalo para solicitudes de derecho al olvido. Devuelve 204 en caso de éxito, y 404 si ningún paciente con ese id es visible para tu clave.
Una eliminación exitosa devuelve
204 con un cuerpo vacío. Un paciente eliminado ya no aparece en los endpoints de lista o consulta.