Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Info |  Desc |  Directly Accessed By Routines |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  External References |  Global Variables Directly Accessed |  Naked Globals |  Local Variables  | All
Print Page as PDF
Global: ^IBE(358.6

Package: Automated Information Collection System

Global: ^IBE(358.6


Information

FileMan FileNo FileMan Filename Package
358.6 IMP/EXP PACKAGE INTERFACE Automated Information Collection System

Description

Directly Accessed By Routines, Total: 8

Package Total Routines
Automated Information Collection System 8 ^SDAUDIT    ALLOWABLE QUALIFIERS    DATA DESCRIPTION    PROTECTED LOCAL VARIABLES    REQUIRED LOCAL VARIABLES    SUBCOLUMN NUMBER    SUBFIELD    ^IBE(358.6

Pointed To By FileMan Files, Total: 4

Package Total FileMan Files
Automated Information Collection System 4 IMP/EXP SELECTION LIST(#358.2)[.11]    IMP/EXP DATA FIELD(#358.5)[.03]    IMP/EXP PACKAGE INTERFACE(#358.6)[.13]    IMP/EXP MULTIPLE CHOICE FIELD(#358.93)[.06]    

Pointer To FileMan Files, Total: 5

Package Total FileMan Files
Automated Information Collection System 4 AICS DATA QUALIFIERS(#357.98)[#358.613(.01)]    IMP/EXP AICS DATA QUALIFIERS(#358.98)[#358.613(.01)]    IMP/EXP PACKAGE INTERFACE(#358.6)[.13]    IMP/EXP AICS DATA ELEMENTS(#358.99)[16.2, 16.6, #358.613(.01)]
Health Summary 1 HEALTH SUMMARY TYPE(#142)[.11]    

Fields, Total: 76

Field # Name Loc Type Details
.01 NAME 0;1 FREE TEXT
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>40!($L(X)<3)!'(X'?1P.E) X
  • LAST EDITED:  APR 09, 1993
  • HELP-PROMPT:  Answer must be 3-40 characters in length. All entries with Action Type other than PRINT REPORT must be be prefixed with the namespace of the package that is responsible for the data.
  • DESCRIPTION:  
    The name of the Package Interface. For interfaces returning data the name should be preceded with the namespace of the package.
  • TECHNICAL DESCR:  
  • CROSS-REFERENCE:  358.6^B
    1)= S ^IBE(358.6,"B",$E(X,1,30),DA)=""
    2)= K ^IBE(358.6,"B",$E(X,1,30),DA)
  • CROSS-REFERENCE:  358.6^E^MUMPS
    1)= S ^IBE(358.6,"E",$E(X,$F(X," "),40),DA)=""
    2)= K ^IBE(358.6,"E",$E(X,$F(X," "),40),DA)
    For package interfaces that are output routines the name has the custodial package's name space as a prefix. This cross-reference removes that prefix. It is used to improve the display of output routines for the user.
.02 ENTRY POINT 0;2 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>8!($L(X)<1) X
  • LAST EDITED:  OCT 18, 1994
  • HELP-PROMPT:  What entry point into the routine does this package interface use?
  • DESCRIPTION:  
    The entry point in the routine that should be called.
.03 ROUTINE 0;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>8!($L(X)<1) X
  • LAST EDITED:  NOV 25, 1992
  • HELP-PROMPT:  What routine does this package interface use?
  • DESCRIPTION:  
    The routine that should be called.
.04 CUSTODIAL PACKAGE 0;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>20!($L(X)<3) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  For Package Interfaces that return data the Custodial Package is the package that is providing the data. For Package Interfaces that print reports it is the package that is providing the report.
  • DESCRIPTION:  
    This is a free text pointer to the package file. It serves only to document the custodial package of the data.
  • CROSS-REFERENCE:  358.6^C
    1)= S ^IBE(358.6,"C",$E(X,1,30),DA)=""
    2)= K ^IBE(358.6,"C",$E(X,1,30),DA)
.05 VARIABLE DATA? 0;5 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  NOV 24, 1993
  • HELP-PROMPT:  Enter YES if the data returned is variable, NO if the data is always the same.
  • DESCRIPTION:  
    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.
