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 |  Accessed By FileMan Db Calls |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  All
Print Page as PDF
Global: ^INTHPC

Package: IHS Generic Interface System

Global: ^INTHPC


Information

FileMan FileNo FileMan Filename Package
4004 BACKGROUND PROCESS CONTROL IHS Generic Interface System

Description

Directly Accessed By Routines, Total: 67

Package Total Routines
IHS Generic Interface System 64 INHB    INHB1    INHBLD    INHD    INHE    INHES2    INHFTDVX    INHFTM
INHFTMSM    INHFTNTM    INHOA    INHOA1    INHOM    INHOP    INHOQT    INHOS
INHOT    INHOTDVX    INHOTM    INHOTMSM    INHOTNTM    INHPCO    INHPCO1    INHPOST
INHPSA    INHPSAM    INHRDUP    INHRPC    INHSYS01    INHSYS09    INHULOG    INHUSEN
INHUSEN2    INHUSEN3    INHUSEN4    INHUSEN5    INHUSEN7    INHUSEN8    INHUT2    INHUTS1
INHUVUT    INHUVUT1    INHUVUT2    INHUVUTX    INHVCRA    INHVCRA1    INHVCRL    INHVCRL2
INHVCRLD    INHVCRV    INHVCRV1    INHVMTR    INHVTAPR    INHVTAPU    INHVTMT    INHVTMT5
INHVTMT6    INTENV1    INTSLO    INTSUT1    INTSUT2    INXHR03    INXHR031    INXPORT
IHS Support HL7 Interfaces 2 BHL3MS    BHLUP    
IHS Changes To Lab 1 BLRRLRES    

Accessed By FileMan Db Calls, Total: 6

Package Total Routines
IHS Generic Interface System 5 INHB    INHB1    INHT    INMPORT    INXPORT    
IHS Immunizations Interface 1 BYIMPORT    

Pointed To By FileMan Files, Total: 3

Package Total FileMan Files
IHS Generic Interface System 3 INTERFACE CRITERIA(#4001.1)[18.0318.0420]
INTERFACE TRANSACTION TYPE(#4000)[.17]    INTERFACE ERROR(#4003)[.11]    

Pointer To FileMan Files, Total: 1

Package Total FileMan Files
IHS Generic Interface System 1 INTERFACE DESTINATION(#4005)[.07]    

Fields, Total: 44

Field # Name Loc Type Details
.001 NUMBER NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999)!(X<1)!(X[".") X
  • LAST EDITED:  APR 17, 1991
  • HELP-PROMPT:  Type a whole number between 1 and 9999
  • DESCRIPTION:  
    This is the unique number identifying the background process.
.01 NAME 0;1 FREE TEXT
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:$L(X)>60!($L(X)<3)!'(X'?1P.E) X
  • LAST EDITED:  JUL 18, 2002
  • HELP-PROMPT:  Answer must be 3-60 characters in length
  • DESCRIPTION:  
    This is the name of the background process.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
  • CROSS-REFERENCE:  4004^B
    1)= S ^INTHPC("B",$E(X,1,60),DA)=""
    2)= K ^INTHPC("B",$E(X,1,60),DA)
.02 ACTIVE 0;2 SET
************************REQUIRED FIELD************************
  • '0' FOR INACTIVE;
  • '1' FOR ACTIVE;

  • LAST EDITED:  MAR 25, 1993
  • DESCRIPTION:  
    This field indicates if this background process is active.  If this field is set to INACTIVE the background process will not be started when using the Start Backgound Process menu options.
  • CROSS-REFERENCE:  4004^ACT
    1)= S ^INTHPC("ACT",$E(X,1,30),DA)=""
    2)= K ^INTHPC("ACT",$E(X,1,30),DA)
  • CROSS-REFERENCE:  4004^AC^MUMPS
    1)= K:'X ^INRHB("RUN",DA)
    2)= Q
    This cross reference will shut down the background process if the field is set to INACTIVE.
