Skip to content

Reference & Guides

Practical guides for implementation and troubleshooting

In This Section

Page Description
Quick Reference Codes, values, and cheat sheets
API Reference Complete API documentation
Deployment Guide Step-by-step deployment
Admin UI Guide Clinic management interface
Troubleshooting Common issues and solutions

Common Tasks

Task Guide
Deploy new version Deployment Guide
Add new clinic Admin UI Guide
Configure OSCAR Admin UI Guide
Manage users Admin UI Guide
View audit logs Admin UI Guide
Debug API issue Troubleshooting

API Quick Reference

Endpoint Method Purpose
/health GET Health check
/api/vapi/search-patient-by-phone POST Find patient
/api/vapi/find-earliest-appointment POST Find slot
/api/vapi/create-appointment POST Book
/api/vapi/get-clinic-info POST Clinic info

Codes Quick Reference

Type Code Meaning
Appointment B 15-min follow-up
Appointment 2 30-min new concern
Appointment 3 45-min physical
Appointment P 15-min phone
Outcome booked Successfully booked
Outcome transferred Transferred to staff
Language en English
Language zh Mandarin

Environment Variables

Variable Required Description
POSTGRES_PASSWORD Yes Database password
NODE_ENV Yes Environment (production)
OSCAR_API_URL Yes OSCAR REST Bridge URL
OSCAR_API_KEY Yes OSCAR API key
VAPI_WEBHOOK_SECRET Yes Vapi signature key
VAPI_BEARER_TOKEN Yes Vapi bearer token auth
TRANSFER_NUMBER Yes Staff transfer number
JWT_SECRET Yes Access token signing key
JWT_REFRESH_SECRET Yes Refresh token signing key
ENCRYPTION_KEY Yes Credential encryption
USE_EMR_ADAPTER No Enable EMR adapter pattern
EMR_DEMO_MODE No Enable demo responses

Contact & Support

Channel Contact
Documentation vitdocs.vitaravox.ca
Support Email support@vitaravox.com
Status Page status.vitaravox.ca

Start Here

  1. Quick lookup → Quick Reference
  2. API details → API Reference
  3. Deploy VitaraVox → Deployment Guide
  4. Manage clinics → Admin UI Guide
  5. Fix issues → Troubleshooting