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: ^INTHU

Package: IHS Generic Interface System

Global: ^INTHU


Information

FileMan FileNo FileMan Filename Package
4001 UNIVERSAL INTERFACE IHS Generic Interface System

Description

Directly Accessed By Routines, Total: 109

Package Total Routines
IHS Generic Interface System 77 INH4CONV    INHBLD    INHD    INHERR2    INHERR3    INHES1    INHES2    INHFTDVX
INHFTMSM    INHFTNTM    INHI    INHMS1    INHMS2    INHOM    INHOQT1    INHOS
INHOT    INHOTDVX    INHOTM    INHOTMSM    INHOTNTM    INHOU    INHOU1    INHOU3
INHOU4    INHOU5    INHOU8    INHP    INHQRIN    INHR    INHRDUP    INHRDUP1
INHRSE    INHRTH    INHRTZ    INHU    INHU1    INHUSEN2    INHUSEN3    INHUSEN5
INHUSEN8    INHUSEQ    INHUT11    INHUT7    INHUTC    INHUTC51    INHUTC52    INHUVUT
INHUVUT3    INHUVUTX    INHVCRL1    INHVCRL2    INHVCRL3    INHVCRV    INHVTA3M    INHVTAPT
INHVTAX1    INHVTMT    INHVTMT1    INHVTMT4    INHXEMN    INHXEMN1    INTENV1    INTQRY
INTSEND    INTSREC    INTST    INTSTF    INTSTO    INTSTO1    INTSTR    INTSUSN
INTSUT1    INTSUT3    INXHA05    INXHR01    INXHR04    
IHS Support HL7 Interfaces 11 BHL3MI    BHLCHRI    BHLEVENT    BHLRLABL    BHLRLABN    BHLRLABR    BHLRLABT    BHLU
BHLX277    BHLX835    BHLXRFL    
IHS Changes To Lab 9 BLRHL7    BLRLINKU    BLRRLFX1    BLRRLMP    BLRRLMU4    BLRRLMV    BLRSHPM    BLRSHPML
BLRSHPMQ    
IHS Immunizations Interface 9 BYIMIMM    BYIMIMM1    BYIMIMM2    BYIMIMM4    BYIMIMM5    BYIMIMM6    BYIMRT    BYIMSEG1
BYIMSEGS    
Data Warehouse Export System 2 BDWBHL    BDWBHL1    
IHS Patient Registration 1 AGHL7    

Accessed By FileMan Db Calls, Total: 31

Package Total Routines
IHS Generic Interface System 20 INHBLD    INHD    INHOS    INHOU    INHOU1    INHOU4    INHOU8    INHP
INHU    INHUSEN2    INHUSEN4    INHUSEN8    INHUTC52    INHUTC7    INHXEMN    INHXEMN1
INTENV1    INTQRY    INTSTR    INTSUSN    
IHS Changes To Lab 3 BLRRLMP    BLRRLMU4    BLRRLMV    
IHS Support HL7 Interfaces 3 BHLCHRI    BHLU    BHLXRFL    
IHS Immunizations Interface 2 BYIMIMM2    BYIMRT    
Contract Health Management Information System 1 ACHS278O    
Data Warehouse Export System 1 BDWBHL    
IHS Patient Registration 1 AGHL7    

Pointed To By FileMan Files, Total: 5

