Eye Reach Patients - Mobile API Reference

Introduction

Use this API get the information needed for your mobile application.

RequestHistory

Gets a list of patient update histories.

API	Description
GET api/RequestHistory/search?createdOperator={createdOperator}&created1={created1}&created2={created2}&page={page}&itemsPerPage={itemsPerPage}	Gets a list of patient update histories.

PatientInsuranceUpdates

Gets/adds/updates insurance details of a patient.

API	Description
GET api/PatientInsuranceUpdates/search	Returns a list of patient insurance updates.
GET api/PatientInsuranceUpdates?type={type}&patientInsuranceUpdateRequestId={patientInsuranceUpdateRequestId}	Returns a patient insurance.
POST api/PatientInsuranceUpdates	Updates a patient insurance.

PghdUpdateRequestDiscardChanges

Discards the health information update requests.

API	Description
POST api/PghdUpdateRequestDiscardChanges	Discards the health information update requests.

MedicationRefillRequests

Gets the list of refill requests of medication.

API	Description
GET api/MedicationRefillRequests/search?patientMedicationId={patientMedicationId}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of refill request of a medication.
POST api/MedicationRefillRequests	Submits the request for medication refill.

PatientFamilyMembers

Gets the family members of a particular patient

API	Description
GET api/patientfamilymembers/search?page={page}&itemsPerPage={itemsPerPage}	Returns the family members of the patient

TransmitHealthSummary

Transmits the health summary to a recipient.

API	Description
POST api/transmithealthsummary	Transmits the health summary to a recipient.

PatientMaritalStatuses

Gets a list of marital statuses.

API	Description
GET api/PatientMaritalStatuses/search?originalMaritalStatusId={originalMaritalStatusId}&addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of marital statuses.

PatientCommunications

Gets a list of patient communications.

API	Description
GET api/PatientCommunications/search?status={status}&method={method}&creationDateOperator={creationDateOperator}&utcCreationDate1={utcCreationDate1}&utcCreationDate2={utcCreationDate2}&alreadySent={alreadySent}&appointmentExternalId={appointmentExternalId}&outgoing={outgoing}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of patient communications.
POST api/PatientCommunications	Marks the communication as read by patient.

ContactSuffixes

Gets a list of contact suffixes.

API	Description
GET api/ContactSuffixes/search?accountNumber={accountNumber}&addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of contact suffixes.

ContactPrefixes

Gets a list of contact prefixes.

API	Description
GET api/ContactPrefixes/search?accountNumber={accountNumber}&addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of contact prefixes.

PatientFamilyHistoryUpdateFamilyHistoryProblems

Gets a list of family history problems.

API	Description
GET api/PatientFamilyHistoryUpdateFamilyHistoryProblems/search?name={name}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of family history problems.

AvailableDoctorsAndTimes

Gets a list of available doctors and times.

API	Description
GET api/availabledoctorshours/search?accountNumber={accountNumber}&requestDate={requestDate}&locationId={locationId}&selectedDoctorId={selectedDoctorId}&appointmentRequestReasonId={appointmentRequestReasonId}	Returns a list of available doctors and time.

PatientPayments

Creates and maintains of a list of patient payments.

API	Description
GET api/patientpayments/search?q={q}&createdUtcOperator={createdUtcOperator}&createdUtc1={createdUtc1}&createdUtc2={createdUtc2}&processedAmountOperator={processedAmountOperator}&processedAmount1={processedAmount1}&processedAmount2={processedAmount2}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of patients bill payments.
GET api/PatientPayments/{id}	Returns the details of a payment made to a patient.

MedicationRoutes

Gets a list of medication routes.

API	Description
GET api/MedicationRoutes/search?name={name}&medicationId={medicationId}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of medication routes.

HealthSummaries

Creates and maintains of a list of health summary.

API	Description
GET api/HealthSummaries?cdaId={cdaId}&download={download}	Returns the health summary (latest health summary if ID is not provided) of the patient.
GET api/healthsummaries/search?enteredOperator={enteredOperator}&entered1={entered1}&entered2={entered2}&doctorId[0]={doctorId[0]}&doctorId[1]={doctorId[1]}&type[0]={type[0]}&type[1]={type[1]}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of health summary of a patient.

