Print Page as PDF
Cancel Appointment API ICR (7064)

Cancel Appointment API    ICR (7064)

Name Value
NUMBER 7064
IA # 7064
DATE CREATED 2019/05/06
CUSTODIAL PACKAGE SCHEDULING
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE SDEC08
NAME Cancel Appointment API
GENERAL DESCRIPTION
Cancelling an appointment impacts several files in all
cases (e.g., Patient, Location, SDEC Appointment) and others in specific cases
(e.g., Consult).  This ICR describes the scheduling API that can be used by
non-scheduling applications to cancel appointments.

Note:  Subscribing applications that want to invoke this API using the SDEC
APPDEL RPC can subscribe to the appropriate controlled ICR (#7065).
STATUS Active
DURATION Till Otherwise Agreed
ID SDEC08
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
APPDEL
APPDEL is the entry point in SDEC08 that is called to
cancel an appointment and have the data updated in all required files.
VARIABLES TYPE VARIABLES DESCRIPTION
SDECY Output
SDECY contains the name of the global array which
stores the results of the cancel appointment operation.  It is in the form of

^TMP("SDEC07",$J,i).  For i=0, the header string "T00020ERRORID" is returned.

If the API call is successful, the next line will contain a null string.

If the API call is unsuccessful, the next line will contain an error reason.
SDECAPTID Input
Pointer to the SDEC Appointment file (#409.84).  The
appointment to be cancelled.    REQUIRED
SDECTYP Input
Indicates the source of the cancellation.  There are
two possible values for this input parameter:

C = Cancelled by clinic PC = Cancelled by patient

REQUIRED
SDECCR Input
Cancellation reason.  Pointer to the Cancellation
Reason file (#409.2).

OPTIONAL
SDECNOT Input
Cancellation note.  Limited to 160 characters.
OPTIONAL
SDECDATE Input
Cancellation date/time in external format.  If blank,
now is used.  OPTIONAL
SDUSER Input
User who cancelled the appointment.  If blank,
defaults to current user.  OPTIONAL
SOURCE Input
Application source.  See the set of codes associated
with field #1 of the Application Events file (#409.94).  If blank, "Other" is
applied.  OPTIONAL.

Note:  This field first appears in patch SD*5.3*715.
SDF Input
Flag to be passed in by external applications to
determine whether a cancelled appointment should be re-opened.

SDF=1 or null (default) - Appointment reopened

SDF=2                   - Appointment not reopened.
Appointment closed with disposition of
"REMOVED/EXTERNAL APP"

Note:  This field first appears in patch SD*5.3*745.
SDECCMT Input
Optional parameter that contains a list of
cancellation comment hash tags separated by ^ (e.g., FIRST^SECOND). A hash tag
is the .01 field of the the SDEC Cancellation Comments file (#409.88).

Note:  Parameter added with patch SD*5.3*756.
DATE ACTIVATED 2020/05/04