Ava developer documentation
Ava Ecosystem is the developer portal for building SMART on FHIR apps against Ava EMR. Apps are public SMART App Launch clients: EHR launch, authorization code with PKCE S256, OpenID Connect identity, and granular SMART v2 scopes against a FHIR R4 API. There is no client secret anywhere in the flow.
Every integration starts in a synthetic sandbox — a private, realistic clinic with generated Ontario primary-care data — and only reaches production after a security review. Nothing you do in the sandbox can touch real patient data.
Start here
- Quickstart — register a sandbox app and make your first FHIR request. If you only read one page, read this one.
- Integration brief — the whole API contract condensed to one page. Paste it into your coding agent's context.
Guides
- App launch & PKCE — every request in the EHR launch flow, in order, with parameters.
- Scopes & permissions — the SMART v2 scope grammar, permission schemas, and re-consent.
- Sandbox & test data — the synthetic clinic your integration builds against.
- Search & pagination — searchset Bundles and cursor pagination.
- Writing documents & media — the create-only write surface.
- Errors & troubleshooting — every failure mode with its fix.
- Going to production — security review, production registration, and marketplace listing.
The contract, machine-readable
The runtime API is self-describing. These two documents are always the authoritative description of what is implemented:
{fhir_base_url}/metadata— the FHIR CapabilityStatement.{issuer}/.well-known/smart-configuration— SMART on FHIR discovery.
If a resource, interaction, search parameter, or scope is advertised there, it is implemented and tested; if it is not advertised, do not depend on it.
For agents
Every page of this documentation is also available as raw markdown — append
.md to any page URL. Two convenience endpoints follow the llms.txt
convention:
/docs/llms.txt— an index of every page's markdown URL./docs/llms-full.txt— the entire corpus in one file.