PatientCommunicationModel
Model used to retrieve information about a patient communication.
| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountName |
Account name of the patient communication. |
string |
None. |
| Created |
Indicates when the patient communication was created. |
date |
None. |
| CreatedUtc |
Date and time in which the communication was created (UTC) |
date |
None. |
| AllowToCancelAppointmentsDuringCommunications |
Indicates whether the patient will be allowed to cancel the related appointments. |
boolean |
None. |
| From |
Indicates the source of the patient communication (Required). |
string |
None. |
| To |
Recipient of the communication. |
string |
None. |
| MessageSubject |
Indicates the message subject of the patient communication. |
string |
None. |
| MessageBody |
Indicates the message body of the patient communication. |
string |
None. |
| MessageVoiceHuman |
Reserved for future use. |
string |
None. |
| MessageVoiceMachine |
Reserved for future use. |
string |
None. |
| Outgoing |
Indicates whether the patient communication is outgoing or not. |
boolean |
None. |
| LocationPhoneNumber |
Indicates the location phone number of the patient communication.. |
string |
None. |
| EyewearReadySetToStatusId |
For eyewear ready communications, this is the order status's unique ID in our system that must be set to the related order. |
globally unique identifier |
None. |
| AlreadySent |
Indicates whether the patient communication is already sent. |
boolean |
None. |
| AppointmentExternalId |
Appointment's unique ID on integrating system belonging to the Appointment. |
string |
None. |
| AppointmentStatusExternalId |
Appointment status's unique ID on integrating system belonging to the patient communication. |
string |
None. |
| TargetObjectExternalId |
External ID of the object that triggered the communication (Appointment, Recall, Order, etc.). |
string |
None. |
| PatientCommunicationID |
Patient communication Id. |
globally unique identifier |
None. |
| Method |
Indicates the communication method. |
string |
None. |
| Type |
Indicates the communication type. |
string |
None. |
| Status |
Indicates current Status of patient communication. |
string |
None. |
| PatientExternalId |
Patient's unique ID on integrating system belonging to the patient communication (Required). |
string |
None. |