Appointment
Data structure to represent an appointment.
Appointment data has following elements:
| AppointmentId | (string) | Unique appointment id. |
| EncoounterId | (string) | Unique encounter id. |
| ApptTypeId | (string) | Appointment Type Id. |
| Status | (string) | Appointment status. |
| FacilityId | (string) | Scheduled Location/Facility Id. |
| ProviderId | (string) | Scheduled Provider Id. |
| PatientId | (string) | Scheduled Patient Id. |
| ApptStart | (string) | Appointment start datetime. |
| ApptStop | (string) | Appointment end datetime. |
| Notes | (string) | Appointment notes, free text. |
| LastModified | (string) | Datetime of last changes. |
| LastModifiedBy | (string) | Operator Id./td> |
| first | (string) | Patient first name. |
| middle | (string) | Patient middle initial. |
| last | (string) | Patient last name. |
| EmailAddress | (string) | Patient email address. |
| BirthDate | (string) | Patient birth date. |
| PrimaryPhone | (string) | Patient Primary phone. |
| sex | (string) | Patient gender. |
| OwnerId | (string) | Same as Patient Id. |
| ApptKind | (string) | Appointment category. |
| MarketingPlanId | (string) | Appointment marketing plan Id. |
| MarketingComments | (string) | Appointment marketing comments. |
| MarketingDetails | (string) | Appointment marketing details. |
| ReferringProviderId | (string) | Id of the provider, who referred the patient for this appointment. |
| ModifyTimestamp | (datetime) | The last modification date of this appointment. |
| vipFlag | (string) | VIP flag. |
| referralComanage | (string) | Referral Comanage. |
XML Example:
JSON Example:
{
"AppointmentId": "09238409",
"EncounterId": "12345",
"ApptTypeId": "0002",
"Status": "S",
"FacilityId": "SUITE113",
"ProviderId": "2",
"PatientId": "TS01831451",
"ApptStart": "5/1/2015 10:00:00 AM",
"ApptStop": "5/1/2015 11:00:00 AM",
"Notes": "Need vision test",
"LastModified": "2/20/2015 12:00:00 AM",
"LastModifiedBy": "ELENTZ",
"first": "Peter",
"middle": "",
"last": "Pistol",
"EMailAddress": "some@dadada.com",
"Birthdate": "01/01/1965",
"PrimaryPhone": "11111111111",
"sex": "M",
"OwnerId": "TS01831451",
"ApptKind": "FUP",
"MarketingPlanId": "",
"MarketingComments": "",
"MarketingDetails": "",
"ReferringProviderId": "",
"ModifyTimestamp": "11/5/2015 7:49:04 AM",
"vipFlag": "0",
"referralComanage": "C"
}
See also:
API Functions,
API Methods,
API Data