Accounts

Provides methods for the creation of accounts.

APIDescription
POST api/Accounts

Creates a new account in Eye Reach Patients.

AccountSettings

Gets or modifies account settings.

APIDescription
GET api/AccountSettings

Gets account settings.

POST api/AccountSettings

Sets account settings.

Allergies

Creates and maintains a list of allergies in Eye Reach Patients.

APIDescription
GET api/Allergies?externalId={externalId}

Gets information about allergy.

POST api/Allergies

Create a new allergy or update an existing allergy information.

DELETE api/Allergies?externalId={externalId}

Delete an allergy from the Eye Reach Patients list.

AllergyReactions

Creates and maintains of a list of allergy reactions in Eye Reach Patients.

APIDescription
GET api/AllergyReactions?externalId={externalId}

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

POST api/AllergyReactions

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

DELETE api/AllergyReactions?externalId={externalId}

Delete an allergy reaction from the Eye Reach Patients list.

AllergySeverities

Creates and maintains of a list of allergy severities in Eye Reach Patients.

APIDescription
GET api/AllergySeverities?externalId={externalId}

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

POST api/AllergySeverities

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

DELETE api/AllergySeverities?externalId={externalId}

Delete an allergy severity from the Eye Reach Patients list.

AmendmentRequests

Creates and maintains a list of amendment requests.

APIDescription
GET api/amendmentrequests/search?alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of amendment requests.

POST api/AmendmentRequests

Update the status to an amendment request.

AmendmentRequestsSent

Flags an amendment request as sent to the integrating system.

APIDescription
POST api/AmendmentRequestsSent

Flags an amendment request as sent to the integrating system.

AppointmentAllowedTimeInAdvance

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

APIDescription
POST api/AppointmentAllowedTimeInAdvance

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

AppointmentCancelRequests

Creates and maintains an appointment cancellation request list.

APIDescription
GET api/appointmentcancelrequests/search?alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Gets a list of appointment cancellation requests.

POST api/AppointmentCancelRequests

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.

AppointmentCancelRequestsSent

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

APIDescription
POST api/AppointmentCancelRequestsSent

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

AppointmentRequestReasons

Creates and maintains a list of appointment request reason.

APIDescription
GET api/appointmentrequestreasons/search?changed={changed}&isDeleted={isDeleted}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of appointment request reasons.

POST api/AppointmentRequestReasons

AppointmentRequestReasonsSent

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

APIDescription
POST api/AppointmentRequestReasonsSent

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

AppointmentRequests

Creates and maintains a list of appointment requests.

APIDescription
GET api/appointmentrequests/search?alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

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

POST api/AppointmentRequests

Apply a result to an appointment request.

AppointmentRequestsLimited

Creates and maintains a list of appointment requests limited.

APIDescription
GET api/appointmentrequestslimited/search?alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

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

AppointmentRequestsSent

Flags an appointment request as sent to the integrating system.

APIDescription
POST api/AppointmentRequestsSent

Flags an appointment request as sent to the integrating system.

Appointments

Creates and maintains of a list of appointments.

APIDescription
GET api/appointments/search?appointmentExternalId={appointmentExternalId}&patientBirthday={patientBirthday}&status={status}&startDateOperator={startDateOperator}&start1={start1}&start2={start2}&portalCreatedOperator={portalCreatedOperator}&portalCreated1={portalCreated1}&portalCreated2={portalCreated2}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of appointments.

GET api/Appointments?externalId={externalId}

Gets information about an appointment.

POST api/Appointments

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

DELETE api/Appointments?externalId={externalId}

Deletes an appointment.

AppointmentStatuses

Creates and maintains of a list of appointment statuses.

APIDescription
POST api/AppointmentStatuses

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

DELETE api/AppointmentStatuses?externalId={externalId}

Deletes an appointment status.

AppointmentUpdatesSent

Flags an appointment update as sent to the integrating system.

APIDescription
POST api/AppointmentUpdatesSent

Flags an appointment update as sent to the integrating system.

AuthorizePatientApplication

This method will be used to supply the code back to the portal and complete the authorization of the application.

APIDescription
POST api/AuthorizePatientApplication

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

CdaLogs

Maintains a list of cda logs.