.03 DEVICE 0;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30 X I $D(X) D TXTPTR^INHU1(3.5,.X)
  • LAST EDITED:  FEB 04, 1993
  • HELP-PROMPT:  Answer must be 1-30 characters in length
  • DESCRIPTION:  
    This is the name of the Device which this program should open and use for all I/O operations.  If it is left blank, this program is assumed to perform no I/O.
  • EXECUTABLE HELP:  D TXTHLP^INHU1(3.5)
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
.04 $JOB 0;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>20 X
  • LAST EDITED:  APR 17, 1991
  • HELP-PROMPT:  Answer must be 1-20 characters in length
  • DESCRIPTION:  
    This indicates the value of $J for this background process the last time it was started.
.05 DATE/TIME LAST STARTED 0;5 DATE

  • INPUT TRANSFORM:  S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
  • LAST EDITED:  APR 17, 1991
  • DESCRIPTION:  
    This indicates the time this background process was last started.
.06 PRIORITY 0;6 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>10)!(X<1)!(X[".") X
  • LAST EDITED:  OCT 22, 1991
  • HELP-PROMPT:  Type a whole number between 1 and 10
  • DESCRIPTION:  This is the priority at which this background task should run. Values are from 1-10 with 1 being highest, 10 is lowest, and 5 is equal to normal user priority. If this field is null, then the value from the Interface
    Site Parameters will be used.
.07 DESTINATION 0;7 POINTER TO INTERFACE DESTINATION FILE (#4005) INTERFACE DESTINATION(#4005)

  • LAST EDITED:  MAR 19, 2002
  • DESCRIPTION:  This field is used by a background transceiver process to determine which messages it should send. Each different destination should have a different entry in the Background Process file. This field is only used if the
    ROUTINE field is equal to  INVTSQT.
  • CROSS-REFERENCE:  4004^DEST
    1)= S ^INTHPC("DEST",$E(X,1,30),DA)=""
    2)= K ^INTHPC("DEST",$E(X,1,30),DA)
.08 CLIENT/SERVER 0;8 SET
  • '0' FOR CLIENT;
  • '1' FOR SERVER;

  • LAST EDITED:  DEC 12, 1994
  • HELP-PROMPT:  Indicate whether this process needs to be opened as a client or a server.
  • DESCRIPTION:  
    If this process opens an TCP/IP port, this field indicates whether it should be opened as a client (the default) or a server.
.09 CONNECTION TYPE 0;9 SET
  • '0' FOR PERSISTENT;
  • '1' FOR TRANSIENT;

  • LAST EDITED:  SEP 30, 1999
  • HELP-PROMPT:  Indicate whether the process will open the connection in persistent mode or transient mode.
  • DESCRIPTION:  The connection type determines how the Background Process will handle the opening and closing of the connection to the destination systems. Persistent connection (default) is opened initially and remains connected
    throughout the life of the process.  Transient connection is opened only during the time of transfer.  For the transmitter, the connection is initiated when a transaction appears in the queue.  The receiver will run in
    server mode and listen for connection.  Closing of the connection is up to the client.
1 ROUTINE ROU;E1,50 FREE TEXT
************************REQUIRED FIELD************************

  • LAST EDITED:  MAY 11, 1999
  • HELP-PROMPT:  Answer must be 1-50 characters in length
  • DESCRIPTION:  
    The name of a routine or TAG^ROUTINE that is to be run.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
