Skip to main content

Appointment Details


Use the Appointment Details screen to retrieve and manage a single appointment.

The screen displays appointment data in structured tabs and controls actions based on appointment status.


This screen includes:

  • Appointment header:
    • Appointment ID
    • Date and time
    • Status
    • Visit type
  • Doctor information
  • Clinic information
  • Patient information
  • Four tabs:
    • Details
    • Charges
    • Documents
    • History
  • Action buttons based on status

Tab Structure

TabData RenderedEdit BehaviorNotes
DetailsAppointment metadata, visit type (Clinic / Home / Video), doctor name and specialty, clinic name and address, patient information, medical issue summaryRead-onlyData sourced from GET /appointments/{id}
ChargesBase cost, discounts, adjustments, total costEditable only when appointment state allows modificationSubmit updates through charge endpoint. Refresh data on success.
DocumentsPrescriptions, visit summaries, attachmentsRead-onlyEach item includes file name, file type, and download action.
HistoryStatus transitions, timestamp, source of changeRead-onlyImmutable audit log. No client-side mutation.

Workflow

  1. Open the appointment from the Appointment List.
  2. Review the appointment header, including date, time, status, and visit type.
  3. View appointment information in the Details tab.
  4. Open Charges to review costs.
  5. Open Documents to access prescriptions or visit summaries.
  6. Open History to review status changes.

Here is the revised MDX-ready section.

Language is precise, integration-focused, and useful for SDK implementers. Rules define UI behavior tied to backend state. No filler.


Validations

ConditionRendering Rule
GET /appointments/{id} returns 404Render error state. Do not mount screen.
status = ScheduledEnable Join Video and Cancel actions.
status = PendingDisable Join Video. Enable Cancel.
status = CompletedRender entire screen read-only. Disable all mutation actions.
status = CanceledRender entire screen read-only. Disable all mutation actions.
Charges section editable flag = trueEnable cost modification controls.
Charges section editable flag = falseRender charges read-only.
Documents array length > 0Render document list.
Documents array empty or nullOmit Documents content area.
Document MIME type unsupportedDisable preview action.
Status update response = 409Do not update UI state. Display conflict error.
API response = 403Display authorization error. Disable mutation actions.
Network request failurePreserve current state. Display error message.

Actions

TriggerSDK Behavior
Join Video selectedInitialize video session using appointment ID.
Cancel selectedCall POST /appointments/{id}/status with canceled. Refresh appointment on success.
Mark as Completed selectedCall POST /appointments/{id}/status with completed. Refresh appointment on success.
Charges modifiedSubmit charge update request. Re-fetch appointment on success.
Tab selectedRender tab content. Do not re-fetch unless required.
Document selectedRequest document resource. Render preview if supported.
Download selectedRequest file download endpoint.
API error responseDo not mutate local state. Surface structured error.

Endpoint Resources

🧰 Endpoint Resources under construction