TITLE | VALUE | |
---|---|---|
NAME | SDES GET CLIN AVAILABILITY | |
DESCRIPTION | This RPC returns available appointment slots within a given timeframe for a given clinic in JSON format. | |
TAG | GETCLAVAILABLTY | |
ROUTINE | SDESCLINICAVAIL | |
INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
INPUT PARAMETER | CLINICIEN | |
DESCRIPTION | The Internal Entry Number (IEN) from HOSPITAL LOCATION FILE #44. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 30 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
INPUT PARAMETER | STARTDATETIME | |
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) | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 25 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 3 |
INPUT PARAMETER | ENDDATETIME | |
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. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 25 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 4 |
INPUT PARAMETER | EASTRCKNGNMBR | |
DESCRIPTION | Enterprise Appointment Scheduling (EAS) Tracking Number associated to an appointment. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 40 | |
RETURN VALUE TYPE | ARRAY | |
RETURN PARAMETER DESCRIPTION | Data is returned in JSON format. If successful, the following data will be returned: { "ClinAvail": [ { "BeginTime": "2022-08-05T10:00-0400", "EndTime": "2022-08-05T10:30-0400", "SlotsAvail": 1 } ] } SlotsAvail can have the following values: NULL Not Available/Overbooked 1,2,.. # of Available Slots X Cancelled If problems are encountered, then the following data will be returned: RETURN("Error",n)=Error_Message where: n = 1,2,... n = 1,2,... | |
AVAILABILITY | RESTRICTED | |
INACTIVE | ||
CLIENT MANAGER | ||
WORD WRAP ON | ||
VERSION | ||
SUPPRESS RDV USER SETUP | ||
APP PROXY ALLOWED | Yes |