Print Page as PDF
REMINDER EXCHANGE APIs ICR (4371)

REMINDER EXCHANGE APIs    ICR (4371)

Name Value
NUMBER 4371
IA # 4371
DATE CREATED 2004/02/25
CUSTODIAL PACKAGE CLINICAL REMINDERS
CUSTODIAL ISC Salt Lake City
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXRMEXSI
NAME REMINDER EXCHANGE APIs
GENERAL DESCRIPTION 
This describes the Reminder Exchange Utility APIs that
can be used to transport and install Reminder Exchange file (#811.8) entries
as part of a KIDS build. ICR #5687 allows subscribing packages to transport
Reminder Exchange file entries using KIDS.

The subscribing package should create a routine, referred to as ROUTINE in the
descriptions below, with an entry point referred to as ENTRY. The purpose of
this routine is to build a list of Reminder Exchange file entries that are to
be transported and installed.

The entry point should have the following arguments:

ENTRY(MODE,ARRAY)

Where MODE can be "I" for include in the build and "A" for install action. The
APIs documented below will set MODE to the appropriate value. ARRAY is the
name of an array that contains the list of Reminder Exchange File entries.
You need the following for each Reminder Exchange entry you want to include:

S LN=LN+1
S ARRAY(LN,1)="NAME"
I MODE["I" S ARRAY(LN,2)="DATE/TIME"
I MODE["A" S ARRAY(LN,3)=ACTION

LN is a counter, ARRAY(LN,1) is the name of the entry, ARRAY(LN,2) is the
date/time the entry was created (these can be cut and pasted from the Exchange
File display), ARRAY(LN,3) is the install action. These are single letter
codes such as install ("I"), merge ("M"), and overwrite ("O"). For example,

I MODE["A" S ARRAY(LN,3)="M"

If you would like the number of Reminder Exchange file entries that are going
to be installed to be displayed during the KIDS install, include the following
in ENTRY^ROUTINE after the list of Reminder Exchange file entries has been
populated:

I MODE="IA" D BMES^XPDUTL("There are "_LN_" Reminder Exchange entries to be
installed.")
STATUS Active
KEYWORDS
  • REMINDER EXCHANGE
  • KIDS
DURATION Till Otherwise Agreed
ID PXRMEXSI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
DELEXE 
Usage:
DELEXE^PXRMEXSI("ENTRY","ROUTINE")

This should be called from the pre-init to clean out all previous versions of
the Reminder Exchange file entries.
VARIABLES TYPE
ENTRY Input
ROUTINE Input
EXFINC 
Usage: $$EXFINC^PXRMEXSI(Y,"ENTRY","ROUTINE")

This is used as a data screen in the KIDS build to determine which Exchange
File entries will be included in the build. The data screen for #811.8 should
be

I $$EXFINC^PXRMEXSI(Y,"ENTRY","ROUTINE")
VARIABLES TYPE
Y Input
ENTRY Input
ROUTINE Input
SMEXINS 
Usage: D SMEXINS^PXRMEXSI("ENTRY","ROUTINE")

This should be included in the post-init and will install all the Reminder
Exchange file entries in the list.
VARIABLES TYPE
ENTRY Input
ROUTINE Input
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC SUBSCRIBING DETAILS
TEXT INTEGRATION UTILITIES Salt Lake City 
Using to install reminder exchange file entries for
exporting TIU Document Definitions.
HEALTH SUMMARY
MENTAL HEALTH 
Mental Health is using the Reminder Exchange system to
update Reminder Dialog entries related to the PCL-5 mental health instrument.
DATE ACTIVATED 2013/05/23