APIDescription
GET api/cdalogs/search?cdaType={cdaType}&operationKey={operationKey}&patientExternalId={patientExternalId}&userExternalId={userExternalId}&cdaUploadedByDoctorExternalId={cdaUploadedByDoctorExternalId}&createdOperator={createdOperator}&created1={created1}&created2={created2}&alreadySent={alreadySent}&excludeUsers={excludeUsers}&excludePatients={excludePatients}&page={page}&itemsPerPage={itemsPerPage}

Returns a list events related with CDA documents.

CdaLogsSent

Flags a cda log as sent to the integrating system.

APIDescription
POST api/CdaLogsSent

Flags a cda log as sent to the integrating system.

ClosedForms

Enable get information about a closed form.

APIDescription
GET api/ClosedForms?internalId={internalId}

Gets information about a closed form.

CommunicationUpdatesAppointments

Provides access to appointments changed through communications.

APIDescription
GET api/communicationupdatesappointments/search?page={page}&itemPerPage={itemPerPage}&appointmentExternalID={appointmentExternalID}&method={method}&alreadySent={alreadySent}

Returns a list of appointments changed through communications.

CommunicationUpdatesOrders

Provides access to orders changed through communications.

APIDescription
GET api/communicationupdatesorders/search?page={page}&itemPerPage={itemPerPage}&orderExternalID={orderExternalID}&alreadySent={alreadySent}&method={method}

Returns a list of orders changed through communications.

CommunicationUpdatesPatients

Provides access to patients changed through communications.

APIDescription
GET api/communicationupdatespatients/search?page={page}&itemsPerPage={itemsPerPage}&patientExternalID={patientExternalID}&method={method}&alreadySent={alreadySent}

Returns a list of patients changed through communications.

CommunicationUpdatesSent

Flags an patient communication as sent to the integrating system.

APIDescription
POST api/CommunicationUpdatesSent

Flags an communication update as sent to the integrating system.

ContactPrefixes

Creates and maintains contact prefixes.

APIDescription
GET api/ContactPrefixes?externalId={externalId}

Gets information about a contact prefix.

POST api/ContactPrefixes

Creates a new prefix or updates an existing prefix.

DELETE api/ContactPrefixes?externalId={externalId}

Deletes a contact prefix.

ContactSuffixes

Creates and maintains contact suffixes.

APIDescription
GET api/ContactSuffixes?externalId={externalId}

Gets information about a contact Suffix.

POST api/ContactSuffixes

Creates a new Suffix or updates an existing Suffix.

DELETE api/ContactSuffixes?externalId={externalId}

Deletes a contact suffix.

ConvertPortalPatientToPatient

Allows to converts a portal patient into a patient. The integrating system will send the Unique ID of 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.

APIDescription
POST api/ConvertPortalPatientToPatient

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.

DoctorAvailabiltySlots

Creates and maintains of a list of doctor availabilty slots.

APIDescription
POST api/DoctorAvailabiltySlots

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

DELETE api/DoctorAvailabiltySlots?externalId={externalId}

Deletes a doctor availabilty slots.

Doctors

Creates and maintains of a list of doctors.

APIDescription
GET api/Doctors?externalId={externalId}

Gets information about a doctor.

POST api/Doctors

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

DELETE api/Doctors?externalId={externalId}

Deletes a doctor.

DosageForms

Creates and maintains of a list of dosage forms.

APIDescription
POST api/DosageForms

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

DELETE api/DosageForms?externalId={externalId}

Deletes a dosage form.

ExamFieldMappingDetails

Creates and maintains of a list of exam field mapping detail.

APIDescription
POST api/ExamFieldMappingDetails

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

DELETE api/ExamFieldMappingDetails?externalId={externalId}

Deletes an existent exam field mapping detail.

ExamFieldMappings

Creates and maintains of a list of exam field mappings.

APIDescription
GET api/ExamFieldMappings?externalId={externalId}

Gets information about a exam field mappings.

POST api/ExamFieldMappings

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

DELETE api/ExamFieldMappings?externalId={externalId}

Deletes a exam field mappings.

Exams

Creates and maintains of a list of exams.

APIDescription
GET api/Exams?externalId={externalId}

Gets information about an exam.

POST api/Exams

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

DELETE api/Exams?externalId={externalId}

Delete an exam.

Maintains a list of external health information link.