Package Total FileMan Files
IHS Generic Interface System 3 INTERFACE CRITERIA(#4001.1)[#4001.19(.01)]    INTERFACE ERROR(#4003)[.04]    UNIVERSAL INTERFACE(#4001)[.06.07.18#4001.01(.03)]    
IHS Immunizations Interface 2 IZ PARAMETERS(#90480)[#90480.04(.06)]    IZ REAL-TIME QUERY(#90480.2)[.07]    

Pointer To FileMan Files, Total: 5

Package Total FileMan Files
IHS Generic Interface System 3 INTERFACE DESTINATION(#4005)[.022.02]    INTERFACE TRANSACTION TYPE(#4000)[.11]    UNIVERSAL INTERFACE(#4001)[.06.07.18#4001.01(.03)]    
Kernel 1 USER(#3)[.152.03]    
Registration 1 MEDICAL CENTER DIVISION(#40.8)[.21]    

Fields, Total: 31

Field # Name Loc Type Details
.01 DATE/TIME 0;1 DATE

  • INPUT TRANSFORM:  S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
  • LAST EDITED:  DEC 09, 1996
  • DESCRIPTION:  
    This is the date/time of the interface message.
  • DELETE TEST:  1,0)= X "I 0" N H,D S D=$P(^INTHU(DA,0),U,2) Q:'D S H=$G(^INLHSCH("DEST",D,DA)) Q:'H K ^INLHSCH("DEST",D,DA),^INLHSCH(H,DA)
  • CROSS-REFERENCE:  4001^B
    1)= S ^INTHU("B",$E(X,1,30),DA)=""
    2)= K ^INTHU("B",$E(X,1,30),DA)
.02 DESTINATION 0;2 POINTER TO INTERFACE DESTINATION FILE (#4005)
************************REQUIRED FIELD************************
INTERFACE DESTINATION(#4005)

  • LAST EDITED:  OCT 26, 1994
  • DESCRIPTION:  
    This is the pointer to the INTERFACE DESTINATION file specifying the destination of the message.
  • CROSS-REFERENCE:  4001^AD
    1)= S ^INTHU("AD",$E(X,1,30),DA)=""
    2)= K ^INTHU("AD",$E(X,1,30),DA)
  • CROSS-REFERENCE:  4001^ADK^MUMPS
    1)= Q
    2)= N P S P=+$P(^INTHU(DA,0),U,16) K ^INLHSCH("DEST",+X,P,DA)
    Cross-reference to kill extraneous nodes in the ^INLHSCH (output controller schedule) global when the destination is altered or the entry is deleted.
.03 STATUS 0;3 SET
************************REQUIRED FIELD************************
  • 'N' FOR NEW;
  • 'P' FOR PENDING;
  • 'S' FOR SENT (Awaiting Acknowledge);
  • 'C' FOR COMPLETE;
  • 'E' FOR ERROR;
  • 'K' FOR NEGATIVE ACKNOWLEDGED;
  • 'A' FOR ACCEPT ACK;

  • LAST EDITED:  OCT 24, 1994
  • DESCRIPTION:  The status of a message begins at NEW when first created. It then is updated as it is processed by the GIS. It may be SENT once the GIS sends it to another system or COMPLETE if it is sent but no acknowledgement is
    required. If acks are required, the status becomes ACCEPT ACK when the acceptance level ack is received, then COMPLETE (or NEGATIVE ACKNOWLEDGED) once the application level ack/nak is received.
  • CROSS-REFERENCE:  4001^AS
    1)= S ^INTHU("AS",$E(X,1,30),DA)=""
    2)= K ^INTHU("AS",$E(X,1,30),DA)
    Cross-reference by status.  Used for reporting and purging.
  • CROSS-REFERENCE:  4001^AE^MUMPS
    1)= D ECHK^INHU(DA)
    2)= Q
  • CROSS-REFERENCE:  4001^ASP^MULTIPLE^^^4001,.03,4001,.16
    1)= N Y2 S Y2=$P(^INTHU(DA,0),U,16) I Y2]"" S Y2=$E(Y2,1,30) S ^INTHU("ASP",$E(X,1,30),Y2,DA)=""
    2)= N Y2 S Y2=$P(^INTHU(DA,0),U,16) I Y2]"" S Y2=$E(Y2,1,30) K ^INTHU("ASP",$E(X,1,30),Y2,DA)
.04 ACKNOWLEDGE REQUIRED? 0;4 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • DESCRIPTION:  This is used to determine the status of an outgoing message as of the time it is sent. If an acknowledgement is not expected, the status is set to COMPLETE. If an acknowledgement is expected, the status is set to SENT.
    The status is then set to COMPLETE when the application acknowledgement is received.  If the message is sent under enhanced ack rules, the status is set to COMMIT ACK RECEIVED.
