TITLE | VALUE | |
---|---|---|
NAME | SDES CREATE CLIN AVAILABILITY | |
DESCRIPTION | Set the clinic availability. | |
TAG | SETCLINAVAIL | |
ROUTINE | SDES | |
INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
INPUT PARAMETER | SDCLINIC | |
DESCRIPTION | CLINIC IEN OR NAME FROM FILE 44 | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 30 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
INPUT PARAMETER | DATES | |
DESCRIPTION | String of dates in ISO8601 extended format separated by semi-colon (e.g., CCYY-MM-DD;CCYY-MM-DD). Adding 9999999 (7 nines) as the last piece of this string will set the pattern to be indefinite. These dates must all be the same day of the week. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 100 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 3 |
INPUT PARAMETER | TIMES | |
DESCRIPTION | STRING OF TIME RANGES IN 24 HOUR FORMAT SEPERATED BY A ;. EX: 0800-0900;0900-1200;1300-1600 Note: Both SLOTS and TIMES have to have a value or be null. If both are sent as null, then the availability for the date/dates will be removed. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 50 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 4 |
INPUT PARAMETER | SLOTS | |
DESCRIPTION | STING OF NUMBERS REPRESENTING THE NUMBER OF SLOTS PER APPOINTMENT WINDOW SEPERATED BY A ;. THESE NUMBERS CAN RANGE FROM 1 TO 26. Note: Both SLOTS and TIMES have to have a value or be null. If both are sent as null, then the availability for the date/dates will be removed. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 30 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 5 |
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 | EITHER ERROR MESSAGES OR MESSAGE THE 'PATTERN FILES'. { "ClinicAvailability": "", { "Create": "Pattern Filed" } "DateIndefiniteScheduleEnds": 2023-12-05 } } | |
AVAILABILITY | ||
INACTIVE | ||
CLIENT MANAGER | ||
WORD WRAP ON | ||
VERSION | ||
SUPPRESS RDV USER SETUP | ||
APP PROXY ALLOWED | Yes |