APIDescription
GET api/externalHealthInformationLinks/search?patientExternalId={patientExternalId}&alreadySent={alreadySent}&page={page}&itemPerPage={itemPerPage}

Returns a list of external health information links.

ExternalHealthInformationLinksSent

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

APIDescription
POST api/ExternalHealthInformationLinksSent

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

FamilyHistories

Creates and maintains of a list of family history.

APIDescription
POST api/FamilyHistories

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

DELETE api/FamilyHistories?externalId={externalId}

Deletes a family history.

FamilyHistoryProblems

Creates and maintains of a list of familyHistoryproblem in Eye Reach Patients.

APIDescription
GET api/FamilyHistoryProblems?externalId={externalId}

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

POST api/FamilyHistoryProblems

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

DELETE api/FamilyHistoryProblems?externalId={externalId}

Delete a familyHistoryproblem from the Eye Reach Patients list.

FamilyHistoryRelationships

Creates and maintains of a list of familyhistoryrelationships in Eye Reach Patients.

APIDescription
GET api/FamilyHistoryRelationships?externalId={externalId}

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

POST api/FamilyHistoryRelationships

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

DELETE api/FamilyHistoryRelationships?externalId={externalId}

Delete a familyhistoryrelationships from the Eye Reach Patients list.

FamilyMembers

Creates and maintains of a list of family members.

APIDescription
POST api/FamilyMembers

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

DELETE api/FamilyMembers?externalId={externalId}

Deletes a family member.

FamilyRelationships

Creates and maintains of a list of family relationship.

APIDescription
POST api/FamilyRelationships

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

DELETE api/FamilyRelationships?externalId={externalId}

Deletes a family relationship.

FormFileSignatures

Gets a list of form files signed by patients.

APIDescription
GET api/FormFileSignatures/search?patientExternalId={patientExternalId}&signatureDateUtcOperator={signatureDateUtcOperator}&signatureDateUtc1={signatureDateUtc1}&signatureDateUtc2={signatureDateUtc2}&page={page}&itemPerPage={itemPerPage}

Returns a list of form files signed by patients.

Forms

Enables a operation to gets information in a form.

APIDescription
GET api/forms/search?formStatus={formStatus}&creationDateOperator={creationDateOperator}&utcCreationDate1={utcCreationDate1}&utcCreationDate2={utcCreationDate2}&completedDateOperator={completedDateOperator}&utcCompletedDate1={utcCompletedDate1}&utcCompletedDate2={utcCompletedDate2}&closedDateOperator={closedDateOperator}&utcClosedDate1={utcClosedDate1}&utcClosedDate2={utcClosedDate2}&patientFirstName={patientFirstName}&patientLastName={patientLastName}&formLayoutActive={formLayoutActive}&page={page}&itemsPerPage={itemsPerPage}&patientExternalId={patientExternalId}&onlyProfileForms={onlyProfileForms}

Gets information about a form.

HealthReviews

Creates and maintains of a list of health reviews.

APIDescription
GET api/HealthReviews?externalId={externalId}

Gets information about a health review.

POST api/HealthReviews

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

DELETE api/HealthReviews?externalId={externalId}

Deletes a health review.

Hl7CDAs

Enable operation for create new Hl7CDA.

APIDescription
POST api/Hl7CDAs

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

IncomingSecureMessages

Maintains a list of incoming secure messages. Secure messages marks as read or unread.

APIDescription
GET api/incomingSecureMessages/search?priority={priority}&secureRecipientName={secureRecipientName}&subject={subject}&body={body}&patientExternalId={patientExternalId}&patientEmailAddress={patientEmailAddress}&creationDateOperator={creationDateOperator}&creationDate1={creationDate1}&creationDate2={creationDate2}&sentDateOperator={sentDateOperator}&sentDate1={sentDate1}&sentDate2={sentDate2}&getFullBody={getFullBody}&read={read}&deletedByUser={deletedByUser}&deletedByPatient={deletedByPatient}&fromRepresentative={fromRepresentative}&alreadySent={alreadySent}&page={page}&itemPerPage={itemPerPage}

Returns a list of incoming secure messages.

GET api/IncomingSecureMessages/{id}

Get information about an incoming secure message.

POST api/IncomingSecureMessages/{id}?read={read}

