EyeFinity API

Does EyeFinity have a public API?

Eyefinity publishes a SMART on FHIR R4 API for its EHR, built to meet the Cures Act patient-access requirement: read-only requests for USCDI data, granted after a connection request that Eyefinity verifies within ten business days. Integuru generates a production-ready HTTP API for the exam room itself from the practice's own login, with 20 verified actions that read the schedule and write the visit note.

An optometrist's note lives in a dozen tabs: complaint, history, a per-eye slit lamp exam, impressions with body-map clicks, plans with prepopulated text. None of that is writable over FHIR. Integuru writes it with direct HTTP requests to the endpoints the Eyefinity EHR uses, authenticated, using your own credentials, with login and any second factor handled for you.

What you can do with the EyeFinity API

An ambient scribe listens through a comprehensive exam. By the time the patient reaches the optical, the visit note should carry the complaint and HPI, the review of systems, the anterior and posterior segment findings for each eye, and the impressions with their plans, in the order the doctor wants them. The actions follow that note tab by tab.

Start the visit with context

• list_appointments_by_date returns a date's appointments, each with the numeric patient.id. list_recent_patient_visits resolves a patient by exact pms_id or fuzzy patient_name (ambiguous names return candidates rather than a guess) and lists their visits.
• get_previous_visit_clinical_context returns the most recent prior visit for a patient_id, excluding current_visit_id and anything after before_datetime, so the scribe knows what was found last time. list_preliminary_notes returns a provider's notes created on a date by provider_name.
• list_patients, list_staff, list_facilities, list_insurances and list_payers supply the reference data.

Resolve the codes

• search_chief_complaints (scoped to a visit_id, 25 per page), search_diagnoses (by keyword) and search_snomed (by keyword within a value_set, default PROBLEM) return the ids the write actions expect.
• list_impression_plan_catalog returns practice-configured diagnoses and their compatible plan templates with default text, using any visit_id as read-only context; filter with query or medical_domain (OPHTHALMOLOGY) and keep page_size small. list_body_locations returns the body-map catalog, per map_id such as ophth_slit_lamp.

Write the note

• update_visit_cc_hpi_ros writes chief_complaints, the problem_list, SNOMED-coded medical, surgical, ocular and family history arrays, a review_of_systems object (a response on a system sets all of its questions) and partial social_history for a visit_id and patient_id. set_first_chief_complaint_additional_hpi replaces the free-text HPI comments on the first complaint.
• create_eye_exam fills the Eye Exam tabs per eye: external, conjunctiva, cornea, ac, iris, lens, discs, fundus, with defer toggles, top-of-exam toggles and additional_exam_notes.
• update_visit_impressions_plans edits or creates impressions from a diagnoses array and attaches special_plans by category, never duplicating a plan already on the visit. select_visit_impression_body_locations records the body-map click for each matched impression, and reorder_visit_diagnoses sets the display order from ordered_diagnosis_ids.

Who uses this

Ambient documentation vendors for eye care map the transcript onto update_visit_cc_hpi_ros, create_eye_exam and update_visit_impressions_plans, running each with dry_run: true in staging and reading get_previous_visit_clinical_context first so a stable finding is carried forward rather than re-dictated. Multi-location optometry and optical retail groups pull list_appointments_by_date per facility to drive pre-appointment work, including VSP benefits through the VSP integration. Groups that also run a broader specialty EHR pair this page with the Modmed and Nextech integrations; the healthcare industry page covers documentation and billing as one workflow.

Setup notes

Integuru authenticates against your practice's subdomain of eyefinityehr.com with an Eyefinity EHR user. Three identifiers matter: the numeric patient_id from an appointment's patient.id, the visit_id of the visit note (not the appointment), and the pms_id or MRN used to find a patient by record number. Dates go in as YYYY-MM-DD and are converted to Eyefinity's MM/dd/yyyy; list_preliminary_notes interprets its date as a US/Pacific practice day. The catalog and search actions are read-only even when they require a visit_id. Two actions, list_impression_plan_catalog and list_payers, do not yet carry full documentation in the table above.

Get started

Install the CLI and connect your Eyefinity EHR login:

npm install -g integuru

Or sign in at app.integuru.com, add EyeFinity, and call list_appointments_by_date for today. Refraction and contact lens data, orders, and the practice management side of Encompass are built on request through the Managed Service.