canonical: https://jentic.com/apis/eyefinity.com

# Eyefinity APIs

Eyefinity provides electronic health record systems for optometry practices, and its FHIR R4 interfaces let integrators read patient data from those records. Jentic publishes and maintains the only available OpenAPI specifications for both Eyefinity FHIR APIs. Together they expose patient demographics, clinical conditions, procedures, observations, medications, allergies, immunisations, and care plans across the Eyefinity Optometry EHR and the Encompass EHR, all over standard FHIR R4 with OAuth 2.0 authorisation.

## For AI agents

An agent can read patient charts from Eyefinity optometry EHR systems over FHIR R4: look up patients by demographics, pull their conditions, procedures, observations, medications, allergies, immunisations, and care plans, and assemble a unified clinical summary. Reads are scoped to the practice that authorised the OAuth 2.0 token.

## Scope

Use for: Reading patient demographics, conditions, and wider clinical resources from Eyefinity optometry EHR systems over FHIR R4 with OAuth 2.0

Not supported:
- clinical writes
- billing
- appointment scheduling
- bulk data export
- insurance claims

## APIs

| API | Category | Endpoints | Description |
| --- | --- | --- | --- |
| Eyefinity Optometry EHR FHIR API | healthcare | 27 | Read patient demographics, conditions, procedures, observations, medications, allergies, immunisations and care plans from Eyefinity Optometry EHR over FHIR R4 with OAuth 2.0. |
| Eyefinity EHR FHIR API | healthcare | 4 | Read patient demographics and clinical conditions from Encompass EHR through a FHIR R4 interface, with OAuth 2.0 authorisation against the Eyefinity authority server. |

## Which API to use

| Need | API | Why |
| --- | --- | --- |
| Full patient chart with medications, allergies, procedures, observations, immunisations and care plans | eyefinity-fhir-api | The Optometry EHR FHIR API spans 27 endpoints across the full clinical resource set, so it covers medication reconciliation and complete chart reads. |
| Patient demographics and clinical conditions from Encompass EHR | eyefinity-ehr-fhir-api | This slimmer 4-endpoint interface exposes only Patient and Condition reads against Encompass, which is enough when the workflow needs demographics and diagnoses only. |
| Confirm which FHIR resources a deployment exposes before reading | eyefinity-ehr-fhir-api | It exposes the FHIR /metadata capability statement so an agent can verify supported interactions before issuing reads. |

## Cross-API use cases

### Verify capability then read the full chart

Start against the Encompass interface to read the FHIR capability statement and confirm supported resources, then fall through to the wider Optometry EHR interface to assemble a complete patient chart including conditions, medications, allergies, and care plans. Both reads are gated by OAuth 2.0 tokens scoped by the authorising practice.

Example prompt: Call GET /metadata on the Encompass interface to confirm exposed resources, then read Patient, Condition, MedicationRequest, and AllergyIntolerance from the Optometry EHR interface and merge them into one chart summary.

### Match a patient across both Eyefinity EHR interfaces

Look up a patient by name and birth date on either interface, then use the resolved FHIR id to pull demographics and conditions from one API and the richer medication and care-plan resources from the other. Useful when a practice runs both Encompass and Optometry EHR deployments.

Example prompt: Search GET /Patient with family and birthdate on the Encompass interface, take the returned FHIR id, and read Condition and MedicationRequest for that id from the Optometry EHR interface.

## Why Jentic

- **Setup:** Wiring the Eyefinity FHIR APIs by hand means running the OAuth 2.0 flow against fhirauthority.eyefinity.com, pointing at the fhirapi.eyefinity.com R4 base, and mapping FHIR search parameters across each clinical resource yourself. With Jentic you install Jentic One once, add either Eyefinity API from the Jentic directory, store the OAuth credential once, and your agent calls both.
- **Permission scoping:** Both APIs put the resource id in the URL path, such as /Patient/{id}, and both surfaces are read-only. Because your Jentic One instance is self-hosted, your own rules decide which operations and credentials the agent may use, so you can pin it to just the Patient, Condition, or medication reads it needs and keep everything else off limits.
- **Credential handling:** Your Eyefinity OAuth 2.0 credential is stored once, encrypted, by your own Jentic One instance, and a scoped access token is injected at execution time. The client secret and refresh token never enter the agent's prompt, logs, or context.
- **Discovery method:** An agent searches the Jentic directory by intent, such as 'read a patient's medications' or 'look up an Eyefinity EHR patient', and Jentic returns the matching operation from the right API with its FHIR R4 search schema, so the agent calls the correct endpoint without learning FHIR search semantics from the docs.

## Related vendors

- **Epic** — Epic runs a widely used EHR with a FHIR R4 API, a common alternative when a practice is not on Eyefinity.
- **Oracle Health (Cerner)** — Cerner exposes FHIR R4 clinical reads from its EHR, another EHR interoperability option for patient-record integrations.
- **athenahealth** — athenahealth offers FHIR APIs over its ambulatory EHR, adjacent for outpatient and specialty practice integrations.

## FAQ

### Does Eyefinity publish official OpenAPI specifications for these APIs?

No. Eyefinity does not publish OpenAPI specifications for its FHIR interfaces. Jentic generates and maintains the specs for both the Optometry EHR and Encompass EHR APIs, validates them against the live services, and keeps them agent-ready.

### What is the difference between the two Eyefinity FHIR APIs?

The Eyefinity Optometry EHR FHIR API spans 27 endpoints across a wide resource set including procedures, observations, medications, allergies, immunisations, and care plans. The Eyefinity EHR FHIR API is a slimmer 4-endpoint interface to the Encompass EHR that exposes only Patient and Condition reads plus the capability statement. Choose the wider one for complete charts and the slimmer one when demographics and diagnoses are enough.

### Do both APIs share the same authentication?

Yes. Both use the OAuth 2.0 authorization-code flow against the same Eyefinity authority server at fhirauthority.eyefinity.com. The scopes each practice grants determine what a given token can read, so access can differ between deployments even with a shared auth model.

### Can an agent write data or handle scheduling and billing through these APIs?

No. Both interfaces are read-only. They do not support clinical writes, appointment scheduling, or billing. They are intended for reading patient records from Eyefinity optometry EHR systems, not for modifying them.

### Are these APIs suitable for handling protected health information?

They return real clinical data, so treat every read as protected health information. Access is limited to the scopes the authorising practice grants, and you remain responsible for handling the returned data in line with your own compliance obligations.

### How should an agent pace requests against these clinical systems?

Neither spec declares explicit rate limits, so pace reads conservatively, honour any 429 responses with exponential backoff, and avoid unbounded patient searches during clinical hours by narrowing with parameters such as _lastUpdated or _count.