.06 ACTION TYPE 0;6 SET
************************REQUIRED FIELD************************
  • '1' FOR INPUT;
  • '2' FOR DISPLAY;
  • '3' FOR SELECTION;
  • '4' FOR PRINT REPORT;

  • LAST EDITED:  AUG 25, 1995
  • HELP-PROMPT:  Is this interface for inputting data, displaying data to a form, for creating lists that will appear on a form, or for printing reports?
  • DESCRIPTION:  
    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 retrieve 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.
.07 DATA TYPE 0;7 SET
  • '1' FOR SINGLE VALUE;
  • '2' FOR RECORD;
  • '3' FOR LIST OF SINGLE VALUES;
  • '4' FOR LIST OF RECORDS;
  • '5' FOR WORD PROCESSING;

  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  What format will the data be in?
  • DESCRIPTION:  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.
.08 PRINT COMPLETE 0;8 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  MAY 07, 1993
  • HELP-PROMPT:  If there is insufficient room on the form to print the data, should it be re-printed in full on a separate page?
  • DESCRIPTION:  
    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.
.09 AVAILABLE? (Y/N) 0;9 SET
************************REQUIRED FIELD************************
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  DEC 13, 1992
  • HELP-PROMPT:  Is this package interface now available for use?
  • DESCRIPTION:  
    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.
.1 HEALTH SUMMARY? 0;10 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  JUN 16, 1993
  • HELP-PROMPT:  Are you requesting a HEALTH SUMMARY to print?
  • DESCRIPTION:  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.
