Check-In API ICR (7066)

Name

Value

NUMBER

7066

IA #

7066

DATE CREATED

2019/05/07

CUSTODIAL PACKAGE

SCHEDULING

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

SDEC25

NAME

Check-In API

GENERAL DESCRIPTION

Checking in an appointment impacts several files -
Location, SDEC Appointment. This ICR describes the scheduling API that can be
used by non-scheduling applications to check in appointments.

Note:  Subscribing applications that want to invoke this API using the SDEC
CHECKIN RPC can subscribe to the appropriate controlled ICR (#7067).

STATUS

Active

DURATION

Till Otherwise Agreed

SDEC25

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

CHECKIN

CHECKIN is the entry point in SDEC25 that is called
to check in 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 results of the check in appointment operation. It is in the form of ^TMP("SDEC07",$J,i). For i=0, the header string "T00020ERRORID^T00150MESSAGE" is returned. If the API call is successful, the next line will contain a zero. 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 checked in. REQUIRED
SDECCDT	Input	Check in date/time in external format or @ to cancel check-in. OPTIONAL. If blank, the current date/time is used.
SDECCC	Input	Clinc stop code (pointer to #40.7). OPTIONAL
SDECPRV	Input	Appointment provider (pointer to #200). Used to change the original provider associated with the appointment. OPTIONAL.
SDECROU	Input	Print routing slip flag (1=yes/0=no). OPTIONAL.
SDECVCL	Input	Unused.
SDECVFM	Input	Unused
SDECOG	Input	Unused
SDECCR	Input	Unused
SDECPCC	Input	Unused
SDECWHF	Input	Unused
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 SD5.3715.

DATE ACTIVATED

2021/11/01