| RETURN PARAMETER DESCRIPTION |
^ Example one: Cancelled appointment
"AppointmentTypeSubCategory": "",
"CurrentEligibilityCode": "COLLATERAL OF VET.",
"DFN": 7204597,
"DateOfBirth": "1950-01-03",
"DateOfBirthInternal": 2500103,
"DateOfDeath": "",
"DemographicsNeedUpdate": 1,
"Eligibility": "COLLATERAL OF VET.",
"EligibilityIEN": 12,
"EligibilityOfVisit": "COLLATERAL OF VET.",
"EnrollmentCode": "",
"AutoRebookedApptDateTime": "",
"EnrollmentDate": "",
"FugitiveFelonFlag": "NO",
"Gender": "FEMALE",
"ICN": "4420062581V571742",
"LastRegistrationDate": "2010-11-02T10:24:13-0400",
"LocalFlag": [
""
],
"Name": "SQA,REQUEST",
"NationalFlag": [
"CancelDateTime": "2023-12-06T14:17:06-0500",
""
],
"NeedInsuranceVerification": 1,
"OriginalRegistrationDate": "2010-09-28T15:04:37-0400",
"PreferredName": "TESTING NAME",
"SSN": 7667,
"SensitivePatientRestrictedRecord": 0,
"SensitivePatientType": 0,
"Street": "GENERAL DELIVERY",
"CancellationReason": "PANDEMIC",
"cellularPhone": "",
"residentialPhone": ""
},
"PatientComments": [
""
],
"PriorXRayResults": "",
"Provider": {
"ID": 1824,
"Name": "CERVANTES,DEWAYNE J",
"CancellationRemarks": "",
"SecId": 1034217513
},
"PurposeOfVisit": "SCHEDULED VISIT",
"RealAppointment": 0,
"RequestIEN": 263452,
"RequestType": "APPT",
"Resource": {
"ClinicIEN": 2147,
"Name": "CHY CARDIOLOGY"
},
"CancelledByUser": {
"ResourceIEN": 1058,
"RoutingSlipPrintDate": "",
"RoutingSlipPrinted": "",
"SchedulerName": "",
"SchedulingApplication": "",
"SchedulingRequestType": "MULTIPLE APPT. BOOKING",
"SpecialSurveyDisposition": "",
"StartTimeFM": 3231206.08,
"Status": "CANCELLED BY CLINIC",
"StatusCancelDateTime": "2023-12-06T14:17:06-0500",
"ID": 520881841,
"VVSApptID": "",
"VeteranVideoCallURL": "",
"Walkin": "",
"WardLocation": "",
"XRAY": "",
"XrayDateTime": ""
}
]
}
Example two with check-in steps:
"Name": "CALIS,NEDIME",
{
"Appointment": [
{
"AppointmentCancelled": "",
"AppointmentDateTime": "2022-11-14T10:00-0500",
"AppointmentIEN": 294806,
"AppointmentType": "REGULAR",
"AppointmentTypeIEN": 9,
"AppointmentTypeSubCategory": "",
"AutoRebookedApptDateTime": "",
"SecId": 20010011913859
"CancelDateTime": "",
"CancellationReason": "",
"CancellationRemarks": "",
"CancelledByUser": [
""
],
"CheckIn": "2022-11-14T14:21:41-0500",
"CheckInEntered": "2022-11-14T14:21:41-0500",
"CheckInSteps": [
{
},
"DateTime": "2022-11-14T14:16:28-0500",
"IEN": 1,
"Status": "PRE-CHECK-IN STARTED"
},
{
"DateTime": "2022-11-14T14:16:53-0500",
"IEN": 2,
"Status": "PRE-CHECK-IN COMPLETE"
},
{
{
"CheckIn": "",
"DateTime": "2022-11-14T14:19:38-0500",
"IEN": 3,
"Status": "CHECK-IN STARTED"
},
{
"DateTime": "2022-11-14T14:21:02-0500",
"IEN": 4,
"Status": "CHECK-IN COMPLETE"
},
{
"CheckInEntered": "",
"DateTime": "2022-11-14T14:21:22-0500",
"IEN": 5,
"Status": "E-CHECK-IN STARTED"
},
{
"DateTime": "2022-11-14T14:21:41-0500",
"IEN": 6,
"Status": "E-CHECK-IN COMPLETE"
}
],
"CheckInSteps": [
"CheckInUser": "TEST,USER",
"CheckOut": "2022-11-14T14:22-0500",
"CheckOutEntered": "2022-11-14T14:23:19-0500",
"CheckOutUser": "TEST,CHECKINUSER",
"Clinic": {
"ClinicIEN": 3753,
"CreditStopCodeAMIS": 179,
"CreditStopCodeName": "RT CLIN VID CARE HOME",
"DisplayClinicAppt": "YES",
"Division": "CHEYENNE VAMROC",
""
"ECheckinAllowed": "YES",
"IsOverbook": 1,
"Name": "CHY ACUTE CARE 1",
"NonCountClinic":1,
"PatientFriendlyName": "CHY ACUTE CARE THOMPSON",
"PbspID": 234,
"PhysicalLocation": "ARROWHEAD BLDG LOBBY",
"PreCheckinAllowed": "YES",
"ProhibitedClinic": 1,
"StationNumber": 442,
],
"StopCodeAMIS": 323,
"StopCodeName": "PRIMARY CARE/MEDICINE",
"Telephone": "(307)778-7550",
"TelephoneExtension": 1234,
"TimeZone": "EASTERN",
"TimeZoneDetails": [
{
"Offset": "-0500",
"TimeFrame": "STANDARD",
"TimeZoneCode": "EST"
"CheckInUser": "",
},
{
"Offset": "-0400",
"TimeFrame": "DAYLIGHT SAVINGS",
"TimeZoneCode": "EDT"
}
],
"TimeZoneException": "",
"VeteranSelfCancel": "NO"
},
"CheckOut": "",
"CollateralVisit": "",
"ConsultLink": "",
"CurrentStatus": "ACT REQ/CHECKED OUT",
"DataEntryClerk": "CALIS,NEDIME",
"DateAppointmentMade": "2022-11-14",
"DesiredDateOfAppointment": "2022-11-14",
"DuplicateApptSameDay": "",
"EASTrackingNumber": "",
"EkgDateTime": "",
"EncounterConversionStatus": "",
"CheckOutEntered": "",
"EncounterFormsAsAddOns": "",
"EncounterFormsPrinted": "",
"EndTime": "2022-11-14T10:30-0500",
"FollowUpVisit": "YES",
"InpatientFlag": 1,
"LabDateTime": "",
"LengthOfAppt": 30,
"MRTCFlag": 0,
"NextAvaApptIndicator": "'NEXT AVA.' APPT. INDICATED BY USER",
"NoShowCancelDateTime": "",
"CheckOutUser": "",
"NoShowCancelledBy": "",
"Note": "",
"NoteAuditing": [
""
],
"NumberOfCollateralSeen": "",
"OriginatingRequestType": "APPT",
"OtherTests": "",
"OtherTravel": " ",
"OutpatientEncounter": "2022-11-14T10:00-0500",
"Clinic": {
"OverLaidAppointmentData": "NO",
"OverbookFlag": "O",
"ParentRecordRequest": "",
"Patient": {
"CurrentEligibilityCode": "HUMANITARIAN EMERGENCY",
"DFN": 7242584,
"DateOfBirth": "1980-10-20",
"DateOfBirthInternal": 2801020,
"DateOfDeath": "",
"DemographicsNeedUpdate": 1,
"Appointment": [
"ClinicIEN": 2147,
"Eligibility": "HUMANITARIAN EMERGENCY",
"EligibilityIEN": 8,
"EligibilityOfVisit": "HUMANITARIAN EMERGENCY",
"EnrollmentCode": "",
"EnrollmentDate": "",
"FugitiveFelonFlag": "NO",
"Gender": "MALE",
"ICN": "4420062425V751830",
"LastRegistrationDate": "2024-08-16T11:36:43-0400",
"LocalFlag": [
"CreditStopCodeAMIS": 179,
""
],
"Name": "INPATIENT,IRAONE",
"NationalFlag": [
""
],
"NeedInsuranceVerification": 1,
"OriginalRegistrationDate": "2022-11-14T13:54:20-0500",
"PreferredName": "TESTING NAME",
"SSN": "0925",
"CreditStopCodeName": "RT CLIN VID CARE HOME",
"SensitivePatientRestrictedRecord": 0,
"SensitivePatientType": 0,
"Street": "2345 STATE ST.",
"cellularPhone": "",
"residentialPhone": "(312) 897-2345"
},
"PatientComments": [
""
],
"PriorXRayResults": "",
"DisplayClinicAppt": "YES",
"Provider": {
"ID": 520664036,
"Name": "TEST,PROVIDER",
"SecId": ""
},
"PurposeOfVisit": "SCHEDULED VISIT",
"RealAppointment": 0,
"RequestIEN": 257996,
"RequestType": "APPT",
"Resource": {
"Division": "CHEYENNE VAMROC",
"ClinicIEN": 3753,
"Name": "CHY ACUTE CARE 1"
},
"ResourceIEN": 2062,
"RoutingSlipPrintDate": "",
"RoutingSlipPrinted": "",
"SchedulerName": "",
"SchedulingApplication": "",
"SchedulingRequestType": "'NEXT AVAILABLE' APPT.",
"SpecialSurveyDisposition": "",
"ECheckinAllowed": "YES",
"StartTimeFM": 3221114.1,
"Status": "ACT REQ/CHECKED OUT",
"StatusCancelDateTime": "",
"VVSApptID": "",
"VeteranVideoCallURL": "",
"Walkin": "",
"WardLocation": "",
"XRAY": "",
"XrayDateTime": ""
}
"IsOverbook": 0,
]
}
"Name": "CHY CARDIOLOGY",
"NonCountClinic":1,
"PatientFriendlyName": "CHY CARDIOLOGY",
{
"PbspID": 73737379999777777,
"PhysicalLocation": "ARROWHEAD BLD A1-16 OR 17",
"PreCheckinAllowed": "YES",
"ProhibitedClinic": 1,
"StationNumber": 442,
"StopCodeAMIS": 108,
"StopCodeName": "LABORATORY",
"Telephone": "(307)778-7550",
"TelephoneExtension": 1234,
"TimeZone": "EASTERN",
"AppointmentCancelled": "CANCELLED",
"TimeZoneDetails": [
{
"Offset": "-0500",
"TimeFrame": "STANDARD",
"TimeZoneCode": "EST"
},
{
"Offset": "-0400",
"TimeFrame": "DAYLIGHT SAVINGS",
"TimeZoneCode": "EDT"
"AppointmentDateTime": "2023-12-06T08:00-0500",
}
],
"TimeZoneException": "",
"VeteranSelfCancel": "NO"
},
"CollateralVisit": "",
"ConsultLink": "",
"CurrentStatus": "CANCELLED BY CLINIC",
"DataEntryClerk": "CALIS,NEDIME",
"DateAppointmentMade": "2023-12-06",
"AppointmentIEN": 298114,
"DesiredDateOfAppointment": "2023-12-06",
"DuplicateApptSameDay": "",
"EASTrackingNumber": "",
"EkgDateTime": "",
"EncounterConversionStatus": "",
"EncounterFormsAsAddOns": "",
"EncounterFormsPrinted": "",
"EndTime": "2023-12-06T08:30-0500",
"FollowUpVisit": "NO",
"InpatientFlag": 0,
"AppointmentType": "REGULAR",
"LabDateTime": "",
"LengthOfAppt": 30,
"MRTCFlag": 1,
"NextAvaApptIndicator": "'NEXT AVA.' APPT. INDICATED BY USER &
CALCULATION",
"NoShowCancelDateTime": "2023-12-06T14:17:06-0500",
"NoShowCancelledBy": "TEST,USER",
"Note": "",
"NoteAuditing": [
""
"AppointmentTypeIEN": 9,
],
"NumberOfCollateralSeen": "",
"OriginatingRequestType": "APPT",
"OtherTests": "",
"OtherTravel": " ",
"OutpatientEncounter": "",
"OverLaidAppointmentData": "NO",
"OverbookFlag": "",
"ParentRecordRequest": "",
"Patient": {
|
