Name | Description | Type | Additional information |
---|---|---|---|
AccountNumber |
URL name of the practice for which the appointment is requested (Required). |
string |
None. |
AppointmentRequestId |
Unique ID of appointment request. |
globally unique identifier |
None. |
AppointmentId |
Unique ID of appointment. |
globally unique identifier |
None. |
PatientId |
Unique ID of patient. |
globally unique identifier |
None. |
LocationId |
Unique ID of location (Required). |
globally unique identifier |
None. |
NewPatient |
Indicates whether new patient or not. |
boolean |
None. |
HasEyeExamAtThisLocation |
Indication if examination is at the given location. |
boolean |
None. |
VisionInsuranceCarrier |
Vision insurance carrier |
string |
None. |
VisionGroupNumber |
Vision group number. |
string |
None. |
VisionPolicyNumber |
Vision policy number. |
string |
None. |
MedicalInsuranceCarrier |
Medical insurance carrier. |
string |
None. |
MedicalGroupNumber |
Medical group number. |
string |
None. |
MedicalPolicyNumber |
Medical policy number. |
string |
None. |
DoctorId |
Unique ID of doctor. |
globally unique identifier |
None. |
Comments |
Comments for the appointment request. |
string |
None. |
RequestedDate |
Requested Date of the appointment request. |
date |
None. |
PatientEmailAddress |
Email address of patient. |
string |
None. |
PhoneNumberIsMobile |
Indicates if the phone number can be used to receive text messages. |
boolean |
None. |
PhoneNumber |
Phone number of the patient. |
string |
None. |
CountryId |
Unique ID of country. |
globally unique identifier |
None. |
AppointmentRequestReasonId |
Unique ID of appointment request reason (Required). |
globally unique identifier |
None. |
AnotherPerson |
Indicates if the appointment request is being created for another person that is not a relative of the current patient. |
boolean |
None. |
FirstName |
First name of the person (Required). |
string |
None. |
MiddleName |
Middle name of the person. |
string |
None. |
LastName |
Last name of the person (Required). |
string |
None. |
DateOfBirth |
Date of birth of the person (Required). |
date |
None. |
PatientSexId |
Patient's sex ID of the model in the portal. |
integer |
None. |
Username |
If the person requesting the appointment wants to create an account in the portal, send the username in this property. |
string |
None. |
Password |
If the person requesting the appointment wants to create an account in the portal, send the passwod in this property. |
string |
None. |
TermsOfUseAccepted |
Indicates if user has accepted the terms of use. |
boolean |
None. |