> ## Documentation Index
> Fetch the complete documentation index at: https://help.elationhealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Build on the Elation platform

> Core Developer gives your team access to APIs, Webhooks, and the Hosted Database so you can connect Elation with other systems, automate workflows, and build custom reporting and analytics.

**CORE DEVELOPER · QUICKSTART**

`REST API 2.0` `FHIR API` `WEBHOOKS` `HOSTED DATABASE` `SANDBOX` `ELATION AI`

***

**01 — CAPABILITIES**

## What you have access to

<CardGroup cols={2}>
  <Card title="APIs & Webhooks" icon="plug">
    Connect Elation to external applications and automate workflows. Most integrations use REST API 2.0; use the FHIR API only when your use case requires FHIR-standard interoperability (e.g. SMART on FHIR, USCDI exchange).
  </Card>

  <Card title="Hosted Database" icon="database">
    Access your Elation EHR data in a cloud-hosted database for SQL-based reporting and analytics.
  </Card>

  <Card title="Sandbox environment" icon="flask">
    Build and test your integration in a separate, non-production environment before going live.
  </Card>

  <Card title="AI-powered tools" icon="sparkles">
    Build faster and explore your data with the MCP Server, in-app AI assistant, Elation Analyst, and Help Center AI.
  </Card>

  <Card title="Technical onboarding" icon="handshake">
    Elation's Technical Solutions team can help with initial setup and review of your integration approach. Managed Services may be available for more complex projects.
  </Card>
</CardGroup>

***

**02 — GETTING STARTED**

## What you should do first

