STANDARD DATA DICTIONARY #601.84 -- MH ADMINISTRATIONS FILE                                                       3/24/25    PAGE 1
STORED IN ^YTT(601.84,  *** NO DATA STORED YET ***   SITE: WWW.BMIRWIN.COM   UCI: VISTA,VISTA                     (VERSION 5.01)   

DATA          NAME                  GLOBAL        DATA
ELEMENT       TITLE                 LOCATION      TYPE
-----------------------------------------------------------------------------------------------------------------------------------
The MH ADMINISTRATIONS file (#601.84) contains the data collected during the administration of a specified instrument from the MH
TESTS AND SURVEYS file (#601.71) given to a patient at a specific date and time. For each administration of a specified instrument
from the MH TESTS AND SURVEYS file (#601.71) there will be an entry in this file. 
 
An entry in this file does not store the results of the instrument's administration but is an index to the instrument's
administration. The entry indicates whether the instrument has been completed, who ordered the instrument, how many questions were
answered and if the test has been electronically signed.  


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

POINTED TO BY: ADMINISTRATION ID field (#1) of the MH ANSWERS File (#601.85) 
               ADMINISTRATION field (#1) of the MH RESULTS File (#601.92) 
               

CROSS
REFERENCED BY: TRANSMISSION STATUS(AD), LOCATION(AL), ORDERED BY(AO), ADMINISTRATION NUMBER(B), PATIENT(C)

INDEXED BY:    INSTRUMENT NAME & DATE GIVEN (AC), PATIENT & INSTRUMENT NAME & DATE GIVEN & IS COMPLETE (ACR)


    LAST MODIFIED: SEP 15,2024@20:51:11

601.84,.01    ADMINISTRATION NUMBER  0;1 NUMBER (Required)

              INPUT TRANSFORM:  S:$TR(X,"new","NEW")="NEW" X=$$NEW^YTQLIB(601.84) K:+X'=X!(X>99999999)!(X<1)!(X?.E1"."1N.N) X S:$G(
                                X) DINUM=X
              LAST EDITED:      JUL 19, 2022 
              HELP-PROMPT:      Type a Number between 1 and 99999999, 0 Decimal Digits 
              DESCRIPTION:
                                This is the unique identifier for this administration record. It is the IEN.  

              NOTES:            XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER

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


601.84,1      PATIENT                0;2 POINTER TO PATIENT FILE (#2) (Required)

              LAST EDITED:      AUG 02, 2005 
              DESCRIPTION:      Pointer to the NAME field (#.01) of the PATIENT file (#2). This specifies the patient attached to
                                this specific administration.  

              CROSS-REFERENCE:  601.84^C 
                                1)= S ^YTT(601.84,"C",$E(X,1,30),DA)=""
                                2)= K ^YTT(601.84,"C",$E(X,1,30),DA)

              RECORD INDEXES:   ACR (#731)

601.84,2      INSTRUMENT NAME        0;3 POINTER TO MH TESTS AND SURVEYS FILE (#601.71) (Required)

              LAST EDITED:      AUG 02, 2005 
              DESCRIPTION:      A pointer to NAME field (#.01) of the MH TESTS AND SURVEYS file (#601.71), it specifies a
                                particular instrument.  

              RECORD INDEXES:   AC (#730), ACR (#731)

601.84,3      DATE GIVEN             0;4 DATE

              INPUT TRANSFORM:  S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      AUG 02, 2005 
              DESCRIPTION:
                                This is the date the patient started the instrument.  

              RECORD INDEXES:   AC (#730), ACR (#731)

601.84,4      DATE SAVED             0;5 DATE

              INPUT TRANSFORM:  S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      MAY 02, 2003 
              DESCRIPTION:
                                Date last edited, ie last time test was worked on for this administration.  


601.84,5      ORDERED BY             0;6 POINTER TO NEW PERSON FILE (#200)

              LAST EDITED:      MAR 24, 2005 
              DESCRIPTION:
                                User who ordered the test.  

              CROSS-REFERENCE:  601.84^AO 
                                1)= S ^YTT(601.84,"AO",$E(X,1,30),DA)=""
                                2)= K ^YTT(601.84,"AO",$E(X,1,30),DA)


601.84,6      ADMINISTERED BY        0;7 POINTER TO NEW PERSON FILE (#200)

              LAST EDITED:      MAY 02, 2003 
              DESCRIPTION:
                                Clerk who actually entered the information or started the patient in front of the computer.  


601.84,7      SIGNED                 0;8 SET

                                'Y' FOR Yes; 
                                'N' FOR No; 
              LAST EDITED:      JAN 27, 2004 
              DESCRIPTION:
                                Has administration been signed by the orderer or administrator.  


601.84,8      IS COMPLETE            0;9 SET

                                'Y' FOR Yes; 
                                'N' FOR No; 
              LAST EDITED:      JAN 25, 2006 
              DESCRIPTION:
                                Boolean specifying if test is complete.  

              RECORD INDEXES:   ACR (#731)

601.84,9      NUMBER OF QUESTIONS ANSWERED 0;10 NUMBER

              INPUT TRANSFORM:  K:+X'=X!(X>9999)!(X<0)!(X?.E1"."1N.N) X
              LAST EDITED:      MAY 02, 2003 
              HELP-PROMPT:      Type a Number between 0 and 9999, 0 Decimal Digits 
              DESCRIPTION:      The number of answers entered. If less than in MH Instrument CONTENT for this instrument, it is
                                incomplete.  


601.84,10     COMMENTS               1;0   WORD-PROCESSING #601.841

              DESCRIPTION:
                                Place for orderer or administrator to make free text comments.  


                LAST EDITED:      MAY 02, 2003 



601.84,11     TRANSMISSION STATUS    2;1 SET

                                'S' FOR Successfully added to db; 
                                'T' FOR Transmitted, not yet added; 
                                'E' FOR Error; 
              LAST EDITED:      JAN 19, 2006 
              DESCRIPTION:
                                Used to indicate success or failure in transmission to the Mental Health National DataBase.  

              CROSS-REFERENCE:  601.84^AD 
                                1)= S ^YTT(601.84,"AD",$E(X,1,30),DA)=""
                                2)= K ^YTT(601.84,"AD",$E(X,1,30),DA)


601.84,12     TRANSMISSION TIME      2;2 DATE

              INPUT TRANSFORM:  S %DT="ESTX" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      JAN 18, 2012 
              DESCRIPTION:
                                Time of last transmission status.  


601.84,13     LOCATION               0;11 POINTER TO HOSPITAL LOCATION FILE (#44)

              LAST EDITED:      MAR 24, 2005 
              HELP-PROMPT:      Enter a Hospital Location 
              DESCRIPTION:      Associates an administration to a Hospital Location. Pointer to the NAME field (#.01) of the
                                HOPSITAL LOCATION file (#44).  

              CROSS-REFERENCE:  601.84^AL 
                                1)= S ^YTT(601.84,"AL",$E(X,1,30),DA)=""
                                2)= K ^YTT(601.84,"AL",$E(X,1,30),DA)


601.84,14     SCORING REVISION       0;12 NUMBER

              INPUT TRANSFORM:  K:+X'=X!(X>999)!(X<0)!(X?.E1"."1N.N) X
              LAST EDITED:      SEP 26, 2017 
              HELP-PROMPT:      Type a number between 0 and 999, 0 decimal digits. 
              DESCRIPTION:      This field contains the revision level of the scoring fields/routines when the administration was
                                last scored.  This is used to indicate if the instrument needs to be re-scored due to updates/fixes
                                to scoring for the instrument.  


601.84,15     ENTRY SOURCE           0;13 POINTER TO MH ADMINISTRATION SOURCE FILE (#601.844)

              LAST EDITED:      APR 23, 2020 
              HELP-PROMPT:      Enter the source used to administer this instrument. 
              DESCRIPTION:      This provides information about which mechanism was used to create the administration. 
                                Applications may add new mechanisms as they are detected.  For example, entry sources might be
                                'ipad' or 'kiosk'.  


601.84,16     SUICIDE RISK           0;14 SET

                                '0' FOR NONE; 
                                '1' FOR POSITIVE RESPONSE; 
                                '2' FOR HIGH RISK; 
                                '3' FOR BOTH HIGH RISK & POSITIVE RESPONSE; 
                                '9' FOR EXPIRED; 
              LAST EDITED:      SEP 22, 2021 
              HELP-PROMPT:      Enter an integer value from 0 to 3 or 9 if expired. 
              DESCRIPTION:      Suicide Risk for this instrument administration. 0 or blank is no risk, 1 is a Positive Response, 2
                                is High Risk, and 3 is both High Risk and Positive Response.  


601.84,17     CONSULT                0;15 POINTER TO REQUEST/CONSULTATION FILE (#123)

              LAST EDITED:      JUN 04, 2020 
              HELP-PROMPT:      Select a consult (if any) to associate with this test. 
              DESCRIPTION:      This field contains a consult number from the Request/Consultation file (#123).  It is used to find
                                the progress note associated with the consult.  

              TECHNICAL DESCR:  The consult number is used to navigate to the TIU RESULT NARRATIVE field (#16) in the
                                REQUEST/CONSULTATION file (#123).  See IA #3162.  
                                 
                                It also indicates whether a regular progress note or a consult note should be created for the
                                instrument administration.  


601.84,18     SAVED BY               0;16 POINTER TO NEW PERSON FILE (#200)

              LAST EDITED:      JUN 10, 2022 
              HELP-PROMPT:      Enter the user who is signed-in when the administration is saved. 
              DESCRIPTION:
                                This is the current user at the time the administration record is saved.  

              TECHNICAL DESCR:  Since ORDERED BY and ADMINISTERED BY may be selected as someone other than the current user, this
                                field saves the current user (DUZ).  This allows one to determine who last saved the
                                administration, should that be needed for debugging or auditing purposes.  


601.84,19     REVIEWED               0;17 SET (BOOLEAN Data Type)

              LAST EDITED:      MAY 14, 2024 
              HELP-PROMPT:      Enter YES if the administration has been reviewed by a clinician, or NO if it has not. 
              DESCRIPTION:
                                This field is set to YES if a clinician has reviewed the administration.  



      FILES POINTED TO                      FIELDS

HOSPITAL LOCATION (#44)           LOCATION (#13)

MH ADMINISTRATION SOURCE 
                   (#601.844)     ENTRY SOURCE (#15)

MH TESTS AND SURVEYS (#601.71)    INSTRUMENT NAME (#2)

NEW PERSON (#200)                 ORDERED BY (#5)
                                  ADMINISTERED BY (#6)
                                  SAVED BY (#18)

PATIENT (#2)                      PATIENT (#1)

REQUEST/CONSULTATION (#123)       CONSULT (#17)


File #601.84

  Record Indexes:

  AC (#730)    RECORD    REGULAR    IR    SORTING ONLY
      Short Descr:  Instrument by Date
        Set Logic:  S ^YTT(601.84,"AC",X(1),X(2),DA)=""
       Kill Logic:  K ^YTT(601.84,"AC",X(1),X(2),DA)
       Whole Kill:  K ^YTT(601.84,"AC")
             X(1):  INSTRUMENT NAME  (601.84,2)  (Subscr 1)  (forwards)
             X(2):  DATE GIVEN  (601.84,3)  (Subscr 2)  (forwards)

  ACR (#731)    RECORD    MUMPS    IR    ACTION
      Short Descr:  Clincal Reminders Index
        Set Logic:  D SMH^YTQPXRM(.X,.DA)
         Set Cond:  S X=$S(X(4)="Y":1,1:0)
       Kill Logic:  D KMH^YTQPXRM(.X,.DA)
        Kill Cond:  S X=$S(X(4)="Y":1,1:0)
       Whole Kill:  K ^PXRMINDX(601.84)
             X(1):  PATIENT  (601.84,1)  (forwards)
             X(2):  INSTRUMENT NAME  (601.84,2)  (forwards)
             X(3):  DATE GIVEN  (601.84,3)  (forwards)
             X(4):  IS COMPLETE  (601.84,8)  (forwards)


INPUT TEMPLATE(S):

PRINT TEMPLATE(S):

SORT TEMPLATE(S):

FORM(S)/BLOCK(S):