Print Page as PDF
CLINICAL REMINDERS APIs ICR (2182)

CLINICAL REMINDERS APIs    ICR (2182)

Name Value
NUMBER 2182
IA # 2182
DATE CREATED 1998/01/14
CUSTODIAL PACKAGE CLINICAL REMINDERS
CUSTODIAL ISC Salt Lake City
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXRM
NAME CLINICAL REMINDERS APIs
STATUS Active
KEYWORDS CLINICAL REMINDERS
DURATION Till Otherwise Agreed
ID PXRM
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
MAIN(DFN,PXRMITEM,OUTTYPE,DISC)
This is the standard entry point for reminder
evaluation. The current date and time are used for the evaluation date and
time.

VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
Pointer to Patient file (#2)
PXRMITEM Input
Internal entry number of Clinical Reminder definition
(file #811.9)

OUTTYPE Input
This is the type of output to return. The possible
values are:
0 - Reminders DUE NOW only (CLINICAL REMINDERS DUE HS component)
1 - All Reminders with Next and Last Information
(CLINICAL REMINDERS SUMMARY HS component)
5 - Health Maintenance (CLINICAL REMINDERS MAINTENANCE HS component)
10 - MyHealtheVet summary
11 - MyHealtheVet detailed
12 - MyHealtheVet combined


DISC Input
(optional)  If this variable is true then the
disclaimer will be loaded in ^TMP("PXRM",$J,"DISC")
TMP Output
The results of the reminder evaluation are returned
in

^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM)

where PXRMRNAM is the PRINT NAME or if it is undefined then it is the NAME.
The format is:

^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM)=STATUS^DUE DATE^LAST D0NE DATE

and

^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM,"TXT",N)=TEXT

where N is a number and TEXT is a text string. The text returned depends on
the output type (OUTTYPE) and the results of the reminder evaluation.

If DISC is true then the disclaimer will be loaded into
^TMP("PXRM",$J,"DISC"). It contains the disclaimer.

The caller should kill both ^TMP("PXRHM",$J) and ^TMP("PXRM",$J) after display
of the data is complete.


FIDATA(DFN,PXRMITEM,.FINDINGS)
Return the finding evaluation array to the caller in
the array FINDINGS. The caller should use the form:

D FIDATA^PXRM(DFN,PXRMITEM,.FINDINGS)

The elements of the FINDINGS array will correspond to the findings in the
reminder definition.  For finding N, FINDINGS(N) will be 0 if the finding is
false and 1 if it is true.  For true findings there will be additional
elements.  The exact set of additional elements will depend on the type of
finding.  Some examples are:
FINDINGS(N)=1
FINDINGS(N,"DATE")=FileMan date
FINDINGS(N,"FINDING")=variable pointer to the finding
FINDINGS(N,"SOURCE")=variable pointer to the data source
FINDINGS(N,"VALUE")=value of the finding, for example the value of a lab test


$$INACTIVE(PXRMITEM)
VARIABLES TYPE VARIABLES DESCRIPTION
$$INACTIVE(PXRMITEM) Output
Return the INACTIVE FLAG
1 - reminder is inactive
0 - reminder is active
MAINDF(DFN,PXRMITEM,OUTTYPE,EVALDT)
This entry point is used for reminder evaluation. The
date and time to use for the evaluation is an input parameter. The finding
evaluation array is returned in ^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM). See below
for details.


VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
Pointer to Patient file (#2)

PXRMITEM Input
Internal entry number of Clinical Reminder definition
(file #811.9)


OUTTYPE Input
This is the type of output to return. The possible
values are:
0 - Reminders DUE NOW only (CLINICAL REMINDERS DUE HS component)
1 - All Reminders with Next and Last Information
(CLINICAL REMINDERS SUMMARY HS component)
5 - Health Maintenance (CLINICAL REMINDERS MAINTENANCE HS component)
10 - MyHealtheVet summary
11 - MyHealtheVet detailed
12 - MyHealtheVet combined

EVALDT Input
This is the FileMan date and time to use for the
reminder evaluation.


TMP Output
The results of the reminder evaluation are returned
in

^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM)

where PXRMRNAM is the PRINT NAME or if it is undefined then it is the NAME.
The format is:

^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM)=STATUS^DUE DATE^LAST DONE DATE and

^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM,"TXT",N)=TEXT

where N is a number and TEXT is a text string. The text returned depends on
the output type (OUTTYPE) and the results of the reminder evaluation.

The finding evaluation array (FIEVAL) is returned in:

^TMP("PXRHM",$J,"PXRMITEM,"FIEVAL")

A description of the contents of FIEVAL can be found in the Clinical Reminders
Managers Manual.

The caller should kill both ^TMP("PXRHM",$J) and ^TMP("PXRM",$J) after display
of the data is complete.




SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC SUBSCRIBING DETAILS
HEALTH SUMMARY Salt Lake City
AUTOMATED INFO COLLECTION SYS Albany
ORDER ENTRY/RESULTS REPORTING Salt Lake City
LAB SERVICE Dallas
SCHEDULING
VA POINT OF SERVICE (KIOSKS)
WOMEN'S HEALTH
HEALTH MANAGEMENT PLATFORM
HMP's subscription to this ICR expired on 10/27/17 with
the shutdown of HMP.  HMP*2.0*12 released on 10/17/17 is an informational
patch outlining the steps for the sites to shut down the application.

If HMP is reactivated in the future, the HMP project team should review the
access provided by this ICR with the custodial application before reactivating
HMP's subscription to this ICR.
DATE ACTIVATED 2012/06/27