.05 MESSAGE ID 0;5 FREE TEXT

  • INPUT TRANSFORM:  K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>30 X
  • LAST EDITED:  SEP 18, 1997
  • HELP-PROMPT:  Answer must be 1-30 characters in length
  • DESCRIPTION:  This is the unique (to CHCS) identifier of the message. It will always be unique for outgoing messages. For incoming messages, if the remote system sends multiple messages with the same ID, the GIS will create a unique
    entry for this field which will be in the format DESTINATION POINTER-MESSID-NUMBER, where NUMBER starts at 1 and is incremented for each message with the same ID.
  • CROSS-REFERENCE:  4001^C
    1)= S ^INTHU("C",$E(X,1,30),DA)=""
    2)= K ^INTHU("C",$E(X,1,30),DA)
.06 ACK MESSAGE (APPLICATION) 0;6 POINTER TO UNIVERSAL INTERFACE FILE (#4001) UNIVERSAL INTERFACE(#4001)

  • OUTPUT TRANSFORM:  S Y=$S($D(^INTHU(+Y,0)):$P(^(0),U,5),1:"")
  • LAST EDITED:  NOV 11, 1999
  • DESCRIPTION:  
    This field is a recursive pointer to the entry in the UIF which contains the application level acknowledgement to the originating message. This field is only used for originating messages.
.07 PARENT MESSAGE 0;7 POINTER TO UNIVERSAL INTERFACE FILE (#4001) UNIVERSAL INTERFACE(#4001)

  • OUTPUT TRANSFORM:  S Y=$S($D(^INTHU(+Y,0)):$P(^(0),U,5),1:"")
  • LAST EDITED:  NOV 11, 1999
  • DESCRIPTION:  
    This is the pointer to the parent message.
.08 SOURCE 0;8 FREE TEXT
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:$L(X)>60 X
  • LAST EDITED:  JAN 30, 1991
  • HELP-PROMPT:  Answer must be 1-60 characters in length
  • DESCRIPTION:  
    This field is used to identify the source of the message.
.09 LAST DATE/TIME 0;9 DATE
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
  • DESCRIPTION:  
    This is the last activity date/time of the message.
.1 IN/OUT 0;10 SET
************************REQUIRED FIELD************************
  • 'I' FOR IN;
  • 'O' FOR OUT;

  • LAST EDITED:  MAR 29, 1991
  • DESCRIPTION:  
    This field indicates the direction of the message.  I=incoming. O=outgoing.
.11 ORIGINATING TRANSACTION TYPE 0;11 POINTER TO INTERFACE TRANSACTION TYPE FILE (#4000) INTERFACE TRANSACTION TYPE(#4000)

  • LAST EDITED:  MAR 29, 1991
  • DESCRIPTION:  
    This field is only filled in for entries which were created through the Interface Formatter (originated in host database).  It indicates the Transaction Type which created this entry.
.12 ATTEMPTS 0;12 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99999)!(X<0)!(X[".") X
  • LAST EDITED:  APR 01, 1991
  • HELP-PROMPT:  Type a whole number between 0 and 99999
  • DESCRIPTION:  
    This is the number of attempts to transmit the outgoing message before it was successfully transmitted.
.13 DEVICE ATTEMPTS 0;13 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999)!(X<0)!(X[".") X
  • LAST EDITED:  MAY 20, 1991
  • HELP-PROMPT:  Type a whole number between 0 and 9999
  • DESCRIPTION:  This is the number of times that this transaction had to be requeued due to the inability to access a device and no other jobs with the same destination were running at the time which would pick up this one after
    completing the current task.
.14 LAST ACTIVITY DATE 0;14 DATE

  • INPUT TRANSFORM:  S %DT="ESTX" D ^%DT S X=Y K:Y<1 X
  • LAST EDITED:  MAY 23, 1991
  • DESCRIPTION:  
    This corresponds to the latest date/time value entered in the Activity Log multiple.  It is used to improve performance on transaction purging.
    UNEDITABLE
.15 USER WHO CREATED 0;15 POINTER TO USER FILE (#3) USER(#3)

  • LAST EDITED:  MAR 03, 1997
  • DESCRIPTION:  
    This user initiated the creation of this transaction.
.16 PRIORITY 0;16 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>10)!(X<0)!(X?.E1"."2N.N) X
  • LAST EDITED:  APR 23, 1992
  • HELP-PROMPT:  Type a number between 0 and 10
  • DESCRIPTION:  
    This is the priority assigned to the transaction at creation time.
    WRITE AUTHORITY:  ^
  • CROSS-REFERENCE:  4001^ASP^MULTIPLE^^^4001,.03,4001,.16
    1)= N Y1 S Y1=$P(^INTHU(DA,0),U,3) I Y1]"" S Y1=$E(Y1,1,30) S ^INTHU("ASP",Y1,$E(X,1,30),DA)=""
    2)= N Y1 S Y1=$P(^INTHU(DA,0),U,3) I Y1]"" S Y1=$E(Y1,1,30) K ^INTHU("ASP",Y1,$E(X,1,30),DA)
