SDES2 GET APPTS BY CLN RES IEN

TITLEVALUE
NAMESDES2 GET APPTS BY CLN RES IEN
DESCRIPTIONThis RPC will return back the appointment for a given clinic resource for
a given time range.

Can only be invoked by Acheron
TAGBYCLINRESOURCE
ROUTINESDES2GETAPPTRPCS
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERSDCONTEXT
DESCRIPTION SDCONTEXT("ACHERON AUDIT ID") = Up to 40 Character unique ID number.
Ex: 11d9dcc6-c6a2-4785-8031-8261576fca37
SDCONTEXT("USER DUZ") = The DUZ of the user taking action on the
calling application.
SDCONTEXT("USER SECID") = The SECID of the user taking action in the
calling application.
SDCONTEXT("PATIENT DFN")= The name of the patient taking action on the
calling application.
SDCONTEXT("PATIENT ICN")= The ICN of the patient taking action on the
calling application.
PARAMETER TYPELIST
REQUIREDYES
MAXIMUM DATA LENGTH32000
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERSDPARAM
DESCRIPTION SDPARAM("ResourceIEN")
SDPARAM("BeginDateTime")
SDPARAM("EndDateTime")
PARAMETER TYPELIST
REQUIREDYES
MAXIMUM DATA LENGTH32000
RETURN VALUE TYPEARRAY
RETURN PARAMETER DESCRIPTIONExample 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": "CALIS,NEDIME",
"SecId": 20010011913859
},
"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": 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",
"TimeZoneDetails": [
{
"Offset": "-0500",
"TimeFrame": "STANDARD",
"TimeZoneCode": "EST"
},
{
"Offset": "-0400",
"TimeFrame": "DAYLIGHT SAVINGS",
"TimeZoneCode": "EDT"
}
],
"TimeZoneException": "",
"VeteranSelfCancel": "NO"
},
"CollateralVisit": "",
"ConsultLink": "",
"CurrentStatus": "CANCELLED BY CLINIC",
"DataEntryClerk": "CALIS,NEDIME",
"DateAppointmentMade": "2023-12-06",
"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,USER",
"Note": "",
"NoteAuditing": [
""
],
"NumberOfCollateralSeen": "",
"OriginatingRequestType": "APPT",
"OtherTests": "",
"OtherTravel": " ",
"OutpatientEncounter": "",
"OverLaidAppointmentData": "NO",
"OverbookFlag": "",
"ParentRecordRequest": "",
"Patient": {
"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": "",
"EnrollmentDate": "",
"FugitiveFelonFlag": "NO",
"Gender": "FEMALE",
"ICN": "4420062581V571742",
"LastRegistrationDate": "2010-11-02T10:24:13-0400",
"LocalFlag": [
""
],
"Name": "SQA,REQUEST",
"NationalFlag": [
""
],
"NeedInsuranceVerification": 1,
"OriginalRegistrationDate": "2010-09-28T15:04:37-0400",
"SSN": 7667,
"SensitivePatientRestrictedRecord": 0,
"SensitivePatientType": 0,
"Street": "GENERAL DELIVERY",
"cellularPhone": "",
"residentialPhone": ""
},
"PatientComments": [
""
],
"PriorXRayResults": "",
"Provider": {
"ID": 1824,
"Name": "CERVANTES,DEWAYNE 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,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",
"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"
},
{
"Offset": "-0400",
"TimeFrame": "DAYLIGHT SAVINGS",
"TimeZoneCode": "EDT"
}
],
"TimeZoneException": "",
"VeteranSelfCancel": "NO"
},
"CollateralVisit": "",
"ConsultLink": "",
"CurrentStatus": "ACT REQ/CHECKED OUT",
"DataEntryClerk": "CALIS,NEDIME",
"DateAppointmentMade": "2022-11-14",
"DesiredDateOfAppointment": "2022-11-14",
"DuplicateApptSameDay": "",
"EASTrackingNumber": "",
"EkgDateTime": "",
"EncounterConversionStatus": "",
"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": "",
"NoShowCancelledBy": "",
"Note": "",
"NoteAuditing": [
""
],
"NumberOfCollateralSeen": "",
"OriginatingRequestType": "APPT",
"OtherTests": "",
"OtherTravel": " ",
"OutpatientEncounter": "2022-11-14T10:00-0500",
"OverLaidAppointmentData": "NO",
"OverbookFlag": "O",
"ParentRecordRequest": "",
"Patient": {
"CurrentEligibilityCode": "HUMANITARIAN EMERGENCY",
"DFN": 7242584,
"DateOfBirth": "1980-10-20",
"DateOfBirthInternal": 2801020,
"DateOfDeath": "",
"DemographicsNeedUpdate": 1,
"Eligibility": "HUMANITARIAN EMERGENCY",
"EligibilityIEN": 8,
"EligibilityOfVisit": "HUMANITARIAN EMERGENCY",
"EnrollmentCode": "",
"EnrollmentDate": "",
"FugitiveFelonFlag": "NO",
"Gender": "MALE",
"ICN": "4420062425V751830",
"LastRegistrationDate": "2024-08-16T11:36:43-0400",
"LocalFlag": [
""
],
"Name": "INPATIENT,IRAONE",
"NationalFlag": [
""
],
"NeedInsuranceVerification": 1,
"OriginalRegistrationDate": "2022-11-14T13:54:20-0500",
"SSN": "0925",
"SensitivePatientRestrictedRecord": 0,
"SensitivePatientType": 0,
"Street": "2345 STATE ST.",
"cellularPhone": "",
"residentialPhone": "(312) 897-2345"
},
"PatientComments": [
""
],
"PriorXRayResults": "",
"Provider": {
"ID": 520664036,
"Name": "TEST,PROVIDER",
"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": "ACT REQ/CHECKED OUT",
"StatusCancelDateTime": "",
"VVSApptID": "",
"VeteranVideoCallURL": "",
"Walkin": "",
"WardLocation": "",
"XRAY": "",
"XrayDateTime": ""
}
]
}
"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