CLINICAL REMINDERS GENERIC EVALUATOR    ICR (6772)

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,DFN)=""
RULE: NAME field (#.01) in the REMINDER LIST
RULE file (#810.4).
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.

Reference to an array that contains the input data.
This array has the following format:

For all types:
PARAMETERS("SUB")=SUB
SUB: Name of the subscript in the global
^TMP($J) under which to return data.

For reminder order checks:
PARAMETERS("DFN")=DFN
DFN: IEN of the patient in the PATIENT file
(#2).
PARAMETERS("ROC",ROC)=""
The "ROC" node specifies the group name(s) to
use during the order check. If one of the
orderable item(s) in the list of orders is
contained in one of these groups and at least
one of the rules associated with that group is
applicable, then the order check is generated.
ROC: GROUP NAME field (#.01) in the REMINDER
ORDER CHECK ITEMS GROUP file (#801) OR
"ALL" to specify all groups.

There are two options to identify the orders to
check: the caller can request the API to search
for orders based on criteria specified by the
caller or the caller can identify the orders for
the API.

To search for orders, the following is required
unless otherwise specified:
PARAMETERS("ROC DISPLAY GROUPS",DG)=""
The "ROC DISPLAY GROUPS" node specifies a list
of display group(s) used in searching for
orders.
DG: NAME field (#.01) in the DISPLAY GROUP file
(#100.98).
PARAMETERS("ROC STATUS",STATUS)=""
The "ROC STATUS" node specifies a list of order
status(es) used in searching for orders.
STATUS: NAME field (#.01) in the ORDER STATUS
file (#100.01).
When searching for orders, you may optionally
specify a date range by using one of the
following groups of dates (you can specify both
groups in the same call and both nodes in a group
are required):
GROUP 1:
PARAMETERS("ROC START")=START
START: Date, in internal FileMan format, that
signifies the earliest date for an
order's DATE/TIME ORDERED field (#.01)
value in the ORDER ACTIONS multiple
field (#.8) in the ORDER file (#100).
This date applies to all orders whose
display group parameter does not have
a start date.
PARAMETERS("ROC STOP")=STOP
STOP: Date, in internal FileMan format, that
signifies the latest date for an order's
DATE/TIME ORDERED field (#.01) value in
the ORDER ACTIONS multiple field (#.8) in
the ORDER file (#100). This date applies
to all orders whose display group
parameter does not have a stop date.
GROUP 2:
PARAMETERS("ROC DISPLAY GROUPS",DG,"START")=START
START: Date, in internal FileMan format, that
signifies the earliest date for an
order's DATE/TIME ORDERED field (#.01)
value in the ORDER ACTIONS multiple
field (#.8) in the ORDER file (#100).
This date overrides the value in
PARAMETERS("ROC START") and is only
applicable to orders with the display
group DG.
PARAMETERS("ROC DISPLAY GROUPS",DG,"STOP")=STOP
STOP: Date, in internal FileMan format, that
signifies the latest date for an order's
DATE/TIME ORDERED field (#.01) value in
the ORDER ACTIONS multiple field (#.8) in
the ORDER file (#100). This date
overrides the value in
PARAMETERS("ROC STOP") and is only
applicable to orders with the display
group DG.
PARAMETERS("ROC ORDERED WITHIN")=""
An optional flag that indicates the order's
WHEN ENTERED field (#4) value in the ORDER file
(#100) should fall within the specified date
range.

To identify the orders, the following is
required:
PARAMETERS("ROC ORDERS",ORDER)=""
The "ROC ORDERS" node specifies a list of
orders to execute order checks against.
ORDER: IEN of the order in the ORDER file
(#100).

PARAMETERS("ROC RETURN TYPE",TYPE)=""
Nodes descendant from "ROC RETURN TYPE" specify
the type(s) of data to return.
TYPE: the type of data to return and is one of
the following:
"GROUPS" for group names, which are
returned descendant from
^TMP($J,SUB,ORDER_IEN,"GROUPS")
"RULES" for rule names, which are
returned descendant from
^TMP($J,SUB,ORDER_IEN,"RULES")
"OI" for orderable item IENs, which are
returned descendant from
^TMP($J,SUB,ORDER_IEN,"OI")

For reminder list rules:
PARAMETERS("LR",RULE)=PARAMS
RULE: IEN of the rule in the REMINDER LIST RULE
file (#810.4) to evaluate.
PARAMS: Caret-delimited string ('^') of
parameters for the specified rule's
evaluation:
"PNAME ^ START ^ STOP ^ SECURE ^
OVERWRITE ^ RETURN"
PNAME - Name of the patient list to create in
the PATIENT LIST file (#810.5).
START - Date, in internal FileMan format,
that signifies the earliest date
for rule evaluation.
STOP - Date, in internal FileMan format,
that signifies the latest date for
rule evaluation.
SECURE - Boolean flag indicating how
secure the patient list should
be; 1 for secure (private) and 0
for not secure (public).
OVERWRITE - Boolean flag indicating if an
existing patient list with
the same PNAME should be
overwritten; 1 for overwrite
and 0 for do not overwrite.
RETURN - Boolean flag indicating whether
to return the patients' data
(the DATA field, #1, in the
PATIENTS field, #30, in the
REMINDER PATIENT LIST file,
#810.5) in nodes descendant from
^TMP($J,SUB,RULE,DFN,"DATA"); 1
for return the data and 0 for do
not return the data.