PatientMedicationUpdates

Gets a list of patient medications.

API	Description
GET api/PatientMedicationUpdates/search?operation[0]={operation[0]}&operation[1]={operation[1]}	Returns a list of patient medications.
GET api/PatientMedicationUpdates?patientMedicationUpdateRequestId={patientMedicationUpdateRequestId}&patientMedicationRecordId={patientMedicationRecordId}	Returns a patient medication.
POST api/PatientMedicationUpdates	Returns a patient medication.
DELETE api/PatientMedicationUpdates?patientMedicationUpdateRequestId={patientMedicationUpdateRequestId}&patientMedicationRecordId={patientMedicationRecordId}	Deletes a patient medication.

PatientAllergyUpdateAllergyReactions

Gets a list of allergy reactions.

API	Description
GET api/PatientAllergyUpdateAllergyReactions/search?allergyId={allergyId}&name={name}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of reactions.

SecureMessagesToPractice

Secure messages sent by the practice.

API	Description
GET api/SecureMessagesToPractice/search?messageStatus={messageStatus}&searchTerm={searchTerm}&secureRecipientName={secureRecipientName}&getFullBody={getFullBody}&page={page}&itemsPerPage={itemsPerPage}	Gets a list of sent secure messages
GET api/SecureMessagesToPractice/{id}	Gets a sent secure message.
POST api/SecureMessagesToPractice	Sends a secure message to the practice or saves it as a draft, depending of the value of Status in the model. A status of Sent will send the message. A status of Draft will save it as a draft.
DELETE api/SecureMessagesToPractice/{id}	Deletes a sent secure message.

Locations

Returns of a list of locations.

API	Description
GET api/locations/search?addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}	Returns a list of locations
GET api/Locations/{id}	Returns the details of a location.

FormFiles

Gets a list of form files.

API	Description
GET api/FormFiles/search?page={page}&itemsPerPage={itemsPerPage}	Returns a list of form files.

PatientAccessHealthSummaries

Gets health summary of a patient using Patient Access Application.

API	Description
GET api/PatientAccessHealthSummaries?cdaId={cdaId}&cdaSubSection={cdaSubSection}&download={download}	Returns the health summary (latest health summary if ID is not provided) of the patient.
GET api/PatientAccessHealthSummaries/search?enteredOperator={enteredOperator}&entered1={entered1}&entered2={entered2}&doctorId[0]={doctorId[0]}&doctorId[1]={doctorId[1]}&type[0]={type[0]}&type[1]={type[1]}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of health summary of a patient.

PatientInsuranceUpdatesStates

Gets a list of states.

API	Description
GET api/PatientInsuranceUpdatesStates/search	Returns a list of states.

PatientMedicationUpdateMedications

Returns a list of medications.

API	Description
GET api/PatientMedicationUpdateMedications/search?searchText={searchText}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of medications.

PatientMedications

Gives a list of medications of a patient.

API	Description
GET api/PatientMedications/search?active={active}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of medications of a patient.
GET api/PatientMedications?patientMedicationId={patientMedicationId}	Returns a medication of a patient.

PatientSexes

Gets a list of sexes of patients.

API	Description
GET api/PatientSexes/search?originalSexId={originalSexId}&addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of sexes.

ContactLensOrders

Used to order a contact lens and get a list of contact lens orders.

API	Description
GET api/ContactLensOrders/search?createdUtcOperator={createdUtcOperator}&createdUtc1={createdUtc1}&createdUtc2={createdUtc2}&page={page}&itemsPerPage={itemsPerPage}	Gets a list of contact lens orders.
POST api/ContactLensOrders	Creates a contact lens order.

SecureMessageRecipients

Recipients of secure messages.

API	Description
GET api/SecureMessageRecipients/search?searchTerm={searchTerm}&page={page}&itemsPerPage={itemsPerPage}	Gets a list of secure recipients.

PatientAllergyUpdateAllergySeverities

Gets a list of allergy severities.

API	Description
GET api/PatientAllergyUpdateAllergySeverities/search?allergyId={allergyId}&name={name}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of allergies.

MedicationFormTypes

Gets a list of medication form types.

