Print Page as PDF
NOTIFICATIONS API ICR (6341)

NOTIFICATIONS API    ICR (6341)

Name Value
NUMBER 6341
IA # 6341
DATE CREATED 2016/01/06
CUSTODIAL PACKAGE ORDER ENTRY/RESULTS REPORTING
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE ORBSMART
NAME NOTIFICATIONS API
GENERAL DESCRIPTION
This integration agreement allows subscribing packages
access to notification-related entry points.

REVISION: 10/2/23 - Added line tag EN
STATUS Active
KEYWORDS NOTIFICATION IEN
DURATION Till Otherwise Agreed
ID ORBSMART
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GETNOTID(ORNOTNM)
This entry point returns the internal entry number
(IEN) of the selected notification in the OE/RR NOTIFICATIONS file.
VARIABLES TYPE VARIABLES DESCRIPTION
ORNOTNM Input
The name of the notification.
$$GETNOTID Output
The IEN of the selected notification. If the
notification does not exist, an empty string is returned.
OUTSMALRT
Clear out a SMART that is being processed and in the
^TMP("ORSMART CURRENT ALERT")
EN
This entry point is used to determine to clear an
alert or to create a new entry in the SCHEDULED ALERT file, file# 100.97.
VARIABLES TYPE VARIABLES DESCRIPTION
ORDATA Input
This passed by reference defines the action the entry
point EN takes with the passed in data. The format for the ORDATA array is:
ORDATA("DATA",FN)="" where FN is the file number can be set to either 100.9 or
100.97.

Structure of ORDATA where FN = 100.9 ORDATA("DFN")=DFN, where DFN is the
patient DFN from file 2 ORDATA("DATA",100.9,"MASTER ID")=ID where ID is the
entry ID for the alert.  ORDATA("DATA",100.9,ID,.01)=IEN is the notification
IEN from file 100.9 ORDATA("DATA",100.9,ID,"ACTION")=ACTION where action is
one of the following values: CLEAR PROVIDER = clear all instance of the
notification IEN for the patient for the current user CLEAR ALL = clear all
instance of the notification IEN for the patient for all users.  CLEAR ONE =
only clear the single instance of the notification based off the XQAID value
associated with the alert for all user

Structure of ORDATA where FN =100.97 ORDATA("DFN")=DFN is the patient DFN from
file 2 ORDATA("DATA",100.97,"+1,",2)=WHEN is the FileMan date/time when the
scheduled alert should be fired ORDATA("DATA",100.97,"+1,",5)=TITLE is the
free text value that should appear in the alert
ORDATA("DATA",100.97,"+1,",6)=BODY is the free text value that should appear
in CPRS
ORY Output
ORY(1)=SUCCESS where success is either a 1 or 0
SUBSCRIBING PACKAGE
DATE ACTIVATED 2023/10/02