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 |  Found Entries |  All
Print Page as PDF
Global: ^INRHT

Package: IHS Generic Interface System

Global: ^INRHT


Information

FileMan FileNo FileMan Filename Package
4000 INTERFACE TRANSACTION TYPE IHS Generic Interface System

Description

Directly Accessed By Routines, Total: 74

Package Total Routines
IHS Generic Interface System 74 INH4CONV    INHD    INHERR3    INHES2    INHF    INHFTDVX    INHFTM    INHFTMSM
INHFTNTM    INHMG1    INHMGD11    INHMS2    INHOQT1    INHOS    INHOU3    INHPCO1
INHPSA    INHPSA4    INHPSAL1    INHPSAM    INHPSAR    INHRDUP    INHRDUP1    INHRSE
INHSGZ    INHSYS03    INHSYS04    INHSYS05    INHSYSUT    INHT    INHU    INHUSEN2
INHUSEN3    INHUSEN8    INHUT2    INHUT7    INHUTC51    INHUTC52    INHVCRL2    INHVCRV
INMPORT    INTSTF    INTSTO    INTSTR    INTSUSN    INXHR04    INXPORT    IS00001C
IS00002C    IS00004M    IS00006E    IS00007M    IS00008    IS00009    IS00011C    IS00011G
IS00012    IS00013    IS00014A    IS00015B    IS00019B    IS00020A    IS00023B    IS00024
IS00024A    IS00028A    IS00028B    IS00029C    IS00029F    IS00029I    IS00029J    IS00030
IS00030A    IS00031C    

Accessed By FileMan Db Calls, Total: 13

Package Total Routines
IHS Generic Interface System 10 INHPSAR    INHSYS04    INHSYSDR    INHSYSUT    INHT    INHUT2    INMPORT    INTENV1
INXPORT    INZTTC    
IHS Support HL7 Interfaces 2 BHL3MS    BHLUP    
IHS Immunizations Interface 1 BYIMPORT    

Pointed To By FileMan Files, Total: 7

