| Name | Description | Type | Additional information |
|---|---|---|---|
| CommunicationId |
Unique ID of communication. |
globally unique identifier |
None. |
| CreatedUtc |
Date (in UTC) of communication is created. |
string |
None. |
| CommunicationMethod |
Method of communication. Possible values: Email, Sms, Voice, MobileNotification. |
string |
None. |
| CommunicationType |
Type of communication. Possible values: AppointmentReminderWithoutConfirmation, AppointmentReminderWithConfirmation, EyewearReady, EyewearFollowUp, ThankYou, Birthday, PatientRecall, AppointmentMissed, Custom, AppointmentConfirmed, AppointmentCanceled, ContactLensReorder, AppointmentCreated, VideoCallCreated, VideoCallReminder, VideoCallCanceled, Recall, PatientWelcome, EyewearReadyImmediate, Cda, CdaImmediate. |
string |
None. |
| CommunicationScheduleId |
Unique ID of communication schedule. |
globally unique identifier |
None. |
| LanguageName |
Language name of communication. |
string |
None. |
| From |
Communication sent from. |
string |
None. |
| To |
Communication sent to. |
string |
None. |
| MessageTemplateId |
Unique ID of message template. |
globally unique identifier |
None. |
| TemplateName |
Name of the template. |
string |
None. |
| MessageSubject |
Subject of the communication. |
string |
None. |
| MessageVoiceHuman |
Human voice message of the communication. |
string |
None. |
| MessageVoiceMachine |
Machine voice message of the communication. |
string |
None. |
| Outgoing |
Indicates whether communication is outgoing or incoming. |
boolean |
None. |
| LocationId |
Unique ID of location. |
globally unique identifier |
None. |
| LocationPhoneNumber |
Phone number at location. |
string |
None. |
| LocationName |
Name of the location. |
string |
None. |
| TimeZoneId |
Unique ID of time zone. |
string |
None. |
| TimeZoneDisplay |
Name of time zone for display. |
string |
None. |
| RecipientId |
Unique ID of recipient of the communication. |
globally unique identifier |
None. |
| RecipientTitle |
Title of recipient |
string |
None. |
| RecipientSuffix |
Suffix of recipient. |
string |
None. |
| RecipientExternalId |
External ID of recipient. |
string |
None. |
| RecipientFirstName |
First name of recipient. |
string |
None. |
| RecipientLastName |
Last name of recipient. |
string |
None. |
| RecipientMiddleName |
Middle name of recipient. |
string |
None. |
| CommunicationStatus |
Status of the communication. Possible values: Succeed, Failed, Delayed, NotAcceptedByPatient, Retried, UnableToReach, InProgress. |
string |
None. |
| StatusNote |
Status notes of communication. |
string |
None. |
| EyewearReadySetToStatusId |
Unique ID of status for eye-wear set to ready. |
globally unique identifier |
None. |
| TargetObjectId |
Unique ID of object related to communication. |
globally unique identifier |
None. |
| TargetObjectExternalId |
Unique external ID of object related to communication. |
string |
None. |
| AlreadySent |
Indicates whether set/updated to EHR or not. |
boolean |
None. |
| RecipientType |
Type of recipient. Possible values: Patient, User. |
string |
None. |
| RecipientBirthday |
Birthday of recipient. |
date |
None. |
| AppointmentExternalId |
Unique external ID of appointment related to communication. |
string |
None. |
| AppointmentStatusExternalId |
Unique external ID of status of appointment related to the communication. |
string |
None. |
| TargetObjectIntegerId |
Unique integer ID of object related to communication. |
integer |
None. |