STANDARD DATA DICTIONARY #409.84 -- SDEC APPOINTMENT FILE                                                         3/24/25    PAGE 1
STORED IN ^SDEC(409.84,  *** NO DATA STORED YET ***   SITE: WWW.BMIRWIN.COM   UCI: VISTA,VISTA                     (VERSION 5.3)   

DATA          NAME                  GLOBAL        DATA
ELEMENT       TITLE                 LOCATION      TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This is where appointment definitions are linked to a resource.  


              DD ACCESS: 
              RD ACCESS: 
              WR ACCESS: 
             DEL ACCESS: 
           LAYGO ACCESS: 
           AUDIT ACCESS: 

POINTED TO BY: MULT APPTS MADE field (#.02) of the MULT APPTS MADE sub-field (#409.852) of the SDEC APPT REQUEST File (#409.85) 
               

CROSS
REFERENCED BY: DATE APPT MADE(AC), CANCEL DATETIME(AD), EXTERNAL ID(AEX), RESOURCE(ARSRC), STARTTIME(B), PATIENT(CPAT)

INDEXED BY:    PATIENT & STARTTIME (APTDT)


    LAST MODIFIED: DEC 15,2024@11:59:31

409.84,.01    STARTTIME              0;1 DATE (Required)

              INPUT TRANSFORM:  S %DT="ETXR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      OCT 21, 2014 
              HELP-PROMPT:      Enter a date and time 
              DESCRIPTION:
                                Date and Time this appointment is scheduled to start.  

              CROSS-REFERENCE:  409.84^B 
                                1)= S ^SDEC(409.84,"B",$E(X,1,30),DA)=""
                                2)= K ^SDEC(409.84,"B",$E(X,1,30),DA)

              RECORD INDEXES:   APTDT (#1557)

409.84,.02    ENDTIME                0;2 DATE (Required)

              INPUT TRANSFORM:  S %DT="ETXR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      OCT 21, 2014 
              HELP-PROMPT:      Enter a date and time 
              DESCRIPTION:
                                The date and time that this appointment ended.  


409.84,.03    CHECKIN                0;3 DATE

              INPUT TRANSFORM:  S %DT="ETR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      NOV 03, 2014 
              HELP-PROMPT:      Enter a date and time 
              DESCRIPTION:
                                Date and Time of the Check-In for this appointment.  


409.84,.04    CHECK IN TIME ENTERED  0;4 DATE

              INPUT TRANSFORM:  S %DT="ETR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      NOV 03, 2014 
              HELP-PROMPT:      Enter a date and time 
              DESCRIPTION:
                                Date/Time the Check-In was entered.  


409.84,.05    PATIENT                0;5 POINTER TO PATIENT/IHS FILE (#9000001)

              LAST EDITED:      JAN 10, 2019 
              HELP-PROMPT:      Select a patient 
              DESCRIPTION:
                                This is the patient that this appointment is scheduled for.  

              CROSS-REFERENCE:  409.84^CPAT 
                                1)= S ^SDEC(409.84,"CPAT",$E(X,1,30),DA)=""
                                2)= K ^SDEC(409.84,"CPAT",$E(X,1,30),DA)
                                This xref is used to look up appointments by Patient.  


              RECORD INDEXES:   APTDT (#1557)

409.84,.06    APPOINTMENT TYPE       0;6 POINTER TO APPOINTMENT TYPE FILE (#409.1)

              LAST EDITED:      MAY 22, 2015 
              HELP-PROMPT:      Select an appointment type. 
              DESCRIPTION:
                                This field represents the Appointment Type.  

              TECHNICAL DESCR:
                                This field is a pointer to the APPOINTMENT TYPE file 409.1.  


409.84,.07    RESOURCE               0;7 POINTER TO SDEC RESOURCE FILE (#409.831)

              LAST EDITED:      AUG 12, 2014 
              HELP-PROMPT:      Select a resource 
              DESCRIPTION:
                                This field represents the resource that is scheduled for this appointment.  

              CROSS-REFERENCE:  409.84^ARSRC^MUMPS 
                                1)= D XR2S^SDEC03(DA)
                                2)= D XR2K^SDEC03(DA)
                                This index is used to find all appointments for a given resource during a given time period.  



409.84,.08    DATA ENTRY CLERK       0;8 POINTER TO NEW PERSON FILE (#200)

              LAST EDITED:      AUG 12, 2014 
              HELP-PROMPT:      Select the clerk who entered this appointment. 
              DESCRIPTION:
                                Field contains the ien of the clerk who made the appointment.  


409.84,.09    DATE APPT MADE         0;9 DATE

              INPUT TRANSFORM:  S %DT="EX" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      JAN 26, 2016 
              HELP-PROMPT:      Enter a date 
              DESCRIPTION:
                                Field contains the date the appointment was made.  

              CROSS-REFERENCE:  409.84^AC 
                                1)= S ^SDEC(409.84,"AC",$E(X,1,30),DA)=""
                                2)= K ^SDEC(409.84,"AC",$E(X,1,30),DA)
                                This cross-reference is used to sort SDEC APPOINTMENT entries by the DATE APPOINTMENT MADE field.  



