Local development uses the built-in SQLite database, so PostgreSQL is not required. This setup is ideal for development, testing, and exploring the FHIR R4 API without any infrastructure overhead.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/sagar-grv/ayush-synapse/llms.txt
Use this file to discover all available pages before exploring further.
Prerequisites — Make sure you have the following installed before you begin:
- Python 3.8+
- pip (bundled with Python 3.4+)
- Git
Setup Steps
Create and Activate a Virtual Environment
(.venv) once the environment is active.Install Dependencies
requirements.txt.Configure Environment Variables
Copy the provided example file to create your local configuration:The defaults in
.env.example are pre-configured for local development with SQLite and demo mode enabled. No further edits are required to get started. See the Configuration reference for a full list of available variables.Accessing the Application
Once the server is running, open your browser and navigate to any of the following paths:| Path | Interface |
|---|---|
http://127.0.0.1:5000/ | Main Interface — landing page with platform overview |
http://127.0.0.1:5000/professional.html | Professional Dashboard — advanced search and dual coding tools for clinicians |
http://127.0.0.1:5000/public.html | Public Dashboard — simplified condition search with multilingual support |
http://127.0.0.1:5000/technical.html | Technical Dashboard — API testing and system monitoring |
http://127.0.0.1:5000/api | API Overview — interactive API documentation |
API Endpoints Quick Reference
The full interactive API reference is available at/api once the server is running. For a structured overview of every endpoint, authentication scheme, and example request/response, see the API Overview.