Eye Reach Patients API Reference

Username of the patient.

Password of the patient.

Data of the patient representative.

Birthday of the patient.

Date in which the patient must reorder contact lenses (used in the Reorder Contact Lenses communication).

check Contact lenses reorder name of the patient.

Recall date 1 of the patient.

Recall date 2 of the patient.

Notes about the patient.

Indicates whether the patient is active or not.

Indicates whether the patient agrees to receive email reminders.

Indicates whether the patient agrees to receive birthday greetings by email.

Indicates whether the patient agrees to receive thank you messages by email.

Indicates whether the patient agrees to receive eyewear related messages by email.

Indicates whether the patient agrees to receive promotional messages by email.

Indicates whether the patient agrees to receive SMS reminders.

Indicates whether the patient agrees to receive birthday greetings by SMS.

Indicates whether the patient agrees to receive thank you messages by SMS.

Indicates whether the patient agrees to receive eyewear related messages by SMS.

Indicates whether the patient agrees to receive promotional messages by SMS.

Indicates whether the patient agrees to receive voice reminders.

Indicates whether the patient agrees to receive birthday greetings by voice.

Indicates whether the patient agrees to receive thank you messages by voice.

Indicates whether the patient agrees to receive eyewear related messages by voice.

Indicates whether the patient agrees to receive promotional calls.

Indicates whether the patient was invited to the web portal or not.

Locations that the patient has visited (Required).

Patient's contact information (Required).

SSN last four digits.

Indicates whether the patient is required for next log on security verification or not.

Indicates wheter the patient representative is required for next log on security verification or not.

Patient's sex unique ID on integrating system.

Patient's marital status unique ID on integrating system.

Patient's race unique ID on integrating system.

Patient's ethnicity unique ID on integrating system.

Preferred language of the patient.

Pharmacy name.

Pharmacy phone.

Pharmacy address 1.

Pharmacy address 2.

Pharmacy city.

Pharmacy state.

Pharmacy ZIP.

Primary insurance name (Required while sending primary insurance information).

Primary insurance ID number (Required while sending primary insurance information).

Primary insurance group number.

Primary insurance employer name.

Primary insurance address 1.

Primary insurance address 2.

Primary insurance city.

Primary insurance state.

Primary insurance ZIP.

Primary insurance. Insured person first name (Required while sending primary insurance information).

Primary insurance. Insured person middle name.

Primary insurance. Insured person last name (Required while sending primary insurance information).

Primary insurance. Insured person date of birth (Required while sending primary insurance information).

Activation date of the primary insurance.

Copay amount for the primary insurance.

Primary insurance. Relationship to insured person should be (Self, Spouse, Child, Other). (Required while sending primary insurance information).

Secondary insurance name (Required while sending secondary insurance information). Enter the primary insurance information before you can specify a secondary insurance.

Secondary insurance ID number (Required while sending secondary insurance information).

Secondary insurance group number.

Secondary insurance employer name.

Secondary insurance address 1.

Secondary insurance address 2.

Secondary insurance city.

Secondary insurance state.

Secondary insurance ZIP.

Secondary insurance. Insured person first name (Required while sending secondary insurance information).

Secondary insurance. Insured person middle name.

Secondary insurance. Insured person last name (Required while sending secondary insurance information).

Secondary insurance. Insured person date of birth (Required while sending secondary insurance information).

Activation date of the secondary insurance.

Copay amount for the secondary insurance.

Secondary insurance. Relationship to insured person should be (Self, Spouse, Child, Other). (Required while sending secondary insurance information).

Tertiary insurance name (Required while sending tertiary insurance information). Enter the primary and secondary insurance information before you can specify a tertiary insurance.

Tertiary insurance ID number (Required while sending tertiary insurance information).

Tertiary insurance group number.

Tertiary insurance employer name.

Tertiary insurance address 1.

Tertiary insurance address 2.

Tertiary insurance city.

Tertiary insurance state.

Tertiary insurance ZIP.

Tertiary insurance. Insured person first name (Required while sending tertiary insurance information).

Tertiary insurance. Insured person middle name.

Tertiary insurance. Insured person last name (Required while sending tertiary insurance information).

Tertiary insurance. Insured person date of birth (Required while sending tertiary insurance information).

Activation date of the tertiary insurance.

Gets or sets the copayment amount required by the patient's tertiary insurance provider.

Tertiary insurance. Relationship to insured person should be (Self, Spouse, Child, Other). (Required while sending tertiary insurance information).

Vision insurance name (Required while sending vision insurance information).

Vision insurance ID number (Required while sending vision insurance information).

Vision insurance group number.

Vision insurance employer name.

Vision insurance address 1.

Vision insurance address 2.

Vision insurance city.

Vision insurance state.

Vision insurance ZIP.

Vision insurance. Insured person first name (Required while sending vision insurance information).

Vision insurance. Insured person middle name.

Vision insurance. Insured person last name (Required while sending vision insurance information).

Vision insurance. Insured person date of birth (Required while sending vision insurance information).

Activation date of the vision insurance.

Copay amount for the vision insurance.

Vision insurance. Relationship to insured person should be (Self, Spouse, Child, Other). (Required while sending vision insurance information).

Gets or sets the relationship of the responsible party to the insured individual.

Gets or sets the identifier prefix associated with the responsible party.

Gets or sets the first name of the responsible party person.

Gets or sets the middle name of the responsible party person.

Gets or sets the last name of the responsible party person.

Gets or sets the identifier for the suffix associated with the responsible party.

Gets or sets the date of birth of the responsible party.

Gets or sets the email address of the responsible party associated with this entity.

Gets or sets the first line of the address for the responsible party.

Gets or sets the second line of the address for the responsible party.

Gets or sets the city of the responsible party.

Gets or sets the state of the responsible party.

Gets or sets the ZIP code of the responsible party.

Gets or sets the voice phone number of the responsible party.

Gets or sets the text phone number of the responsible party.

Gets or sets the work phone number of the responsible party.

Gets or sets the extension for the work phone number of the responsible party.

Primary care physician.

Emergency contact 1 name.

Emergency contact 1 relationship.

Emergency contact 1 address1.

Emergency contact 1 address2.

Emergency contact 1 city.

Emergency contact 1 state.

Emergency contact 1 zip.

Emergency contact 1 cellphone number.

Emergency contact 1 home phone number.

Emergency contact 1 work phone number.

Emergency contact 1 email address.

Emergency contact 2 name.

Emergency contact 2 relationship.

Emergency contact 2 address1.

Emergency contact 2 address2

Emergency contact 2 city.

Emergency contact 2 state.

Emergency contact 2 zip.

Emergency contact 2 cellphone number.

Emergency contact 2 home phone number.

Emergency contact 2 work phone number.

Emergency contact 2 email address.

Contains list of category communication preferences.

Practice management system ID.

Medical record number of the patient.

Unique ID of the model in the portal (Read only).

Unique ID of the model on integrating system (Required).