API HistAppointments
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See HistAppointment Database Schema.
HistAppointments GET (multiple)
Version Added: 23.1.30
A HistAppointment is a historical copy of an appointment. A new HistAppointment entry is created anytime an appointment is created, changed, missed, cancelled, or deleted. A single AptNum may have many associated HistAppointments.
Parameters: All optional.
HistApptAction: Either "Created", "Changed", "Missed", "Cancelled", or "Deleted".
AptNum: Filter responses by AptNum.
PatNum: Filter responses by PatNum.
AptStatus: Either "Scheduled", "Complete", "UnschedList", "Broken", or "Planned".
ClinicNum: Filter responses by ClinicNum. Leave blank if not using clincs or want results for all clinics.
date: For a single day, in "yyyy-MM-dd" format.
dateStart, dateEnd: For a date range, inclusive of both dates, in "yyyy-MM-dd" format.
Example Requests:
GET /histappointments
GET /histappointments?PatNum=1
GET /histappointments?AptNum=266
Example Responses:
[
{
"HistApptNum": 1,
"HistUserNum": 0,
"HistDateTStamp": "2021-05-20 14:50:44",
"HistApptAction": "Created",
"ApptSource": "EConnector",
"AptNum": 1,
"PatNum": 1,
"AptStatus": "Scheduled",
"Pattern": "//XXXX//",
"Confirmed": 19,
"confirmed": "Not Called",
"TimeLocked": "false",
"Op": 7,
"Note": "",
"ProvNum": 1,
"provAbbr": "DOC",
"ProvHyg": 0,
"AptDateTime": "2021-05-20 15:50:44",
"NextAptNum": 0,
"UnschedStatus": 0,
"unschedStatus": "",
"IsNewPatient": "false",
"ProcDescript": "",
"ClinicNum": 1,
"IsHygiene": "false",
"DateTStamp": "2021-05-20 14:50:44",
"DateTimeArrived": "0001-01-01 00:00:00",
"DateTimeSeated": "0001-01-01 00:00:00",
"DateTimeDismissed": "0001-01-01 00:00:00",
"InsPlan1": 1,
"InsPlan2": 0,
"DateTimeAskedToArrive": "0001-01-01 00:00:00",
"colorOverride": "0,0,0",
"AppointmentTypeNum": 0,
"SecUserNumEntry": 1,
"SecDateTEntry": "2021-05-20 14:49:02",
"Priority": "Normal",
"PatternSecondary": "/X////X/",
"ItemOrderPlanned": 0
},
{
"HistApptNum": 3,
"HistUserNum": 1,
"HistDateTStamp": "2021-05-24 14:32:40",
"HistApptAction": "Changed",
"ApptSource": "None",
"AptNum": 2,
"PatNum": 1,
"AptStatus": "Scheduled",
"Pattern": "//XXXXXXXX//",
"Confirmed": 19,
"confirmed": "Not Called",
"TimeLocked": "false",
"Op": 7,
"Note": "",
"ProvNum": 1,
"provAbbr": "DOC",
"ProvHyg": 0,
"AptDateTime": "2021-05-24 12:00:00",
"NextAptNum": 0,
"UnschedStatus": 0,
"unschedStatus": "",
"IsNewPatient": "true",
"ProcDescript": "PerEx, LimEx, CmpEx",
"ClinicNum": 1,
"IsHygiene": "false",
"DateTStamp": "2021-05-24 14:32:40",
"DateTimeArrived": "0001-01-01 00:00:00",
"DateTimeSeated": "0001-01-01 00:00:00",
"DateTimeDismissed": "0001-01-01 00:00:00",
"InsPlan1": 1,
"InsPlan2": 0,
"DateTimeAskedToArrive": "0001-01-01 00:00:00",
"colorOverride": "0,0,0",
"AppointmentTypeNum": 0,
"SecUserNumEntry": 1,
"SecDateTEntry": "2021-05-24 14:32:36",
"Priority": "Normal",
"PatternSecondary": "XX////////XX",
"ItemOrderPlanned": 0
},
{
"HistApptNum": 4,
"HistUserNum": 1,
"HistDateTStamp": "2021-05-25 08:39:47",
"HistApptAction": "Changed",
"ApptSource": "None",
"AptNum": 2,
"PatNum": 1,
"AptStatus": "Scheduled",
"Pattern": "//XXXXXXXX//",
"Confirmed": 19,
"confirmed": "Not Called",
"TimeLocked": "false",
"Op": 7,
"Note": "",
"ProvNum": 1,
"provAbbr": "DOC",
"ProvHyg": 0,
"AptDateTime": "2021-05-25 12:00:00",
"NextAptNum": 0,
"UnschedStatus": 0,
"unschedStatus": "",
"IsNewPatient": "true",
"ProcDescript": "PerEx, LimEx, CmpEx",
"ClinicNum": 1,
"IsHygiene": "false",
"DateTStamp": "2021-05-25 08:39:47",
"DateTimeArrived": "0001-01-01 00:00:00",
"DateTimeSeated": "0001-01-01 00:00:00",
"DateTimeDismissed": "0001-01-01 00:00:00",
"InsPlan1": 1,
"InsPlan2": 0,
"DateTimeAskedToArrive": "0001-01-01 00:00:00",
"colorOverride": "0,0,0",
"AppointmentTypeNum": 0,
"SecUserNumEntry": 1,
"SecDateTEntry": "2021-05-25 08:38:52",
"Priority": "Normal",
"PatternSecondary": "XX////////XX",
"ItemOrderPlanned": 0
},
etc...
]
or
[
{
"HistApptNum": 2751,
"HistUserNum": 1,
"HistDateTStamp": "2022-05-16 09:51:38",
"HistApptAction": "Changed",
"ApptSource": "None",
"AptNum": 266,
"PatNum": 68,
"AptStatus": "Scheduled",
"Pattern": "//XX//",
"Confirmed": 19,
"confirmed": "Not Called",
TimeLocked": "false",
"Op": 15,
"Note": "",
"ProvNum": 1,
"provAbbr": "DOC",
"ProvHyg": 0,
"AptDateTime": "2022-05-16 12:40:00",
"NextAptNum": 0,
"UnschedStatus": 0,
"unschedStatus": "",
"IsNewPatient": "false",
"ProcDescript": "ProChild",
"ClinicNum": 5,
"IsHygiene": "false",
"DateTStamp": "2022-05-16 09:51:38",
"DateTimeArrived": "0001-01-01 00:00:00",
"DateTimeSeated": "0001-01-01 00:00:00",
"DateTimeDismissed": "0001-01-01 00:00:00",
"InsPlan1": 12,
"InsPlan2": 5,
"DateTimeAskedToArrive": "0001-01-01 00:00:00",
"colorOverride": "0,0,0",
"AppointmentTypeNum": 0,
"SecUserNumEntry": 1,
"SecDateTEntry": "2022-05-16 09:51:14",
"Priority": "Normal",
"PatternSecondary": "//////",
"ItemOrderPlanned": 0
},
{
"HistApptNum": 2752,
"HistUserNum": 1,
"HistDateTStamp": "2022-05-16 09:52:28",
"HistApptAction": "Changed",
"ApptSource": "None",
"AptNum": 266,
"PatNum": 68,
"AptStatus": "Scheduled",
"Pattern": "//XX//",
"Confirmed": 19,
"confirmed": "Not Called",
TimeLocked": "false",
"Op": 15,
"Note": "",
"ProvNum": 1,
"provAbbr": "DOC",
"ProvHyg": 0,
"AptDateTime": "2022-05-16 12:40:00",
"NextAptNum": 0,
"UnschedStatus": 0,
"unschedStatus": "",
"IsNewPatient": "false",
"ProcDescript": "ProChild",
"ClinicNum": 5,
"IsHygiene": "false",
"DateTStamp": "2022-05-16 09:52:28",
"DateTimeArrived": "2022-05-16 00:00:00",
"DateTimeSeated": "2022-05-16 00:00:00",
"DateTimeDismissed": "2022-05-16 00:00:00",
"InsPlan1": 9,
"InsPlan2": 15,
"DateTimeAskedToArrive": "0001-01-01 00:00:00",
"colorOverride": "0,0,0",
"AppointmentTypeNum": 0,
"SecUserNumEntry": 1,
"SecDateTEntry": "2022-05-16 09:51:47",
"Priority": "Normal",
"PatternSecondary": "//////",
"ItemOrderPlanned": 0
},
{
"HistApptNum": 2753,
"HistUserNum": 1,
"HistDateTStamp": "2022-05-16 09:55:06",
"HistApptAction": "Missed",
"ApptSource": "None",
"AptNum": 266,
"PatNum": 68,
"AptStatus": "Broken",
"Pattern": "//XX//",
"Confirmed": 19,
"confirmed": "Not Called",
"TimeLocked": "false",
"Op": 15,
"Note": "",
"ProvNum": 1,
"provAbbr": "DOC",
"ProvHyg": 0,
"AptDateTime": "2022-05-16 12:40:00",
"NextAptNum": 0,
"UnschedStatus": 0,
"unschedStatus": "",
"IsNewPatient": "false",
"ProcDescript": "ProChild",
"ClinicNum": 5,
"IsHygiene": "false",
"DateTStamp": "2022-05-16 09:55:06",
"DateTimeArrived": "2022-05-16 00:00:00",
"DateTimeSeated": "2022-05-16 00:00:00",
"DateTimeDismissed": "2022-05-16 00:00:00",
"InsPlan1": 3,
"InsPlan2": 0,
"DateTimeAskedToArrive": "0001-01-01 00:00:00",
"colorOverride": "0,0,0",
"AppointmentTypeNum": 0,
"SecUserNumEntry": 1,
"SecDateTEntry": "2022-05-16 09:54:38",
"Priority": "Normal",
"PatternSecondary": "//////",
"ItemOrderPlanned": 0
},
{
"HistApptNum": 2754,
"HistUserNum": 1,
"HistDateTStamp": "2022-05-16 09:55:19",
"HistApptAction": "Deleted",
"ApptSource": "None",
"AptNum": 266,
"PatNum": 68,
"AptStatus": "Broken",
"Pattern": "//XX//",
"Confirmed": 19,
"confirmed": "Not Called",
"TimeLocked": "false",
"Op": 15,
"Note": "",
"ProvNum": 1,
"provAbbr": "DOC",
"ProvHyg": 0,
"AptDateTime": "2022-05-16 12:40:00",
"NextAptNum": 0,
"UnschedStatus": 0,
"unschedStatus": "",
"IsNewPatient": "false",
"ProcDescript": "ProChild",
"ClinicNum": 5,
"IsHygiene": "false",
"DateTStamp": "2022-05-16 09:55:19",
"DateTimeArrived": "2022-05-16 00:00:00",
"DateTimeSeated": "2022-05-16 00:00:00",
"DateTimeDismissed": "2022-05-16 00:00:00",
"InsPlan1": 4,
"InsPlan2": 0,
"DateTimeAskedToArrive": "0001-01-01 00:00:00",
"colorOverride": "0,0,0",
"AppointmentTypeNum": 0,
"SecUserNumEntry": 1,
"SecDateTEntry": "2022-05-16 09:54:44",
"Priority": "Normal",
"PatternSecondary": "//////",
"ItemOrderPlanned": 0
}
]
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)