.11 TYPE OF HEALTH SUMMARY 0;11 POINTER TO HEALTH SUMMARY TYPE FILE (#142) HEALTH SUMMARY TYPE(#142)

  • INPUT TRANSFORM:  S DIC("S")="I $P(^(0),U)'=""GMTS HS ADHOC OPTION""" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X
  • LAST EDITED:  JUN 17, 1993
  • HELP-PROMPT:  Which Health Summary do you want printed?
  • DESCRIPTION:  
    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.
  • SCREEN:  S DIC("S")="I $P(^(0),U)'=""GMTS HS ADHOC OPTION"""
  • EXPLANATION:  EXCLUDES AD HOC HEALTH SUMMARIES
.12 TOOLKIT MEMBER? 0;12 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  JUL 11, 1995
  • HELP-PROMPT:  Enter YES if this PACKAGE INTERFACE was added by the package developers as part of the toolkit, enter NO otherwise.
  • DESCRIPTION:  
    Package Interfaces that are developed for national use will be documented as being part of the toolkit.
.13 PACKAGE INTERFACE FOR INPUT 0;13 POINTER TO IMP/EXP PACKAGE INTERFACE FILE (#358.6) IMP/EXP PACKAGE INTERFACE(#358.6)

  • INPUT TRANSFORM:  S DIC("S")="I $P(^(0),U,6)=1,$P(^(0),U,9)=1,$P(^(0),U,16)[""S""" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X
  • LAST EDITED:  AUG 25, 1995
  • HELP-PROMPT:  What interface should be used for inputting data entered on the selection list?
  • DESCRIPTION:  
    Used to map scanned data to DHCP.
  • SCREEN:  S DIC("S")="I $P(^(0),U,6)=1,$P(^(0),U,9)=1,$P(^(0),U,16)[""S"""
  • EXPLANATION:  Must be an available interfaces for accepting input from selection lists.
.14 DYNAMIC SELECTIONS 0;14 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  DEC 21, 1994
  • HELP-PROMPT:  Only for selection routines. Enter YES if the Package Interface builds the selection list each time the form is printed.
  • DESCRIPTION:  
    This is used to indicate whether the interface is used to build selection lists at print time.
.15 DO NOT USE DFN AS A SUBSCRIPT 0;15 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  APR 13, 1995
  • HELP-PROMPT:  If the patient DFN should not be used as a subscript when passing data enter YES.
  • DESCRIPTION:  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.
  • SCREEN:  S DIC("S")="I (Y=1)!($P(^IBE(358.6,DA,0),U,6)=2)"
  • EXPLANATION:  If the action type is not OUTPUT ROUTINE then this field should not be set to NO.
.16 ALLOWED OBJECT USE 0;16 FREE TEXT

  • INPUT TRANSFORM:  S X=$$UPPER^VALM1(X) K:$L(X)>4!("SMHP"'[$E(X,1))!("SMHP"'[$E(X,2))!("SMHP"'[$E(X,3))!("SMHP"'[$E(X,4)) X
  • LAST EDITED:  SEP 13, 1995
  • DESCRIPTION:  This 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.
  • EXECUTABLE HELP:  D HELP7^IBDFU5A
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
.17 ASK FOR ADDITIONAL NARRATIVE 0;17 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  JAN 23, 1996
  • HELP-PROMPT:  Answer yes or no.
  • DESCRIPTION:  Enter whether users should be prompted 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 diagnosis and clinical lexicon entries will want this field set to Yes.
.18 ASK FOR CLINICAL LEXICON 0;18 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  FEB 05, 1996
  • HELP-PROMPT:  Enter 'Yes' if you want to map entries from this interface to the clinical lexicon.
  • DESCRIPTION:  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.
.19 DQ REQUIRED 0;19 SET
  • '1' FOR YES;

  • LAST EDITED:  FEB 12, 1996
  • DESCRIPTION:  
    Field used to determine if a data qualifier is required for this input interface.
.2 ASK FOR CLINICAL REMINDERS 0;20 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  OCT 15, 1997
  • HELP-PROMPT:  If this package interface is for display of clinical reminders answer yes, otherwise answer no.
  • DESCRIPTION:  
    If this package interface is for display of clinical reminders answer yes, otherwise answer no.
.21 ASK FOR CPT MODIFIERS? 0;21 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  JAN 24, 2000
  • HELP-PROMPT:  If this package interface is to prompt for CPT Modifiers, answer yes, otherwise answer no.
  • DESCRIPTION:  
    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.
1 DESCRIPTION 1;0 WORD-PROCESSING #358.61

  • DESCRIPTION:  
    Should describe the data being exchanged by the package interface.
  • LAST EDITED:  FEB 10, 1993
  • HELP-PROMPT:  Enter a description of the data being exchanged.
  • DESCRIPTION:  
    This should describe the data being exchanged b the package interface.
2.01 PIECE 1 DESCRIPTIVE NAME 2;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<3) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Answer must be 3-30 characters in length.
  • DESCRIPTION:  
    Should be a descriptive name of the first field in the record returned by the interface.
2.02 PIECE 1 MAXIMUM LENGTH 2;2 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>210)!(X<0)!(X?.E1"."1N.N) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Type a Number between 0 and 210, 0 Decimal Digits
  • DESCRIPTION:  
    The maximum length of the first field of the record returned by the interface.
2.03 PIECE 2 DESCRIPTIVE NAME 2;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<3) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Answer must be 3-30 characters in length.
  • DESCRIPTION:  
    A descriptive name of the second field of the record returned by the interface routine.
2.04 WHAT IS ITS MAXIMUM LENGTH? 2;4 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>210)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Type a Number between 1 and 210, 0 Decimal Digits
  • DESCRIPTION:  
    The maximum length of the second field of the record returned by the interface routine.
2.05 PIECE 3 DESCRIPTIVE NAME 2;5 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<3) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Answer must be 3-30 characters in length.
  • DESCRIPTION:  
    A descriptive name of the third field of the record returned by the interface routine.
2.06 PIECE 3 MAXIMUM LENGTH 2;6 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>210)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Type a Number between 1 and 210, 0 Decimal Digits
  • DESCRIPTION:  
    The maximum length of the 3rd field returned by the interface routine.
2.07 PIECE 4 DESCRIPTIVE NAME 2;7 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<3) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Answer must be 3-30 characters in length.
  • DESCRIPTION:  
    A descriptive name of the 4th field returned by the interface routine.
2.08 PIECE 4 MAXIMUM LENGTH 2;8 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>200)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Type a Number between 1 and 200, 0 Decimal Digits
  • DESCRIPTION:  
    The maximum length of the 4th field returned by the interface routine.