Mark as Read / Unread an incoming secure message.

DELETE api/IncomingSecureMessages/{id}

Delete an incoming secure message.

IncomingSecureMessagesSent

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

APIDescription
POST api/IncomingSecureMessagesSent

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

Insurances

Creates and maintains of a list of insurances.

APIDescription
POST api/Insurances

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

DELETE api/Insurances?externalId={externalId}

Deletes an insurance.

Locations

Creates and maintains of a list of locations. Locations can be optical stores and / or doctor offices.

APIDescription
GET api/locations/search?externalId={externalId}&name={name}&active={active}&city={city}&state={state}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of locations.

GET api/Locations?externalId={externalId}

Gets information about a location.

POST api/Locations

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

DELETE api/Locations?externalId={externalId}

Deletes a location.

MeaningfulUses

Enables a operation to gets information in a meaningful uses.

APIDescription
POST api/MeaningfulUses

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

MedicationDosages

Creates and maintains of a list of medication dosages in Eye Reach Patients.

APIDescription
GET api/MedicationDosages?externalId={externalId}

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

POST api/MedicationDosages

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

DELETE api/MedicationDosages?externalId={externalId}

Delete a medication dosage from the Eye Reach Patients list.

MedicationFormTypes

Creates and maintains of a list of medication form type in Eye Reach Patients.

APIDescription
GET api/MedicationFormTypes?externalId={externalId}

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

POST api/MedicationFormTypes

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

DELETE api/MedicationFormTypes?externalId={externalId}

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

MedicationFrequencies

Creates and maintains of a list of medication frequencies in Eye Reach Patients.

APIDescription
GET api/MedicationFrequencies?externalId={externalId}

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

POST api/MedicationFrequencies

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

DELETE api/MedicationFrequencies?externalId={externalId}

Delete a medication frequency from the Eye Reach Patients list.

MedicationRefillRequests

Update and maintains of a list of medication refills request.

APIDescription
GET api/medicationrefillrequests/search?patientExternalId={patientExternalId}&doctorExternalId={doctorExternalId}&patientMedicationExternalId={patientMedicationExternalId}&doctorFirstName={doctorFirstName}&doctorLastName={doctorLastName}&medicationName={medicationName}&status={status}&createdOperator={createdOperator}&created1={created1}&created2={created2}&lastStatusChangeOperator={lastStatusChangeOperator}&lastStatusChange1={lastStatusChange1}&lastStatusChange2={lastStatusChange2}&alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of medication refill requests.

GET api/MedicationRefillRequests/{id}

Gets information about a medication refill.

POST api/MedicationRefillRequests

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

DELETE api/MedicationRefillRequests/{id}

Deletes a medication refill.

MedicationRefillRequestsSent

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

APIDescription
POST api/MedicationRefillRequestsSent

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

MedicationRoutes

Creates and maintains of a list of medication route in Eye Reach Patients.

APIDescription
GET api/MedicationRoutes?externalId={externalId}

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

POST api/MedicationRoutes

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

DELETE api/MedicationRoutes?externalId={externalId}

Delete a medication route from the Eye Reach Patients list.

Medications

Creates and maintains of a list of medications in Eye Reach Patients.

APIDescription
GET api/Medications?externalId={externalId}

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

POST api/Medications

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

DELETE api/Medications?externalId={externalId}

Delete a medication from the Eye Reach Patients list.

MergePatients

Provides functionalities to merge patients' data.

APIDescription
POST api/MergePatients

Merge one patient's data with other patient.

OneOffMessages

Creates and maintains of a list of patient communications.

APIDescription
POST api/OneOffMessages

Send communication.

OpenForms

Creates and maintains of a list of open forms.

APIDescription
GET api/OpenForms?internalId={internalId}

Gets information about a open form.

POST api/OpenForms

Close an open form.

Orders

Creates and maintains of a list of order.

APIDescription
GET api/orders/search?patientExternalId={patientExternalId}&locationExternalId={locationExternalId}&externalId={externalId}&utcCreationDate={utcCreationDate}&utcPickupDate={utcPickupDate}&patientBalance={patientBalance}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of orders.

GET api/Orders?externalId={externalId}

Gets information about an order.

POST api/Orders

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

DELETE api/Orders?externalId={externalId}