1.01 OPEN RETRIES 1;1 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999)!(X<1)!(X[".") X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the number of times the GIS will attempt to open a socket.
  • DESCRIPTION:  
    This contains the number of times the GIS will attempt to open a socket.
1.1 TRANSMITTER HANG 1;10 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999999)!(X<1)!(X[".") X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the time, in seconds, that the transmitter will wait between checks of the message queue to identify messages to send.
  • DESCRIPTION:  
    This is the hang time for the transmitter if the message queue is empty. It can be set relatively high for background processes that have low message traffic and low priority messages.
1.11 SEND RETRIES 1;11 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999)!(X<1)!(X[".") X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the maximum number of times the transmitter should attempt to send a single message.
  • DESCRIPTION:  This is the number of times the transmitter will attempt to send a single message. In enhanced processing, the transmitter will accept this number of NAKS before concluding the message is faulty, at which point the message
    activity log will reflect "maximum number of retries exceeded" and the transmitter will send the next message in the queue.
1.12 SEND HANG 1;12 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99999)!(X<1)!(X[".") X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the time, in seconds, that the transmitter will hang between attempts to send a message.
  • DESCRIPTION:  
    This is the hang time between attempts to send (field 1.11)
1.13 IGNORE START OF MESSAGE 1;13 SET
  • '0' FOR false;
  • '1' FOR true;

  • LAST EDITED:  JAN 14, 1997
  • HELP-PROMPT:  Enter 'False' to not ignore start of message, and 'True' to ignore message.
  • DESCRIPTION:  
    This field indicates if the receiver process should require a remote systems to send a Start Of Message (SOM) at the beginning of every HL7 message.
1.14 SEND MAXIMUM 1;14 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999999)!(X<1)!(X[".") X
  • LAST EDITED:  MAY 11, 1999
  • HELP-PROMPT:  Enter the maximum number of messages that a multi-threaded transceiver can have in-flight at any point in time.
  • DESCRIPTION:  The maximum number of messages that a multi-threaded transceiver can have in-flight at any point in time. This is the number of messages (maximum) that can be sent to the destination system prior to attempting to receive
    any responses from that destination system.  This value can be set relatively low to provide interface manageability or high to provide potentially faster throughput.  Consideration should be given to the TCP/IP buffer
    size in use on the source and destination systems when setting this value.  High values can result in blocking of the sending application if source and target buffers become full.
1.15 DISCONNECT RETRIES 0;15 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  DEC 17, 1999
  • HELP-PROMPT:  Enter the number of times the GIS will attempt to open a socket following consecutive remote end disconnects
  • DESCRIPTION:  
    Number of times to try to open socekt following consecutive remote end disconnects. This parameter may be needed if connecting through a firewall--which will likely give "false" connect messages.
1.16 START OF MESSAGE 1;16 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>15 X
  • LAST EDITED:  APR 22, 1999
  • HELP-PROMPT:  Enter the ASCII value of the start-of-message character. Separate values with commas if there is more than one character.
  • DESCRIPTION:  
    This is the start-of-message character(s) used for message framing. It will be different depending on the lower level protocol used for a specific interface protocol (e.g. HL7 or X12)
1.17 END OF MESSAGE 1;17 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>15 X
  • LAST EDITED:  APR 22, 1999
  • HELP-PROMPT:  Enter the ASCII value of the end-of-message character. Separate values with commas if there is more than one character.
  • DESCRIPTION:  
    This is the end-of-message character(s) used for framing messages. It will be different depending on the lower level protocol used for a specific interface protocol (e.g. HL7 or X12).
1.18 DISCONNECT HANG 0;18 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99.9)!(X<0)!(X?.E1"."2N.N) X
  • LAST EDITED:  DEC 17, 1999
  • HELP-PROMPT:  Type a Number between 0 and 99.9, 1 Decimal Digit
  • DESCRIPTION:  
    This is the hang time between attempts to open a socket following remote end disconnects.
