SDES GET CLIN AVAILABILITY (4582)    REMOTE PROCEDURE (8994)

Name Value
NAME SDES GET CLIN AVAILABILITY
TAG GETCLAVAILABLTY
ROUTINE SDESCLINICAVAIL
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
APP PROXY ALLOWED Yes
DESCRIPTION 
This RPC returns available appointment slots within a given timeframe for
a given clinic in JSON format.
INPUT PARAMETER
  • CLINICIEN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The Internal Entry Number (IEN) from HOSPITAL LOCATION FILE #44.
  • STARTDATETIME
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   25
    REQUIRED:   YES
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    The search start date/time in ISO8601 format
 (e.g., CCYY-MM-DDTHH:MM:SS-HH:MM)
or just the date in external format (e.g., CCYY-MM-DD)
  • ENDDATETIME
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   25
    REQUIRED:   YES
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    This is the search end date/time in ISO8601 format 
 (e.g., CCYY-MM-DDTHH:MM:SS-HH:MM)
or just the date in external format (e.g., CCYY-MM-DD)
 
This date must be the same as the start date. The time cannot be before
the start time.
  • 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 
Data is returned in JSON format.
         }
     ]
 }
 
SlotsAvail can have the following values:
 NULL     Not Available/Overbooked
 1,2,..   # of Available Slots
 X        Cancelled
 
 
If successful, the following data will be returned:
 If problems are encountered, then the following data will be returned:
 
 RETURN("Error",n)=Error_Message
 
  where:
   n = 1,2,...
   n = 1,2,...
 
 {
    "ClinAvail": [
        {
            "BeginTime": "2022-08-05T10:00-0400",
            "EndTime": "2022-08-05T10:30-0400",
            "SlotsAvail": 1