Deletes an order.

OrderStatuses

Creates and maintains of a list of order statuses.

APIDescription
GET api/orderstatuses/search?name={name}&externalId={externalId}&active={active}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of order statuses.

GET api/OrderStatuses?externalId={externalId}

Gets information about a order statuses.

POST api/OrderStatuses

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

DELETE api/OrderStatuses?externalId={externalId}

Delete an order status.

OrderUpdatesSent

Flags an order update as sent to the integrating system.

APIDescription
POST api/OrderUpdatesSent

Flags an order update as sent to the integrating system.

OutgoingSecureMessages

Maintains a list of outgoing secure messages.Get the information of a message, send a message or keeping in a draft.

APIDescription
GET api/outgoingSecureMessages/search?status={status}&priority={priority}&fromText={fromText}&subject={subject}&body={body}&patientExternalId={patientExternalId}&sentDateOperator={sentDateOperator}&sentDate1={sentDate1}&sentDate2={sentDate2}&getFullBody={getFullBody}&read={read}&deletedByPatient={deletedByPatient}&deletedByUser={deletedByUser}&alreadySent={alreadySent}&createdFromApi={createdFromApi}&fromSecureRecipientName={fromSecureRecipientName}&searchTerm={searchTerm}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of outgoing secure messages.

GET api/OutgoingSecureMessages?externalId={externalId}

Get information about an outgoing secure message.

DELETE api/OutgoingSecureMessages?externalId={externalId}

Deletes an outgoing message.

POST api/OutgoingSecureMessages

Send a message or draft one.

OutgoingSecureMessagesSent

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

APIDescription
POST api/OutgoingSecureMessagesSent

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

PatientAllergies

Creates and maintains of a list of patient allergies in Eye Reach Patients.

APIDescription
GET api/PatientAllergies?externalId={externalId}

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

POST api/PatientAllergies

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

DELETE api/PatientAllergies?externalId={externalId}

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

PatientApplicationAuthentication

This method will be used to authenticate patient access using an authorized application.

APIDescription
POST api/PatientApplicationAuthentication

Authenticate patient access using an authorized application.

PatientApplications

This method will be used to register a patient application in the portal.

APIDescription
POST api/PatientApplications

Register a patient application.

PatientCommunicationPreferences

Allows to get or update the communication preferences of a patient.

APIDescription
POST api/PatientCommunicationPreferences

Allows to update the communication preferences of a patient.

GET api/PatientCommunicationPreferences?externalId={externalId}

Gets information about a patient's communication preferences.

PatientCommunications

Creates and maintains of a list of patient communications.

APIDescription
GET api/patientcommunications/search?status={status}&creationDateOperator={creationDateOperator}&utcCreationDate1={utcCreationDate1}&utcCreationDate2={utcCreationDate2}&alreadySent={alreadySent}&patientExternalId={patientExternalId}&appointmentExternalId={appointmentExternalId}&outgoing={outgoing}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patient communications.

PatientEducationMaterials

Creates and maintains of a list of patient education materials.

APIDescription
GET api/patienteducationmaterials/search?type={type}&externalId={externalId}&doctorExternalId={doctorExternalId}&patientExternalId={patientExternalId}&active={active}&viewed={viewed}&reviews={reviews}&dateOperator={dateOperator}&date1={date1}&date2={date2}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patient education materials.

GET api/PatientEducationMaterials?externalId={externalId}

Gets information about a patient education material model.

POST api/PatientEducationMaterials

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

DELETE api/PatientEducationMaterials?externalId={externalId}

Deletes a patient education material.

PatientEducationMaterialViews

Get a list of patient education material views.

APIDescription
GET api/patienteducationmaterialviews/search?type={type}&patientEducationMaterialExternalId={patientEducationMaterialExternalId}&patientExternalId={patientExternalId}&dateViewedOperator={dateViewedOperator}&dateViewed1={dateViewed1}&dateViewed2={dateViewed2}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patient education material views.

PatientEthnicities

Creates and maintains of a list of patient ethnicities in Eye Reach Patients.

APIDescription
GET api/PatientEthnicities?externalId={externalId}

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

POST api/PatientEthnicities

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

DELETE api/PatientEthnicities?externalId={externalId}

Delete a patient ethnicity from the Eye Reach Patients list.

