SDES2 CANCEL CLINIC AVAIL (5004)    REMOTE PROCEDURE (8994)

Name Value
NAME SDES2 CANCEL CLINIC AVAIL
TAG CANCEL
ROUTINE SDES2CANCLNAVAIL
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
INACTIVE ACTIVE
WORD WRAP ON FALSE
APP PROXY ALLOWED Yes
DESCRIPTION
This 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
INPUT PARAMETER
  • SDCONTEXT
    PARAMETER TYPE:   LIST
    MAXIMUM DATA LENGTH:   32000
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
       SDCONTEXT("ACHERON AUDIT ID") = Up to 40 Character unique ID number.
                                 calling application. 
                                 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
    
  • CANCEL
    PARAMETER TYPE:   LIST
    MAXIMUM DATA LENGTH:   32000
    REQUIRED:   YES
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    CANCEL("CLINIC IEN")=4118
    CANCEL("END DATE TIME")="2024-01-03T12:00-05:00"
    CANCEL("REMARKS")="This is a remark"
    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"
    
RETURN PARAMETER DESCRIPTION
{
                        "AppointmentID": 301510
                }
        ]
}
        "CancelClinicAvailability": [
                "Clinic availability has been successfully cancelled."
        ],
        "CancelledAppointment": [
                {
                        "AppointmentID": 301509
                },
                {