409.84,.1     NOSHOW                 0;10 SET

                                '1' FOR YES; 
                                '0' FOR NO; 
              LAST EDITED:      AUG 12, 2014 
              HELP-PROMPT:      Enter 1 or YES if this appointment was a No-Show. Enter 0 or NO if this appointment was not a 
                                No-Show. 
              DESCRIPTION:
                                Yes/No field indicating this appointment was a No-Show.  


409.84,.101   NOSHOW DATETIME        0;23 DATE

              INPUT TRANSFORM:  S %DT="ETXR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      OCT 21, 2014 
              HELP-PROMPT:      Enter a date and time 
              DESCRIPTION:
                                This is the Date/Time that the No-Show was entered.  


409.84,.102   NOSHOW BY USER         0;24 POINTER TO NEW PERSON FILE (#200)

              LAST EDITED:      OCT 15, 2014 
              HELP-PROMPT:      Select the user that entered the No-Show 
              DESCRIPTION:
                                This is the User that entered the No-Show.  


409.84,.11    REBOOK DATETIME        0;11 DATE

              INPUT TRANSFORM:  S %DT="ETXR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      OCT 21, 2014 
              HELP-PROMPT:      Enter a date and time 
              DESCRIPTION:
                                This the date and time that the rebooking was entered.  


409.84,.12    CANCEL DATETIME        0;12 DATE

              INPUT TRANSFORM:  S %DT="ETXR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      MAR 07, 2016 
              HELP-PROMPT:      Enter cancellation date and time 
              DESCRIPTION:
                                The date/time the cancellation was entered.  

              CROSS-REFERENCE:  409.84^AD 
                                1)= S ^SDEC(409.84,"AD",$E(X,1,30),DA)=""
                                2)= K ^SDEC(409.84,"AD",$E(X,1,30),DA)
                                This cross-reference is used to sort SDEC APPOINTMENT entries by the CANCEL DATETIME field.  



