Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/FerchoSG/healthcare-web/llms.txt

Use this file to discover all available pages before exploring further.

Each CitaBox clinic gets its own patient portal — a simple web page where patients log in with their national ID and password to view their appointments, prescriptions, and consultation history. The portal is scoped to a single clinic, so a patient who visits more than one CitaBox-powered clinic will have a separate login for each one.
The portal is per-clinic. A patient registered at Clínica Sol and Clínica Norte will need two separate logins — one for each clinic’s portal. Credentials do not carry over between clinics.

​
Portal URL

The patient portal for each clinic is available at: 
https://citabox.app/portal/{clinicSlug}
Replace {clinicSlug} with your clinic’s unique identifier. For example, a clinic with the slug clinica-sol would have its portal at https://citabox.app/portal/clinica-sol.
Share the portal URL with patients after their first visit so they can log in to review their appointment history and download prescriptions. You can include it in the confirmation WhatsApp message or print it on the clinic’s receipt.

​
Patient login

Patients log in using their national ID (cédula or DIMEX) and a password set by the clinic. No email address is needed.
The portal password is separate from the clinic staff login. Staff credentials are managed under Settings → Users and are not shared with patients. Patient passwords are assigned or reset from the patient record inside CitaBox.

​
Login credentials

FieldTypeDescription
identificationstringPatient’s cédula or DIMEX number
passwordstringPatient’s portal password, set by clinic staff
clinic_idstring (UUID)The clinic’s internal ID (resolved automatically from the URL slug)

​
Login response

A successful login returns a PatientLoginResponse: 
{
  "access_token": "eyJhbGci...",
  "patient": {
    "id": "uuid",
    "first_name": "Maria",
    "last_name": "Fernandez"
  }
}
The access_token is a Bearer token used to authenticate all subsequent portal API requests. It is stored in the browser session and cleared when the patient logs out.

​
Portal login flow

1

Open the clinic portal URL

The patient navigates to https://citabox.app/portal/{clinicSlug}. The page loads the clinic’s name and logo from the public clinic record before showing the login form.
2

Enter cédula and password

The patient types their national ID (cédula or DIMEX) into the Identificación field and their portal password into the Contraseña field, then clicks Ingresar.
3

Authenticate against the clinic

The portal sends a POST /portal/login request with { identification, password, clinic_id }. On success it receives an access_token and the patient’s id, first_name, and last_name.
4

View appointments and records

After login, the patient can see:
  • Citas — a list of their appointments at this clinic, each showing the date/time, doctor name, and status.
  • Indicaciones — prescriptions linked to their consultation records, including medications, dosages, and additional notes.

​
Portal API endpoints

All portal data endpoints require the Bearer token returned by the login step.
EndpointDescription
POST /portal/loginAuthenticate with cédula, password, and clinic ID
GET /portal/profileFetch the patient’s name and identification
GET /portal/appointmentsList the patient’s appointments at this clinic
GET /portal/prescriptionsList prescriptions from the patient’s medical records

Build docs developers (and LLMs) love

Get started for freeTalk to us