Print Page as PDF
Make Appointment API ICR (7058)

Make Appointment API    ICR (7058)

Name Value
NUMBER 7058
IA # 7058
DATE CREATED 2019/04/25
CUSTODIAL PACKAGE SCHEDULING
USAGE Controlled Subscription
TYPE Routine
ROUTINE SDEC07
NAME Make Appointment API
GENERAL DESCRIPTION
Making 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 make appointments.

Note:  Subscribing applications that want to invoke this API using the SDEC
APPADD RPC can subscribe to the appropriate controlled ICR (#7059).
STATUS Pending
DURATION Till Otherwise Agreed
ID SDEC07
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
APPADD
APPADD is the entry point in SDEC07 that is called to
make an appointment and have the data updated in all required files.

Sequence of input parameters:

1.  SDECSTART
2.  SDECEND
3.  DFN
4.  SDRES
5.  SDCLEN
6.  SDECNOTE
7.  SDECATID
8.  SDECCR
9.  SDMRTC
10.  SDDDT
11.  SDREQBY
12.  SDLAB
13.  PROVIEN
14.  SDID
15.  SDAPTYP
16.  SDSVCP
17.  SDSVCPR
18.  SDCL
19.  SDEKG
20.  SDXRAY
21.  APPTYPE
22.  EESTAT
23.  OVB
24.  SDPARENT
25.  SDEL
26.  SOURCE (introduce in patch 715)
VARIABLES TYPE VARIABLES DESCRIPTION
SDECY Output
SDECY contains the name of the global array which
stores the results of the make appointment operation.  It is in the form of
^TMP("SDEC07",$J,i).  For i=0, the header string
"I00020APPOINTMENTID^T00020ERRORID" is returned.

If the API call is successful, the next line will contain a pointer to the
SDEC Appointment file (#409.84) entry that was created.

If the API call is unsuccessful, the next line will contain a 0 in piece 1 (on
"^") and the error reason text in piece 2.
SDECSTART Input
Contains the start date/time of the appointment in
external format.  Both date and time must be present.  REQUIRED.
SDECEND Input
Contains the end date/time of the appointment in
external format.  Both date and time must be present.  REQUIRED.
DFN Input
Patient file (#2) pointer.  REQUIRED.
SDECRES Input
Either the pointer or the name of the SDEC Resource
(#409.831) being scheduled.  If the name is specified, it must be an exact
match with the .01 field.  REQUIRED.
SDECLEN Input
Length of the appointment in minutes.  OPTIONAL.
SDECNOTE Input
Appointment comment.  OPTIONAL.

Prior to patch SD*5.3*715, this field is restricted to 75 characters because
of CPRS limitations.  After patch 715, the comment is stored in a word
processing field and the practical limitation is 32K.
SDECATID Input
If appointment is a walk-in then set to WALKIN.
Otherwise leave null.
SDECCR Input
Applies to WALKIN appointments only.  1=print routing
slip. OPTIONAL.
SDMRTC Input
If appointment is for an MRTC, set to TRUE.
OPTIONAL.
SDDDT Input
Desired date of appointment in external format. If
missing or invalid, it is set to the date of the appointment.  OPTIONAL.
SDREQBY Input
Appointment requested by.  Possible values are
PROVIDER or PATIENT.  OPTIONAL.
SDLAB Input
Date/time of labs in external format.  OPTIONAL.
SDEKG Input
Date/time of EKG in external format.  OPTIONAL.
PROVIEN Input
Provider.  Pointer to New Person file (#200).
OPTIONAL.
SDID Input
Extrernal ID.  OPTIONAL.
SDAPTYP Input
Requst type.  Format is X | pointer where X="A" for
APPT, "C" for consult, "E" for EWL or "R" for Recall and pointer is a pointer
to #409.85 for APPT, to #123 for Consult, to #409.3 for EWL and to #403.5 for
Recall.

REQUIRED
SDSVCP Input
Service Connected.  Value is either "YES" or "NO".
OPTIONAL.
SDSVCPR Input
Service connected percentage.  Value is 0-100.
OPTIONAL.
SDCL Input
Clinic.  Pointer to file #44.  OPTIONAL.
SDXRAY Input
Date/time in external format of last x-ray.
OPTIONAL.
APPTYPE Input
Appointment type.  Pointer to file #409.1. OPTIONAL.
EESTAT Input
Patient status.  Values permitted are:
N,NEW,E,ESTABLISHED.  OPTIONAL.
OVB Input
Appointment is an overbook (1=YES, 0=NO).  OPTIONAL.
SDPARENT Input
Parent request of an MRTC.  Pointer to #409.85.
OPTIONAL.
SDEL Input
Patient eligibility.  Pointer to #8.  REQUIRED.
SOURCE Input
Appointment source.  Permitted values are: GUI,
VistA, Other.  OPTIONAL.

NOTE:  This field first appears in patch SD*5.3*715.