Print Page as PDF
ORDER CHECK INSTANCES API ICR (5729)

ORDER CHECK INSTANCES API    ICR (5729)

Name Value
NUMBER 5729
IA # 5729
DATE CREATED 2011/10/03
CUSTODIAL PACKAGE ORDER ENTRY/RESULTS REPORTING
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE OROCAPI1
NAME ORDER CHECK INSTANCES API
GENERAL DESCRIPTION
This integration agreement allows subscribing packages
to save data into and retrieve data from the ORDER CHECK INSTANCES file
(#100.05).
STATUS Active
DURATION Till Otherwise Agreed
ID OROCAPI1
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
SAVEOC(ORL,RET)
Create one or more new entries.
VARIABLES TYPE VARIABLES DESCRIPTION
ORL Input
Array of new entries to create.

Data Format:
NOTE: Unless specified otherwise, pass in all
fields in internal format.

ORL(COUNT,1)=Caret-delimited string
COUNT - number that starts at one and increments
by one for each subsequent new entry
Caret-delimited string:
Piece   Stored in Field
==================================================
1       ORDER (#.01)
2       OCCURRENCE (#2)
3       USER (#3)
4       OCCURRENCE DATE/TIME (#4)
5       ORDER CHECK (#5)
6       CLINICAL DANGER LEVEL (#6) (optional)

ORL(COUNT,2)
Nodes descendant from this node are stored in
the ORDER CHECK MESSAGE field (#8).
COUNT - number that starts at one and increments
by one for each subsequent new entry
Descendant nodes are FileMan word-processing
field type compatible.  Refer to FileMan
documentation for WP^DIE for details on how to
structure the descendant nodes.

ORL(COUNT,3)=TEXT
COUNT - number that starts at one and increments
by one for each subsequent new entry
TEXT - stored in the OVERRIDE REASON (#7) field
RET Input
A reference to the array in which to return the new
entries' internal entry number (IEN).

Data Format:
RET(COUNT,IEN)=""
COUNT - corresponds to the COUNT node in the
ORL input parameter (the IEN is for
the ORL(COUNT) entry).
IEN - IEN of the new entry
TMP GLOBAL Input
Nodes descendant from ^TMP("OROCIDATA",$J,CRC16) are
stored (optional).

Data Format:
NOTE: Unless specified otherwise, pass in all
fields in internal format.
$J - ID number of the current process
CRC16 - Cyclic Redundancy Code (CRC) of the order
check message. Use integration control
registration #3156 XLFCRC to compute this
node.

^TMP("OROCIDATA",$J,CRC16,100.05,84)=DATABASE
field (#84)

^TMP("OROCIDATA",$J,CRC16,100.517,COUNT,FIELD)=VALUE
COUNT - number that starts at one and increments
by one for each subsequent new entry in
the DRUG ALLERGIES field (#17)
FIELD - number of the field to store data in.
Refer to the ^ORD(100.05,D0,4,D1 global
reference section in integration control
registration #5731 ORDER CHECK INSTANCES
FILE - DRUG ALLERGIES for valid field
numbers.
VALUE - the data to store

^TMP("OROCIDATA",$J,CRC16,"CLASS",COUNT,EIEN)=DATA
COUNT - corresponds to the COUNT node in the
^TMP("OROCIDATA",$J,CRC16,100.517,COUNT,
FIELD) input parameter.
EIEN - a plus-sign character followed by a
number that starts at two and increments
by one followed by a comma.
NOTE: The number must be unique across
the "CLASS", "INGREDIENT", and
"SIGN" nodes. There cannot be a
"+2," value for "CLASS",
"INGREDIENT", and "SIGN".
DATA - VA DRUG CLASS sub-field (#.01) in the VA
DRUG CLASSES sub-field (#3)

^TMP("OROCIDATA",$J,CRC16,"INGREDIENT",COUNT,EIEN
)=DATA
COUNT - corresponds to the COUNT node in the
^TMP("OROCIDATA",$J,CRC16,100.517,COUNT,
FIELD) input parameter.
EIEN - a plus-sign character followed by a
number that starts at two and
increments by one followed by a comma.
NOTE: The number must be unique across
the "CLASS", "INGREDIENT", and
"SIGN" nodes. There cannot be a
"+2," value for "CLASS",
"INGREDIENT", and "SIGN".
DATA - DRUG INGREDIENT sub-field (#.01) in the
DRUG INGREDIENTS sub-field (#4)

^TMP("OROCIDATA",$J,CRC16,"SIGN",COUNT,EIEN)=DATA
COUNT - corresponds to the COUNT node in the
^TMP("OROCIDATA",$J,CRC16,100.517,COUNT,
FIELD) input parameter.
EIEN - a plus-sign character followed by a
number that starts at two and
increments by one followed by a comma.
NOTE: The number must be unique across
the "CLASS", "INGREDIENT", and
"SIGN" nodes. There cannot be a
"+2," value for "CLASS",
"INGREDIENT", and "SIGN".
DATA - SIGN/SYMPTOM sub-field (#.01) in the
SIGNS/SYMPTOMS sub-field (#5)
GETOC1(IEN,RET)
Return data for a specific order check instance.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
IEN of the entry in the ORDER CHECK INSTANCES file
(#100.05) to return data for.
RET Output
A reference to the array in which to return the
entry's data.

Data Format:
RET(IEN,0)=Value of ^OR(100.05,IEN,0)

RET(IEN,1)=Value of ^OR(100.05,IEN,1)
NOTE: The first caret piece is a semi-colon
delimited string. The first semi-colon
piece is the external format of the
first caret piece of ^OR(100.05,IEN,1).
The second semi-colon piece is the
first caret piece of ^OR(100.05,IEN,1)
(internal format).

RET(IEN,"OC")
Nodes descendant from this node are from the
ORDER CHECK MESSAGE field (#8).

RET(IEN,"OR")
Nodes descendant from this node are from the
OVERRIDE REASON field (#7).

RET(IEN,"OI",OIEN,0)=Caret delimited string
OIEN - number that starts at one and increments
by one for each subsequent orderable item
Caret delimited string:
Piece   Value
==================================================
1       NAME field (#.01) in the ORDERABLE
ITEMS file (#101.43)
2       ID field (#2) in the ORDERABLE ITEMS
file (#101.43)
GETOC2(ORD,RET)
Return all ORDER CHECK INSTANCES file IENs for a
specific entry in the ORDERS file (#100).
VARIABLES TYPE VARIABLES DESCRIPTION
ORD Input
IEN in the ORDERS file (#100).
RET Output
A reference to the array in which to return the data.

Data Format:
RET(ORD,IEN)=""
ORD - corresponds to the ORD input parameter
IEN - IEN of the ORDER CHECK INSTANCES file
entry
GETOC3(ORD,OCC,RET)
Return all ORDER CHECK INSTANCES file IENs for a
specific order/occurrence pair.
VARIABLES TYPE VARIABLES DESCRIPTION
ORD Input
IEN in the ORDERS file (#100).
OCC Input
OCCURRENCE field (#2) value.
RET Output
A reference to the array in which to return the data.

Data Format:
RET(ORD,IEN)=""
ORD - corresponds to the ORD input parameter
IEN - IEN of the ORDER CHECK INSTANCES file
entry
GETOC4(ORD,RET)
Return data for all order check instances for a
specific entry in the ORDERS file (#100).
VARIABLES TYPE VARIABLES DESCRIPTION
ORD Input
IEN in the ORDERS file (#100).
RET Output
A reference to the array in which to return data.

Data Format:
RET(ORD,IEN)=""
ORD - corresponds to the ORD input parameter
IEN - IEN of the ORDER CHECK INSTANCES file
entry

RET(ORD,IEN,"DATA")
Nodes descendant from this node are the same
nodes that are descendant from the RET(IEN)
array returned by the GETOC1(IEN,RET)
component.
GETOC5(ORD,OCC,RET)
Return data for all order check instances for a
specific order/occurrence pair.
VARIABLES TYPE VARIABLES DESCRIPTION
ORD Input
IEN in the ORDERS file (#100).
OCC Input
OCCURRENCE field (#2) value.
RET Output
A reference to the array in which to return data.

Data Format:
RET(ORD,IEN)=""
ORD - corresponds to the ORD input parameter
IEN - IEN of the ORDER CHECK INSTANCES file
entry

RET(ORD,IEN,"DATA")
Nodes descendant from this node are the same
nodes that are descendant from the RET(IEN)
array returned by the GETOC1(IEN,RET)
component.
SUBSCRIBING PACKAGE
DATE ACTIVATED 2016/07/28