Package Total FileMan Files
IHS Generic Interface System 7 INTERFACE CRITERIA(#4001.1)[713.01#4001.13(.01)]
INTERFACE FORMATTER TASK(#4000.1)[.01]    INTERFACE DESTINATION(#4005)[.02.1]    INTERFACE TRANSACTION TYPE(#4000)[.06.09]    INTERFACE ERROR(#4003)[.02]    SCRIPT GENERATOR MESSAGE(#4011)[#4011.02(.01)]    UNIVERSAL INTERFACE(#4001)[.11]    

Pointer To FileMan Files, Total: 4

Package Total FileMan Files
IHS Generic Interface System 4 INTERFACE DESTINATION(#4005)[.02]    INTERFACE SCRIPT(#4006)[.03]    INTERFACE TRANSACTION TYPE(#4000)[.06.09]    BACKGROUND PROCESS CONTROL(#4004)[.17]    

Fields, Total: 26

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

  • INPUT TRANSFORM:  K:X["""" X I $D(X) K:$L(X)>60!($L(X)<3)!'(X'?1P.E)!'$$ISNS^INHUT2(X) X I $D(X),$D(^INRHT("B",X)) K X
  • LAST EDITED:  JUL 13, 1995
  • HELP-PROMPT:  The transaction type is the basis for creation of interface messages. Enter a unique name, 3-60 characters in length and properly name-spaced.
  • DESCRIPTION:  
    The INTERFACE TRANSACTION TYPE supplies the formatter process of the interface with information on how the formatter will handle any particular transaction.  The name must be UNIQUE.
  • EXECUTABLE HELP:  D:$D(DW)>1 MSG^INHUT2
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
  • CROSS-REFERENCE:  4000^B
    1)= S ^INRHT("B",$E(X,1,60),DA)=""
    2)= K ^INRHT("B",$E(X,1,60),DA)
  • CROSS-REFERENCE:  4000^AUNQ^MUMPS
    1)= D UNQ^INHUT2(DA)
    2)= Q
    Trigger to set unique ID when .01 entry is first created.
.02 DESTINATION 0;2 POINTER TO INTERFACE DESTINATION FILE (#4005) INTERFACE DESTINATION(#4005)

  • LAST EDITED:  APR 10, 1991
  • HELP-PROMPT:  Enter the DESTINATION to which this transaction type is to be sent. This field is not used for parent transaction types.
  • DESCRIPTION:  
    This points to the INTERFACE DESTINATION FILE, which contains the destination for the transaction type.
.03 SCRIPT 0;3 POINTER TO INTERFACE SCRIPT FILE (#4006) INTERFACE SCRIPT(#4006)

  • LAST EDITED:  APR 10, 1991
  • HELP-PROMPT:  Enter the name of the script which creates the interface message. No entry is needed if you will be using the script generator for the script because the field will be filled in automatically.
  • DESCRIPTION:  
    This field contains the name of the script which is run to generate an interface message. The field is automatically stuffed with the name if the script is created using the script generator.
.04 UNIQUE IDENTIFIER 0;4 FREE TEXT
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:X["""" X I $D(X) K:$L(X)>4!($L(X)<4)!('$$UNIQUE^INHUT2(X)) X
  • LAST EDITED:  AUG 22, 1994
  • HELP-PROMPT:  Answer must be 4 characters in length & unique
  • DESCRIPTION:  
    This field should contain a unique identifier for the transaction type.  Its value will be used in the construction of cms elements in the form of routines.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
  • CROSS-REFERENCE:  4000^ID
    1)= S ^INRHT("ID",$E(X,1,30),DA)=""
    2)= K ^INRHT("ID",$E(X,1,30),DA)
    This cross-reference will be used by the field to insure that all entries are unique.
.05 ACTIVE 0;5 SET
  • '0' FOR INACTIVE;
  • '1' FOR ACTIVE;

  • HELP-PROMPT:  If the transaction type is inactive the script generator will not generate a script for it. If an existing tt is changed from active to inactive, the interface formatter will ignore it.
  • DESCRIPTION:  
    This field designates whether the transaction type is active or inactive.
.06 PARENT 0;6 POINTER TO INTERFACE TRANSACTION TYPE FILE (#4000) INTERFACE TRANSACTION TYPE(#4000)

  • LAST EDITED:  JAN 14, 1991
  • HELP-PROMPT:  Enter the name of the "parent" transaction type. The scripts (messages) for the current transaction type will be triggered by the "parent" designated in this field.
  • DESCRIPTION:  
    The application calls a "parent" transaction type, which does not directly generate messages. "Child" transaction types point to the "parent" and do generate messages.
  • CROSS-REFERENCE:  4000^AC
    1)= S ^INRHT("AC",$E(X,1,30),DA)=""
    2)= K ^INRHT("AC",$E(X,1,30),DA)
.07 DEPENDENCY 0;7 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>1000)!(X<1)!(X[".") X
  • LAST EDITED:  AUG 01, 1995
  • HELP-PROMPT:  Type a whole number between 1 and 1000
  • DESCRIPTION:  Use this field to indicate the dependency order of the children TTs within a parent TT. Otherwise leave it blank. The Format controller executes the children TT in the dependency order entered (from low to high). The
    children TT that does not have a dependency value is executed last.
.08 IN/OUT 0;8 SET
************************REQUIRED FIELD************************
  • 'I' FOR IN;
  • 'O' FOR OUT;

  • LAST EDITED:  JUN 17, 1991
  • HELP-PROMPT:  Enter I for INCOMING transaction types, O for OUTGOING transaction types. Parent transaction types do not need to be designated.
  • DESCRIPTION:  
    Designates Outgoing vs Incoming transaction types.
.09 ACKNOWLEDGE TT 0;9 POINTER TO INTERFACE TRANSACTION TYPE FILE (#4000) INTERFACE TRANSACTION TYPE(#4000)

  • LAST EDITED:  JUN 12, 1991
  • HELP-PROMPT:  This field is only needed for INCOMING transaction types. Enter the name of the OUTGOING transaction type which creates the acknowledgement message.
  • DESCRIPTION:  
    If this field is non-null, it indicates that messages of this Transaction Type must be acknowledged.  The value placed here is the name of a Transaction Type which is used to send the outgoing acknowledge message.
.1 RETRY RATE 0;10 FREE TEXT

  • INPUT TRANSFORM:  K:(X'?1N.N1"D")&(X'?1N.N1"H")&(X'?1N.N1"M") X
  • LAST EDITED:  JAN 23, 1991
  • HELP-PROMPT:  Enter the number of hours (nnH), minutes (nnM) or days (nnD) between retry attempts. This is only used for OUTGOING transaction types.
  • DESCRIPTION:  
    This is the amount of time between attempts to process entries.  Only entries with the PENDING status will be retried.  Enter a number of hours (nnH), number of minutes (nnM), or number of days (nnD).
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
.11 MAX NUMBER OF ATTEMPTS 0;11 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999)!(X<1)!(X[".") X
  • LAST EDITED:  OCT 07, 1993
  • HELP-PROMPT:  Type a whole number between 1 and 9999
  • DESCRIPTION:  This indicates the maximum number of times that this type of transaction will be requeued. If no value is present in this field the default will be based on the value in the Max # of Attempts field in the Interface
    Destination file.
.12 ACKNOWLEDGE EXPECTED 0;12 SET
  • '0' FOR NO;
  • '1' FOR YES;

  • LAST EDITED:  JUN 12, 1991
  • DESCRIPTION:  This field is used for outgoing transactions to indicate whether or not an acknowledge is to be expected. This is important in determing the status of the transaction after transmission. If there is no acknowledge
    required, the transaction is COMPLETE after it is successfully sent.  Otherwise it's status is SENT (Awaiting Acknowledge) following its successful transmission.
.13 FORMATTER PROCESS TIME 0;13 FREE TEXT

  • INPUT TRANSFORM:  S X=$$CASECONV^UTIL(X,"U") Q:X="STAT" K:'$$RELDT^INHUTC21(X,"TS") X
  • LAST EDITED:  AUG 26, 1997
  • HELP-PROMPT:  Enter the time at which this transaction is to process in the formatter queue. Enter "STAT" to force to the top of the queue.
  • DESCRIPTION:  If this field is non-null, it will indicate a time at which a transaction of this type should be processed. This field will remain as the original text and not be transformed to a date. This value will be used as the
    implicit value of the 4th parameter of the ^INHF call.  Placing a value in the 4th parameter will override this value. Leaving this blank equates to NOW. An entry of STAT will force the transaction to the top of the queue.
    Examples of valid entry are: T-3@1030, NOW-2H, etc.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
.14 FORMAT PRIORITY 0;14 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>10)!(X<0)!(X?.E1"."2N.N) X
  • LAST EDITED:  AUG 04, 1994
  • HELP-PROMPT:  Enter a number between 0 (highest priority) and 10 (lowest). This is the priority in the format queue.
  • DESCRIPTION:  This field is used to prioritize messages as they are processed by the format controller. Valid values are from 0-10 with 0 (default) being the highest and 10 being lowest. If no priorities are assigned to any
    transactions, or if they all have the same priority, they will be processed in the order received.
.15 OUTPUT PROCESS TIME 0;15 FREE TEXT

  • INPUT TRANSFORM:  S X=$$CASECONV^UTIL(X,"U") Q:X="STAT" K:'$$RELDT^INHUTC21(X,"TS") X
  • LAST EDITED:  AUG 26, 1997
  • HELP-PROMPT:  Enter the time at which this transaction will be processed in the interface queue. Enter STAT to force to the top of the queue.
  • DESCRIPTION:  If this field is non-null, it will indicate a time at which a transaction of this type should be processed. This field will remain as the original text and not be transformed to a date. It should be a relative value such
    as T@0500 or T+1@0200 or NOW-2H.  A value of STAT will force entries to the top of the queue.  Leaving this blank equates to NOW.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
.16 OUTPUT PRIORITY 0;16 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>10)!(X<0)!(X?.E1"."2N.N) X
  • LAST EDITED:  AUG 04, 1994
  • HELP-PROMPT:  Enter the priority to be used in the output queue. Enter number between 0 (highest) and 10 (lowest).
  • DESCRIPTION:  This field is used to prioritize messages to the output controller. Valid values are from 0-10 with 0 (default) being highest and 10 being lowest. If no priorities are assigned to any transactions, or if all transactions
    have the same priority, they will all be procssed in the order received.
  • TECHNICAL DESCR:  
    Until August, 1994, priorities were set in field .08 of the Interface Destination File.
.17 BACKGROUND PROCESS 0;17 POINTER TO BACKGROUND PROCESS CONTROL FILE (#4004) BACKGROUND PROCESS CONTROL(#4004)

  • LAST EDITED:  JUN 22, 1995
  • HELP-PROMPT:  Enter Background Process to start when this Transaction Type is used with interactive messaging.
  • DESCRIPTION:  Pointer to an entry in the BACKGROUND PROCESS CONTROL file for a server background job that will be created by this transaction type. This field will be used during server creation to access the name of the routine to run
    and to search for the next available server slot.
.18 APPLICATION ACK CONDITIONS 0;18 SET
  • 'AL' FOR ALWAYS;
  • 'NE' FOR NEVER;
  • 'SU' FOR SUCCESS ONLY;
  • 'ER' FOR ERROR ONLY;

  • LAST EDITED:  JUL 06, 1995
  • HELP-PROMPT:  Enter a code in this field to specify the conditions under which an application acknowledgement will be created. Any value entered here will over-ride the value of the MSH-16 field.
  • DESCRIPTION:  This field specifies the conditions under which an application acknowledgement message will be created and returned in response to an incoming message. It is a set of codes which coincides with the HL7 specified values for
    acknowledgements. A value in this field will over-ride any value contained in MSH-16 of the incoming message.
1 DOCUMENTATION 1;0 WORD-PROCESSING #4000.01

  • DESCRIPTION:  
    This is a description of this transaction type.
3 API SRMC 3;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 API Selective Routing M Code.  Screening logic placed here will be executed at the GIS API (^INHF) process.   This screening logic is applicable to outbound parent transaction types only.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
4 FORMAT CONTROLLER SRMC 4;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 Format Controller Selective Routing M Code. Screening logic placed here will be executed at the Format Controller process. This screening logic is applicable to outbound parent, child, and base transaction
    types only.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
5 MESSAGE REPLICATION SRMC 5;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 Message Replication Selective Routing M Code. Screening logic placed here will be executed at the Message Replication process. This screening logic is applicable to outbound base and replicant transaction
    types only.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
6 OUTPUT CONTROLLER IN SRMC 6;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 Output Controller Inbound Selective Routing M Code.  Screening logic placed here will be executed at the Output Controller process.   This screening logic is applicable to inbound transaction types only.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
7 OUTPUT CONTROLLER OUT SRMC 7;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 Output Controller Outbound Selective Routing M Code. Screening logic placed here will be executed at the Output Controller process. This screening logic is applicable to outbound child and base transaction
    types only.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
8 RECEIVER SRMC 8;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.   This screening logic is applicable to inbound transaction types only.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
9 TRANSMITTER SRMC 9;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.   This screening logic is applicable to outbound child and replicant transaction types only.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER

Found Entries, Total: 32

NAME: HL IHS DW1ALPMR A08 OUT CHILD    NAME: HL IHS DW1ALPMR A08 OUT PARENT    NAME: HL IHS IZV04 ACCEPT ACKNOWLEDGEMENT    NAME: HL IHS IZV04 IN    NAME: HL IHS IZV04 INCOMING ACK    NAME: HL IHS IZV04 OUT CHILD    NAME: HL IHS IZV04 OUT FOOTER CHILD    NAME: HL IHS IZV04 OUT FOOTER PARENT    
NAME: HL IHS IZV04 OUT HEADER CHILD    NAME: HL IHS IZV04 OUT HEADER PARENT    NAME: HL IHS IZV04 OUT PARENT    NAME: HL IHS IZV04 QBP OUT CHILD    NAME: HL IHS IZV04 QBP OUT PARENT    NAME: HL IHS IZV04 SEND ACK    NAME: HL IHS IZV04 V01 IN    NAME: HL IHS IZV04 V01 OUT CHILD    
NAME: HL IHS IZV04 V01 OUT PARENT    NAME: HL IHS IZV04 V01VXQ IN    NAME: HL IHS IZV04 V01VXQ OUT CHILD    NAME: HL IHS IZV04 V01VXQ OUT PARENT    NAME: HL IHS IZV04 V02 IN    NAME: HL IHS IZV04 V02 OUT CHILD    NAME: HL IHS IZV04 V02 OUT PARENT    NAME: HL IHS IZV04 V02VXX IN    
NAME: HL IHS IZV04 V02VXX OUT CHILD    NAME: HL IHS IZV04 V02VXX OUT PARENT    NAME: HL IHS IZV04 V03 IN    NAME: HL IHS IZV04 V03 OUT CHILD    NAME: HL IHS IZV04 V03 OUT PARENT    NAME: HL IHS IZV04 V03VXR IN    NAME: HL IHS IZV04 V03VXR OUT CHILD    NAME: HL IHS IZV04 V03VXR OUT PARENT    
Info |  Desc |  Directly Accessed By Routines |  Accessed By FileMan Db Calls |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  Found Entries |  All