SDES GET APPTS BY PATIENT DFN3

TITLEVALUE
NAMESDES GET APPTS BY PATIENT DFN3
DESCRIPTIONThis RPC retrieves and returns appointments from SDEC APPOINTMENT File
#409.84, HOSPITAL LOCATION File #44, and Appointment Multiple Patient File
#2 for a given patient DFN within a given date range in JSON format.
TAGBYPATDFN
ROUTINESDESGETAPPTRPCS
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERDFN
DESCRIPTIONPatient Data File Number (DFN) from Patient File #2.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH32000
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERSDBEGIN
DESCRIPTIONThe beginning date/time in ISO 8601 Time Format to start for the search.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH25
INPUT PARAMETERSSEQUENCE NUMBER3
INPUT PARAMETERSDEND
DESCRIPTIONThe ending date/time in ISO 8601 Time Format to start for the search.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH25
INPUT PARAMETERSSEQUENCE NUMBER4
INPUT PARAMETEREASTRCKNGNMBR
DESCRIPTIONEnterprise Appointment Scheduling (EAS) Tracking Number associated to an
appointment.
PARAMETER TYPELITERAL
REQUIREDNO
MAXIMUM DATA LENGTH40
RETURN VALUE TYPEARRAY
RETURN PARAMETER DESCRIPTION Example one: Cancelled appointment
{
"Appointment": [
{
"AppointmentCancelled": "CANCELLED",
"AppointmentDateTime": "2023-12-06T08:00-0500",
"AppointmentIEN": 298114,
"AppointmentType": "REGULAR",
"AppointmentTypeIEN": 9,
"AppointmentTypeSubCategory": "",
"AutoRebookedApptDateTime": "",
"CancelDateTime": "2023-12-06T14:17:06-0500",
"CancellationReason": "PANDEMIC",
"CancellationRemarks": "",
"CancelledByUser": {
"ID": 520881841,
"Name": "TEST,USR",
"SecId": 1060245260
},
"CheckIn": "",
"CheckInEntered": "",
"CheckInSteps": [
""
],
"CheckInUser": "",
"CheckOut": "",
"CheckOutEntered": "",
"CheckOutUser": "",
"Clinic": {
"ClinicIEN": 2147,
"CreditStopCodeAMIS": 179,
"CreditStopCodeName": "RT CLIN VID CARE HOME",
"DisplayClinicAppt": "YES",
"Division": "CHEYENNE VAMROC",
"ECheckinAllowed": "YES",
"IsOverbook": 0,
"Name": "CHY CARDIOLOGY",
"PatientFriendlyName": "CHY CARDIOLOGY",
"PbspID": "",
"PhysicalLocation": "ARROWHEAD BLD A1-16 OR 17",
"PreCheckinAllowed": "YES",
"ProhibitedClinic": 0,
"StationNumber": 442,
"StopCodeAMIS": 303,
"StopCodeName": "CARDIOLOGY",
"Telephone": "(307)778-7550",
"TelephoneExtension": 1234,
"TimeZone": "EASTERN",
"TimeZoneDetails": [
{
"Offset": "-0500",
"TimeFrame": "STANDARD",
"TimeZoneCode": "EST"
},
{
"Offset": "-0400",
"TimeFrame": "DAYLIGHT SAVINGS",
"TimeZoneCode": "EDT"
}
],
"TimeZoneException": ""
},
"CollateralVisit": "",
"ConsultLink": "",
"CurrentStatus": "CANCELLED BY CLINIC",
"DataEntryClerk": "TEST,USR",
"DateAppointmentMade": "2023-12-06T14:12:13-0500",
"DesiredDateOfAppointment": "2023-12-06",
"DuplicateApptSameDay": "",
"EASTrackingNumber": "",
"EkgDateTime": "",
"EncounterConversionStatus": "",
"EncounterFormsAsAddOns": "",
"EncounterFormsPrinted": "",
"EndTime": "2023-12-06T08:30-0500",
"FollowUpVisit": "NO",
"InpatientFlag": 0,
"LabDateTime": "",
"LengthOfAppt": 30,
"MRTCFlag": 1,
"NextAvaApptIndicator": "'NEXT AVA.' APPT. INDICATED BY USER &
CALCULATION",
"NoShowCancelDateTime": "2023-12-06T14:17:06-0500",
"NoShowCancelledBy": "TEST,USR",
"Note": "",
"NumberOfCollateralSeen": "",
"OriginatingRequestType": "APPT",
"OtherTests": "",
"OtherTravel": " ",
"OutpatientEncounter": "",
"OverLaidAppointmentData": "NO",
"OverbookFlag": "",
"ParentRecordRequest": "",
"Patient": {
"CurrentEligibilityCode": "SERVICE CONNECTED 50% to 100%",
"DFN": 7209450,
"DateOfBirth": "1990-06-06",
"DateOfBirthInternal": 2900606,
"DateOfDeath": "",
"DemographicsNeedUpdate": 1,
"Eligibility": "SERVICE CONNECTED 50% to 100%",
"EligibilityIEN": 1,
"EligibilityOfVisit": "SERVICE CONNECTED 50% to 100%",
"EnrollmentCode": "",
"EnrollmentDate": "",
"FugitiveFelonFlag": "NO",
"Gender": "MALE",
"ICN": "4420062499V538982",
"LastRegistrationDate": "2023-09-01T15:13:57-0400",
"LocalFlag": [
{
"AssignedDate": "2014-12-03T14:50:22-0500",
"Category": "II (LOCAL)",
"Name": "AT RISK PATIENT",
"Narrative": [
"This is a test account. The actual record text was removed Feb
14, 2018.",

"ABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLM
N",
"OPQRSTABCDEFGHIJKLMNOPQRST",

"ABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLM
N",
"OPQRSTABCDEFGHIJKLMNOPQRST",

"ABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLM
N",
"OPQRSTABCDEFGHIJKLMNOPQRST",

"ABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLM
N",
"OPQRSTABCDEFGHIJKLMNOPQRST",

"ABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLMNOPQRSTABCDEFGHIJKLM
N",
"OPQRSTABCDEFGHIJKLMNOPQRST",
" ",
"END OF TEXT"
],
"OriginatingSiteID": 442,
"OriginatingSiteName": "CHEYENNE VA MEDICAL",
"OwnerSiteID": 442,
"OwnerSiteName": "CHEYENNE VA MEDICAL",
"ReviewDate": "2023-12-13",
"Type": "OTHER"
}
],
"Name": "VSE,LOCAL FLAG",
"NationalFlag": [
""
],
"NeedInsuranceVerification": 1,
"OriginalRegistrationDate": "2011-03-22T10:49:09-0400",
"SSN": "0690P",
"SensitivePatientRestrictedRecord": 0,
"SensitivePatientType": 0,
"Street": "C/O P MAI (136B)"
},
"PatientComments": [
""
],
"PriorXRayResults": "",
"Provider": {
"ID": 1824,
"Name": "PROVIDER,TEST J",
"SecId": 1034217513
},
"PurposeOfVisit": "SCHEDULED VISIT",
"RealAppointment": 0,
"RequestIEN": 263452,
"RequestType": "APPT",
"Resource": {
"ClinicIEN": 2147,
"Name": "CHY CARDIOLOGY"
},
"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",
"VVSApptID": "",
"VeteranVideoCallURL": "",
"Walkin": "",
"WardLocation": "",
"XRAY": "",
"XrayDateTime": ""
}
]
}
Example two with check-in steps:
{
"Appointment": [
{
"AppointmentCancelled": "",
"AppointmentDateTime": "2022-11-14T10:00-0500",
"AppointmentIEN": 294806,
"AppointmentType": "REGULAR",
"AppointmentTypeIEN": 9,
"AppointmentTypeSubCategory": "",
"AutoRebookedApptDateTime": "",
"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"
},
{
"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"
},
{
"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"
}
],
"CheckInUser": "TEST,NEDIME",
"CheckOut": "2022-11-14T14:22-0500",
"CheckOutEntered": "2022-11-14T14:23:19-0500",
"CheckOutUser": "TEST,FELIX JR",
"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",
"PatientFriendlyName": "CHY ACUTE CARE THOMPSON",
"PbspID": "RANDY TEST PBSP",
"PhysicalLocation": "ARROWHEAD BLDG LOBBY",
"PreCheckinAllowed": "YES",
"ProhibitedClinic": 0,
"StationNumber": 442,
"StopCodeAMIS": 323,
"StopCodeName": "PRIMARY CARE/MEDICINE",
"Telephone": "(307)778-7550",
"TelephoneExtension": 1234,
"TimeZone": "EASTERN",
"TimeZoneDetails": [
{
"Offset": "-0500",
"TimeFrame": "STANDARD",
"TimeZoneCode": "EST"
},
{
"Offset": "-0400",
"TimeFrame": "DAYLIGHT SAVINGS",
"TimeZoneCode": "EDT"
}
],
"TimeZoneException": ""
},
"CollateralVisit": "",
"ConsultLink": "",
"CurrentStatus": "INPATIENT/ACT REQ",
"DataEntryClerk": "CALIS,NEDIME",
"DateAppointmentMade": "2022-11-14T13:34:28-0500",
"DesiredDateOfAppointment": "2022-11-14",
"DuplicateApptSameDay": "",
"EASTrackingNumber": "",
"EkgDateTime": "",
"EncounterConversionStatus": "",
"EncounterFormsAsAddOns": "",
"EncounterFormsPrinted": "",
"EndTime": "2022-11-14T10:30-0500",
"FollowUpVisit": "YES",
"InpatientFlag": 1,
"LabDateTime": "",
"LengthOfAppt": 30,
"MRTCFlag": 1,
"NextAvaApptIndicator": "'NEXT AVA.' APPT. INDICATED BY USER",
"NoShowCancelDateTime": "",
"NoShowCancelledBy": "",
"Note": "",
"NumberOfCollateralSeen": "",
"OriginatingRequestType": "APPT",
"OtherTests": "",
"OtherTravel": " ",
"OutpatientEncounter": "2022-11-14T10:00-0500",
"OverLaidAppointmentData": "NO",
"OverbookFlag": "O",
"ParentRecordRequest": "",
"Patient": {
"CurrentEligibilityCode": "",
"DFN": 44354,
"DateOfBirth": "1951-05-27",
"DateOfBirthInternal": 2510527,
"DateOfDeath": "",
"DemographicsNeedUpdate": 1,
"Eligibility": "",
"EligibilityIEN": "",
"EligibilityOfVisit": "",
"EnrollmentCode": "",
"EnrollmentDate": "",
"FugitiveFelonFlag": "YES",
"Gender": "MALE",
"ICN": "4420062490V261831",
"LastRegistrationDate": "2022-09-26T16:23:58-0400",
"LocalFlag": [
""
],
"Name": "VSE,FUGITIVE FELON",
"NationalFlag": [
{
"AssignedDate": "2003-11-13T07:41:27-0500",
"Category": "I (NATIONAL)",
"Name": "BEHAVIORAL",
"Narrative": [
"This is a test account. The actual record text was removed Feb
14, 2018."
],
"OriginatingSiteID": 629,
"OriginatingSiteName": "SE LOUISIANA VETERANS HCS",
"OwnerSiteID": 671,
"OwnerSiteName": "AUDIE L. MURPHY MEMORIAL HOSP",
"ReviewDate": "",
"Type": "BEHAVIORAL"
}
],
"NeedInsuranceVerification": 1,
"OriginalRegistrationDate": "2022-09-26T16:23:58-0400",
"SSN": "2751P",
"SensitivePatientRestrictedRecord": 1,
"SensitivePatientType": 1,
"Street": "10000 MAIN"
},
"PatientComments": [
""
],
"PriorXRayResults": "",
"Provider": {
"ID": 520664036,
"Name": "TEST,GREGORIO D",
"SecId": ""
},
"PurposeOfVisit": "SCHEDULED VISIT",
"RealAppointment": 0,
"RequestIEN": 257996,
"RequestType": "APPT",
"Resource": {
"ClinicIEN": 3753,
"Name": "CHY ACUTE CARE 1"
},
"ResourceIEN": 2062,
"RoutingSlipPrintDate": "",
"RoutingSlipPrinted": "",
"SchedulerName": "",
"SchedulingApplication": "",
"SchedulingRequestType": "'NEXT AVAILABLE' APPT.",
"SpecialSurveyDisposition": "",
"StartTimeFM": 3221114.1,
"Status": "INPATIENT/ACT REQ",
"StatusCancelDateTime": "",
"VVSApptID": "",
"VeteranVideoCallURL": "",
"Walkin": "",
"WardLocation": "",
"XRAY": "",
"XrayDateTime": ""
}
]
}
AVAILABILITYRESTRICTED
INACTIVE
CLIENT MANAGER
WORD WRAP ON
VERSION
SUPPRESS RDV USER SETUP
APP PROXY ALLOWEDYes