PatientFamilyHistoryProblems

Creates and maintains of a list of patient family history problems in Eye Reach Patients.

APIDescription
GET api/PatientFamilyHistoryProblems?externalId={externalId}

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

POST api/PatientFamilyHistoryProblems

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

DELETE api/PatientFamilyHistoryProblems?externalId={externalId}

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

PatientMaritalStatuses

Creates and maintains of a list of marital statuses in Eye Reach Patients.

APIDescription
GET api/PatientMaritalStatuses?externalId={externalId}

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

POST api/PatientMaritalStatuses

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

DELETE api/PatientMaritalStatuses?externalId={externalId}

Delete a marital status from the Eye Reach Patients list.

PatientMedicationRecords

Creates and maintains of a list of patient medication records in Eye Reach Patients.

APIDescription
GET api/PatientMedicationRecords?externalId={externalId}

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

POST api/PatientMedicationRecords

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

DELETE api/PatientMedicationRecords?externalId={externalId}

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

PatientMedications

Creates and maintains of a list of patient medications.

APIDescription
GET api/patientmedications/search?patientExternalId={patientExternalId}&doctorExternalId={doctorExternalId}&externalId={externalId}&name={name}&active={active}&lastRefillRequestOperator={lastRefillRequestOperator}&lastRefillRequest1={lastRefillRequest1}&lastRefillRequest2={lastRefillRequest2}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patient medications.

GET api/PatientMedications?externalId={externalId}

Gets information about a patient medication.

POST api/PatientMedications

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

DELETE api/PatientMedications?externalId={externalId}

Deletes a patient medication.

PatientPayments

Maintains a list of patient payments.

APIDescription
GET api/patientPayments/search?creationDateOperator={creationDateOperator}&creationDate1={creationDate1}&creationDate2={creationDate2}&transactionId={transactionId}&cardholderName={cardholderName}&last4CardNumber={last4CardNumber}&referenceNumber={referenceNumber}&paymentSuccessful={paymentSuccessful}&alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patient payments.

PatientPaymentsSent

Flags a patient payment as sent to the integrating system.

APIDescription
POST api/PatientPaymentsSent

Flags a patient payment as sent to the integrating system.

PatientRaces

Creates and maintains of a list of patient races in Eye Reach Patients.

APIDescription
GET api/PatientRaces?externalId={externalId}

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

POST api/PatientRaces

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

DELETE api/PatientRaces?externalId={externalId}

Delete a patient race from the Eye Reach Patients list.

PatientRelationships

Creates and maintains of a list of patient relationships.

APIDescription
GET api/PatientRelationships?externalId={externalId}

Gets information about a patient relationship.

POST api/PatientRelationships

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

DELETE api/PatientRelationships?externalId={externalId}

Deletes a patient relationship.

Patients

Creates and maintains of a list of Patient.

APIDescription
GET api/patients/search?fullName={fullName}&birthday={birthday}&active={active}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patients.

GET api/Patients?externalId={externalId}

Gets information about a patient.

POST api/Patients

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

DELETE api/Patients?externalId={externalId}

Deletes a patient.

PatientSexes

Creates and maintains of a list of patient sexes in Eye Reach Patients.

APIDescription
GET api/PatientSexes?externalId={externalId}

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

POST api/PatientSexes

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

DELETE api/PatientSexes?externalId={externalId}

Delete a patient sex from the Eye Reach Patients list.

PatientSharedFiles

Allows access to files shared by patients

APIDescription
GET api/patientSharedFiles/search?patientExternalId={patientExternalId}&creationDateOperator={creationDateOperator}&creationDate1={creationDate1}&creationDate2={creationDate2}&displayName={displayName}&fileName={fileName}&patientComments={patientComments}&status={status}&alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patient shared files.

GET api/PatientSharedFiles/{id}

Get information about a file shared by a patient.

POST api/PatientSharedFiles

Modify the status of the file shared by the patient.

DELETE api/PatientSharedFiles/{id}

Deletes file shared by the patient.

PatientSharedFilesBinary

Allow access to the binary files of the files shared by patients.

APIDescription
GET api/PatientSharedFilesBinary/{id}

Gets a binary file shared by a patient.

PatientSharedFilesSent

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

APIDescription
POST api/PatientSharedFilesSent

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