API	Description
GET api/MedicationFormTypes/search?name={name}&medicationId={medicationId}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of medication form types.

PatientFamilyHistoryUpdateFamilyHistoryRelationships

Gets a list of family history relationships.

API	Description
GET api/PatientFamilyHistoryUpdateFamilyHistoryRelationships/search?name={name}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of family history relationships.

MedicationRefillRequestsOnly

Gets the list of refill requests only of medication.

API	Description
GET api/MedicationRefillRequestsOnly/search?createdOperator={createdOperator}&created1={created1}&created2={created2}&medicationName={medicationName}&pharmacyName={pharmacyName}&pharmacyPhone={pharmacyPhone}&secureRecipientId[0]={secureRecipientId[0]}&secureRecipientId[1]={secureRecipientId[1]}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of refill request only of a medication.
GET api/MedicationRefillRequestsOnly	Returns the preferred pharmacy details of medication refill request only.
POST api/MedicationRefillRequestsOnly	Submits the request for medication refill.

AppointmentRequestLocations

Gets a list of locations for appointment.

API	Description
GET api/AppointmentRequestLocations/search?accountNumber={accountNumber}&latitude={latitude}&longitude={longitude}&patientId={patientId}&distance={distance}&searchTerm={searchTerm}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of locations.

PatientSurgeryUpdateSurgeries

Gets a list of surgeries.

API	Description
GET api/PatientSurgeryUpdateSurgeries/search?name={name}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of surgeries.

AppointmentRequestDoctors

Gets a list of doctors for appointment request process.

API	Description
GET api/AppointmentRequestDoctors/search?accountNumber={accountNumber}&locationId={locationId}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of doctors for appointment request process.

AppointmentRequestReasons

Gets a list of reasons for appointment request.

API	Description
GET api/appointmentrequestreasons/search?accountNumber={accountNumber}&newPatient={newPatient}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of reasons.

ContactLensPrescriptions

Gets a list of contact lens prescriptions.

API	Description
GET api/contactlensprescriptions/search?page={page}&itemsPerPage={itemsPerPage}	Returns a list of contact lens prescriptions.

SecureMessagesToPatient

Secure messages sent to the patient.

API	Description
GET api/SecureMessagesToPatient/search?serchTerm={serchTerm}&secureRecipientName={secureRecipientName}&getFullBody={getFullBody}&page={page}&itemsPerPage={itemsPerPage}	Gets a list of secure message
GET api/SecureMessagesToPatient/{id}	Gets a secure message.
POST api/SecureMessagesToPatient?messageId={messageId}&read={read}	Marks the secure message as read.
DELETE api/SecureMessagesToPatient/{id}	Deletes a secure message.

PatientAllergyUpdateAllergies

Gets a list of allergies.

API	Description
GET api/PatientAllergyUpdateAllergies/search?name={name}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of allergies.

Doctors

Returns of a list of doctors.

API	Description
GET api/doctors/search?addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of doctors

MedicationFrequencies

Gets a list of medication frequencies.

API	Description
GET api/MedicationFrequencies/search?name={name}&medicationId={medicationId}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of medication frequencies.

AppointmentStatuses

Returns a list of appointment statuses.

API	Description
GET api/appointmentstatuses/search?itemType={itemType}	Returns a list of appointment statuses.

PatientEducationMaterial

Gives a list of education material of a patient.

API	Description
GET api/PatientEducationMaterial/search?name={name}&doctorId={doctorId}&dateAddedOperator={dateAddedOperator}&dateAdded1={dateAdded1}&dateAdded2={dateAdded2}&type={type}&active={active}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of education material of a patient.
GET api/PatientEducationMaterial?patientEducationMaterialId={patientEducationMaterialId}	Returns specific education material of a patient.
POST api/PatientEducationMaterial	Updates the status (viewed or not) of the patient education material.

MedicationDosages

Gets a list of medication dosages.

API	Description
GET api/MedicationDosages/search?name={name}&medicationId={medicationId}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of medication dosages.

AppointmentRequestAvailableDates

Gets a list of available dates.