.17 SEQUENCE NUMBER 0;17 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>100000000)!(X<-1)!(X[".") X
  • LAST EDITED:  OCT 26, 1994
  • HELP-PROMPT:  Type a whole number between -1 and 100000000
  • DESCRIPTION:  
    This field is stuffed with the sequence number if the message is being sent under sequence number protocol.
  • CROSS-REFERENCE:  4001^ASEQ^MUMPS
    1)= Q
    2)= K ^INTHU("ASEQ",$P(^INTHU(DA,0),U,2),$P(^INTHU(DA,0),U,17))
    This is a cross reference in the format ^INTHU("ASEQ",dest.,seq #,da)="" For sites which use sequence number protocol, it allows interface messages to be re-queued based on the sequence number for the specified
    destination. The x-ref is set directly by the sequence number protocol routine. The x-ref is killed when the INTHU entry is purged or when the interface is restarted using a different sequence number.
.18 ACK MESSAGE (ACCEPT) 0;18 POINTER TO UNIVERSAL INTERFACE FILE (#4001) UNIVERSAL INTERFACE(#4001)

  • OUTPUT TRANSFORM:  S Y=$S($D(^INTHU(+Y,0)):$P(^(0),U,5),1:"")
  • LAST EDITED:  NOV 11, 1999
  • DESCRIPTION:  This is a recursive pointer to the accept acknowledgement message It will only be used for messages which require accept acknowledgement. Once the acknowledgement is received by the GIS, the ack is stored as an entry in
    the UIF and this field is updated for the originating message to point to the accept ack.
.19 TIME TO PROCESS 0;19 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>15 X
  • LAST EDITED:  NOV 14, 1994
  • HELP-PROMPT:  Answer must be 1-15 characters in length
  • DESCRIPTION:  This is stuffed with the time-to-process at the time the output controller creates the message. It is used as the default value if the message is re-queued. The value stuffed in this field is a string which is identical to
    the value of the time-to-process field in the Interface Transaction Type File.
.2 SUPRESS FROM OUTPUT 0;20 SET
  • '1' FOR YES;
  • '0' FOR NO;

  • LAST EDITED:  DEC 31, 1995
  • DESCRIPTION:  
    Indicates if message should not be processed by the output controller.
.21 DIVISION 0;21 POINTER TO MEDICAL CENTER DIVISION FILE (#40.8) MEDICAL CENTER DIVISION(#40.8)

  • LAST EDITED:  DEC 04, 1996
  • DESCRIPTION:  
    This division is associated with this transaction.
1 ACTIVITY LOG MULTIPLE 1;0 DATE Multiple #4001.01 4001.01

  • LAST EDITED:  OCT 26, 1994
  • DESCRIPTION:  
    This multiple contains an entry for each action (such as a successful transmission or a failure) as a message is processed by the GIS.
2.02 ORIGINATING SYSTEM 2;2 POINTER TO INTERFACE DESTINATION FILE (#4005) INTERFACE DESTINATION(#4005)

  • LAST EDITED:  JUN 25, 1996
  • HELP-PROMPT:  Enter an existing INTERFACE DESTINATION file IEN.
  • DESCRIPTION:  This is a pointer to the INTERFACE DESTINATION file, specifying the outbound destination associated with the originator of this inbound message. This field is used to support routing of application acknowledgements to the
    originating system when multiple instantiations of a remote system type exist.
2.03 USER WHO EDITED 2;3 POINTER TO USER FILE (#3) USER(#3)

  • LAST EDITED:  MAR 03, 1997
  • DESCRIPTION:  
    The user who last edited this transaction.  The user's number will appear in the @EDITED special script variable if this transaction is processed into the local database.
2.1 INCOMING MESSAGE ID 2;1 FREE TEXT

  • INPUT TRANSFORM:  K:X["""" X I $D(X) K:$L(X)>20 X
  • LAST EDITED:  DEC 16, 1994
  • HELP-PROMPT:  This is the incoming message id.
  • DESCRIPTION:  
    This field stores the message ID as transmitted by the remote system. It is used when the GIS creates an acknowledge message, of which the MSA segment must contain the originating message ID.
  • CROSS-REFERENCE:  4001^D
    1)= S ^INTHU("D",$E(X,1,30),DA)=""
    2)= K ^INTHU("D",$E(X,1,30),DA)
    This x-ref is used to look-up the message ID of incoming messages.
3 MESSAGE TEXT 3;0 WORD-PROCESSING #4001.03

  • LAST EDITED:  OCT 26, 1994
  • DESCRIPTION:  
    This is the actual text of the interface message.
4.01 TASK NUMBER 4;1 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999999999999)!(X<0)!(X[".") X
  • LAST EDITED:  APR 23, 1999
  • DESCRIPTION:  
    This is the task number created by the INHF routine to format a GIS message. The value is not entered by a user. It is entered by the GIS Formatter process when the message is created.
  • CROSS-REFERENCE:  4001^AT
    1)= S ^INTHU("AT",X,DA)=""
    2)= K ^INTHU("AT",X,DA)
    This cross ref. is used in the search function for the GIS query/response functionality in INTQRY routine.
4.02 TASK DATE/TIME 4;2 DATE

  • INPUT TRANSFORM:  S %DT="EST" D ^%DT S X=Y K:Y<1 X
  • LAST EDITED:  APR 23, 1999
  • DESCRIPTION:  
    This field holds the FileMan date and time that the Formatter task was scheduled to execute. It is not entered by a user. The value is entered by the GIS Formatter process as the message is created.
5 COMPUTED DATE COMPUTED DATE

  • MUMPS CODE:  N DIO S DIO(1)=$G(^INTHU(D0,0)) S X=$P(DIO(1),U),X=$P(X,".")
  • ALGORITHM:  DATE(#.01)
  • LAST EDITED:  JAN 25, 1996
  • DESCRIPTION:  
    This is a computed field.  It indicates the date of the message.  It is derived from the DATE/TIME (#.01) field.
6 INDA ARRAY 6;0 WORD-PROCESSING #4001.04 (UNEDITABLE)

  • DESCRIPTION:  
    INDA array merged into this outbound message by the Format Controller prior to outbound script execution.  Used by application teams screening logic to determine outbound destinations to which to route a message.
7 INA ARRAY 7;0 WORD-PROCESSING #4001.05 (UNEDITABLE)

  • DESCRIPTION:  Selected subnodes of the INA array merged into this outbound message by Format Controller after outbound script execution. Used by application teams screening logic to determine outbound destinations to which to route a
    message.
Info |  Desc |  Directly Accessed By Routines |  Accessed By FileMan Db Calls |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  All