PatientSurgeries

Creates and maintains of a list of patient surgeries in Eye Reach Patients.

APIDescription
GET api/PatientSurgeries?externalId={externalId}

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

POST api/PatientSurgeries

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

DELETE api/PatientSurgeries?externalId={externalId}

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

PatientUpdatesSent

Flags a patient update as sent to the integrating system.

APIDescription
POST api/PatientUpdatesSent

Flags a patient update as sent to the integrating system.

PghdUpdateRequests

List of pghd update requests.

APIDescription
GET api/pghdupdaterequests/search?patientExternalId={patientExternalId}&createdOperator={createdOperator}&created1={created1}&created2={created2}&alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of PGHD update requests.

PghdUpdateRequestsSent

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

APIDescription
POST api/PghdUpdateRequestsSent

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

PortalPatients

Returns information about "Portal Patients". These are patients that exist in the portal but may not be registered yet as patients in the integrating system, i.e. when a new patient creates an account in the portal without going to the office before.

APIDescription
GET api/portalpatients/search?firstName={firstName}&lastName={lastName}&alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

GET api/PortalPatients/{id}

Gets information about a portal patient.

PortalPatientsSent

Flags a portal patient as sent to the integrating system.

APIDescription
POST api/PortalPatientsSent

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

RCPSettings

Gets or sets RCP settings.

APIDescription
GET api/RCPSettings

Gets RCP settings.

POST api/RCPSettings

Sets RCP settings.

Recalls

Creates and maintains of a list of recalls.

APIDescription
GET api/recalls/search?locationExternalId={locationExternalId}&doctorExternalId={doctorExternalId}&patientExternalId={patientExternalId}&active={active}&dateOperator={dateOperator}&date1={date1}&date2={date2}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of recalls.

GET api/Recalls?externalId={externalId}

Gets information about a recall.

POST api/Recalls

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

DELETE api/Recalls?externalId={externalId}

Deletes a recall.

Referrals

Creates and maintains of a list of referral.

APIDescription
POST api/Referrals

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

DELETE api/Referrals?externalId={externalId}

Deletes a referral.

SecureRecipients

Creates and maintains of a list of secure recipients.

APIDescription
GET api/securerecipients/search?page={page}&itemsPerPage={itemsPerPage}

Returns a list of secure recipients.

GET api/SecureRecipients?externalId={externalId}

Gets information about a secure recipient.

POST api/SecureRecipients

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

DELETE api/SecureRecipients?externalId={externalId}

Deletes a secure recipient.

SocialHistoryAlcohols

Creates and maintains a list of possible alcohol use entries (for patient social history).

APIDescription
GET api/SocialHistoryAlcohols?externalId={externalId}

Gets information about an alcohol use entry.

POST api/SocialHistoryAlcohols

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

DELETE api/SocialHistoryAlcohols?externalId={externalId}

Deletes a social history alcohol.

SocialHistoryDrugs

Creates and maintains a list of possible drug use entries (for patient social history).

APIDescription
GET api/SocialHistoryDrugs?externalId={externalId}

Gets information about a drug use entry.

POST api/SocialHistoryDrugs

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

DELETE api/SocialHistoryDrugs?externalId={externalId}

Deletes a drug use entry.

Surgeries

Creates and maintains of a list of surgeries in Eye Reach Patients.

APIDescription
GET api/Surgeries?externalId={externalId}

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

POST api/Surgeries

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

DELETE api/Surgeries?externalId={externalId}

Delete a surgery from the Eye Reach Patients list.

Users

Creates and maintains the list of users in Eye Reach Patients. It is not mandatory to create more users in Eye Reach Patients but if you want, you can use this API to create, update or delete users

APIDescription
GET api/users/search?active={active}&username={username}&firstName={firstName}&lastName={lastName}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of users.

GET api/Users?externalId={externalId}

Gets information about an user.

POST api/Users

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

DELETE api/Users?externalId={externalId}

Deletes a user.

VerifyPatientUsername

Verify whether a patient already have the username.

APIDescription
GET api/VerifyPatientUsername?username={username}

Verify whether a patient already have the username.

VerifyUserUsername

Verify whether a user already have the username.

APIDescription
GET api/VerifyUserUsername?username={username}

Verify whether a user already have the username.