YTAPI10A ICR (4458)

Name

Value

NUMBER

4458

IA #

4458

DATE CREATED

2006/08/03

CUSTODIAL PACKAGE

MENTAL HEALTH

CUSTODIAL ISC

Dallas

USAGE

Private

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

YTAPI10A

NAME

YTAPI10A

STATUS

Active

YTAPI10A

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

OCCUR

This api returns the number of occurrences of a
specific psychological test administered to a specific patient.  The input
parameter is passed in the form of an array named YS.  Output is passed back
in the array ^TMP($J,YSSUB.  To call the API use D OCCUR^YTAPI10A(YSSUB,.YS).

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

The input parameter is passed in an array named YS.
Contained in the array is:
YS("CODE")= IEN of the instrument from the MH INSTRUMENT file (#601)
YS("BEGIN")= The start date to begin the search. Use an inclusive date
in %DT acceptable format (11/11/2011) This variable is
optional.
YS("END")= The finish date to end the search. Use an inclusive date
in %DT acceptable format (11/11/2011) This variable is
optional.
YS("LIMIT")= This is the number of occurences to return.  This variable
is optional.

Example of the YS array:
YS("CODE")=205
YS("BEGIN")="01/01/1990"
YS("END")="12/31/2004"
YS("LIMIT")=10

YSSUB

Output

The output is an array in the format:

^TMP($J,YSSUB,1)=[DATA]^NUMBER FOUND
^TMP($J,YSSUB,DFN,OCCURANCE)=DAS^DFN^TEST

This is an example of the

^TMP(545332100,1) = [DATA]^5 ^TMP(545332100,1,49,1) =
49;1;205;1;2940428^2940428^205 ^TMP(545332100,1,66,1) =
66;1;205;1;2940608^2940608^205 ^TMP(545332100,1,236,1) =
236;1;205;1;3040824^3040824^205 ^TMP(545332100,1,551,1) =
551;1;205;1;2940428^2940428^205 ^TMP(545332100,1,919,1) =
919;1;205;1;2940608^2940608^205

PTTEST

This api returns all psychological test scoring for a
specified patient. The input parameter is passed in the form of an array named
YS.  Output is passed back in the array YSDATA.  To call the API use D
PTTEST^YTAPI10A(.YSDATA,.DAS).  Where YSDATA is the output array and YS  is
the input array parameter.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

The input parameter is passed in an array named YS.
Contained in the array is:
YS("CODE")= IEN of the instrument from the MH INSTRUMENT file (#601)
YS("DFN")= IEN of the patient from the PATIENT file (#2)
YS("BEGIN")= The start date to begin the search. Use an inclusive date
in %DT acceptable format (11/11/2011) This variable is
optional.
YS("END")= The finish date to end the search. Use an inclusive date
in %DT acceptable format (11/11/2011) This variable is
optional.
YS("LIMIT")= This is the number of occurences to return.  This variable
is optional. If this variable is not used, the default is
one occurance returned.

Example of the YS array:
YS("CODE")=205
YS("DFN")=236
YS("BEGIN")="01/01/1990"
YS("END")="12/31/2004"
YS("LIMIT")=10

YSDATA

Output

Output is returned in the array YSDATA.  The array
contains the patient IEN from the PATIENT file (#2), the instrument IEN from
the MH INSTRUMENT file (#601) and the date the instrument was completed from
the PSYCH INSTRUMENT PATIENT file (#601.2) taken from the Clinical Reminder
Index global.

Example #1

YSDATA(1)=[DATA]^1 YSDATA(2)=236;1;205;1;3040824^3040824

Example #2

YSDATA(1)=[DATA]^3 YSDATA(2)=236;1;205;1;3040831^3040831
YSDATA(3)=236;1;205;1;3040826^3040826 YSDATA(4)=236;1;205;1;3040824^3040824

SUBSCRIBING PACKAGE

SUBSCRIBING PACKAGE	ISC
CLINICAL REMINDERS	Salt Lake City