API	Description
GET api/AppointmentRequestAvailableDates/search?accountNumber={accountNumber}&requestDate={requestDate}&locationId={locationId}&selectedDoctorId={selectedDoctorId}&appointmentRequestReasonId={appointmentRequestReasonId}&startDate={startDate}&endDate={endDate}	Returns a list of available dates.

PatientEthnicities

Gets a list of ethnicities.

API	Description
GET api/PatientEthnicities/search?originalEthnicityId={originalEthnicityId}&addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of ethnicities.

ReadableHealthSummary

Gets the health summary in HTML format

API	Description
GET api/readablehealthsummary?id={id}	Returns the health summary in HTML format.

PatientSurgeryUpdates

Gets a list of patient surgical histories.

API	Description
GET api/PatientSurgeryUpdates/search	Returns a list of patient surgical histories.
GET api/PatientSurgeryUpdates?patientSurgeryUpdateRequestId={patientSurgeryUpdateRequestId}&patientSurgeryId={patientSurgeryId}	Returns a patient surgical history.
POST api/PatientSurgeryUpdates	Updates a patient surgery.
DELETE api/PatientSurgeryUpdates?patientSurgeryUpdateRequestId={patientSurgeryUpdateRequestId}&patientSurgeryId={patientSurgeryId}	Deletes a patient surgery request.

GlassesPrescriptions

Returns of a list of glasses prescriptions.

API	Description
GET api/glassesprescriptions/search?page={page}&itemsPerPage={itemsPerPage}	Returns a list of glasses prescriptions.

PatientRaces

Gets a list of races.

API	Description
GET api/PatientRaces/search?originalRaceId={originalRaceId}&addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of races.

PatientFamilyHistoryUpdates

Gets a list of patient family histories.

API	Description
GET api/PatientFamilyHistoryUpdates/search	Returns a list of patient family histories.
GET api/PatientFamilyHistoryUpdates?patientFamilyHistoryProblemUpdateRequestId={patientFamilyHistoryProblemUpdateRequestId}&patientFamilyHistoryProblemId={patientFamilyHistoryProblemId}	Returns a patient family history.
POST api/PatientFamilyHistoryUpdates	Updates a patient family history.
DELETE api/PatientFamilyHistoryUpdates?patientFamilyHistoryProblemUpdateRequestId={patientFamilyHistoryProblemUpdateRequestId}&patientFamilyHistoryProblemId={patientFamilyHistoryProblemId}	Deletes a patient family history update request.

PatientLanguages

Gets a list of languages.

API	Description
GET api/PatientLanguages/search?addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}	Returns a list of languages.

Appointments

Creates and maintains of a list of appointments.

API	Description
GET api/appointments/search?locationId={locationId}&doctorId={doctorId}&externalId={externalId}&startDateOperator={startDateOperator}&start1={start1}&start2={start2}&status={status}&itemType={itemType}&page={page}&itemsPerPage={itemsPerPage}	Returns a list of appointments.

PatientAllergyUpdates

Gets a list of patient allergies.

API	Description
GET api/PatientAllergyUpdates/search?operation[0]={operation[0]}&operation[1]={operation[1]}	Returns a list of patient allergies.
GET api/PatientAllergyUpdates?patientAllergyUpdateRequestId={patientAllergyUpdateRequestId}&patientAllergyId={patientAllergyId}	Returns a patient allergy.
POST api/PatientAllergyUpdates	Updates a patient allergy.
DELETE api/PatientAllergyUpdates?patientAllergyUpdateRequestId={patientAllergyUpdateRequestId}&patientAllergyId={patientAllergyId}	Deletes a patient allergy.

HealthInformationSettings

Get a list of Patient health information modules.

API	Description
GET api/HealthInformationSettings?accountNumber={accountNumber}&clientType={clientType}	Returns the health information configuration settings of the given account.

CheckIn

Provides methods to access and modify information about an appointment check in.

API	Description
GET api/CheckIn	Returns information used in an appointment check in process.
POST api/CheckIn	Checks in an appointment.

RepresentativeCredentials

Changes the username and password of the representative of a patient.

API	Description
POST api/RepresentativeCredentials	Changes the username and password of the representative of a patient.

SecureMessagesToPatientAttachment

Returns the content of an attachment of a secure message.

