DBIA 4811 ICR (4811)

Name

Value

NUMBER

4811

IA #

4811

DATE CREATED

2005/10/26

CUSTODIAL PACKAGE

CLINICAL REMINDERS

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

PXRMMHV

NAME

DBIA 4811

GENERAL DESCRIPTION

This integration agreement describes the Clinical
Reminders APIs developed for use by My HealtheVet.

STATUS

Active

KEYWORDS

Clinical Reminders
My HealtheVet

DURATION

Till Otherwise Agreed

PXRMMHV

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

MHVC(DFN)

This entry point returns the combined MHV summary and
MHV detailed output for an individual patient.

VARIABLES

TYPE

VARIABLES DESCRIPTION

DFN

Input

The patient DFN.

~TMP

Output

Output is returned in ^TMP("PXRMMHVC",$J,RIEN) where
RIEN is the internal entry number of the reminder definition (file #811.9).
The evaluation status is returned in
^TMP("PXRMMHVC",$J,RIEN,"STATUS")=STATUS^DUE DATE^LAST DONE DATE

The detailed output is returned in
^TMP("PXRMMHVC",$J,RIEN,"DETAIL",L)=TEXT line L

where L is the line number.

The summary text is returned in ^TMP("PXRMMHVC",$J,RIEN,"SUMMARY",L)=TEXT line
L

The caller should kill ^TMP("PXRMMHVC",$J) once it has finished processing it.

~TMP

Output

Output is returned in ^TMP("PXRMMHVC",$J,RIEN)
where RIEN is the internal entry number of the reminder
definition (file #811.9).

The evaluation status is returned in
^TMP("PXRMMHVC",$J,RIEN,"STATUS")=STATUS^DUE DATE^LAST DONE DATE

The detailed output is returned in
^TMP("PXRMMHVC",$J,RIEN,"DETAIL",L)=TEXT line L

where L is the line number.

The summary text is returned in
^TMP("PXRMMHVC",$J,RIEN,"SUMMARY",L)=TEXT line L

The caller should kill ^TMP("PXRMMHVC",$J) once they have finished processing
it.

PREMLIST

This entry point returns a list of all the active
clinical reminders that have been written for use by patients. A reminder is
marked as a patient reminder when it contains a "P" is the USAGE field.

VARIABLES

TYPE

VARIABLES DESCRIPTION

~TMP

Output

Output is returned in
^TMP("PXRMMHVL",$J,RIEN)=NAME^PRINT NAME^CLASS

where RIEN is the internal entry number of the reminder definition, (file
#811.9), NAME is the reminder name (field 811.9, .01),  PRINT NAME is the
print name (field 811.9, 1.2), and CLASS is the reminder class (field 811.9,
100).

The caller should kill ^TMP("PXRMMHVL",$J) once they have finished processing
it.

WEBALL

This entry point returns the web site information for
all active patient reminders.

VARIABLES

TYPE

VARIABLES DESCRIPTION

~TMP

Output

Output is returned in ^TMP("PXRMMHVW",$J,RIEN,"WEB");
the format is:
^TMP("PXRMMHVW",$J,RIEN,"WEB",N,"URL")=URL
^TMP("PXRMMHVW",$J,RIEN,"WEB",N,"TITLE")=TITLE
^TMP("PXRMMHVW",$J,RIEN,"WEB",N,"DESCRIPTION",1)=TEXT line L

where RIEN is the internal entry number of the reminder definition (file
#811.9), N is the nth web site defined for this reminder, URL is the web site
URL, TITLE is the web site title, L is the lth line of the description.

The caller should kill ^TMP("PXRMMHVW",$J) once they have finished processing
it.

WEBI(RIEN,NODE)

This API returns the web site information for an
individual reminder.

VARIABLES

TYPE

VARIABLES DESCRIPTION

RIEN

Input

This is the internal entry number of the reminder
definition (file #811.9).

NODE

Input

NODE is the subscript of ^TMP where the output will
be returned, i.e., ^TMP(NODE,$J).

~TMP

Output

The output is returned in ^TMP(NODE,$J,RIEN,WEB); the
format is;
^TMP(NODE,$J,RIEN,"WEB",N,"URL")=URL
^TMP(NODE,$J,RIEN,"WEB",N,"TITLE")=TITLE
^TMP(NODE,$J,RIEN,"WEB",N,"DESCRIPTION",L)=TEXT line L

where RIEN is the internal entry number of the reminder definition (file
#811.9), N is the nth web site defined for this reminder, URL is the web site
URL, TITLE is the web site title, L is the lth line of the description.

The caller should kill ^TMP(NODE,$J) once they have finished processing it.

SUBSCRIBING PACKAGE