2.09 PIECE 5 DESCRIPTIVE NAME 2;9 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<3) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Answer must be 3-30 characters in length.
  • DESCRIPTION:  
    A descriptive name of the 5th field returned by the interface routine.
2.1 PIECE 5 MAXIMUM LENGTH 2;10 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>210)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Type a Number between 1 and 210, 0 Decimal Digits
  • DESCRIPTION:  
    The maximum length of the 5th field returned by the interface routine.
2.11 PIECE 6 DESCRIPTIVE NAME 2;11 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<3) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Answer must be 3-30 characters in length.
  • DESCRIPTION:  
    A descriptive name fo the 6th field returned by the interface routine.
2.12 PIECE 6 MAXIMUM LENGTH 2;12 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>210)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Type a Number between 1 and 210, 0 Decimal Digits
  • DESCRIPTION:  
    The maximum length of the 6th field returned by the interface routine.
2.13 PIECE 7 DESCRIPTIVE NAME 2;13 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<3) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Answer must be 3-30 characters in length.
  • DESCRIPTION:  
    A descriptive name for the 7th field returned by the package interface routine.
2.14 PIECE 7 MAXIMUM LENGTH 2;14 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>210)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Type a Number between 1 and 210, 0 Decimal Digits
  • DESCRIPTION:  
    The maximum length of the 7th field returned by the interface routine.
2.16 PIECE 1 RECOMMENDED HEADER 2;16 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>20!($L(X)<1) X
  • LAST EDITED:  APR 17, 1995
  • HELP-PROMPT:  Answer must be 1-20 characters in length.
  • DESCRIPTION:  
    The recommended header will be used as the default when designing a form.
2.17 IS PIECE 1 DISPLAYABLE? 2;17 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  AUG 10, 1993
  • HELP-PROMPT:  The first piece of the returned record is reserved for the unique id of the selection. Enter no if it should not be displayed, for example, if it is a pointer.
  • DESCRIPTION:  
    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.18 EXPORT SELECTIONS/CHOICES? 2;18 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  AUG 25, 1995
  • HELP-PROMPT:  Enter NO if the ID returned by the PACKAGE INTERFACE is not constant between sites, for example, if it is a pointer. Otherwise answer YES.
  • DESCRIPTION:  
    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.
