SDES2 CANCEL CLINIC AVAIL

TITLEVALUE
NAMESDES2 CANCEL CLINIC AVAIL
DESCRIPTIONThis RPC will cancel clinic availability.

If the day being cancelled has scheduled appointments, those appointments
will be cancelled and their IENs will be included in the returned JSON
object.

Can only be invoked by Acheron
TAGCANCEL
ROUTINESDES2CANCLNAVAIL
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERSDCONTEXT
DESCRIPTION SDCONTEXT("ACHERON AUDIT ID") = Up to 40 Character unique ID number.
Ex: 11d9dcc6-c6a2-4785-8031-8261576fca37
SDCONTEXT("USER DUZ") = The DUZ of the user taking action on the
calling application.
SDCONTEXT("USER SECID") = The SECID of the user taking action in the
calling application.
SDCONTEXT("PATIENT DFN")= The name of the patient taking action on the
calling application.
SDCONTEXT("PATIENT ICN")= The ICN of the patient taking action on the
calling application.
PARAMETER TYPELIST
REQUIREDYES
MAXIMUM DATA LENGTH32000
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERCANCEL
DESCRIPTIONCANCEL("CLINIC IEN")=4118
CANCEL("FULL PARTIAL FLAG")="P"
* If "FULL PARTIAL FLAG" is "P" (Partial Day), the START DATE TIME
and END DATE TIME must fall on the same calendar day and include
both date and time.
* If the flag is "F" (Full Day), only the date portion is required for
both START DATE TIME and END DATE TIME, and the cancellation window
may span multiple days.
CANCEL("START DATE TIME")="2024-01-03T09:00-05:00"
CANCEL("END DATE TIME")="2024-01-03T12:00-05:00"
CANCEL("REMARKS")="This is a remark"
PARAMETER TYPELIST
REQUIREDYES
MAXIMUM DATA LENGTH32000
RETURN VALUE TYPEARRAY
RETURN PARAMETER DESCRIPTION{
"CancelClinicAvailability": [
"Clinic availability has been successfully cancelled."
],
"CancelledAppointment": [
{
"AppointmentID": 301509
},
{
"AppointmentID": 301510
}
]
}
AVAILABILITYRESTRICTED
INACTIVEACTIVE
CLIENT MANAGER
WORD WRAP ONFALSE
VERSION
SUPPRESS RDV USER SETUP
APP PROXY ALLOWEDYes