SDES GET APPTS BY CLIN IEN 3 (4709)    REMOTE PROCEDURE (8994)

Name Value
NAME SDES GET APPTS BY CLIN IEN 3
TAG GETAPPTBYCLNIEN
ROUTINE SDESGETAPPTWRAP4
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
APP PROXY ALLOWED Yes
DESCRIPTION
This RPC retrieves and returns appointments from SDEC APPOINTMENT File
#409.84, HOSPITAL LOCATION File #44, and Appointment Multiple Patient File
#2 for a given clinic within a given date range in JSON format.
INPUT PARAMETER
  • CLINICIEN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   20
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The Internal Entry Number (IEN) from HOSPITAL LOCATION FILE #44.
    
  • SDBEGIN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   25
    REQUIRED:   YES
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    The beginning date/time in ISO 8601 Time Format to start for the search.
    
  • SDEND
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   25
    REQUIRED:   YES
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    The ending date/time in ISO 8601 Time Format to start for the search.
    
  • EASTRCKNGNMBR
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   40
    REQUIRED:   NO
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    Enterprise Appointment Scheduling (EAS) Tracking Number associated to an 
    appointment.
    
RETURN PARAMETER DESCRIPTION
{
   "AutoRebookedApptDateTime": "",
   "PatientComments": [
    ""
   ],
   "PriorXRayResults": "",
   "Provider": {
    "ID": 1234,
    "Name": "TEST,PROVIDER",
    "SecId": 123
   },
   "PurposeOfVisit": "SCHEDULED VISIT",
   "CancelDateTime": "2023-03-28T10:16:21-0400",
   "RealAppointment": 0,
   "RequestIEN": 259956,
   "RequestType": "APPT",
   "Resource": {
    "ClinicIEN": 2147,
    "Name": "CHY CARDIOLOGY"
   },
   "ResourceIEN": 1058,
   "RoutingSlipPrintDate": "",
   "RoutingSlipPrinted": "",
   "CancellationReason": "OTHER",
   "SchedulerName": "",
   "SchedulingApplication": "",
   "SchedulingRequestType": "OTHER THAN 'NEXT AVA.' (PATIENT REQ.)",
   "SpecialSurveyDisposition": "",
   "StartTimeFM": 3230329.08,
   "Status": "CANCELLED BY CLINIC",
   "StatusCancelDateTime": "2023-03-28T10:16:21-0400",
   "VVSApptID": "",
   "VeteranVideoCallURL": "",
   "Walkin": "",
   "CancellationRemarks": "",
   "WardLocation": "",
   "XRAY": "",
   "XrayDateTime": ""
  },
 ]
}
   "CancelledByUser": {
    "ID": 33333,
    "Name": "SCHEDULER,ONE",
    "SecId": ""
   },
   "CheckIn": "",
 "Appointment": [
   "CheckInEntered": "",
   "CheckInSteps": [
    ""
   ],
   "CheckInUser": "",
   "CheckOut": "",
   "CheckOutEntered": "",
   "CheckOutUser": "",
   "Clinic": {
    "ClinicIEN": 2147,
  {
    "CreditStopCodeAMIS": 391,
    "CreditStopCodeName": "RT CLIN VID CARE HOME",
    "DisplayClinicAppt": "YES",
    "Division": "CHEYENNE VAMROC",
    "ECheckinAllowed": "YES",
    "IsOverbook": 0,
    "Name": "CHY CARDIOLOGY",
    "PatientFriendlyName": "CHY CARDIOLOGY",
    "PhysicalLocation": "ARROWHEAD BLD A1-16 OR 17",
    "PreCheckinAllowed": "YES",
   "AppointmentCancelled": "CANCELLED",
    "StationNumber": 442,
    "StopCodeAMIS": 147,
    "StopCodeName": "CARDIOLOGY",
    "Telephone": "(888)123-4567",
    "TelephoneExtension": "x1234",
    "TimeZone": "EASTERN",
    "TimeZoneDetails": [
     {
      "Offset": "-0500",
      "TimeFrame": "STANDARD",
   "AppointmentDateTime": "2023-03-29T08:00-0400",
      "TimeZoneCode": "EST"
     },
     {
      "Offset": "-0400",
      "TimeFrame": "DAYLIGHT SAVINGS",
      "TimeZoneCode": "EDT"
     }
    ],
    "TimeZoneException": ""
   },
   "AppointmentIEN": 296025,
   "CollateralVisit": "",
   "ConsultLink": "",
   "CurrentStatus": "CANCELLED BY CLINIC",
   "DataEntryClerk": "SCHEDULER,ONE",
   "DateAppointmentMade": "2023-03-28T10:15:20-0400",
   "DesiredDateOfAppointment": "2023-03-22",
   "DuplicateApptSameDay": "",
   "EASTrackingNumber": "",
   "EkgDateTime": "",
   "EncounterConversionStatus": "",
   "AppointmentType": "REGULAR",
   "EncounterFormsAsAddOns": "",
   "EncounterFormsPrinted": "",
   "EndTime": "2023-03-29T08:30-0400",
   "FollowUpVisit": "NO",
   "LabDateTime": "",
   "LengthOfAppt": 30,
   "NextAvaApptIndicator": "NOT INDICATED TO BE A 'NEXT AVA.' APPT.",
   "NoShowCancelDateTime": "2023-03-28T10:16:21-0400",
   "NoShowCancelledBy": "SCHEDULER,ONE",
   "Note": "",
   "AppointmentTypeIEN": 9,
   "NumberOfCollateralSeen": "",
   "OriginatingRequestType": "APPT",
   "OtherTests": "",
   "OtherTravel": "  ",
   "OutpatientEncounter": "",
   "OverLaidAppointmentData": "NO",
   "OverbookFlag": "",
   "ParentRecordRequest": "",
   "Patient": {
    "CurrentEligibilityCode": "EMPLOYEE",
   "AppointmentTypeSubCategory": "",
    "DFN": 7242615,
    "EligibilityIEN": 13,
    "EligibilityOfVisit": "EMPLOYEE",
    "EnrollmentCode": "",
    "EnrollmentDate": "",
    "ICN": "1013111140V840598",
    "Name": "TEST,PATIENT",
    "SSN": 0,
    "Street": "123 HOPE AVE"
   },