Portal Docs v4

Patient

Appointments

How a time is found and confirmed, resolving patient, visit type, provider, location and time in the order the organisation sets — never asking twice.

Access

How a patient reaches the screen, and what has to be true for it to open.

Element What it decides Permissions
Navigation Bottom bar → Appts. on a phone; side menu → Appointments on a desktop. Client:appointments.on

Header

What the band states before anything below it is actionable.

Element What it decides Permissions
Title “Appointments”, with how many are upcoming and past. —

Main actions

What belongs to the page rather than to one appointment.

Element What it decides Permissions
Schedule Opens a new booking. —

Form · Schedule

What a booking needs, asked in the order the organisation sets, with every answer reviewed before the time is held.

Field Validations Permissions
Patient Required. The patient, or one of the people they manage. —
Visit type Required. —
Provider Required. Only those who deliver the visit type chosen. —
Location Required. Only where that provider sees patients. —
Time Required. Only times still open. —

Filters

Which appointments the list holds.

Element What it decides Permissions
View Upcoming · Past · Recurring. —
Status Narrows the list to the statuses chosen. —
Location Narrows the list to one location. —
Date range Narrows the list to the period chosen. —

Table

What one appointment shows in a row.

Element What it decides Permissions
Date A date block with the time. —
Visit type What the visit is for. —
Provider Who it is with. —
Location Where it happens. —
Status Confirmed · Forms pending · Cancelled. —
Recurring A series states how often it repeats and when it next happens, and is changed as a series. —

Row actions

What can be done to one appointment.

Element What it decides Permissions
Check in Offered on the visit close enough to check into; runs identity, insurance and any outstanding forms, then confirms. —
Reschedule Returns to the time, keeping every earlier answer. —
Cancel Asks once, stating the policy if one applies. —
View details Opens the appointment. —

Record · Appointment

One visit, in full.

Element What it decides Permissions
When Date and time. —
Visit Visit type and provider. —
Where Location, with directions. —
What to bring What the practice asks the patient to have with them. —

Errors

Not yet written from the code.

API calls

Not yet written from the code.