YS*5.01*53 (2690)    BUILD (9.6)

Name Value
NAME YS*5.01*53
DATE DISTRIBUTED 2000-01-13 00:00:00
PACKAGE FILE LINK MENTAL HEALTH
TYPE SINGLE PACKAGE
ALPHA/BETA TESTING NO
DESCRIPTION OF ENHANCEMENTS
Seven new Psychological Testing APIs/RPCs have been developed to allow reading 
       one new file MH MULTIPLE SCORING (#601.6).  This file allows the
Array(6)=S1^Scale Name^Raw Score^Transformed Score
Array(7)=S2^ Scale Name^Raw Score^Transformed Score
And onward as needed.

Example: 
Input
-----
YS("DFN")=83
YS("CODE")=MMPI2
YS("ADATE")=05/09/1994
       user to score multiple instruments.

Output
------
YSDATA(1)=[DATA]
YSDATA(2)=CAPP,ANDY W^MMPI2^--- Minnesota Multiphasic Personality Inventory-2 --
-^2940509^05/09/1994^CAULFIELD,MARY A
YSDATA(3)=R1^TTTFTTFTTTFTTFFFFFFTTFFFFFFFTFFFFFFFFFFFFFFFFFFFFFFTFFFFFFFFFFFFFFF
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFTTTTTTFFFFFFFFFFFFFFFFFFFFFFFFFFFFFTTTTFFFTTFFFFFF
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
YSDATA(4)=R2^FFFFFFFFFFFFFFFFFFFFFFFFFTTTTTTTTTTTTTTTTFFFFFFFFFFFFFFFFFFFFFFFFFF

FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFTTT
YSDATA(5)=R3^TTTTTTTTTTTTTTTTTTTTTTTFFFFFFFFFFFFFFFFFFFFTTFFFTFTFTFTFTFTFTFTFTFF
FTFTFTFTFTFTFTFTFTFTFTFTTFTFTFTFFFFTFFTFTFTFTFTFTFFTFTFTFTFTFFFFFFFFFFFFFFFFFFFF
FFFFFFFFFFFFFFFFFFFF
YSDATA(6)=S1^L Lie^12^87
YSDATA(7)=S2^F Infrequency^19^95
.
.
.
       eleven new routines YSGAFAPI, YSMTI, YSMTI0, YSMTI1, YSMTI3
YSDATA(89)=S84^Ma-S Hypomania, Subtle^10^50


4. SAVEIT
      RPC: YTAPI SAVEIT
       M: SAVEIT^YTAPI1
This API allows saving of patient responses to a test or interview in the
PSYCH INSTRUMENT PATIENT file (#601.2). The patient ien, the test code,
and administration date is required along with the responses. All responses
are checked for validity. No scoring is returned but successful addition
       YSMTI4, YSMTI5, YTAPI, YTAPI1, YTAPI2 and YTAPI3.
to the PSYCH INSTRUMENT PATIENT file (#601.2) is indicated.
               
Input: 
     DFN : Patient internal identifier
     CODE: Test code from file 601 or "ASI" e.g. "CAGE", "BDI"
    ADATE: Inclusive administration date in %DT acceptable format (11/11/2011)
    Staff: DUZ of professional ordering the test
       R1: String of patient responses 1-200
       R2: String of patient responses 201-400 [as needed]
       R3: String of patient responses 401-600 [as needed]


Output:
Array(1)=[DATA] indicates successful call

Example:
Input
-----
YS("DFN")=6
YS("ADATE")="T"
YS("CODE")="ZUNG"
       one new option Multiple Psych Testing [YT MTI] displays history of
YS("STAFF")=67
YS("R1")="12121212121212121212"

Output
------
YSDATA(1)=[DATA]
YSDATA(2)=saved 


5. SHOWIT
       psychological testing for an individual patient.
      RPC: YTAPI SHOWIT
        M: SHOWIT^YTAPI3

This API returns the text, bottom, introduction and possible correct 
responses for a specified test item in MH INSTRUMENT file (#601). It will
work only for tests as opposed to interviews or batteries. The ASI is
not supported.
               
Input: 
     CODE: Test code from in the MH INSTRUMENT file (#601) e.g. "CAGE", "BDI"

     ITEM: A positive whole number between 1 and the highest item number
           for the specified test.

Output:
Array(1)=[DATA] ;indicates successful  call
Array(2)=MMPI2 item: 1 ;SECOND LINE IS TEST CODE AND ITEM NUMBER
Array(3)=[BEGIN ITEM]; BEGINS EACH ITEM
Array(4)=MMPI2^1 ;CODE^ITEM NUMBER
Array(5)=[INTRO];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT
Array(12)=[TEXT];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT

Array(14)=[BOTTOM];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT
Array(18)=[RESPONSE];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT
Array(21)=[END ITEM]; ENDS EACH ITEM

Example:
Input
-----
YS("CODE")="MMPI2"
YS("ITEM")=1

and saving of psychological testing data. This data normally resides in the 
Documentation for APIs and RPCs
Output
------
YSDATA(1)=[DATA]
YSDATA(2)=[BEGIN ITEM]
YSDATA(3)=MMPI2^1
YSDATA(4)=[INTRO]
YSDATA(5)=Please read each statement carefully and decide whether it is true
YSDATA(6)=as applied to you or false as applied to you.
YSDATA(7)= 
YSDATA(8)=If a statement is true or mostly true, as applied to you, answer 'T'.
-------------------------------
YSDATA(9)=If a statement is false or not usually true, as applied to you, 
answer
YSDATA(10)='F'.
YSDATA(11)= 
YSDATA(12)=Remember to give your own opinion of yourself.
YSDATA(13)=[TEXT]
YSDATA(14)=I like mechanics magazines.
YSDATA(15)=[BOTTOM]
YSDATA(16)=T= True
YSDATA(17)=F= False
1. LISTALL
YSDATA(18)=Answer= 
YSDATA(19)=[RESPONSE]
YSDATA(20)=TFX
YSDATA(21)=[END ITEM]


6. SHOWALL
       RPC: YTAPI SHOWALL
         M: SHOWALL^YTAPI3

       RPC: YTAPI LISTALL
This API returns the text, bottom, introduction and possible correct 
responses for all items in a test in the MH INSTRUMENT file (#601). It
will work only for tests as opposed to interviews or batteries.
The ASI is not supported.
               
Input: 
     CODE: Test code from the MH INSTRUMENT file (#601).  e.g. "CAGE", "BDI"

Output:
Array(1)=[DATA] ;indicates successful  call
         M: LISTALL^YTAPI
Array(2)=MMPI2 item: 1 ;SECOND LINE IS TEST CODE AND ITEM NUMBER
Array(3)=[BEGIN ITEM]; BEGINS EACH ITEM
Array(4)=MMPI2^1 ;CODE^ITEM NUMBER
Array(5)=[INTRO];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT
Array(12)=[TEXT];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT
Array(14)=[BOTTOM];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT
Array(18)=[RESPONSE];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT
Array(21)=[END ITEM]; ENDS EACH ITEM
.
.
This API returns all psychological test administrations for a specified 
.
Array(1003)=[BEGIN ITEM]; BEGINS EACH ITEM
Array(1004)=MMPI2^567 ;CODE^ITEM NUMBER
Array(1005)=[INTRO];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT
Array(1012)=[TEXT];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT
Array(1014)=[BOTTOM];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT
Array(1018)=[RESPONSE];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT
Array(1021)=[END ITEM];ENDS EACH ITEM

Example:
patient during a specified time period. No scoring is returned.
Input
-----
YS("CODE")="MMPI2"
YS("ITEM")=1

Output
------
YSDATA(1)=[DATA]
YSDATA(2)=[BEGIN ITEM]
YSDATA(3)=MMPI2^1
               
YSDATA(4)=[INTRO]
YSDATA(5)=Please read each statement carefully and decide whether it is true
YSDATA(6)=as applied to you or false as applied to you.
YSDATA(7)= 
YSDATA(8)=If a statement is true or mostly true, as applied to you, answer 
'T'.
YSDATA(9)=If a statement is false or not usually true, as applied to you, 
answer
YSDATA(10)='F'.
YSDATA(11)= 
Input: 
YSDATA(12)=Remember to give your own opinion of yourself.
YSDATA(13)=[TEXT]
YSDATA(14)=I like mechanics magazines.
YSDATA(15)=[BOTTOM]
YSDATA(16)=T= True
YSDATA(17)=F= False
YSDATA(18)=Answer= 
YSDATA(19)=[RESPONSE]
YSDATA(20)=TFX
YSDATA(21)=[END ITEM]
      DFN : Patient internal identifier
.
.
.
YSDATA(6950)=[BEGIN ITEM]
YSDATA(6951)=MMPI2^567
YSDATA(6952)=[INTRO]
YSDATA(6953)=[TEXT]
YSDATA(6954)=Most married couples don't show much affection for each other.
YSDATA(6955)=[BOTTOM]
YSDATA(6956)=T= True
PSYCH INSTRUMENT PATIENT file (#601.2) for patient responses and the
     BEGIN: Inclusive date in %DT acceptable format (11/11/2011) 
YSDATA(6957)=F= False
YSDATA(6958)=Answer= 
YSDATA(6959)=[RESPONSE]
YSDATA(6960)=TFX
YSDATA(6961)=[END ITEM]


7. GAFHX
     RPC: YS GAF API
       M: GAFHX^YSGAFAPI
            to begin search [optional]

This API returns the GAF scores for a specified patient. It can be 
constrained by both date range and occurrence limit. Please note that data 
for this API comes from the DIAGNOSTIC RESULTS - MENTAL HEALTH file (#627.8).

Input: 
      DFN: Patient internal identifier
    BEGIN: Inclusive date in %DT acceptable format (11/11/2011) 
           to begin search [optional]
      END: Inclusive date in %DT acceptable format (11/11/2011) 
       END: Inclusive date in %DT acceptable format (11/11/2011) 
           to end search  [optional]
    LIMIT: Constrains to the last N diagnoses [optional]

Output:
Array(1)=[DATA] ;indicates successful  call
Array(1)=GAF Score^Internal Date^External Date^Provider^Comment
.
.
Array(N)=GAF Score^Internal Date^External Date^Provider^Comment

            to end search  [optional]
Example:
Input
-----
YS("DFN")=29601
YS("LIMIT")=3

Output
------
YSDATA(1)=[DATA]
YSDATA(2)=100^2981209.1105^12/09/1998@11:05^DEVLIN,MARK^

YSDATA(3)=99^2981209.092^12/09/1998@09:20^DEVLIN,MARK^
YSDATA(4)=66^2981124.1406^11/24/1998@14:06^DEVLIN,MARK^


  Associated NOIS:   None
   
     Test Site(s):   Bay Pines Test LAB
                     Tuscaloosa, AL
                     West Palm Beach, FL
                     
Output:
   
   ROUTINE SUMMARY:
   ================
   The second line of the routine now looks like:
  
   <tab>   ;;5.01;MENTAL HEALTH;**[patch list]**;Dec 30, 1994
  
                               Checksum Values
  
   Routine Name       Before Patch        After Patch         Patch List
Array= internal administration date^external administration date^test code 
   ------------       ------------        -----------         ----------
   YSGAFAPI               N/A                 1326501         53
   YSMTI                  N/A                 9401597         53
   YSMTI0                 N/A                 3775566         53
   YSMTI1                 N/A                 8825610         53
   YSMTI3                 N/A                 6387181         53
   YSMTI4                 N/A                13759340         53
   YSMTI5                 N/A                 8420657         53
   YTAPI                  N/A                 9153058         53
   YTAPI1                 N/A                 3410744         53
Data is sorted in order of most recent administration to the oldest
   YTAPI2                 N/A                 6279046         53
   YTAPI3                 N/A                 4047466         53
  
  
  
   Installation Instructions:
   ==========================
  
   1. Use the 'INSTALL/CHECK MESSAGE' option on the PackMan menu.
      This option will load the KIDS package in this message onto your
administration. If no administrations are f,ound Array(2) will not be 
      system.

   2. The patch has now been loaded into a Transport global on your
      system. You now need to use KIDS to install the Transport global.
      On the KIDS menu, under the 'Installation' menu, use the
      following options:
  
                 Print Transport Global
                 Compare Transport Global to Current System
                 Verify Checksums in Transport Global
returned. If patient has no PSYCH INSTRUMENT PATIENT file (#601.2) data,
                 Backup a Transport Global
  
   3. Users may remain on the system, but installation should be done at
      off peak hours.
  
   4. Installation will take less than five minutes. 
  
   5. From the 'Installation Menu' of the KIDS menu, run the option 
      'Install Package(s)' Select the package 'YS*5.01*53' and proceed
      with install.
MH INSTRUMENT file (#601) for test and interviews.  In addition, the
an error will be returned.

   6. If you do not intend to queue the installation to run after normal
      business hours, then answer "NO" to the following prompt:
    
      Want KIDS to Rebuild Menu Trees Upon Completion of Install? YES// NO
    
      If you answer "YES", then the installation will require much more 
      than 5 minutes to run due to the menu rebuild process.

   7. When prompted 'Want to DISABLE Scheduled Options, Menu Options,

      and Protocols? YES//', respond  NO.
Example:
Input
-----
YS("DFN")=6
YS("BEGIN")="10/01/89"
YS("END")="06/08/1999"

Output
APIs/RPCs retrieve ADDICTION SEVERITY INDEX data found in the ADDICTION
------
YSDATA(1)=[DATA]  
YSDATA(2)=2901120^11/20/1990^AOR
YSDATA(3)=2900730^07/30/1990^ALCO
YSDATA(4)=2900730^07/30/1990^HX2
YSDATA(5)=2900730^07/30/1990^MROS
YSDATA(6)=2900730^07/30/1990^PSOC
YSDATA(7)=2900730^07/30/1990^TRMT


SEVERITY INDEX file (#604) and Global Assessment of Functioning (GAF) data
2. LISTONE
       RPC: YTAPI LISTONE
         M: LISTONE^YTAPI
an error will be returned.

Example: 
Input
-----
YS("DFN")=83
YS("CODE")=MMPI2
found in the DIAGNOSTIC RESULTS - MENTAL HEALTH file (#627.8).
YS("SCALE")=2

Output
------
YSDATA(1)=[DATA]
YSDATA(2)=2940509^05/09/1994^MMPI2^F Infrequency^19^95
YSDATA(3)=2920925^09/25/1992^MMPI2^F Infrequency^26^116
YSDATA(4)=2920924^09/24/1992^MMPI2^F Infrequency^25^113



3. SCOREIT
       RPC: YTAPI SCOREIT
         M: SCOREIT^YTAPI2
This API returns all scoring information for a specified patient given a 
specified administration date for a specified test or instrument.  User 
must have adequate privileges to receive this information (i.e. often the 
YSP KEY).
       
Input: 
      DFN : Patient internal identifier
This patch contains:
      CODE: Test code from MH INSTRUMENT file (#601) or "ASI"
            e.g. "CAGE", "BDI"
     ADATE: Inclusive administration date in %DT acceptable format (11/11/2011)

Output:
Array(2)= Patient Name^Test Code^Test Title^Internal Admin date^External 
Admin Date ^Ordered by
Array(3)=R1^Responses 1-200 undelimited
Array(4)=R2^ Responses 201-400 undelimited (even if less than 200)
Array(5)=R3^ Responses 401-600 undelimited
TRACK PACKAGE NATIONALLY YES
FILE
  • UPDATE THE DATA DICTIONARY:   YES
    SEND SECURITY CODE:   YES
    SEND FULL OR PARTIAL DD:   FULL
    RESOLVE POINTERS:   NO
    DATA COMES WITH FILE:   YES
    SITE'S DATA:   OVERWRITE
    MAY USER OVERRIDE DATA UPDATE:   NO
BUILD COMPONENTS
  • ENTRIES:
    • YT MTI
      ACTION:   SEND TO SITE
  • ENTRIES:
    • YTAPI LISTALL
      ACTION:   SEND TO SITE
    • YTAPI LISTONE
      ACTION:   SEND TO SITE
    • YTAPI SAVEIT
      ACTION:   SEND TO SITE
    • YTAPI SCOREIT
      ACTION:   SEND TO SITE
    • YTAPI SHOWALL
      ACTION:   SEND TO SITE
    • YTAPI SHOWIT
      ACTION:   SEND TO SITE
    • YS GAF API
      ACTION:   SEND TO SITE
  • ENTRIES:
    • YTAPI
      ACTION:   SEND TO SITE
      CHECKSUM:   B19764806
    • YSMTI4
      ACTION:   SEND TO SITE
      CHECKSUM:   B19348256
    • YSMTI5
      ACTION:   SEND TO SITE
      CHECKSUM:   B12163284
    • YSGAFAPI
      ACTION:   SEND TO SITE
      CHECKSUM:   B2305393
    • YTAPI1
      ACTION:   SEND TO SITE
      CHECKSUM:   B5646251
    • YTAPI2
      ACTION:   SEND TO SITE
      CHECKSUM:   B16567326
    • YTAPI3
      ACTION:   SEND TO SITE
      CHECKSUM:   B7774096
    • YSMTI
      ACTION:   SEND TO SITE
      CHECKSUM:   B16384688
    • YSMTI0
      ACTION:   SEND TO SITE
      CHECKSUM:   B6160997
    • YSMTI1
      ACTION:   SEND TO SITE
      CHECKSUM:   B17173726
    • YSMTI3
      ACTION:   SEND TO SITE
      CHECKSUM:   B9252592