3 USER LOOKUP 3;1 FREE TEXT

  • INPUT TRANSFORM:  K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>240!($L(X)<1) X
  • LAST EDITED:  JUL 26, 1993
  • HELP-PROMPT:  Enter words separated with spaces. They will be indexed to assist in lookup.
  • DESCRIPTION:  
    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.
  • EXECUTABLE HELP:  D LOOKUP^IBDF16
  • CROSS-REFERENCE:  358.6^D^KWIC
    1)= S %1=1 F %=1:1:$L(X)+1 S I=$E(X,%) I "(,.?! '-/&:;)"[I S I=$E($E(X,%1,%-1),1,30),%1=%+1 I $L(I)>2,^DD("KWIC")'[I S ^IBE(358.6,"D",I,DA)=""
    2)= S %1=1 F %=1:1:$L(X)+1 S I=$E(X,%) I "(,.?! '-/&:;)"[I S I=$E($E(X,%1,%-1),1,30),%1=%+1 I $L(I)>2 K ^IBE(358.6,"D",I,DA)
    This index is meant to assist the user in locating the correct package interface needed to display a particular item of data to a form.
4.01 ENTRY ACTION 4;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 21, 1993
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This code will be executed after the PROTECTED VARIABLES are newed, but before the interface routine is called.
    WRITE AUTHORITY: @
5.01 EXIT ACTION 5;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 18, 1993
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    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.
    WRITE AUTHORITY: @
6 PROTECTED LOCAL VARIABLES 6;0 Multiple #358.66 358.66

  • DESCRIPTION:  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
7 REQUIRED LOCAL VARIABLES 7;0 Multiple #358.67 358.67

  • DESCRIPTION:  
    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.
8.01 PIECE 1 NODE 8;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>10!($L(X)<1) X
  • LAST EDITED:  DEC 03, 1993
  • HELP-PROMPT:  Answer must be 1-10 characters in length.
8.02 PIECE 2 NODE 8;2 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>10!($L(X)<1) X
  • LAST EDITED:  DEC 03, 1993
  • HELP-PROMPT:  Answer must be 1-10 characters in length.
8.03 PIECE 3 NODE 8;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>10!($L(X)<1) X
  • LAST EDITED:  DEC 03, 1993
  • HELP-PROMPT:  Answer must be 1-10 characters in length.
8.04 PIECE 4 NODE 8;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>10!($L(X)<1) X
  • LAST EDITED:  DEC 03, 1993
  • HELP-PROMPT:  Answer must be 1-10 characters in length.
8.05 PIECE 5 NODE 8;5 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>10!($L(X)<1) X
  • LAST EDITED:  DEC 03, 1993
  • HELP-PROMPT:  Answer must be 1-10 characters in length.
8.06 PIECE 6 NODE 8;6 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>10!($L(X)<1) X
  • LAST EDITED:  DEC 03, 1993
  • HELP-PROMPT:  Answer must be 1-10 characters in length.
8.07 PIECE 7 NODE 8;7 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>10!($L(X)<1) X
  • LAST EDITED:  DEC 03, 1993
  • HELP-PROMPT:  Answer must be 1-10 characters in length.
9 PCE DIM INPUT TRANSFORM 9;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  APR 01, 1996
  • HELP-PROMPT:  The input transform should transform X to the value that should be passed.
  • DESCRIPTION:  
    Used to transform X, the identifier stored with the form object, to the form that should be passed to the PCE Device Interface Module (DIM). It may, for example, transform a code to an ien.
    WRITE AUTHORITY: @
10 HELP TEXT 10;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>245!($L(X)<1) X
  • LAST EDITED:  MAY 22, 1995
  • HELP-PROMPT:  This should provide some help to the user who is trying to enter a value associated with a bubble.
  • DESCRIPTION:  
    This should provide some help to the user who is trying to enter a value associated with a bubble.
11 VALIDATOR 11;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  SEP 08, 1995
  • HELP-PROMPT:  This is Standard MUMPS code will kill X if X no longer identifies a valid code.
  • DESCRIPTION:  This 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.
    WRITE AUTHORITY: @
12.01 PCE DIM NODE 12;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<1) X
  • LAST EDITED:  APR 01, 1996
  • HELP-PROMPT:  What node will be used to pass the data?
  • DESCRIPTION:  
    The node used to pass the data to PCE, using the PCE DEVICE INTERFACE MODULE.
12.02 PCE DIM PIECE, VALUE 12;2 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  APR 01, 1996
  • HELP-PROMPT:  What piece should be used to pass the value?
  • DESCRIPTION:  
    The piece in the PXCA node used to pass the input value.
12.03 PCE DIM PIECE, NARRATIVE 12;3 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  APR 01, 1996
  • HELP-PROMPT:  What piece should be used to pass the text displayed on the form?
  • DESCRIPTION:  
    The piece in the PCXA node used to pass the text displayed on the form.
12.04 PCE DIM PIECE, HEADER 12;4 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  APR 01, 1996
  • HELP-PROMPT:  What piece should be used to pass the header displayed on the form?
  • DESCRIPTION:  
    The piece on the node specified by the PCE Device Interface Module that the header is mapped to.
12.05 PCE DIM PIECE, DATA QUALIFIER 12;5 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  APR 01, 1996
  • HELP-PROMPT:  What piece should be used to pass the data qualifier?
  • DESCRIPTION:  
    The piece of the PXCA node where the data modifier belongs.
12.06 PCE DIM PIECE, QUANTITY 12;6 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  OCT 31, 1996
  • HELP-PROMPT:  Type a Number between 1 and 99, 0 Decimal Digits
  • DESCRIPTION:  
    An entry in this field indicates which piece of the array the quantity should be passed on when sending data to PCE.