<Steps>
  <Step title="Define your use case">
    Identify the workflow you're building, the systems involved, and the data you need. Core Developer already packages the REST API, FHIR API, Webhooks, and Hosted Database together — most integrations use a combination of them, so this step is about mapping which tools your workflow will draw on rather than choosing between them.
  </Step>

  <Step title="Stay up to date on critical changes">
    **Subscribe to our API and Hosted Database RSS feeds.** Follow changes automatically — see [Subscribe to Elation Release Feeds](/articles/subscribe-to-release-feeds) for the feed addresses and how to subscribe in Slack or any feed reader.

    **Know where our changelogs live so you stay current on releases:**

    * [API 2.0 Changelog](/articles/rest/changelog/changelog) — new endpoints, field changes, deprecations, and breaking changes.
    * [Hosted Database Release Notes](/articles/hdb/hdb-snowflake) — schema changes, new tables, and breaking changes.
  </Step>

  <Step title="Make sure you have all the access you need">
    Before you start building, confirm you have every piece of access your use case calls for. You don't necessarily need both tracks — request what applies to what you're building.

    * **Building an API integration?** You'll need access to the Sandbox EHR environment plus your Sandbox and (later) Production API credentials.
    * **Using Hosted Database?** You'll need a Hosted Database login and data access. Request it from your Elation representative — you'll use either an Elation-managed Reader Account or a Direct Share to your organization's Snowflake account.
  </Step>

  <Step title="Generate sandbox credentials & make your first call">
    Once your Sandbox is ready, go to **Settings > API Access** and generate your client ID and secret — no support ticket required. Exchange them for an OAuth2 access token (Client Credentials grant), then use it as a Bearer token against a documented endpoint (e.g. `GET /api/2.0/patients/`).

    ```bash theme={null}
    curl -X POST https://sandbox.elationemr.com/api/2.0/oauth2/token/ \
      -H "Content-Type: application/x-www-form-urlencoded" \
      -d "grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET"
    ```

    Tokens expire (`expires_in`, typically 3600s) — request a new one when they do. See [Authentication](/articles/rest/overview/oauth) and [Get Token](/articles/rest/overview/get-token).
  </Step>

  <Step title="Set up Webhooks if you need real-time updates">
    If your workflow needs to respond when data changes, create subscriptions through the [Event Subscription API](/articles/rest/event-subscription-api/event-subscriptions/subscribe-to-a-resource-updates) (`POST /api/2.0/app/subscriptions/`). No separate enablement request is required.
  </Step>

  <Step title="Log into your Hosted Database and run a test query">
    Once your Hosted Database access is set up, log into your Snowflake account, open a worksheet, and run a quick query to confirm your data is there. This verifies your login, warehouse, and data share are all working before you build reporting on top of them. In the worksheet, set your database and schema context first, then run:

    ```sql theme={null}
    -- Confirm your Hosted Database has data
    SELECT COUNT(*) AS patient_count FROM patient;

    -- Preview a few rows
    SELECT * FROM patient LIMIT 10;
    ```

    If the count returns a number and the preview shows rows, your Hosted Database is ready. Remember data refreshes once daily and reflects the prior day's activity. See the [Hosted Database schema](https://dbdocs.io/hosteddb_support/hosted_database_snowflake) for the full list of tables and fields.
  </Step>

  <Step title="Review the documentation for your use case">
    * [API documentation](/articles/rest/overview/introduction) — REST endpoints, auth, pagination, errors.
    * [FHIR documentation](/articles/fhir/getting-started-with-standardized-api) — FHIR-standard interoperability.
    * [Hosted Database schema](https://dbdocs.io/hosteddb_support/hosted_database_snowflake) — tables, fields, and SQL reporting.
    * [Official Snowflake documentation](https://docs.snowflake.com/) — SQL syntax, connectors, and account/warehouse concepts for querying the Hosted Database.
  </Step>

  <Step title="Attend a technical kickoff, if scheduled">
    Your Elation contact may coordinate a kickoff with Technical Solutions to review your integration approach, data requirements, and available support. These conversations are most valuable early — before your team has spent weeks building.
  </Step>
</Steps>

***

**03 — ELATION AI**

## Build and explore faster with Elation AI

Use Elation's AI-powered tools to find answers, understand documentation, build integrations, and explore your data.

| Tool                                      | Best for                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Elation MCP Server**                    | Connect Elation's documentation to your AI coding tools (Cursor, Windsurf, Claude Desktop). Once connected, your AI assistant can answer technical questions about Elation, generate example requests, and even test API calls right inside your editor — without leaving your development environment. Use your own credentials and never place production secrets in prompts. See the [MCP Server setup guide](/articles/rest/overview/mcp-server). |
| **In-app AI assistant** (Sandbox Chatbot) | Documentation and integration questions while you build. Access it from the **Help** menu → **Contact Elation Support**. For account-specific issues or Production access, contact Support or Technical Solutions.                                                                                                                                                                                                                                    |
| **Elation Analyst** (Beta)                | Asking questions about your Hosted Database data in plain language — appointments, diagnoses, medications, orders, vitals, patient tags. Review generated SQL before relying on it.                                                                                                                                                                                                                                                                   |
| **Help Center AI**                        | Finding product and support guidance. Open via the Ask Assistant button (or ⌘K on Mac, Ctrl+K on Windows) in the Help Center. Verify AI answers against the docs.                                                                                                                                                                                                                                                                                     |

***

**04 — TIMELINE**

## What to expect, week by week

<CardGroup cols={3}>
  <Card title="Week 1 · API">
    Sandbox request submitted → provisioned in 1–2 business days. Generate credentials, make your first API call, attend kickoff.
  </Card>

  <Card title="Week 2+ · Build / Test">
    Build against sandbox with non-PHI test data. Timeline depends on integration complexity — no fixed target.
  </Card>

  <Card title="Go-live">
    Once sandbox testing passes, contact [support@elationhealth.com](mailto:support@elationhealth.com) to start the Production process.
  </Card>
</CardGroup>

***

**05 — HOSTED DATABASE**

## Choose your Hosted Database access model

Hosted Database data can be accessed through either a Reader Account or a Direct Share. Your Elation contact can help confirm which fits your needs.

<CardGroup cols={2}>
  <Card title="Reader Account" icon="book-open">
    Elation provides a Snowflake account for read-only access to the Hosted Database data we provide. You cannot create, edit, delete, or load data. A good fit for a straightforward querying and reporting environment.
  </Card>

  <Card title="Direct Share" icon="share-nodes">
    Elation shares Hosted Database data with a Snowflake account your organization owns and controls. A better fit when your team already has its own Snowflake environment or needs capabilities not available in a Reader Account.
  </Card>
</CardGroup>

### How to request a Direct Share

<Steps>
  <Step title="Confirm your Snowflake account">
    Confirm your organization has its own Snowflake account and identify the edition, cloud, and region.
  </Step>

  <Step title="Find your account details">
    From your Snowflake account (not the Reader Account), open **Admin → Accounts** to find your Account, Locator, and (when applicable) Organization information.
  </Step>

  <Step title="Send the details to Elation">
    Send these to your CSM or Elation representative and request a Hosted Database Direct Share: Snowflake account, edition, cloud, region, and locator or organization identifier.
  </Step>

  <Step title="Validate access">
    Work with Elation to validate the Direct Share is available and your team can access the data before changing your workflows.
  </Step>
</Steps>

<Warning>
  **Migrating from a Reader Account:** plan the transition carefully — Reader Account access ends 30 days after the Direct Share is set up. Confirm your Direct Share works before that window expires, and contact your Elation representative early if you need more time.
</Warning>

***

**06 — SUPPORT**

## Where to get help

* For account-specific onboarding, API Production access, Hosted Database access, or contract questions, contact your Elation representative.
* [API documentation](/articles/rest/overview/introduction) — API 2.0 overview, endpoints, auth, pagination, errors.
* [FHIR documentation](/articles/fhir/getting-started-with-standardized-api) — standards-based, read-only FHIR access.
* [Hosted Database schema](https://dbdocs.io/hosteddb_support/hosted_database_snowflake) — tables, fields, and schema for SQL reporting.
* [Elation MCP Server](/articles/rest/overview/mcp-server) — connect Elation documentation to Cursor, Claude, and similar coding assistants.
* In-app AI assistant (Sandbox Chatbot) — documentation and integration questions while you build; open it from the **Help** menu → **Contact Elation Support**.
* [Help Center AI](https://help.elationhealth.com) — ask questions in natural language via the Ask Assistant button (or ⌘K on Mac, Ctrl+K on Windows) in the Help Center; verify answers against the docs.
* For additional implementation guidance, ask about Managed Services support.

***

**07 — REFERENCE**

## Important things to know

<Info>
  **Sandbox and Production are separate.** Sandbox is for development and testing — a separate environment from your live account. Data and configuration do not automatically transfer. Use sample or test data only; do not enter real patient information or other PHI into Sandbox. Production credentials are newly generated, not promoted from Sandbox.
</Info>

<Info>
  **Your team needs technical resources.** Your team — or a third-party partner — should have experience with programming, data handling, integration security, and API development. Hosted Database users also need SQL knowledge to query and analyze the data.
</Info>

<Info>
  **API access is controlled by available endpoints.** The APIs do not provide unrestricted access to every part of Elation. The documentation identifies the available endpoints, supported actions, and returned data. Review it early to confirm your planned workflow is supported.
</Info>

<Info>
  **Hosted Database data is refreshed in batches.** Designed for reporting and analytics, not real-time workflows. Data refreshes once daily at **1am PT or 5am PT** (your choice — contact Support to change it), so a given day reflects the prior day's activity. Data is in Pacific Time, except the `appt_time` column on the appointment table. It excludes Elation Billing data. Webhooks may be a better fit for timely event notifications.
</Info>

<Note>
  **Stay up to date on critical releases and fixes.** Elation's public RSS feeds provide automatic updates on endpoints, field changes, deprecations, breaking changes, and schema updates. Subscribe to the [API 2.0 changelog](/articles/rest/changelog/changelog) and [Hosted Database release notes](/articles/hdb/hdb-snowflake). If your workspace supports Slack's RSS app, use `/feed subscribe [feed address]`.
</Note>
