Eye Reach Patients API Reference

Creates a new account in Eye Reach Patients.

Gets account settings.

Sets account settings.

Gets information about allergy.

Create a new allergy or update an existing allergy information.

Delete an allergy from the Eye Reach Patients list.

Gets information about an allergy reaction in the Eye Reach Patients list.

Create a new allergy reaction or update an existing allergy reaction in the Eye Reach Patients list.

Delete an allergy reaction from the Eye Reach Patients list.

Gets information about an allergy severity in the Eye Reach Patients list.

Create a new allergy severity or update an existing allergy severity in the Eye Reach Patients list.

Delete an allergy severity from the Eye Reach Patients list.

Returns a list of amendment requests.

Update the status to an amendment request.

Flags an amendment request as sent to the integrating system.

Sets the time span (in days) beyond which future appointments cannot be scheduled.

Gets a list of appointment cancellation requests.

Sets the status for the appointment cancellation request to approved or denied. (To do) Triggers an email to inform patient of the results of the cancellation request.

Flags an appointment cancellation request as received to the integrating system.

Returns a list of appointment request reasons.

Flags an appointment request reasons as sent to the integrating system.

Returns a list of appointment requests with patient data in case of new patients.

Apply a result to an appointment request.

Returns a list of appointment requests limited with patient data in case of new patients.

Flags an appointment request as sent to the integrating system.

Returns a list of appointments.

Gets information about an appointment.

Creates a new appointment or updates an existent appointment's information.

Deletes an appointment.

Creates a new appointment status or updates an existent appointment status's information.

Deletes an appointment status.

Returns a list of appointment types.

Gets information about an appointment type in the Eye Reach Patients list.

Create a new appointment type or update an existing appointment type in the Eye Reach Patients list.

Delete an appointment type from the Eye Reach Patients list.

Flags an appointment update as sent to the integrating system.

Supply the code to the portal in order to complete the authorization of the application.

Returns a list events related with CDA documents.

Flags a cda log as sent to the integrating system.

Gets information about a closed form.

Returns a list of appointments changed through communications.

Returns a list of orders changed through communications.

Returns a list of patients changed through communications.

Flags an communication update as sent to the integrating system.

Gets information about a contact lens prescription in the Eye Reach Patients list.

Creates a new contact lens prescription or updates an existent contact lens prescriptions. Accepted files are PDFs only.

Deactivate or activate a contact lens prescription.

Delete a contact lens prescription from the Eye Reach Patients list.

Gets information about a contact prefix.

Creates a new prefix or updates an existing prefix.

Deletes a contact prefix.

Gets information about a contact Suffix.

Creates a new Suffix or updates an existing Suffix.

Deletes a contact suffix.

Converts a portal patient into a patient. If the patient does not exist, a new patient will be created. All the data of the portal patient will be transferred to the patient.

Creates a new doctor availabilty slots or updates an existent doctor availabilty slots' information.

Deletes a doctor availabilty slots.

Returns a list of doctors.

Gets information about a doctor.

Creates a new doctor or updates the information of an existent doctor.

Deletes a doctor.

Creates a new dosage form or updates an existent dosage form's information.

Deletes a dosage form.

Creates a new exam field mapping detail or updates an existent exam field mapping detail's information.

Deletes an existent exam field mapping detail.

Gets information about a exam field mappings.

Creates a new exam field mappings or updates an existent exam field mappings' information.

Deletes a exam field mappings.

Gets information about an exam.

Creates a new exam or updates the information of an existent exam.

Delete an exam.

Returns a list of external health information links.

Flags an external health information link as sent to the integrating system.

Creates a new family history or updates an existent family history's information.

Deletes a family history.

Gets information about a familyHistoryproblem in the Eye Reach Patients list.

Create a new familyHistoryproblem or update an existing familyHistoryproblem in the Eye Reach Patients list.

Delete a familyHistoryproblem from the Eye Reach Patients list.

Gets information about a familyhistoryrelationships in the Eye Reach Patients list.

Create a new familyhistoryrelationships or update an existing familyhistoryrelationships in the Eye Reach Patients list.

Delete a familyhistoryrelationships from the Eye Reach Patients list.

Creates a new family member or updates an existent family member's information.

Deletes a family member.

Creates a new family relationship or update an existent family relationship's information.

Deletes a family relationship.

Returns a list of form files signed by patients.

Flags a form file signature as sent to the integrating system.

Gets information about a form.

Gets information about a glasses prescription in the Eye Reach Patients list.

Create a new glasses prescription or update an existing glasses prescription in the Eye Reach Patients list. Accepted files are PDFs only.

Delete a glasses prescription from the Eye Reach Patients list.

Activate/deactivate a glasses prescription.

Gets information about a health review.

Creates a new health review or updates an existent health review's information.

Deletes a health review.

Creates a new Hl7CDA or updates an existent Hl7CDA's information.

Returns a list of incoming secure messages.

Get information about an incoming secure message.

Mark as Read / Unread an incoming secure message.

Delete an incoming secure message.

Flags an incoming secure message as sent to the integrating system.

Creates a new insurance or updates an existent insurance's information.

Deletes an insurance.

Returns a list of locations.

Gets information about a location.

Creates a new location or updates an existent location's information.

Deletes a location.

Creates a new meaningful use or updates an existent meaningful use's information.

Gets information about a medication dosage in the Eye Reach Patients list.

Create a new medication dosage or update an existing medication dosage in the Eye Reach Patients list.

Delete a medication dosage from the Eye Reach Patients list.

Gets information about a medication form type in the Eye Reach Patients list.

Create a new medication dosage or update an existing medication form type in the Eye Reach Patients list.

Delete a medication form type from the Eye Reach Patients list.

Gets information about a medication frequency in the Eye Reach Patients list.