13 ALLOWABLE QUALIFIERS 13;0 VARIABLE POINTER Multiple #358.613 358.613

  • DESCRIPTION:  
    This mulitiple contains the list of quailifiers that may apply to the data.
14 PCE DIM OUTPUT TRANSFORM 14;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  APR 01, 1996
  • HELP-PROMPT:  This should change Y, the value to be passed, to a value suitable for display.
  • DESCRIPTION:  
    This transform should set Y, the value to be passed to the PCE Device Interface Module, to a value that is suitable for display. It may, for example, change an ien to a code.
    WRITE AUTHORITY: @
15 DATA DESCRIPTION 15;0 Multiple #358.615 358.615

  • DESCRIPTION:  
    For interfaces that return records, this multiple stores information on the fields, other than the first field.
  • IDENTIFIED BY:  
    "WRITE": D EN^DDIOL(" PIECE="_$P(^(0),U,3),"","?0")
16.1 ALLOW INPUT OF NARRATIVE? 16;1 SET
  • 'n' FOR NO;
  • 'o' FOR OPTIONAL;
  • 'r' FOR REQUIRED;

  • LAST EDITED:  APR 21, 1995
  • HELP-PROMPT:  Should the user be allowed to enter a narrative? Answer n=NO, o=OPTIONAL, r=REQUIRED
  • DESCRIPTION:  
    For input interfaces, this field determines whether a narrative is allowed by the PCE Generic Device Interface.
