SDES GET CLIN AVAILABILITY

TITLEVALUE
NAMESDES GET CLIN AVAILABILITY
DESCRIPTIONThis RPC returns available appointment slots within a given timeframe for
a given clinic in JSON format.
TAGGETCLAVAILABLTY
ROUTINESDESCLINICAVAIL
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERCLINICIEN
DESCRIPTIONThe Internal Entry Number (IEN) from HOSPITAL LOCATION FILE #44.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH30

INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERSTARTDATETIME
DESCRIPTIONThe 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 TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH25

INPUT PARAMETERSSEQUENCE NUMBER3
INPUT PARAMETERENDDATETIME
DESCRIPTIONThis 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 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 DESCRIPTIONData 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,...
AVAILABILITYRESTRICTED
INACTIVE
CLIENT MANAGER
WORD WRAP ON
VERSION
SUPPRESS RDV USER SETUP
APP PROXY ALLOWEDYes