This file contains a description of all of the interfaces with other packages. The form will invoke the proper interface routines by doing a lookup on this file and then calling the routine by indirection. The Data will be exchanged between the encounter form utilities and other packages by putting the data in at @IBARY. Interfaces that pass a single value or record will will reference data as in: S DATA=@IBARY. Interfaces that pass lists of records or values will reference the data as in: S DATA=@IBARY@(). Note that multiple entries in this file can have the same entry points into routines. This is for efficiency purposes. For example, patient name, DOB and sex are all located on the same node of the Patient file. Each of these items of data can have its own entry in the Package Interface file, but by using the same entry point there is a savings because all of the data on that node can be obtained at once. The routine that invokes the entry points keeps track of those already invoked so that they are not repeated.
.01name(+)0;1FREE TEXTB The name of the Package Interface. The name should be preceded with the namespace of the package.
.02entry point0;2FREE TEXT The entry point in the routine that should be called.
.03routine0;3FREE TEXT The routine that should be called.
.04custodial package0;4FREE TEXTCThis is a free text pointer to the package file. It serves only to document the custodial package of the data.
.05variable data?0;5BOOLEAN0:NO
This field is used in the batch printing of encounter forms. The purpose is to avoid recomputing fields whose data does not change from patient to patient.
.06action type(+)0;6SET OF CODES1:INPUT
Enter 1 for INPUT if the interface accepts data input from the user and transmits the data to the appropriate package. Enter 2 for DISPLAY if the interface retrieves data for display to a form. Enter 3 for SELECTION if the interface is for building a list to display to a form. Enter 4 if the interface is for printing a report. If the ACTION TYPE is SELECTION then the data type must be a record and the first piece must be the ID use to uniquely identify the selection.
Only applies to selection or display interfaces, both of which retrieve data for display to a form. It is the type of format the data should be in. A single value is a string without pieces. A record is a set of strings concatenated together with "^" separating the pieces. A list is an indefinite number of values, each numbered, each containing the same type of information. A word processing data type will be in FM format. If the ACTION TYPE is SELECTION then the data type must be record.
.08print complete0;8BOOLEAN0:NO
This field is used to determine what should happen if the data does not fit in the space allocated to it on the form. If answered YES the data will be printed on another page.
.09available? (y/n)(+)0;9BOOLEAN0:NO
This field should be set to YES if the interface is available, NO if it is not available. Interfaces that are not available are not called.
.1health summary?0;10BOOLEAN0:NO
This field will determine how to go about printing the report or form. It applies only to Package Interfaces of ACTION TYPE = PRINT REPORT. Health Summaries use the field HEALTH SUMMARY to determine the type of Health Summary to print. The process of printing Health Summaries dos not use the fields ENTRY POINT or ROUTINE, since all Health Summaries are printed in the same way.
.11type of health summary0;11POINTER142 This identifies the Health Summary that should be printed when this Package Interface is invoked. It should be null unless the HEALTH SUMMARY? field #.1 is coded YES.
.12toolkit member?0;12BOOLEAN0:NO
Package Interfaces that are developed for national use will be documented as being part of the toolkit.
.13package interface for input0;13POINTER357.6Used to map scanned data to DHCP.
.14dynamic selections0;14BOOLEAN0:NO
This is used to indicate whether the interface is used to build selection lists at print time.
.15do not use dfn as a subscript0;15BOOLEAN0:NO
Originally, the patient DFN was used as a subscript when returning data for Package Interfaces of type output, but not for other types of interfaces. It is no longer necessary for any new Package Interface to use DFN as a subscript, but, to maintain compatibilty, output routines must set this field to YES if DFN is not to be used as a subscript. This field has no effect on other types of interfaces.
.16allowed object use0;16FREE TEXTThis field applies only to package interfaces for input and is used to determine which package interfaces a particular type of form object may point to. Some combinations don't make sense. For example, it would not make sense to allow a multiple choice question to point to vitals, which is used to input data such as temperature and blood pressure.
.17ask for additional narrative0;17BOOLEAN0:NO
Enter whether users should be prompt for specifying the provider narrative that will be sent to PCE (and problem list) when creating a selection list. If this is answered no and the narrative is sent to PCE then the text as it appears on the form will be used as the provider narrative. Generally only dianosis and clinical lexicon entries will want this field set to Yes.
.18ask for clinical lexicon0;18BOOLEAN0:NO
If this field is answered 'Yes' then users who are editing or creating selection lists based on this interface will be asked to map each entry (thought it is optional) to a clinical lexicon entry. This is highly recommended for user who are scanning diagnosis entries and trying to add entries to the Patients Problem list. The primary purpose of this field is to allow sites who have built selection lists using the ICD9 Diagnosis file to map each entry to the clinical lexicon. The Problem List EP has recommended that each problem added to the problem list be associated with a clinical lexicon entry.
.19dq required0;19BOOLEAN1:YES
Field used to determine if a data qualifier is required for this input interface.
.2ask for clinical reminders0;20BOOLEAN0:NO
If this package interface is for display of clinical reminders answer yes, otherwise answer no.
.21ask for cpt modifiers?0;21BOOLEAN0:NO
ASK FOR CPT MODIFIERS field will be used when selecting CPT codes. If answered "YES" and data is a procedure, CPT Modifiers should be asked during Forms Design and Manual Data Entry.
.22icd coding system0;22POINTER80.4This field is used to indicate the ICD coding system that should be used for the package interface.
1description1;0WORD-PROCESSINGShould describe the data being exchanged by the package interface.
2.01piece 1 descriptive name2;1FREE TEXT Should be a descriptive name of the first field in the record returned by the interface.
2.02piece 1 maximum length2;2NUMERIC The maximum length of the first field of the record returned by the interface.
2.16piece 1 recommended header2;16FREE TEXTThe recommended header will be used as the default when designing a form.
2.17is piece 1 displayable?2;17BOOLEAN0:NO
This is used only for selection type interfaces. If NO, then the value can not be displayed to the encounter form. The first piece must contain the unique id of the selection.
2.18export selections/choices?2;18BOOLEAN0:NO
Applies to selection and input routines. Determines whether selections appearing on selection lists and choices in a multiple choice field will be exported along with the form that they appear on. The import/export utility will not resolve pointers, so if the id used by the package interface is a pointer that differs between sites this field should contain NO.
3user lookup3;1FREE TEXT This field is used to create a KWIC index for this file. The purpose is to assist the user in locating the package interface he needs to display a particular item of data to a form.
4.01entry action4;E1,245FREE TEXT This code will be executed after the PROTECTED VARIABLES are newed, but before the interface routine is called.
5.01exit action5;E1,245FREE TEXT This code will be executed after the interface routine is called. The effect of the NEW done on the PROTECTED VARIABLES is still in effect.
6protected local variables6;0MULTIPLE357.66 This is a list of variables that should be newed before the entry action or calling the interface routine. It is protection against interfaces that alter or kill variables, or entry actions that do so. Note that REQUIRED VARIABLES should not also be PROTECTED VARIABLES. If an interface routine changes a required variable, however, there is a way to protect it. Supposing, for example, DFN is killed by the interface. This will protect it: PROTECTED VARIABLE: IBDFN ENTRY ACTION: S IBDFN=DFN EXIT ACTION: S DFN=IBDFN
7required local variables7;0MULTIPLE357.67 The interface may require inputs. This field is a list of the required local variables. The interface will not be called unless the variables are determined to exist.
9pce dim input transform9;E1,245FREE TEXTUsed to transform X, the identifier stored with the form object, to the form that should be passed to the PCE Device Interface Module. It may, for example, transform a code to an ien.
10help text10;1FREE TEXTThis should provide some help to the user who is trying to enter a value associated with a bubble.
11validator11;E1,245FREE TEXTThis field is used to validate codes currently on a form. The variable X should be set to the identifier that was returned by the Package Interface. For selection interfaces, the identifier is always piece 1 of the 0 node of the entry in the selection list. Xecuting this field will result in X being killed if the value is not valid. This is used by the maintanance utility, for example, to find CPT codes that have been inactivated.
12.01pce dim node12;1FREE TEXTThe node used to pass the data to PCE, using the PCE DEVICE INTERFACE MODULE.
12.02pce dim piece, value12;2NUMERICThe piece in the PXCA node used to pass the input value.
12.03pce dim piece, narrative12;3NUMERICThe piece in the PCXA node used to pass the text displayed on the form.
12.04pce dim piece, header12;4NUMERICThe piece on the node specified by the PCE DIM that the header is mapped to.
12.05pce dim piece, data qualifier12;5NUMERICThe piece of the PXCA node where the data modifier belongs.
12.06pce dim piece, quantity12;6NUMERICAn entry in this field indicates which piece of the array the quantity should be passed on when sending data to PCE.
13allowable qualifiers13;0MULTIPLE357.613This mulitiple contains the list of qualifiers that may apply to the data.
14pce dim output transform14;E1,245FREE TEXTThis transform should set Y, the value to be passed to the PCE Device Interface Module (DIM), to a value that is suitable for display. It may, for example, change an ien to a code.
15data description15;0MULTIPLE357.615For interfaces that return records, this multiple stores information on the fields, other than the first field.
16.1allow input of narrative?16;1SET OF CODESn:NO
For selection interfaces, this field determines whether a narrative is allowed by the PCE Generic Device Interface.
16.2narrative data type16;2POINTER359.1This determines, among other things, how much space to allocate for the narrative.
16.3narrative header16;3FREE TEXTUsed to label the narrative field.
16.5allow input of primary value?16;5SET OF CODESn:NO
For selectin interfaces this determines whether a value, other than a narrative, can be entered.
16.6primary value data type16;6POINTER359.1For selection interfaces this determines, among other things, the data type of the value to be entered.
16.7primary value header16;7FREE TEXTUsed to label the primary value field.
16.8allow multipliers16;8BOOLEAN1:YES
For selection interfaces, this determines whether 'quantity' should be asked at form development time to pass multiple occurrences of a selection to PCE.
16.9allow input of multiple codes?16;9BOOLEAN1:YES
Enter a one in this field if the users will be allowed to add more than one code to pass along to PCE when one entry is bubbled. Data in this field REQUIRES that field 17 be populated with mumps code that will allow selection of the code if the entry is edited.
17selector17;E1,245FREE TEXTThis field only applies to input interfaces. It is executed as by an input transform when creating a multiple choice field. It should: 1) Kill X if an nothing is selected, otherwise set X to a value suitable for display, perhaps the code. 2) Set IBLABEL to a suitable label for the choice. 3) Set IBID to an identifier. The identifier should ideally be exportable, meaning the same from site to site. This usually means a coded value rather than an ien. The identfier should match that of a corresponding selection interface, if there is one.
18manual data entry routine18;E1,245FREE TEXTEnter the code to be executed to do manual data entry for this interface. This field should only be completed for input package interfaces. This code will be executed to provide quick data entry for a user trying to input data for a form. It is expected that the output of this field will be used to format the PXCA array prior to calling PCE to file the data for the encounter. Developers writing routines for this entry should provide a roll and scroll interface for manaul entry of items only on the form.
19external display values19;E1,245FREE TEXTExecutable code used to translate the internal value that is to be passed to PCE into its external value for display purposes. It is used by the data validation routines to display the external values and descriptions of what is to be passed, to the user for verification.
20pass dq as value20;1BOOLEAN1:YES
If the value of the Data Qualifier shall be passed to PCE as the VALUE, this field should be set to one. Doing so will prevent the data in the VALUE from populating the PCE DIM NODE, but instead, will allow the Data Qualifier to pass as the VALUE. This is used mostly for YES/NO Data Qualifiers, where the value may be a question, and the Data Qualifier Value, if bubbled, is the value that must be placed on the PCE DIM NODE.
21pce dim piece, variable value21;E1,245FREE TEXTThis field should be populated when the PCE DIM PIECE VALUE is not constant. If the value of that field is dependent upon specific conditions, those conditions may be evaluated by placing the MUMPS code in this field. Ultimately, the code should return a value that will be used as the PCE DIM PIECE VALUE. If the return value is null, the original PCE DIM PIECE VALUE field will be used to determine the piece location to pass the VALUE on.

Referenced by 7 types

  1. SELECTION LIST (357.2) -- selection interface
  2. DATA FIELD (357.5) -- type of data
  3. PACKAGE INTERFACE (357.6) -- package interface for input
  4. MULTIPLE CHOICE FIELD (357.93) -- type of data
  5. IMP/EXP HAND PRINT FIELD (358.94) -- type of data
  6. AICS ERROR AND WARNING LOG (359.3) -- package interface
  7. HAND PRINT FIELD (359.94) -- type of data