16.2 NARRATIVE DATA TYPE 16;2 POINTER TO IMP/EXP AICS DATA ELEMENTS FILE (#358.99) IMP/EXP AICS DATA ELEMENTS(#358.99)

  • LAST EDITED:  OCT 18, 1995
  • HELP-PROMPT:  What data type definition describes the narrative?
  • DESCRIPTION:  
    This determines, among other things, how much space to allocate for the narrative.
16.3 NARRATIVE HEADER 16;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>40!($L(X)<1) X
  • LAST EDITED:  AUG 15, 1995
  • HELP-PROMPT:  Answer must be 1-40 characters in length.
  • DESCRIPTION:  
    Used to label the narrative field.
16.5 ALLOW INPUT OF PRIMARY VALUE? 16;5 SET
  • 'n' FOR NO;
  • 'o' FOR OPTIONAL;
  • 'r' FOR REQUIRED;

  • LAST EDITED:  APR 26, 1995
  • HELP-PROMPT:  Should a code be entered? n=NO, o=OPTIONAL, r=REQUIRED
  • DESCRIPTION:  
    This applies only to interfaces for input and determines whether a value, other than a narrative, can be entered.
16.6 PRIMARY VALUE DATA TYPE 16;6 POINTER TO IMP/EXP AICS DATA ELEMENTS FILE (#358.99) IMP/EXP AICS DATA ELEMENTS(#358.99)

  • LAST EDITED:  SEP 14, 1995
  • HELP-PROMPT:  What type of data is the primary value?
  • DESCRIPTION:  
    This applies only to interfaces for input and determines, among other things, the data type of the value to be entered.
16.7 PRIMARY VALUE HEADER 16;7 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>40!($L(X)<1) X
  • LAST EDITED:  AUG 15, 1995
  • HELP-PROMPT:  Answer must be 1-40 characters in length.
  • DESCRIPTION:  
    Used to label the primary value field.
16.8 ALLOW MULTIPLIERS 16;8 SET
  • '1' FOR YES;

  • LAST EDITED:  OCT 31, 1996
  • HELP-PROMPT:  Enter yes if this interface will allow entry of quantity at form development time.
  • DESCRIPTION:  
    For selection interfaces, this determines whether 'quantity' should be asked at form development time to pass multiple occurrences of a selection to PCE.
16.9 ALLOW INPUT OF MULTIPLE CODES? 16;9 SET
  • '1' FOR YES;

  • LAST EDITED:  OCT 31, 1996
  • HELP-PROMPT:  Enter a 1 for 'YES'.
  • DESCRIPTION:  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.
17 SELECTOR 17;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  SEP 08, 1995
  • HELP-PROMPT:  Enter mumps code that will allow the form designer to add a choice to a multiple choice field.
  • DESCRIPTION:  This 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.
    WRITE AUTHORITY: @
18 MANUAL DATA ENTRY ROUTINE 18;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  JAN 23, 1996
  • HELP-PROMPT:  Enter the code to be executed during manual data entry for this interface. This is Standard MUMPS code.
  • DESCRIPTION:  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 manual entry of items only on the form.
    WRITE AUTHORITY: @
19 EXTERNAL DISPLAY VALUES 19;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  FEB 14, 1996
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  Executable 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
    the data to be passed, to the user for verification.
    WRITE AUTHORITY: @
20 PASS DQ AS VALUE 20;1 SET
  • '1' FOR YES;

  • LAST EDITED:  OCT 31, 1996
  • HELP-PROMPT:  Enter Yes if the Data Qualifier should be passed as the Value when sending data to PCE.
  • DESCRIPTION:  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.
21 PCE DIM PIECE, VARIABLE VALUE 21;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  OCT 31, 1996
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  This 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.
    WRITE AUTHORITY: @

External References

Name Field # of Occurrence
EN^DDIOL IDWRITE+1, IDWRITE1+1
^DIC .11+1, .13+1
^DIM 4.01+1, 5.01+1, 9+1, 11+1, 14+1, 17+1, 18+1, 19+1, 21+1
LOOKUP^IBDF16 3(HELP )
HELP7^IBDFU5A .16(HELP )
$$UPPER^VALM1 .16+1

Global Variables Directly Accessed

Name Line Occurrences  (* Changed,  ! Killed)
^DD("KWIC" 3(XREF 1S)
^IBE(358.6 - [#358.6] .01(XREF 1S), .01(XREF 1K), .01(XREF 2S), .01(XREF 2K), .04(XREF 1S), .04(XREF 1K), 3(XREF 1S), 3(XREF 1K)

Naked Globals

Name Field # of Occurrence
^(0 IDWRITE+1, IDWRITE1+1

Local Variables

Legend:

>> Not killed explicitly
* Changed
! Killed
~ Newed

Name Field # of Occurrence
>> % 3(XREF 1S), 3(XREF 1K)
>> %1 3(XREF 1S), 3(XREF 1K)
>> DA .01(XREF 1S), .01(XREF 1K), .01(XREF 2S), .01(XREF 2K), .04(XREF 1S), .04(XREF 1K), 3(XREF 1S), 3(XREF 1K)
DIC .11+1!*, .13+1!*
DIC("S" .11+1*, .11SCR+1*, .13+1*, .13SCR+1*, .15SCR+1*
>> DIE .11+1, .13+1
>> I 3(XREF 1S), 3(XREF 1K)
IBDWNAM IDWRITE+1~*
IBDWTYPE IDWRITE1+1~*
U IDWRITE+1, IDWRITE1+1
X .01+1!, .01(XREF 1S), .01(XREF 1K), .01(XREF 2S), .01(XREF 2K), .02+1!, .03+1!, .04+1!, .04(XREF 1S), .04(XREF 1K)
, .11+1*!, .13+1*!, .16+1*!, 2.01+1!, 2.02+1!, 2.03+1!, 2.04+1!, 2.05+1!, 2.06+1!, 2.07+1!
, 2.08+1!, 2.09+1!, 2.1+1!, 2.11+1!, 2.12+1!, 2.13+1!, 2.14+1!, 2.16+1!, 3+1!, 3(XREF 1S)
, 3(XREF 1K), 4.01+1!, 5.01+1!, 8.01+1!, 8.02+1!, 8.03+1!, 8.04+1!, 8.05+1!, 8.06+1!, 8.07+1!
, 9+1!, 10+1!, 11+1!, 12.01+1!, 12.02+1!, 12.03+1!, 12.04+1!, 12.05+1!, 12.06+1!, 14+1!
, 16.3+1!, 16.7+1!, 17+1!, 18+1!, 19+1!, 21+1!
>> Y .11+1, .13+1
Info |  Desc |  Directly Accessed By Routines |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  External References |  Global Variables Directly Accessed |  Naked Globals |  Local Variables  | All