Print Page as PDF
DBIA2889 ICR (2889)

DBIA2889    ICR (2889)

Name Value
NUMBER 2889
IA # 2889
DATE CREATED 1999/08/16
CUSTODIAL PACKAGE MENTAL HEALTH
CUSTODIAL ISC Dallas
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE YTAPI
NAME DBIA2889
STATUS Active
DURATION Till Otherwise Agreed
ID YTAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
LISTALL 
This API returns all psychological test
administrations for a specified patient during a specified time period. No
scoring is returned.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input 
Internal Entry number for patient name in the PATIENT
file (#2).
BEGIN Input 
Inclusive date in %DT acceptable format (11/11/2011)
to begin search [optional].  Example: YS("BEGIN")="10/01/89"
END Input 
Inclusive date in %DT acceptable format (11/11/2011)
to end search  [optional].  Example: YS("END")="11/11/2011"
YSDATA Output 
Array= internal administration date^external
administration date^test code

Data is sorted in order of most recent administration to the oldest
administration. If no administrations are found Array(2) will not be returned.
If patient has no If patient has no PSYCH INSTRUMENT PATIENT file (#601.2)
data, Array(1) will return [ERROR] with an explanation.  Example:
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
LISTONE 
This API returns all psychological test
administrations for a specified patient during a specified time period for a
specified test.  If a scale is also specified, scoring for that scale is
returned. User must have adequate privileges to receive this information (i.e.
often the YSP KEY).
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input 
This is the Patient's name, a pointer value to the
Patient file #2.
CODE Input 
Test code from the MH INSTRUMENT file (#601) or "ASI"
e.g. "CAGE", "BDI".
BEGIN Input 
Inclusive date in %DT acceptable format (11/11/2011)
to begin search [optional].
END Input 
Inclusive date in %DT acceptable format (11/11/2011)
to end search [optional].
LIMIT Input 
Constrains to the last N administrations [optional]
SCALE Input 
Scale number from the MH INSTRUMENT file (#601) or
1-7 on ASI [optional]
YSDATA Output 
Array= internal administration date ^ external
administration date^test code [^scale name^raw score^transformed score] Data
is sorted in order of most recent administration to the oldest administration.
If no administrations are found Array(2) will not be returned. If patient has
no PSYCH INSTRUMENT PATIENT file (#601.2) data, Array(1) will return [ERROR]
with an explanation.

EXAMPLE: Input
-----
YS("DFN")=83 YS("CODE")=MMPI2 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