Create a new medication frequency or update the configuration of an existing medication frequency in the Eye Reach Patients list.

Delete a medication frequency from the Eye Reach Patients list.

Returns a list of medication refill requests.

Gets information about a medication refill.

Creates a new a medication refill or updates an existent medication refill's information.

Deletes a medication refill.

Flags a medication refill request as sent to the integrating system.

Gets information about a medication route in the Eye Reach Patients list.

Create a new medication route or update an existing medication route in the Eye Reach Patients list.

Delete a medication route from the Eye Reach Patients list.

Gets information about a medication in the Eye Reach Patients list.

Create a new medication or update the configuration of an existing medication in the Eye Reach Patients list.

Delete a medication from the Eye Reach Patients list.

Merge one patient's data with other patient.

Gets MessageBroker settings.

Sets MessageBroker settings.

Send communication.

Gets information about a open form.

Close an open form.

Returns a list of orders.

Gets information about an order.

Creates a new order or updates an existent order's information.

Deletes an order.

Returns a list of order statuses.

Gets information about a order statuses.

Creates a new order status or updates an existent order status's information.

Delete an order status.

Flags an order update as sent to the integrating system.

Returns a list of outgoing secure messages.

Get information about an outgoing secure message.

Deletes an outgoing message.

Send a message or draft one.

Flags an outgoing secure message as sent to the integrating system.

Returns a list of partner files.

Upload a partner file. Important: This endpoint will not modify existent files. If a file name already exist in the portal you will get an error.

Deletes a partner file.

Gets a binary file uploaded by a partner.

Marks a partner file as sent to the integrating system.

Gets information about a patient allergy in the Eye Reach Patients list.

Create a new patient allergy record or update an existing patient allergy record in the Eye Reach Patients list.

Delete a patient allergy record from the Eye Reach Patients list.

Authenticate patient access using an authorized application.

Register a patient application.

Allows to update the communication preferences of a patient.

Gets information about a patient's communication preferences.

Returns a list of patient communications.

Returns a list of patient education materials.

Gets information about a patient education material model.

Creates a new patient education material or updates an existent patient education material's information.

Deletes a patient education material.

Returns a list of patient education material views.

Gets information about a patient ethnicity in the Eye Reach Patients list.

Create a new patient ethnicity or update the configuration of an existing patient ethnicity in the Eye Reach Patients list.

Delete a patient ethnicity from the Eye Reach Patients list.

Gets information about a patient family history problem in the Eye Reach Patients list.

Create a new patient family history problem record or update an existing patient family history problem record in the Eye Reach Patients list.

Delete a patient family history problem record from the Eye Reach Patients list.

Gets the configuration for a marital status in the Eye Reach Patients list.

Create a new marital status or update the configuration of an existing marital status in the Eye Reach Patients list.

Delete a marital status from the Eye Reach Patients list.

Gets information about a patient medication record in the Eye Reach Patients list.

Create a new patient medication record or update an existing patient medication record in the Eye Reach Patients list.

Delete a patient medication record from the Eye Reach Patients list.

Returns a list of patient medications.

Gets information about a patient medication.

Creates a new patient medication or updates an existent patient medication's information.

Deletes a patient medication.

Returns a list of patient payments.

Flags a patient payment as sent to the integrating system.

Gets information about a patient race in the Eye Reach Patients list.

Create a new patient race or update the configuration of an existing patient race in the Eye Reach Patients list.

Delete a patient race from the Eye Reach Patients list.

Gets information about a patient relationship.

Creates a new patient relationship or updates an existent patient relationship's information.

Deletes a patient relationship.

Returns a list related with patient responsible balances.

Modify the value of the patient responsible balance.

Returns a list of patients.

Gets information about a patient.

Creates a new patient or updates information for an existent patient.

Deletes a patient.

Gets information about a patient sex in the Eye Reach Patients list.

Create a new patient sex or update an existing patient sex in the Eye Reach Patients list.

Delete a patient sex from the Eye Reach Patients list.

Returns a list of patient shared files.

Get information about a file shared by a patient.

Modify the status of the file shared by the patient.

Deletes file shared by the patient.

Gets a binary file shared by a patient.

Flags a patient shared file as sent to the integrating system.

Gets information about a patient surgeries in the Eye Reach Patients list.

Create a new patient surgery record or update an existing patient surgery record in the Eye Reach Patients list.

Delete a patient surgery record from the Eye Reach Patients list.

Flags a patient update as sent to the integrating system.

Returns a list of PGHD update requests.

Flags a PGHD update request as sent to the integrating system.

Flags a PGHD update request as sent to the integrating system.

Returns information about pending operations on the portal. The pending operations include modifications requested to appointments, orders, patients, etc.

Gets information about a portal patient.

Flags a patient shared file as sent to the integrating system.

Gets RCP settings.

Sets RCP settings.

Returns a list of recalls.

Gets information about a recall.

Creates a new recall or updates an existent recall's information.

Deletes a recall.

Creates a new referral or updates an existent referral's information.

Deletes a referral.

Returns a list of secure recipients.

Gets information about a secure recipient.

Creates a new secure recipient or updates an existent secure recipient's information.

Deletes a secure recipient.

Gets information about an alcohol use entry.

Creates a new alcohol use entry or updates an existing one.

Deletes a social history alcohol.

Gets information about a drug use entry.

Creates a new drug use entry or updates an existing one.

Deletes a drug use entry.

Gets information about a surgery in the Eye Reach Patients list.

Create a new surgery or update the configuration of an existing surgery in the Eye Reach Patients list.

Delete a surgery from the Eye Reach Patients list.

Returns a list of users.

Gets information about an user.

Adds a new user or updates information on an existing user.

Deletes a user.

Verify whether a patient already have the username.

Verify whether a user already have the username.