Print Page as PDF
WV APIS FOR CLINICAL REMINDERS ICR (6776)

WV APIS FOR CLINICAL REMINDERS    ICR (6776)

Name Value
NUMBER 6776
IA # 6776
DATE CREATED 2017/06/26
CUSTODIAL PACKAGE WOMEN'S HEALTH
USAGE Private
TYPE Routine
ROUTINE WVRPCGF1
NAME WV APIS FOR CLINICAL REMINDERS
GENERAL DESCRIPTION
This provides a list of APIs used by the Clinical
Reminder packages for procedure tracking from the Women's Veterans files in
CPRS, effective with CPRS 31.B, patches WV*1.0*24 and PXRM*2.0*45 for SMART
alert functionality.


STATUS Pending
KEYWORDS WVRPCGF1
DURATION Till Otherwise Agreed
ID WVRPCGF1
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
GETTEST
This entry point returns the text of a Women's Health
procedure in a local variable. It also returns the primary diagnosis as a pass
by reference variable.

VARIABLES TYPE VARIABLES DESCRIPTION
WVIEN Input
This variable is the record IEN from WV PROCEDURE
file, file #790.1.

TEXT Output
This variable returns the text of a WV PROCEDURE file
entry in an a local array format of TEXT(n)="text".

DIAG Output
This variable returns the output text from
RESULT/DIAGNOSIS field from the WV PROCEDURE file entry.

$$NEXTPROC
This entry point returns the patients next procedure
name and date it is due based from the WV PATIENT file, file $790.

The result return is based off the procedure type pass to the entry point.

The output is returned as a string PROCEDURE NAME^PROCEDURE DATE



VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
The patient DFN from file 2.

TYPE Input
This value determines which fields to return from
file #790:

BR: for Breast Treatment   (returns fields BR TX NEED^BR TX NEED DUE DATE) CX:
for Cervical Treatment (returns fields CX TX NEED^CX TX NEED DUE DATE)


GETWVP
This entry report returns an array of text to the
calling application. The array of text contains a subset of fields from file
WV PROCEDURE file, file #790.1 and WV NOTIFICATION file, file *790.4.

VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
The patient DFN from file #2.

ITEM Input
The record IEN from file 790.1.

TEXT Output
TEXT is a local array pass by reference it returns
the text output in the format TEXT(n)="TEXT".


VIEWDATA
This entry point is used by Clinical Reminders to
display different text reports when the user requests to view the output text
type in a Clinical Reminder Dialog in CPRS.

VARIABLES TYPE VARIABLES DESCRIPTION
DATA Input
DATA is an array of strings by package file entry,
file number, an integer value.

DATA("WOMEN"S HEALTH",790.1,n)=STRING

Where string contains the following fields

SUBSCRIPT^VALUE^PROMPT IEN^SUBSCRIPT

Based off the subscript fields and the value field, this API determines which
text report to send back to the calling application.


PAT Input
PAT is the patient DFN from file #2.

FINDVAL Input
FINDVAL is a colon delimited string of record IEN
from the WV PROCEDURE file, file #790.1.

RESULT Output
RESULT is a local array that returns the different
text reports back to the calling application in the following format
TEXT(n)="TEXT".


SUBSCRIBING PACKAGE CLINICAL REMINDERS