API	Description
GET api/SecureMessagesToPatientAttachment/{id}	Returns the content of an attachment of a secure message.

FormFileSignature

Marks a form file as signed by patient.

API	Description
POST api/FormFileSignature	Marks a form file as signed by patient.

PatientDashboardCards

Gets the dashboard cards of the logged in patient.

API	Description
GET api/PatientDashboardCards	Returns the dashboard cards of logged in patient.

HealthSummaryAmendmentRequest

Used to submit health summary amendment request.

API	Description
POST api/HealthSummaryAmendmentRequest	Sends an health summary amendment request.

AccountSettings

Gets the account settings.

API	Description
GET api/AccountSettings?accountNumber={accountNumber}&clientType={clientType}	Returns the settings of an account.

HealthInformationUpdatePreview

Get the preview of patient health information update request.

API	Description
GET api/HealthInformationUpdatePreview?pghdUpdateRequestId={pghdUpdateRequestId}	Get the preview of patient health information update request.
POST api/HealthInformationUpdatePreview	Submit the health information update request.

PatientSecurityVerification

To be used to process the security verification of a new patient at first login.

API	Description
POST api/PatientSecurityVerification	Submits the request for security verification.

PatientDemographics

Gets the demographics information of the current patient.

API	Description
GET api/PatientDemographics	Returns the demographics information of the current patient.
POST api/PatientDemographics	Saves the patient demographics information change request.
PATCH api/PatientDemographics	Saves the patient demographics information change request.

ActivateDevice

Provides the method to activate a mobile/kiosk device.

API	Description
POST api/ActivateDevice	Activates the device.

AccountValidation

Provide methods to validate the customer account.

API	Description
GET api/AccountValidation?accountUrlName={accountUrlName}	Validates if the supplied account number is valid.

HttpPortal

API	Description
POST api/HttpPortal?operation={operation}	No documentation available.

PatientCredentials

Changes the username and password of a patient.

API	Description
POST api/PatientCredentials	Changes the username and password of a patient.

AppointmentCancellationRequest

Handles requests to cancel appointments.

API	Description
POST api/AppointmentCancellationRequest	Adds a request to cancel an appointment.

PasswordResetRequest

Used to reset the password of the patient.

API	Description
POST api/PasswordResetRequest	Used to reset the password of the patient.

PatientEducationMaterialBinary

Gets the binary content of patient education material document.

API	Description
GET api/PatientEducationMaterialBinary/{id}?urlDownload={urlDownload}	Gets the binary content of patient education material document.

PatientProfile

Provide methods to access the patient profile.

API	Description
GET api/PatientProfile	Returns the profile information of the current patient.

PatientMobileDevices

Provides methods to send or delete personal devices which the patient has enabled push notifications.

API	Description
POST api/PatientMobileDevices	Activates the device.

CommunicationPreferences

Provides methods to access and modify the communication preferences of the current patient.

API	Description
GET api/CommunicationPreferences	Returns the communication preferences of the current patient.
POST api/CommunicationPreferences	Updates the communication preferences of the current patient.

FormFilesBinary

Gets the binary file of the form file.

API	Description
GET api/FormFilesBinary/{id}	Gets the binary file of the form file.

AppointmentRequests

Creates and maintains an appointment request.

API	Description
POST api/AppointmentRequests	Creates a new appointment requests.

TermsAndConditions

Used to accept the terms and conditions of use of myCare mobile, kiosk applications.

API	Description
GET api/TermsAndConditions?accountUrlName={accountUrlName}	Returns the contents of the terms and conditions.
POST api/TermsAndConditions	Accepts the terms and conditions of use of myCare mobile, kiosk applications.

PatientPreferredLocation

Gets the preferred location of a particular patient

API	Description
GET api/PatientPreferredLocation?patientId={patientId}	Returns the preferred location of the patient

AppointmentRequestsLimited

API	Description
POST api/AppointmentRequestsLimited	Creates a new appointment request or updates an existent appointment request.

PatientPaymentEmailReceipts

Provides method to send receipt to patient.

API	Description
POST api/PatientPaymentEmailReceipts

PatientRegistration

Provides methods for the registration of patients.

API	Description
POST api/PatientRegistration	Registers a new patient in Eye Reach Patients.