409.84,.121   CANCELLED BY USER      0;21 POINTER TO NEW PERSON FILE (#200)

              LAST EDITED:      OCT 14, 2014 
              HELP-PROMPT:      Select the user who entered this cancellation. 
              DESCRIPTION:
                                This is the user that entered the cancellation.  


409.84,.122   CANCELLATION REASON    0;22 POINTER TO CANCELLATION REASONS FILE (#409.2)

              LAST EDITED:      OCT 14, 2014 
              HELP-PROMPT:      Select a cancellation reason 
              DESCRIPTION:
                                Reason for Cancellation that was selected from the CANCELLATION REASON file 409.2.  


409.84,.13    WALKIN                 0;13 SET

                                'y' FOR YES; 
                                'n' FOR NO; 
              LAST EDITED:      AUG 12, 2014 
              HELP-PROMPT:      Enter y or YES if this is a walk-in appointment. Enter n or NO if this is not a walk-in 
                                appointment. 
              DESCRIPTION:
                                Yes/No field to indicate that this appointment was a Walk-in or adhoc appointment.  


409.84,.14    CHECKOUT               0;14 DATE

              INPUT TRANSFORM:  S %DT="ETXR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      OCT 21, 2014 
              HELP-PROMPT:      Enter checkout date and time 
              DESCRIPTION:
                                CHECKOUT DATE/TIME FOR APPOINTMENT.  


409.84,.15    V PROVIDER IEN         0;15 POINTER TO V PROVIDER FILE (#9000010.06)

              LAST EDITED:      AUG 12, 2014 
              HELP-PROMPT:      Select provider 
              DESCRIPTION:
                                V PROVIDER IEN is the pointer to the V PROVIDER file for the patient.  


409.84,.16    PROVIDER               0;16 POINTER TO NEW PERSON FILE (#200)

              LAST EDITED:      AUG 12, 2014 
              HELP-PROMPT:      Select a provider 
              DESCRIPTION:
                                The primary provider for this appointment.  


409.84,.17    STATUS                 0;17 SET

                                'N' FOR NO-SHOW; 
                                'C' FOR CANCELLED BY CLINIC; 
                                'NA' FOR NO-SHOW & AUTO RE-BOOK; 
                                'CA' FOR CANCELLED BY CLINIC & AUTO RE-BOOK; 
                                'I' FOR INPATIENT APPOINTMENT; 
                                'PC' FOR CANCELLED BY PATIENT; 
                                'PCA' FOR CANCELLED BY PATIENT & AUTO-REBOOK; 
                                'NT' FOR NO ACTION TAKEN; 
              LAST EDITED:      JUN 18, 2015 
              HELP-PROMPT:      Select an appointment status 
              DESCRIPTION:
                                Populated by SDEC CANCEL APPOINTMENT in the event there is an 'undo' of a Cancelled Appointment.  


409.84,.18    LENGTH OF APPT         0;18 NUMBER

              INPUT TRANSFORM:  K:+X'=X!(X>240)!(X<5)!(X?.E1"."1N.N) X
              LAST EDITED:      APR 09, 2024 
              HELP-PROMPT:      Please enter appointment length in minutes between 5 and 240, 0 decimal digits. 
              DESCRIPTION:      This represents the length of this appointment in minutes. This is populated when an appointment is
                                cancelled and is used in the event that the appointment is re-instated.  


409.84,.19    PREV APPT STATUS       0;19 POINTER TO APPOINTMENT STATUS FILE (#409.63)

              LAST EDITED:      AUG 12, 2014 
              HELP-PROMPT:      Select an appointment status 
              DESCRIPTION:      Pointer to APPOINTMENT STATUS file; used to restore status in visit encounter in the event that a
                                user re-instates the appointment after a 'cancel' has been processed.  


409.84,.2     DESIRED DATE OF APPOINTMENT 0;20 DATE

              INPUT TRANSFORM:  S %DT="EX" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      OCT 22, 2014 
              HELP-PROMPT:      Enter the desired date for this appointment. 
              DESCRIPTION:
                                This is the appointment date that is needed/desired.  


409.84,.21    EXTERNAL ID            0;25 FREE TEXT

              INPUT TRANSFORM:  K:$L(X)>50!($L(X)<1) X
              LAST EDITED:      OCT 16, 2014 
              HELP-PROMPT:      Answer must be 1-50 characters in length. 
              DESCRIPTION:
                                This is used to hold an external identifier.  

              CROSS-REFERENCE:  409.84^AEX 
                                1)= S ^SDEC(409.84,"AEX",$E(X,1,30),DA)=""
                                2)= K ^SDEC(409.84,"AEX",$E(X,1,30),DA)
                                Used to lookup the SDEC APPOINTMENT ien using the external ID.  



409.84,.22    APPT REQUEST TYPE      2;1          VARIABLE POINTER

              FILE  ORDER  PREFIX    LAYGO  MESSAGE
             409.3    1    E            y   EWL 
                 123  2    C            y   CONSULT 
             403.5    3    R            y   RECALL 
            409.85    4    A            y   APPT 
                                         
              OUTPUT TRANSFORM: S Y=$S($P(Y,";",2)="SDWL(409.3,":"EWL",$P(Y,";",2)="GMR(123,":"CONSULT",$P(Y,";",2)="SD(403.5,":"RE
                                CALL",$P(Y,";",2)="SDEC(409.85,":"APPT",1:"")
              LAST EDITED:      SEP 10, 2015 
              HELP-PROMPT:      Select from SD WAIT LIST, REQUEST/CONSULTATION, SDEC APPT REQUEST, or RECALL REMINDERS. 
              DESCRIPTION:      This Variable Pointer field holds a pointer to either the SD WAIT LIST file, REQUEST/CONSULTATION
                                file, SDEC APPT REQUEST, or RECALL REMINDERS file.  


409.84,.23    PATIENT STATUS         2;2 SET

                                'N' FOR NEW; 
                                'E' FOR ESTABLISHED; 
              LAST EDITED:      JUN 09, 2015 
              HELP-PROMPT:      Enter N or NEW if the patient is a new patient. Enter E or ESTABLISHED if this patient has been 
                                seen in the past 24 months. 
              DESCRIPTION:      This field represents the status of the patient in regards to being a 'NEW' or 'ESTABLISHED'
                                patient.  An ESTABLISHED patient has been seen within the past 24 months.  


409.84,.24    APPLICATION            2;3 SET

                                'C' FOR CPRS; 
                                'VG' FOR VSE GUI; 
                                'O' FOR OTHER; 
              LAST EDITED:      APR 07, 2021 
              HELP-PROMPT:      Enter the name of the application used to create the appointment in the file. 
              DESCRIPTION:
                                This is the application that was being used when this appointment was created.  

              TECHNICAL DESCR:  This is the application that was being used when this appointment was created and will be used to
                                help determine what system might be responsible for any data issues.  


409.84,.25    VERSION NUMBER         2;4 FREE TEXT

              INPUT TRANSFORM:  K:$L(X)>30!($L(X)<1) X
              MAXIMUM LENGTH:   30
              LAST EDITED:      APR 06, 2021 
              HELP-PROMPT:      Answer must be 1-30 characters in length. 
              DESCRIPTION:
                                This is the version number of the software specified in the APPLICATION (#.24) field.  

              TECHNICAL DESCR:  This is the version number of the software specified in the APPLICATION (#.24) field and will help
                                determine what system and version number might be responsible for any data issues.  


409.84,1      NOTE                   1;0   WORD-PROCESSING #409.841   (IGNORE "|")

              TECHNICAL DESCR:  This field should only be updated using the VSE GUI or ISS applications, and not directly via
                                FileMan.  


                LAST EDITED:      AUG 12, 2014 
                HELP-PROMPT:      Enter the reason for this appointment. 
                DESCRIPTION:
                                  For each entry, this is a line of text for the reason for the appointment.  




409.84,1.1    NOTE AUDITING          NOTEAUD;0 DATE Multiple #409.847 (Add New Entry without Asking)

              LAST EDITED:      SEP 25, 2024 
              DESCRIPTION:      The multiple will audit the NOTE (#409.841) word-processing sub-file by tracking each update
                                including the additional note entered, the date/time it was entered, and the user who had entered
                                the note.  

              TECHNICAL DESCR:  This sub-file should only be updated indirectly using the VSE GUI or ISS applications, and not
                                directly via FileMan.  


409.847,.01     DATE/TIME NOTE ADDED   0;1 DATE

                INPUT TRANSFORM:  S %DT="ET" D ^%DT S X=Y K:Y<1 X
                LAST EDITED:      SEP 30, 2024 
                HELP-PROMPT:      Please enter the date/time the note was added. 
                DESCRIPTION:
                                  The date/time a new note was added to the NOTE (#409.841) word- processing sub-file.  

                CROSS-REFERENCE:  409.847^B 
                                  1)= S ^SDEC(409.84,DA(1),"NOTEAUD","B",$E(X,1,30),DA)=""
                                  2)= K ^SDEC(409.84,DA(1),"NOTEAUD","B",$E(X,1,30),DA)


409.847,1       NOTE ADDED BY          0;2 POINTER TO NEW PERSON FILE (#200)

                LAST EDITED:      SEP 25, 2024 
                HELP-PROMPT:      Please enter the user who had entered the new note. 
                DESCRIPTION:
                                  The DUZ of the user who had added the new note to the NOTE (#409.841) word-processing sub-file.  


409.847,2       NOTE                   0;3 FREE TEXT

                INPUT TRANSFORM:  K:$L(X)>150!($L(X)<3) X
                MAXIMUM LENGTH:   150
                LAST EDITED:      SEP 30, 2024 
                HELP-PROMPT:      Answer must be 3-150 characters in length. 
                DESCRIPTION:
                                  The new note being added to the NOTE (#409.841) word-processing sub-file.  




409.84,2      VVS APPOINTMENT        0;26 FREE TEXT

              INPUT TRANSFORM:  K:$L(X)>60!($L(X)<1) X
              MAXIMUM LENGTH:   60
              LAST EDITED:      APR 16, 2021 
              HELP-PROMPT:      Answer must be 1-60 characters in length. 
              DESCRIPTION:      This is the Video Visit Appointment ID. It is used to link to appointments to the Video Visit
                                Service (VVS).  

              TECHNICAL DESCR:  This Video Visit Appointment ID uniquely identifies the Video Visit Service (VVS) appointment
                                associated with this appointment in the SDEC APPOINTMENT (#409.84) file.  


409.84,2.1    MISSION ACT ELIGIBLE   0;27 SET (BOOLEAN Data Type)

              LAST EDITED:      MAR 10, 2023 
              HELP-PROMPT:      Enter 'YES' if appointment is Mission Act eligible. 
              DESCRIPTION:      This field contains 'YES' if the appointment is a Mission Act appointment.  The field is updated
                                using SDEC APPADD Remote Procedure.  


409.84,3      CHECK-IN STEP STATUS   3;0 POINTER Multiple #409.843 (Add New Entry without Asking)

              DESCRIPTION:      This is a multiple field that will contain the CHECK-IN STEP STATUS information.  This multiple
                                field will hold the current appointment check-in status and the date/time stamp this check-in step
                                status was entered.  

              TECHNICAL DESCR:  The multiple CHECK-IN STEP STATUS field is a pointer into the SDEC CHECK-IN STEP STATUS (#409.842)
                                file.  


409.843,.01     CHECK-IN STEP STATUS   0;1 POINTER TO SDEC CHECK-IN STEP STATUS FILE (#409.842)

                LAST EDITED:      JUN 22, 2021 
                HELP-PROMPT:      Enter a number indicating the status of the PRECHECKIN STATUS. 
                DESCRIPTION:      This field indicates the current pre-check-in status and indicates if the Veterans have completed
                                  the pre-visit questionnaire.  

                TECHNICAL DESCR:  The CHECK-IN STEP STATUS is a pointer into the SDEC CHECK-IN STEP STATUS (#409.842) file that
                                  provides visibility into patients that have started the check-in process.  

                CROSS-REFERENCE:  409.843^B 
                                  1)= S ^SDEC(409.84,DA(1),3,"B",$E(X,1,30),DA)=""
                                  2)= K ^SDEC(409.84,DA(1),3,"B",$E(X,1,30),DA)


409.843,1       DATE/TIME ENTERED      0;2 DATE (Required)

                INPUT TRANSFORM:  S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
                LAST EDITED:      JUN 24, 2021 
                HELP-PROMPT:      Enter a date and time. 
                DESCRIPTION:
                                  This DATE/TIME ENTERED field represents the DATE/TIME that the PRECHECKIN STATUS was entered.  

                TECHNICAL DESCR:
                                  This field holds the date/time that the pre check-in status was entered.  




409.84,4      PATIENT COMMENTS       6;0   WORD-PROCESSING #409.846   (IGNORE "|")


                LAST EDITED:      OCT 11, 2022 
                HELP-PROMPT:      Enter the patient comments. 
                DESCRIPTION:      This field stores patient comments associated with the linked appointment request. When the
                                  appointment is created, the comments residing in the PATIENT COMMENTS (409.85,60) field are
                                  copied into this word processing field.  




409.84,5.1    RECALL REMINDER REMOVED 5;1 POINTER TO RECALL REMINDERS REMOVED FILE (#403.56)

              LAST EDITED:      MAY 31, 2022 
              HELP-PROMPT:      Enter the removed recall reminder. 
              DESCRIPTION:
                                This pointer links the appointment to the recall reminders removed entry.  


409.84,100    EAS TRACKING NUMBER    4;1 FREE TEXT (audited)

              INPUT TRANSFORM:  K:$L(X)>40!($L(X)<1) X
              MAXIMUM LENGTH:   40
              LAST EDITED:      DEC 23, 2021 
              HELP-PROMPT:      Answer must be 1-40 characters in length. 
              DESCRIPTION:      The EAS tracking number originates from the Enterprise Appointment Scheduling system. This number
                                allows actions performed by a proxy user to be traceable back to the end user.  

              AUDIT:            YES, ALWAYS


      FILES POINTED TO                      FIELDS

APPOINTMENT STATUS (#409.63)      PREV APPT STATUS (#.19)

APPOINTMENT TYPE (#409.1)         APPOINTMENT TYPE (#.06)

CANCELLATION REASONS (#409.2)     CANCELLATION REASON (#.122)

NEW PERSON (#200)                 DATA ENTRY CLERK (#.08)
                                  NOSHOW BY USER (#.102)
                                  CANCELLED BY USER (#.121)
                                  PROVIDER (#.16)
                                  NOTE AUDITING:NOTE ADDED BY (#1)

PATIENT/IHS (#9000001)            PATIENT (#.05)

RECALL REMINDERS (#403.5)         APPT REQUEST TYPE (#.22)

RECALL REMINDERS REMOVED 
                   (#403.56)      RECALL REMINDER REMOVED (#5.1)

REQUEST/CONSULTATION (#123)       APPT REQUEST TYPE (#.22)

SD WAIT LIST (#409.3)             APPT REQUEST TYPE (#.22)

SDEC APPT REQUEST (#409.85)       APPT REQUEST TYPE (#.22)

SDEC CHECK-IN STEP STATUS 
                   (#409.842)     CHECK-IN STEP STATUS:CHECK-IN STEP STATUS (#.01)

SDEC RESOURCE (#409.831)          RESOURCE (#.07)

V PROVIDER (#9000010.06)          V PROVIDER IEN (#.15)


File #409.84

  Record Indexes:

  APTDT (#1557)    RECORD    REGULAR    IR    SORTING ONLY
      Short Descr:  Allows lookup of appointments for patient by start time
      Description:  Cross reference on the PATIENT (#.05) and STARTTIME (#.01) fields allowing appointments to be found for a given
                    patient and time range.  
        Set Logic:  S ^SDEC(409.84,"APTDT",$E(X(1),1,30),$E(X(2),1,30),DA)=""
       Kill Logic:  K ^SDEC(409.84,"APTDT",$E(X(1),1,30),$E(X(2),1,30),DA)
       Whole Kill:  K ^SDEC(409.84,"APTDT")
             X(1):  PATIENT  (409.84,.05)  (Subscr 1)  (Len 30)  (forwards)
             X(2):  STARTTIME  (409.84,.01)  (Subscr 2)  (Len 30)  (forwards)


INPUT TEMPLATE(S):

PRINT TEMPLATE(S):
SDEC NULL RESOURCE            MAY 16, 2019@13:21  USER #0                                                   SDEC APPOINTMENT Search

SORT TEMPLATE(S):
SDEC NULL RESOURCE            MAY 07, 2019@10:23  USER #0      RESOURCE NULL
     Searches the appointment file (#409.84) for entries with null resource 
     pointer (#409.831) fields. These are caused by legacy VistA making an
     appointment for a clinic that does not have a matching resource.


FORM(S)/BLOCK(S):