SDES CANCEL CLIN PRECAN LIST

TITLEVALUE
NAMESDES CANCEL CLIN PRECAN LIST
DESCRIPTIONPre-cancellation appointment list for cancelling clinic availability.
TAGPRECANLIST
ROUTINESDESCLINPRECAN
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERCLINICIEN
DESCRIPTIONClinic IEN
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH20

INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERFULLPARTIAL
DESCRIPTIONF - for Full day cancellation
P - for Partial day cancellation
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH20

INPUT PARAMETERSSEQUENCE NUMBER3
INPUT PARAMETERSTARTDATETIME
DESCRIPTIONStart date/time in ISO format
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH25

INPUT PARAMETERSSEQUENCE NUMBER4
INPUT PARAMETERENDDATETIME
DESCRIPTIONEnd date/time in ISO 8601 format.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH25

INPUT PARAMETERSSEQUENCE NUMBER5
INPUT PARAMETEREASTRCKNGNMBR
DESCRIPTIONEnterprise Appointment Scheduling (EAS) Tracking Number associated to an
appointment.
PARAMETER TYPELITERAL
REQUIREDNO
MAXIMUM DATA LENGTH40

RETURN VALUE TYPEARRAY
RETURN PARAMETER DESCRIPTIONPre-cancellation appointment list:

{
"PreCancellationList": {
"Appointment": [
{
"AppointmentCancelled": "",
"AppointmentDateTime": "2022-09-13T11:30-0400",
"AppointmentIEN": 292983,
"AppointmentType": "REGULAR",
"AppointmentTypeIEN": 9,
"AppointmentTypeSubCategory": "",
"AutoRebookedApptDateTime": "",
"CancellationReason": "",
"CancellationRemarks": "",
"CheckIn": "",
"CheckInEntered": "",
"CheckInSteps": [
""
],
"CheckInUser": "",
"CheckOut": "",
"CheckOutEntered": "",
"CheckOutUser": "",
"Clinic": {
"Division": "CHEYENNE VAMROC",
"IsOverbook": 0,
"Name": "ZZBWF TEST CLINIC1",
"PatientFriendlyName": "",
"PhysicalLocation": "ARROW",
"StationNumber": 442,
"Telephone": "(800)222-2222",
"TelephoneExtension": "x1234"
},
"CollateralVisit": "",
"ConsultLink": "",
"CurrentStatus": "NO ACTION TAKEN/TODAY",
"DataEntryClerk": "FISHER,BRADLEY W",
"DateAppointmentMade": "2022-09-02T11:04:36-0400",
"DesiredDateOfAppointment": "2022-09-16",
"DuplicateApptSameDay": "",
"EASTrackingNumber": "",
"EkgDateTime": "",
"EncounterConversionStatus": "",
"EncounterFormsAsAddOns": "",
"EncounterFormsPrinted": "",
"EndTime": "2022-09-13T12:00-0400",
"FollowUpVisit": "NO",
"LabDateTime": "",
"LengthOfAppt": 30,
"NextAvaApptIndicator": "NOT INDICATED TO BE A 'NEXT AVA.' APPT.",
"NoShowCancelDateTime": "",
"NoShowCancelledBy": "",
"Note": [
"BWF TESTING MRTC"
],
"NumberOfCollateralSeen": "",
"OtherTests": "BWF TESTING MRTC",
"OtherTravel": " BWF TESTING MRTC",
"OutpatientEncounter": "",
"OverLaidAppointmentData": "NO",
"OverbookFlag": "",
"ParentRecordRequest": "",
"Patient": {
"CurrentEligibilityCode": "EMPLOYEE",
"DFN": 7212594,
"EligibilityIEN": 13,
"EnrollmentCode": "",
"EnrollmentDate": "",
"ICN": "4420062484V974298",
"Name": "VSETEST,BRADTWO TEST",
"SSN": 1234,
"Street": "1700 EAST FOUR MILE ROAD"
},
"PriorXRayResults": "",
"Provider": {
"ID": 520881857,
"Name": "FISHER,BRADLEY W",
"SecId": 1034237835
},
"PurposeOfVisit": "SCHEDULED VISIT",
"RealAppointment": 1,
"Resource": {
"ClinicIEN": 5263,
"Name": "ZZBWF TEST CLINIC1"
},
"ResourceIEN": 3634,
"RoutingSlipPrintDate": "",
"RoutingSlipPrinted": "",
"SchedulerName": "",
"SchedulingApplication": "",
"SchedulingRequestType": "MULTIPLE APPT. BOOKING",
"SpecialSurveyDisposition": "",
"StartTimeFM": 3220913.113,
"Status": "NO ACTION TAKEN/TODAY",
"StatusCancelDateTime": "",
"VeteranVideoCallURL": "",
"WardLocation": "",
"XRAY": "",
"XrayDateTime": ""
}
]
}
}
"AutoRebookedApptDateTime": "",
"CancellationReason": "",
"CancellationRemarks": "",
"CheckIn": "",
"CheckInEntered": "",
"CheckInSteps": [
""
],
"CheckInUser": "",
"CheckOut": "",
"CheckOutEntered": "",
"CheckOutUser": "",
"Clinic": {
"Division": "CHEYENNE VAMROC",
"IsOverbook": 0,
"Name": "ZZBWF TEST CLINIC1",
"PatientFriendlyName": "",
"PhysicalLocation": "ARROW",
"Telephone": "(800)222-2222",
"TelephoneExtension": "x1234"
},
"CollateralVisit": "",
"ConsultLink": "",
"CurrentStatus": "FUTURE",
"DataEntryClerk": "TEST,USER A",
"DateAppointmentMade": "2022-08-15T09:38:01-0400",
"DesiredDateOfAppointment": "2022-08-08",
"DuplicateApptSameDay": "",
"EASTrackingNumber": "",
"EkgDateTime": "",
"EncounterConversionStatus": "",
"EncounterFormsAsAddOns": "",
"EncounterFormsPrinted": "",
"EndTime": "2022-10-20T14:00-0400",
"FollowUpVisit": "NO",
"LabDateTime": "",
"LengthOfAppt": 30,
"NextAvaApptIndicator": "NOT INDICATED TO BE A 'NEXT AVA.' APPT.",
"NoShowCancelDateTime": "",
"NoShowCancelledBy": "",
"Note": "",
"NumberOfCollateralSeen": "",
"OtherTests": "",
"OtherTravel": " ",
"OutpatientEncounter": "",
"OverLaidAppointmentData": "NO",
"OverbookFlag": "",
"ParentRecordRequest": "",
"Patient": {
"CurrentEligibilityCode": "EMPLOYEE",
"DFN": 7212594,
"EligibilityIEN": 13,
"EnrollmentCode": "",
"EnrollmentDate": "",
"ICN": "",
"Last4": "",
"Name": "VSETEST,PATIENT TEST",
"SSN": "",
"Street": "1234 TEST ROAD"
},
"PriorXRayResults": "",
"Provider": [
""
],
"PurposeOfVisit": "SCHEDULED VISIT",
"RealAppointment": 1,
"Resource": {
"ClinicIEN": 5263,
"Name": "ZZBWF TEST CLINIC1"
},
"ResourceIEN": 3634,
"RoutingSlipPrintDate": "",
"RoutingSlipPrinted": "",
"SchedulerName": "",
"SchedulingApplication": "",
"SchedulingRequestType": "OTHER THAN 'NEXT AVA.' (PATIENT REQ.)",
"SpecialSurveyDisposition": "",
"StartTimeFM": 3221020.133,
"Status": "",
"StatusCancelDateTime": "",
"VeteranVideoCallURL": "",
"WardLocation": "",
"XRAY": "",
"XrayDateTime": ""
}
]
}
}
AVAILABILITYRESTRICTED
INACTIVE
CLIENT MANAGER
WORD WRAP ON
VERSION
SUPPRESS RDV USER SETUP
APP PROXY ALLOWEDYes