1.2 OPEN HANG 1;2 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999999)!(X<0)!(X[".") X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the hang time, in seconds, between attempts to open a socket.
  • DESCRIPTION:  
    This is the hang time between open retries.
1.3 RECEIVE TIMEOUT 1;3 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999)!(X<0)!(X[".") X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the time, in seconds, that the receiver will wait for input before aborting.
  • DESCRIPTION:  
    This is the length of time the interface will wait for a read.
1.4 SEND TIMEOUT 1;4 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999)!(X<0)!(X[".") X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the time, in seconds, that the transmitter will attempt to send a message before timing out.
  • DESCRIPTION:  
    This is the amount of time the transmitter will attempt to send.
1.5 READ RETRIES 1;5 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999)!(X<1)!(X[".") X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the number of times the receiver will attempt to read from a socket.
  • DESCRIPTION:  
    This is the number of times the receiver will attempt to read from a socket before giving up.
1.6 READ HANG 1;6 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99999)!(X<0)!(X[".") X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the hang time, in seconds, between attempts to read from a socket.
  • DESCRIPTION:  
    This is the hang time between attempts to read from a socket.
1.7 END OF LINE 1;7 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>20 X
  • LAST EDITED:  DEC 23, 1994
  • HELP-PROMPT:  Enter the ASCII code, or codes, for the EOL terminator in the format "NN1,NN2,NN3..."
  • DESCRIPTION:  
    This field contains the ASCII end-of-line terminator. It will be in the format NN, or NN1,NN2,NN3. The GIS will convert this into $C(NN1)_$C(NN2) etc. and use it as the terminator for messages.
1.8 INITIALIZATION 1;8 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>90 X
  • LAST EDITED:  JUN 13, 1995
  • HELP-PROMPT:  Enter the initialization string the client process will send to the server process in the format NN,NN,NN where NN is the ASCII value
  • DESCRIPTION:  This is an ASCII code or string of codes which is sent by the iniating system to the receiving system to signal that an interface link is being made. It is entered in the format NN1,NN2,NN3 etc and is converted by the GIS
    into $C(NN1)_$C(NN2)_$C(NN3) etc.
1.9 INIT RESPONSE 1;9 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>90 X
  • LAST EDITED:  JUN 13, 1995
  • HELP-PROMPT:  Enter the response code which the server process will return to the client in the format NN,NN,NN where NN is an ASCII value.
  • DESCRIPTION:  This is a set of ASCII codes which the receiving system sends to the transmitting system in response to the initiation codes (contained in field 1.8). It is entered in the format NN1,NN2,NN3 and the GIS converts it into
    $C(NN1)_$C(NN2)_$C(NN3) etc
2 CONTROL ERROR 2;0 DATE Multiple #4004.01 4004.01

  • DESCRIPTION:  
    This is the multiple for the background process control error.
5 IP PORT 5;0 Multiple #4004.02 4004.02

  • DESCRIPTION:  This multiple will hold the IP Ports on the remote system that the background receiver process should open up for use by the remote transceiver. These are typically the commonly known IP ports (starting at 2000).
    Determination of the port(s) to use must be coordinated with the remote system manager.  This field will only be used if the ROUTINE field is equal to  INHVTSR.
6 CLIENT IP ADDRESS 6;0 Multiple #4004.03 4004.03

  • DESCRIPTION:  
    This multiple will contain IP address(es) if the process is to be opened as a client
7.01 SUPPRESS STARTUP 7;1 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  JUN 22, 1995
  • HELP-PROMPT:  Flag to suppress manual startup of this process. '0' for NO, '1' for YES
  • DESCRIPTION:  Flag to identify a background process as a server-only process. A server-only process cannot be started manually. Individual servers will be started by another background process as requested. These servers can be shut
    down manually.
7.02 MAX NUMBER OF JOBS 7;2 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999)!(X<1)!(X[".") X
  • LAST EDITED:  JUN 22, 1995
  • HELP-PROMPT:  Type a whole number between 1 and 9999
  • DESCRIPTION:  
    Maximum number of this type of server background process that can be started/active at any point in time.  If this field is null, the default will be 9999.  The actual maximum is dependent upon system resource limitations.
7.03 LAST APPLICATION SRVR ASSIGNED 7;3 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999)!(X<1)!(X[".") X
  • LAST EDITED:  JUN 22, 1995
  • HELP-PROMPT:  Type a whole number between 1 and 9999 (same upper bound as MAX NUMBER OF JOBS)
  • DESCRIPTION:  The last application server number to be assigned to a server background job. This field is used to enhance performance when searching for an available server slot. If this field is null upon process startup, the field
    will be initialized to 1.
    UNEDITABLE
7.04 KEY FRAME 7;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>10!($L(X)<5)!'(X?1U4.9UN) X
  • LAST EDITED:  JUN 22, 1995
  • HELP-PROMPT:  Enter 5-10 uppercase alpha or numeric characters.
  • DESCRIPTION:  
    A frame for the key supplied to a workstation during logon.  Each workstation that wishes to connect to a server must have this frame defined and pass it with the security key/ticket provided by the logon process.
7.05 REMOTE SYSTEM TIMEOUT 7;5 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99999)!(X<1)!(X[".") X
  • LAST EDITED:  JAN 20, 1996
  • HELP-PROMPT:  Type a whole number between 1 and 99999
  • DESCRIPTION:  
    # of seconds to wait for remote system to communicate before connection is closed.  Used with interactive sessions (e.g. PWS).
8 DESTINATION DETERMINATION CODE 8;E1,245

  • INPUT TRANSFORM:  K:$L(X)>245 X D ^DIM
  • LAST EDITED:  DEC 23, 1999
  • HELP-PROMPT:  Standard MUMPS code
  • DESCRIPTION:  
    This field is executable MUMPS code that is used to determine the INTERFACE DESTINATION for an inbound message received by this background process.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
9.01 DEBUG LEVEL 9;1 NUMBER

  • INPUT TRANSFORM:  K:X'?1N X
  • LAST EDITED:  JUN 06, 1995
  • HELP-PROMPT:  Type a whole number between 0 and 9
  • DESCRIPTION:  
    This field indicates the level of debugging for this Background Process.  If this field is null or 0, debugging is turned off.  The amount of debugging info logged grows as the value of this field is increased.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
9.02 LOG LOCATION 9;2 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>50 X I $D(X) D LOGLOCI^INHVCRA1
  • OUTPUT TRANSFORM:  D LOGLOCO^INHVCRA1
  • LAST EDITED:  JUN 07, 1995
  • HELP-PROMPT:  Answer must be 5-50 characters in length
  • DESCRIPTION:  This field stores the location for output of debug logging for this Background Process. It may contain a .DAT file spec, DEVICE Name, or the literal "GLOBAL". If the value is "GLOBAL", data will be stored descendant from
    ^UTILITY("INDEBUG",BackgroundProcessIEN,Server#,$J).  Output to the LOG LOCATION depends on the value of the field DEBUG LEVEL.
  • EXECUTABLE HELP:  D TXTHLP^INHU1(3.5)
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
10.01 ENCRYPT 10;1 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  APR 22, 1999
  • HELP-PROMPT:  Enter YES if messages should be encrypted/decrypted for this background process.
  • DESCRIPTION:  
    This is a yes/no flag to indicate whether this background job should encrypt/decrypt messages.
10.02 DES KEY 10;2 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>8!($L(X)<8) X
  • LAST EDITED:  APR 22, 1999
  • HELP-PROMPT:  Enter the 8-character DES key.
  • DESCRIPTION:  
    This is an 8-character key which both the sender and the receiver of interface messages must use to encrypt and decrypt each other's messages.
11 RECEIVER SRMC 11;E1,240 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>240 X D MUMPS^INHUT5
  • LAST EDITED:  JAN 22, 1996
  • HELP-PROMPT:  Answer must be 1-240 characters in length
  • DESCRIPTION:  
    This is the Receiver  Selective Routing M Code.  Screening logic placed here will be executed at the Receiver  process for inbound messages.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
12 TRANSMITTER SRMC 12;E1,240 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>240 X D MUMPS^INHUT5
  • LAST EDITED:  JAN 22, 1996
  • HELP-PROMPT:  Answer must be 1-240 characters in length
  • DESCRIPTION:  
    This is the Transmitter  Selective Routing M Code.  Screening logic placed here will be executed at the Transmitter  process for outbound messages.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
Info |  Desc |  Directly Accessed By Routines |  Accessed By FileMan Db Calls |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  All