Print Page as PDF
CLINICAL REMINDERS GENERIC EVALUATOR ICR (6772)

CLINICAL REMINDERS GENERIC EVALUATOR    ICR (6772)

Name Value
NUMBER 6772
IA # 6772
DATE CREATED 2017/06/22
CUSTODIAL PACKAGE CLINICAL REMINDERS
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXRMGEV
NAME CLINICAL REMINDERS GENERIC EVALUATOR
GENERAL DESCRIPTION
This integration agreement allows subscribing packages
to execute various components within the Clinical Reminders package, such as
order checks and list rules.

Revision History:
-3/26/25- Effective with patch PXRM*2.0*81, added Reminder Terms as an item
that can be evaluated and made it so multiple list rules can be pass to the
API.
STATUS ['The reminder evaluation status as a', 'string value', 'DUE DATE: The date the reminder is due', 'LAST DONE: The date the reminder evaluation', 'determines as the last time the', 'reminder was completed.', 'The following subscript will only be returned', 'if pass in parameters specified if they', 'should returned.', '^TMP($J,SUB,REMINDER,"PRINT NAME")=', "Reminder's print name (or name if print name", 'is null) ^TMP($J,SUB,REMINDER,"FIEVAL")=', 'Merged copy of the FIEVAL array. ^TMP($J,SUB,REMINDER,"MAINTENANCE",X)=', 'Line X of the maintenance output.', '^TMP($J,SUB,REMINDER,"FINDINGS",COMPONENT REMINDER)=', '"STATUS^DUE DATE^LAST DONE"', 'If REMINDER has the VA-REMINDER DEFINITION', 'computed finding and its SAVETEMP parameter', 'value is 1, then data for the COMPONENT', 'REMINDER that is executed is returned under', 'this node. ^TMP($J,SUB,REMINDER,"FINDINGS",COMPONENT REMINDER,"FIEVAL")=', 'Merged copy of the FIEVAL array for', 'COMPONENT REMINDER that is executed as a', 'finding, where COMPONENT REMINDER is the', 'PRINT NAME of that reminder. ^TMP($J,SUB,REMINDER,"FINDINGS",COMPONENT', 'REMINDER,"MAINTENANCE",X)=', 'Line X of the maintenance output for COMPONENT', 'REMINDER that is executed as a finding, where', 'COMPONENT REMINDER is the PRINT NAME of that', 'reminder.', 'Reminder Terms ^TMP($J,SUB,"TERMS",TERM)=RESULT', 'TERM: The IEN of the entry from file 811.5,', 'or the .01 of the entry from file 811.5. RESULT: 1 for the term', 'applies to the patient', 'or 0 the term does not apply to the', 'patient.', 'The following subscript will only be returned', 'if pass in parameters specified if they', 'should returned.', '^TMP($J,SUB,"TERMS",TERM,"FIEVAL")=Merged copy of', 'the term FIEVAL array. ^TMP($J,SUB,"TERMS",TERM,"DETAIL', 'TEXT",X,0)=Line', 'X of the term.']
KEYWORDS
  • GEV
  • REMINDER ORDER CHECKS
  • REMINDER LIST RULES
DURATION Till Otherwise Agreed
ID PXRMGEV
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
EN(RESULT,PARAMETERS)
This is the main entry point.
VARIABLES TYPE VARIABLES DESCRIPTION
RESULT Both
Reference to a variable that will contain the global
node address of the result global ^TMP($J,SUB) after this component finishes
executing. The value of SUB comes from the PARAMETERS("SUB") node. The result
global has the following format:

^TMP($J,SUB,0)=STATUS^MESSAGE
STATUS: Success or failure. Possible values are
-1 for an error, 0 for no data returned
and 1 for data was returned.
MESSAGE: Error message. This piece is only set
when the STATUS is -1.

Order Checks:
^TMP($J,SUB,ORDER_IEN)=ORQ1^CAP
ORDER_IEN: Internal entry number (IEN) of the
order in the ORDER file (#100).
ORQ1: Data returned from EN^ORQ1 call (refer to
the DETAIL Input variable in integration
agreement #3154 for how this section is
formatted).
CAP: CURRENT AGENT/PROVIDER field (#1) in the
ORDER file (#100), in internal format.
^TMP($J,SUB,ORDER_IEN,"RULES",RULE)=""
RULE: RULE NAME (#.01) field in the REMINDER
ORDER CHECK RULES file (#801.1).
Only rules that evaluate as true for this order
are returned.
^TMP($J,SUB,ORDER_IEN,"GROUPS",GROUP)=""
GROUP: GROUP NAME field (#.01) in the REMINDER
ORDER CHECK ITEMS GROUP file (#801).
Only those groups that contain this order's
orderable item(s) are returned.
^TMP($J,SUB,ORDER_IEN,"TX",LINE)=TEXT
LINE: Line number of text.
TEXT: Order text as returned by the EN^ORQ1
call (refer to the TMP('ORR',$J,ORLIST,i)
Output variable in integration agreement
#3154 for details).
^TMP($J,SUB,ORDER_IEN,"OI",OI)=DATA
OI: IEN of the orderable item in the ORDERABLE
ITEMS file (#101.43).
DATA: Data returned from OIS^ORX8 call (refer
to the OIS component in integration
agreement #2467 for how this section is
formatted).

List Rules:
^TMP($J,SUB,RULE,INSTANCE,DFN)=""
RULE: NAME field (#.01) in the REMINDER LIST
RULE file (#810.4).
INSTANCE: Whole number; allows running of same
list rule set with different
parameters.
DFN: IEN of the patient in the PATIENT file
(#2).
All of the patients that satisfy the rule's
criteria are returned descendant from the RULE
node.
^TMP($J,SUB,RULE,DFN,"DATA",TYPE)=VALUE
TYPE: The second comma-piece of the DATA TYPE
field (#.01) in the DATA field (#1) in
the PATIENTS field (#30) in the REMINDER
PATIENT LIST file (#810.5).
VALUE: The VALUE field (#.02) in the DATA field
(#1) in the PATIENTS field (#30) in the
REMINDER PATIENT LIST file (#810.5).
^TMP($J,SUB,RULE,"PATIENT LIST CREATED")=NAME
NAME: NAME field (#.01) in the REMINDER
PATIENT LIST file (#810.5) for the
patient list that was created.

Reminder Definitions: ^TMP($J,SUB,REMINDER)="STATUS^DUE DATE^LAST DONE"
SUBSCRIBING PACKAGE
DATE ACTIVATED 2025/03/17
REMINDER ['IEN of the entry from file 811.9 or', 'the .01 value of the file entry.']