Parameters
-a (Append)
Optional
Requests that the generated EDI data be appended to the output file (specified with the -o parameter) if it already exists. This overrides the default behavior of replacing the file if it exists.
Format of Parameters
-a
Example
Append the generated EDI data to the existing EDI_997.txt output file instead of replacing it:
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -a
-apf (APF File)
Optional, unless you are generating CTX segments for a 999 or overriding values in Response Generator output files (see on the page ).
Allows you to signal the use of a Validation Profile (.apf) file. A similar entry in the TPA setup file, called ‘APFPath’, will also be added.
Format of Parameters
-apf
filename
filename | The APF file to be used, including path and filename. |
Example
Use the specified .apf file when processing this request:
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -
apf
"C:\profiles\custom.apf"
-c (Control Number)
Optional
Specifies the starting transaction set control number for the outbound EDI file.
For X12, this is the starting ST02 number.
For EDIFACT, this is the starting UNH01 number.
Format of Parameters
-c
n
Where:
n
A number greater than zero. Default is 1.
OR
Is the starting number control number. It can be either of these:
-
A control number.
-
The name of a file that contains the control number. If this file does not exit, Response Generator creates it and places the first control number in it. If it does exist, Response Generator uses the number it contains for the first control number. It then updates the file each time it uses a control number. This lets you run multiple instances of Response Generator, all using unique control numbers.
Example
Make 500 the starting ST02 number for the outbound EDI file:
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -
c 500
-cd (Configuration Directory)
Optional
Specifies the directory in which RespGen should look to find the configuration files ErrMsgTrans.txt and ErrRespXref.txt.
Format of Parameters
-cd
directory
Where:
directory
|
Path to the configuration files ErrMsgTrans.txt and ErrRespXref.txt. |
Example
Direct RespGen to look in c:\configs for the necessary error configurations files:
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -
cd
“c:\configs”
-csovr (Control Segment Override)
Optional, X12, and EDIFACT responses only.
Directs Response Generator to use the value of the specified field in the interchange and/or group header segment(s).
Format of Parameters
-csovr
key=value;key=value
Where:
key
|
Mnemonic of X12 or EDIFACT interchange or group header segment field. See X12 Key Information and EDIFACT Key Information . |
value
|
Value to be used in the specified field. |
Example 1
Direct Response Generator to look in c:\configs
for the necessary error configurations files:
RespGen –csovr"ISENDQ='01';ISEND='12345';IRECVQ='01';
IRECV='00WERQ'"
Example 2
Set an outgoing element as empty. Note that empty elements will be written, even if they are the last element of a segment.
RespGen -csovr"ISENDQ=''"
This will create the following:
UNB+UNOB:1+987654321:1:ROUTING ADDR+123456789:1+170906:1422+1
++++++
'
Omit the -csovr flag if you prefer those empty elements not be written:
UNB+UNOB:1+987654321:1:ROUTING ADDR+123456789:1+170906:1422+1'
Example 3
Use the backslash character (\) as an escape character to include a single quote or a backslash in a value:
-csovr"ISEND='JIM\'SCO'"
Example 3
Use two consecutive single quotes to send nothing in a field (i.e., force the field to be blank):
-csovr"-IDATE='';ITIME=''"
X12 Key Information
KEY= (X12 Field Mnemonic) |
X12 Element ID |
X12 Element Name |
X12 Version Information |
---|---|---|---|
Segment ISA Interchange Control Header | |||
AUTHQ |
ISA01:I01 |
Authorization Information |
|
AUTH |
ISA02:I02 |
Authorization Information |
|
SECQ |
ISA03:I03 |
Security Information Qualifier |
|
SEC |
ISA04:I04 |
Security Information |
|
ISENDQ |
ISA05:I05 |
Interchange ID Qualifier |
|
ISEND |
ISA06:I06 |
Interchange Sender ID |
|
IRECVQ |
ISA07:I05 |
Interchange ID Qualifier |
|
IRECV |
ISA08:I07 |
Interchange Receiver ID |
|
IDATE |
ISA09:I08 |
Interchange Date |
|
ITIME |
ISA10:I09 |
Interchange Time |
|
Stx
|
ISA11:I10 |
Interchange Control Standards Identifier |
pre-4020 |
IVER |
ISA12:I11 |
Interchange Control Version Number |
|
ICTL |
ISA13:I12 |
Interchange Control Number |
|
ACK |
ISA14:I13 |
Acknowledgment Requested |
|
USAGE |
ISA15:I14 |
Interchange Usage Indicator |
|
SESEP |
ISA16:I15 |
Component Element Separator |
|
Segment GS Functional Group Header |
|||
FUNCID |
GS01:479 |
Functional Identifier Code |
|
GSEND |
GS02:142 |
Application Sender's Code |
|
GRECV |
GS03:124 |
Application Receiver's Code |
|
GDATE |
GS04:373 |
Date |
|
GTIME |
GS05:337 |
Time |
|
GCTL |
GS06:28 |
Group Control Number |
|
RAC |
GS07:455 |
Responsible Agency Code |
|
GVER |
GS08:480 |
Version/Release/Industry Identifier Code |
|
EDIFACT Key Information
KEY= |
EDIFACT Element ID |
EDIFACT Element Name |
EDIFACT Version Info |
---|---|---|---|
Segment UNB Interchange Header | |||
|
UNB01:S001 |
|
|
SYNID |
UNB01.01:0001 |
Syntax Identifier |
|
SYNVER |
UNB01.02:0002 |
Syntax Version Number |
|
SCVER |
UNB01.03:0080 |
Service Code List Directory Version Number |
V4 |
ENC |
UNB01.04:0133 |
Character Encoding, Coded |
V4 |
SYNREL |
UNB01.05:0076 |
Syntax Release Number |
V4 |
|
UNB02:S002 |
|
|
ISEND |
UNB02.01:0004 |
Interchange Sender Identification |
|
ISENDQ |
UNB02.02:0007 |
Identification Code Qualifier |
|
ISENDID |
UNB02.03:0008 |
Interchange Sender Internal Identification |
|
ISENDSUBID |
UNB02.04:0042 |
Interchange Sender Internal Sub-Identification |
V4 |
|
UNB03:S003 |
|
|
IRECV |
UNB03.01:0010 |
Interchange Recipient Identification |
|
IRECVQ |
UNB03.02:0007 |
Identification Code Qualifier |
|
IRECVID |
UNB03.03:0014 |
Interchange Recipient Internal Identification |
|
IRECVSUBID |
UNB03.04:0046 |
Interchange Recipient Internal Sub-Identification |
V4 |
|
UNB04:S004 |
|
|
IDATE |
UNB04.01:0017 |
Date |
|
ITIME |
UNB04.02:0019 |
Time |
|
ICTL |
UNB05:0020 |
Interchange Control Reference |
|
|
UNB06:S005 |
|
|
ACK |
UNB09:0030 |
Acknowledgment Requested |
|
USAGE |
UNB11:0035 |
Interchange Usage Indicator |
|
RECPW |
UNB06.01:0022 |
Recipient Reference/ Password |
|
RECPWQ |
UNB06.02:0025 |
Recipient Reference/ Password Qualifier |
|
APPLREF |
UNB07:0026 |
Application Reference |
|
PROCPTY |
UNB08:0029 |
Processing Priority Code |
|
AGREEID |
UNB10:0032 |
Interchange Agreement Identifier |
|
Segment UNG Functional Group Header |
|||
MSGGRPID |
UNG01:0038 |
Message Group Identification |
|
|
UNG02:S006 |
|
|
GSEND |
UNG02.01:0040 |
Application Sender Identification |
|
GSENDQ |
UNG02.02:0007 |
Application Code Qualifier |
|
|
UNG03:S007 |
|
|
GRECV |
UNG03.01:0044 |
Application Recipient Identification |
|
GRECVQ |
UNG03.02:0007 |
Application Code Qualifier |
|
|
UNG04:S004 |
|
|
GDATE |
UNG04.01:0017 |
Date |
|
GTIME |
UNG04.02:0019 |
Time |
|
GCTL |
UNG05:0048 |
Group Reference Number |
|
RAC |
UNG06:0051 |
Controlling Agency, Coded |
|
|
UNG07:S008 |
|
|
MSGVNO |
UNG07.01:0052 |
Message Version Number |
|
GVER |
UNG07.02:0054 |
Message Release Number |
|
AAC |
UNG07.03:0057 |
Association Assigned Code |
|
APPLPW |
UNG08:0058 |
Application Password |
|
-dac (Specify Starting Group Control Number)
Optional
Specifies the Starting Group Control Number for the first outbound group envelope in each interchange.
For X12, this is the starting GS06 number.
For EDIFACT, this is the starting UNG05 number.
Format of Parameters
-dac n
Where:
n
Is a number greater than 0 and less than or equal to 999999999 (that’s nine 9s). The default is 1.
OR
Is the starting number control number. It can be either of these:
-
A control number.
-
The name of a file that contains the control number. If this file does not exist, the Response Generator creates it and places the first control number in it. If it does exist, Response Generator uses the number it contains for the first control number. It then updates the file each time it uses a control number. This lets you run multiple instances of Response Generator, all using unique control numbers.
Example group control numbers:
|
no -dac on command line |
-dac 5 on command line |
---|---|---|
ISA |
|
|
GS |
1 |
5 |
GS |
2 |
6 |
ISA |
|
|
ISA |
|
|
GS |
1 |
5 |
GS |
2 |
6 |
ISA |
|
|
Example
When generating this output, have Functional Group Control Numbers start at 1001.
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt”
-dac 1001
-dar (Application Receiver ID)
Optional
Specifies the Application Receiver ID (GS03) for the outbound GS.
Format of Parameters
-dar dar
Where:
dar
Desired Application Receiver ID. 2 to 15 alphanumeric characters. Default is the first Application Sender ID (GS02) in the inbound EDI file.
Example
Make PURCH1256 the Application Receiver ID for the outbound GS:
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -
dar PURCH1256
-das (Application Sender ID)
Optional
Specifies the Application Sender ID (GS02) for the outbound GS.
Format of Parameters
-das das
Where:
das
Desired Application Sender ID. 2 to 15 alphanumeric characters. Default is the first Application Receiver ID (GS03) in the inbound EDI file.
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -
das PURCH1258
-dav (Application Version)
Optional
Specifies the Application Version (GS08) for the outbound GS. Regardless of the contents of the GS08 being created, Response Generator will use the rules described on page Output Version. If the transaction has an ST03, this will be populated by the same value as the GS08.
Format of Parameters
-dav
string
Where:
string
Desired Application Version. A string from 1 to 12 characters long. Default is 005010.
Example
Make 004010 the application version for the outbound GS:
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt”
-dav 004010
-dcc (Contact Information)
Optional
Specifies the contact information needed for the custom report trailers.
Format of Parameters
-dcc
contact_info
Where:
contact_info
User-defined contact information.
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt”
-dcc AlphaHealthcare
-dcd (864 Description)
Optional
Allows you to specify the 864 description field.
Format of Parameters
-dcd description
Where:
description The 864 description field. (Up to 80 alphanumeric characters.)
Example
-i
input_file
-o997
output_file
-dcd Claim123
-dcg (GS Control Number)
Optional
Allows you to specify a GS Control Number. This user-specified GS Control Number should be thought of as a GS-level trace number; it is not the same as the GS06 number.
Format of Parameters
-dcg n
Where:
n
The desired GS Control Number. (1-9 numbers.)
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt”
-dcg 0009
-dcm (864 MIT Description)
Optional
Allows you to specify the 864 MIT description field.
Format of Parameters
-dcm n
Where:
n
The 864 MIT description field. (Up to 80 alphanumeric characters.)
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt”
-dcm Claim46
-dco (Original filename)
Optional
Specifies the original filename value as needed for the Custom Report headers.
Format of Parameters
-dco original_filename
Where:
Original_filename
The original filename.
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -dco “AllClaims030510”
-dcp (864 Purpose Code)
Optional
Allows you to specify the 864 purpose code.
Format of Parameters
-dcp code
Where:
code
The desired 864 purpose code.
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -dcp DCPC1
-de<option> [-dea, -dec, -der, and dev] (New UNH Values)
Optional
Allows you to specify a new UNHx value.
Format of Parameters
-de
<option> value
Where:
<option> |
|
value
|
The appropriate number or code. |
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -der 101
-dic (Interchange Control Number)
Optional
Allows you to specify the 864 MIT description field.
Format of Parameters
-dic
start
(min max)
Where:
start |
Mandatory if -dic is used. It is the starting number control number. It can be either of these:
|
min | Minimum number for a range of control numbers. Required if max is used. |
max |
Maximum number for a range of control numbers. Required if min is used. The control number automatically increments until it reaches the value you specified in max or until it reaches 999999999. At that point, it starts over at min (if used) or 1. |
Example
When generating this output, have Interchange Control Numbers start with 9001:
-i ”C:\Files\HV_Results.txt” -o824 ”C:\Files\EDI_824.txt”
-o997 ”C:\Files\EDI_997.txt” -o277 ”C:\Files\EDI_277.txt” -ge -dic 9001 -dac 1001 -s
Here are additional examples of responses with and without the -dic command:
Inbound data |
Response |
ISA13 without -dic |
ISA13 with -dic 148, 100, 150 |
---|---|---|---|
ISA |
|
|
|
837 |
997 |
1 |
148 |
|
824 |
2 |
149 |
837 |
997 |
3 |
150 |
|
824 |
4 |
100 |
IEA |
|
|
|
ISA |
|
|
|
837 |
997 |
5 |
101 |
|
824 |
6 |
102 |
IEA |
|
|
|
-diq (generate a TA1 for the document)
Optional
Sets a flag in the ISA14 element to notify the receiver that the sender is expecting a TA1 to be returned for the document.
-diq <on|off>
Format of Parameters
-diq <on|off>
Where:
on | If on, ISA14 is set to '1', indicating the sender is requesting a TA1 be returned for the document. |
off |
If off, ISA14 is set to '0' (default), indicating the sender is not requesting a TA1 for the document. |
Example
RespGen -i “HV_Results.txt” -o824 ”C:\Files\EDI_824.txt” -ge
-y -diq on -fUseShortGS05"
-dir and -dis (Interchange Receiver ID and Qualifier or Sender ID and Qualifier)
Optional
Change the:
Interchange Receiver ID and qualifier (-dir) to be used in the outbound ISA07 and ISA08
Or
Interchange Sender ID and qualifier (-dis) to use in the outbound ISA05 and ISA06.
Defaults are the values from the ISA07 and ISA08 or the ISA05 and ISA06 in the originating interchange.
Format of Parameters
-dir
qq*nnnnnnnn
or
-dis
qq*nnnnnnnn
Where:
qq* |
The qualifier is followed by an asterisk. The qualifier is 2 characters long. If you omit qq to accept the qualifier from the originating document, also omit the asterisk. Note: The asterisk character is required after qq, it is not a variable and does not represent an element separator. Response Generator will automatically use the appropriate element separator. Do not substitute a different character or the string will be interpreted incorrectly. See Incorrect Example, below.
|
nnnnnnnn | The receiver or sender ID, 2-15 alphanumeric. If shorter than 15, it will be padded on the right with spaces to make it 15 characters. |
Examples
ISA07 will be XX and ISA08 will be 123456789012345:
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -dir “XX*123456789012345”
ISA07 will be whatever was used in the originating interchange. ISA08 will be 1234567890 followed by 5 spaces of padding:
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -dir “1234567890”
Incorrect example
This command line incorrectly attempts to use a character other than an asterisk between the qq and nnn… values.
When Response Generator finds no * in the -dir command, the string is treated as one value. Therefore the ISA07 will be whatever was used in the originating interchange and the ISA08 will be XX\1234567890 followed by 2 spaces of padding.
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -dir “XX\1234567890”
-diu (Interchange Usage Indicator)
Optional
Specifies the Interchange Usage Indicator (ISA15) for the outbound ISA.
Format of Parameters
-diu
indicator
Where:
Indicator |
One of the following usage indicators: I = Information (leaves the ISA15 unchanged, regardless of validity) P = Production (default) T = Testing X =Use the value from the input file’s ISA15 |
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -diu T
-e<option> (Error Severity and Encoding)
Optional
Error Severity
Sets the error severity that will result in
-
a rejected transaction set (-er)
-
an ‘Accepted but Errors were Noted’ acknowledgment for the transaction set (-ew).
See Acceptance or Rejection Criteria for details about how -er and -ew work together.
Format of Parameters
-e<
option
>
n
Where:
<option> |
|
n |
One of the following error severity codes: 0 = Ignore 1 = Information 2 = Warning 3 = Error (Default) 4 = Serious Error 5 = User Level #1 6 = User Level #2 |
Example
Accept sets with severities of 2 and 3 with errors. Reject sets with severities of 4 and above:
RespGen -i “HV_Results.txt” -o999 “EDI_999.txt” -er 4 -ew 2
Encoding
Sets the encoding for the output data.
See UNICODE_at_Foresight.pdf for details about encoding.
Format of Parameters
-e<
option
>
Where:
<option> |
|
If -e is omitted, the output will match the originating file but without any BOM.
Example
Creates a 999 encoded as UTF16:
RespGen -i “HV_Results.txt” -o999 “EDI_999.txt” -eUTF16 -ge
-f (Format)
Optional
The -f parameter can be used to specify numerous formatting options for the Response Generator output.
Format of Parameters
-f<
option
>
Where -foption can be any of the following:
-f997_group_only
|
Causes 997s and 999s to have AK1 and AK9 segments only (no AK2/AK3/AK4/AK5). |
-fak3 | For warnings (severity of 2), Inserts AK3/AK4 in 997s and IK3/IK4 in 999s. |
-fak901E
|
Causes Response Generator to use E in the 997/999 AK901 to indicate Accepted with Errors when all AK501s generated for the functional group are set to A or E. By default, the AK901 contains A under these circumstances. |
-fAllowAll2000D
|
Produces a 277CA that includes patient-level errors (2000D). |
-fca277 | Generates a 277CA instead of a 277U (must be accompanied by -o277). |
-fdo_gs08_passthrough
|
Causes GS08 for created 997 to mirror the GS08 of the source document. This option is incompatible with the -dav option, and Response Generator will fail if both are set. |
-fdo277x070 | Creates a 277 that conforms to the 3070x070A standard. |
-fdo277x167 | Creates a 277 that conforms to the 4040x167 standard. |
-fdo824x166 |
Creates an 824 that conforms to the 824x166 standard. |
-fdo824x186 | Creates an 824 that conforms to the 824x186 standard. |
-fdo864wrapper
|
Creates an 864 wrapper around a custom report. All enveloping flags are valid if this parameter is used. |
-f997_no_ST03 | Suppresses the ST03 in cases where the response document is greater than 4060. |
-fdo999ne | Creates a non-errata version (based upon 005010x231) of the HIPAA 999. |
-fdo_ctlnum_passthrough | If set, all control numbers (ISA, GS, ST) are passed through to all generated response documents. |
-fdogs05_hhmm | If present, the format of the GS05 is set to four characters (HHMM). |
-fdogs05_hhmmss
|
If present, the format of the GS05 is set to six characters (HHMMSS). |
-fdogs05_hhmmssd | If present, the format of the GS05 is set to seven characters (HHMMSSD). |
-fdogs05_hhmmssdd | If present, the format of the GS05 is set to eight characters (HHMMSSDD). |
-fdo_gs06_passthrough | If set, outgoing response documents (864, 997, 824, and 277) will use the GS06 (Group Control Number) of the incoming document. MIT01 is currently set to GS06, so using the -fdo_gs06_passthrough flag will cause the MIT01 to be set to the incoming GS06. |
-fdo_HIPAA_824 | Generates an 824 that conforms to either the 824x166 or 824x186 standard, based upon the version of the source document. |
-fdo_loop_rollup |
Causes 277CA, 277H, and 277U responses to have one loop per provider, even if the incoming document had multiple 2000A loops for a single provider. This parameter should be used with caution as it can cause differences in the interpretation of bad claims between the response document and DocSplitter/Importer. |
-fdostrict999 |
(Instream Healthcare Edition/HIPAA Only) If possible, generates a syntactically correct (types 1-2) 999 response that is valid according to the base X12 5010 999 syntactical requirements. Note: The generation of a 999 response with this specification is entirely dependent on your inbound data. The strict 999 implementation attempts to create a syntactically correct 999 response based on your inbound data. If any inbound data required for use in the 999 does not meet syntax (i.e., min/max lengths, missing mandatory elements, invalid characters, etc.), an error is generated and no 999 is created.
Important: It is recommended that you test the use of this parameter thoroughly before promoting it to your production environment.
|
-fdostrictTA1 |
(Instream Healthcare Edition/HIPAA Only) If possible, generates a syntactically correct TA1 response that is valid according to the base X12 5010 TA1 syntactical requirements. You must use the -oTA1 parameter with this parameter. Example: -oTA1 TA1.txt -fdostrictTA1 Note: The generation of a TA1 response with this specification is entirely dependent on your inbound data. The strict TA1 implementation attempts to create a syntactically correct TA1 response based on your inbound data. If any inbound data required for use in the TA1 does not meet syntax (i.e., min/max lengths, missing mandatory elements, invalid characters, etc.), an error is generated and no TA1 is created.
Important: It is recommended that you test use of this parameter thoroughly before promoting it to your production environment.
|
-fedifact_gen_una |
Generates a UNA segment in the EDIFACT CONTRL response. (If this is not set, Response Generator generates a UNA if any delimiters are different from the defaults.) |
-fedifact_ic_only |
Causes the EDIFACT CONTRL document to generate a response for the status of the Interchange only. |
-fedifact_no_ucm | Causes the EDIFACT CONTRL document to generate a response for the Interchange/Functional Group. |
-fhm277 | Causes the requested 277 to be generated in a specific format. This is a highly customized parameter that is only useful in very specific circumstances. |
-floose_src_check | Causes Response Generator to return 100 (success) even in cases where it can’t create a response document from the source, such as a 997 from a 997 or a 277 from a non-837. |
-fno_AIS | If present, the generated 277U will NOT use the value in a ZZKPA custom record that has been inserted into the validation detail file via business rules. |
-fno_AK103 | Suppresses output of the 997 AK103 segments. By default, AK103s are created if the source document is version 4060 or greater or if a 999 is requested. If this parameter is present, AK103 output is suppressed. |
-fno_ung | Turns off functional group (UNG) data in EDIFACT CONTRL responses |
-fsa824 and fsa277 | Creates 824s and 277s from clean documents. |
-fSTC12_Write_2000D_Only
|
Generates a 277CA with the 2000D STC12 only. |
-fuse_highest_99x
|
Generates options any previously specified output (such as -o997 or -o999 |
-fuseshortGS05
|
If present, the GS05 is set to four characters (HHMM), instead of the default six (HHMMSS). |
-fver_pass
|
Causes Response Generator to pass the ISA and GS version numbers for the source document through unchanged. ST03/AK0103/AK0203s are generated based on the presence or absence of ST03 in the source document. |
-fWriteSTC12 | When generating a 277CA, causes Response Generator to write the DTL record's more descriptive error text (EMSG) into the STC12 when STC01.01=A3 and STC01.02=21 is encountered. Note: The STC12 will be used at any loop level when the A3:21 condition is met. This will generate an invalid 277CA when the errors reported within are at the 2000B or 2000C level. Example: Default behavior provides error information that may be considered too generic to be useful. 21=Missing or invalid information If -fWriteSTC12 is used, the more descriptive error message found in the Instream Detail file is written into the STC12 segment (when STC01.01=A3 and STC01.02=21 are both presents).
|
Examples
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt”
-f997_group_only
RespGen -i “HV_Results.txt” -o277 “EDI_277.txt” -fca277
-ge (Generate interchange and functional group)
Optional
Generate interchange and functional group envelopes (the TA1 response does not need functional groups).
The -di options control various envelope elements. If no Sender and/or Receiver IDs are specified on the command line, the Response Generator will use the Sender/Receiver IDs from the inbound envelope, reversing them for the outbound transaction.
Format of Parameters
-ge
Example
-i ”C:\Files\HV_Results.txt” -o824 ”C:\Files\EDI_824.txt” -o997 ”C:\Files\EDI_997.txt” -o277 ”C:\Files\EDI_277.txt” -ge -dic 9001 -dac 1001 -s
-gTA1 (Generate TA1 segment)
Optional
Generate a TA1 segment within the 997 or 999. This determines the conditions under which a TA1 segment will be created.
If -gTA1 is omitted, but -oTA1 is used, then option 2 (Always) is assumed.
For details, refer TA1 Parameter Combinations.
Format of Parameters
-gTA1 n
Where:
n |
One of the following: 0 = Never (default). 1 = Generate TA1 acknowledgment for interchanges if the ISA14=1. This works if the ISA1 SVALU record is present in the results. If the SVALU is not present, Response Generator outputs the TA1 by default. 2 = Always (default). If -gTA1 is omitted, but -oTA1 is used, then option 2 (Always) is assumed. 3 = If envelope errors occurred. 4 = If envelope errors occurred, the only segment between the ISA and IEA will be the TA1. No 997 or 999 data will be generated for that interchange. 5 = If envelope errors occurred, the only segment between the ISA and IEA will be the TA1. No 997 or 999 data will be generated for that interchange and no other output (824, 277, custom report, etc.) will be generated for that interchange. 6 = Output is controlled by the contents of the ISA14 as shown on page TA1 Parameter Combinations. |
Example
For details, refer TA1 Parameter Combinations.
-i (Input File)
Required
Specifies the Instream validation detail results file to be used as input by Response Generator. This input file and a specified output file are the two required parameters for RespGen. All other parameters are optional.
Format of Parameters
-i
filename
Where:
filename
The validation results file to be used as input, including path and filename.
Example
Using the file “Validation_Results.txt” as input, output an 824 response document and save it to “EDI_824.txt”:
RespGen -i "C:\Files\Validation_Results.txt" -o824 “C:\Files\EDI_824.txt”
-k (Lenient AK501)
Optional
Specifies that a 997 or 999 AK501 and AK509 can contain only A or E:
-
If there are no errors, then the AK501 = A.
-
If there are errors, regardless of type or number of claims, then the AK501 = E.
Format of Parameters
-k
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -k
-l (Delimiters)
Optional
Segment, element, composite subelement, and element repetition delimiters to use in the outbound EDI file. Each delimiter may be the actual character, or the ASCII number representing the character.
This ASCII number may be hexadecimal, by starting the number with 0x, octal by starting the number with a zero, or decimal.
If a new-line sequence is to be used as a segment terminator, set the Segment Delimiter to zero (0), and do NOT use the -n option below.
Default delimiters are:
Segment | ~ |
Element | * |
Subelement | : |
Element repetition |
^ |
Format of Parameters
-l
“segdelim,elemdelim,compdelim,elemrep”
See the examples for clarification of “segdelim,elemdelim,compdelim,elemrep”.
Example
To change the segment terminator to the character |, and the element separator to the character #, use this parameter:
-l "|,#"
Segment terminator = |, element separator = \, and composite subelement separator = #
-l "|,\,#,&"
Segment terminator = | and element separator = \ (In the absence of a subelement separator, use two slashes to distinguish it from the escape character slash)
-l "|,\\"
Segment terminator = the RS control character (ASCII 30), composite sub-element separator= the character ^
-l "30,,^"
Instead of 30 for segment terminator, we could have used the hexadecimal equivalent 0x1E, or the octal equivalent 037.
-lsource (Use Source delimiters)
Optional
Directs RespGen to use the source document’s delimiters for the response document delimiters.
Format of Parameters
-lsource
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -lsource
-n (No New-Line)
Optional
No new-line sequence follows each segment delimiter in the EDI output.
Format of Parameters
-n
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -n
-np (No Partial Functional Group)
Optional
No partial functional group acceptance is permitted when generating a 997 or 824 response. If any transaction is rejected, the entire functional group is rejected.
The default behavior is to partially accept a functional group if any transaction set is accepted, and reject a functional group only if all transaction sets are rejected.
Format of Parameters
-np
Example
RespGen -i “HV_Results.txt” -o824 “EDI_824.txt” -np
-nz (No Zero Length Files)
Optional
No zero length files are to be generated. If any generated files are 0 bytes long, they are deleted.
Format of Parameters
-nz
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -nz
-o (Output Type)
Required
Specifies the type of output to be generated from the Instream validation detail results input file and the file where the output should be saved. The input file (-i) and the specified output type and destination file are the two required parameters for RespGen. All other parameters are optional.
Format of Parameters
-o<
type> filename
Where:
type
|
Is any one of the available response types. See Output Type Options below. |
filename | The validation results file to be used as input, including path and filename. |
Output Type Options
Any of these output types can be used in the -otype file name parameter:
277 |
Output either a 277U or a 277CA with file name yyy.
|
||||||||||||||||||
824 | Output an 824 with file name yyy. The 824 reports on errors only, so if the input contains no errors, then the 824 output will be empty. | ||||||||||||||||||
997 | Output a 997 with file name yyy. You cannot generate both a 997 and a 999. | ||||||||||||||||||
999 |
Output a 999 with file name yyy. You cannot generate both a 997 and a 999. The type of 999 generated is based on published standards adopted for X12 999 implementation. The following 4010 and 5010 HIPAA documents result in a 999 5010X231 or 5010X231A1 response:
This type of 999 includes:
All other 4010 and 5010 documents, such as 824, 850, etc., result in a 5010 response. This type of 999 includes:
|
||||||||||||||||||
ctl | Output an EDIFACT CONTRL message with file name yyy. | ||||||||||||||||||
msa | Output an HL7 MSA (Message acknowledgment segment) with file name yyy. | ||||||||||||||||||
TA1 | Output a file containing a TA1 segment surrounded with ISA and IEA, instead of putting the TA1 in the 997 or 999 files. (See also -gTA1.) Note that this parameter produces a TA1 even if syntactically incorrect data means the TA1 is invalid.
Example: -oTA1 TA1file.txt If -gTA1 is not used, a TA1 value of 2 (Always) is assumed. If -gTA1 is 0, a warning is issued and no TA1 is created. Use -fdostrictTA1 to produce a TA1 only when the TA1 is valid according to the base X12 5010 TA1 syntactical requirements. For details, refer TA1 Parameter Combinations. |
||||||||||||||||||
text | Used to generate custom report output. See “-otext (Output Custom Report)”. |
Example
Using the specified input file, output an 824 response document and save it to “EDI_824.txt”:
RespGen -i "C:\Files\Validation_Results.txt" -o824 “C:\Files\EDI_824.txt”
-otext (Output Custom Report)
Optional
Generates text, formats the text using the specified template, and outputs a custom report. You can only output one custom report at a time (the command line cannot have two -otext parameters). The input EDI that was validated can be 837, 834, 835, 276 or 277u.
See page for details about custom reports and templates.
Format of Parameters
-otext -tpl
tplfilename
(-te n -tel nn -tev nn) filename
Where:
tpl | Required. Specifies a template (tplfilename) to be used when creating the custom report. |
te |
Optional. Specifies the contents of the custom report, where n = 0 All 1 Error only (default) 2 Error-free only 3 Claims with errors, but only if the errors are not envelope-related 4 Claims with warnings only (no errors) |
tel
|
Optional. Specifies which error types are included in the report. Example: -tel 123 |
tev | Optional. Specifies which severity levels are included in the If -tev is omitted, all severity levels are included in the report. |
filename | Required. The name of the file in which the -otext output should be saved. |
See page for details about custom reports.
Example
Using the specified input file, output a text response document that uses the template 824Custom(-tpl) shows all claims (-te 1) and includes errors of types 1, 2, and 3 (-tel 123), all severity levels (-tev option is omitted) and save it to “Custom_824.txt”:
RespGen -i "C:\Files\Validation_Results.txt" -otext -tpl (C:\Templates\824Custom” -te 1 -tel 123 “C:\Files\Custom_824.txt”
-pt (Partial transaction set acceptance)
Optional
The partial transaction set acceptance. A transaction set can be accepted with errors if you use Response Generator’s -pt parameter. You can then run the EDI through Docsplitter and process the valid claims.
This parameter can be used when responding to 834, 835, and 837 transactions.
If a transaction set contains errors, the 997/999 created by Response Generator will partially accept the transaction set by placing an E in the AK501.
A variation is -pt p, which causes a P to be placed in the AK501 if the transaction set has errors.
AK501 Default |
AK501 -pt |
AK501 -pt p__ |
|
---|---|---|---|
Clean set | A | A | A |
Errors in set | R | E | P |
Warnings in set | E | E | E |
Errors in all sets | R | R | R |
Format of Parameters
-pt (p)
Where:
p | Optional. Causes a P to be placed in the AK501 if the transaction set has errors. (P is not a standard code and should be used only with the agreement of your trading partners and your translator.) |
-pt824 (Partial transaction set acceptance for 824 responses)
Optional
The -pt824 parameter allows partial transaction set acceptance when generating an 824 response. You can then run the EDI through Docsplitter and process the valid claims.
This parameter can be used when responding to any transaction.
If one or more transaction sets (but not all) contains errors, the 824 created by Response Generator will partially accept the transaction set by placing a TE in the OT101.
OT101 Default |
OT101 -pt824 |
|
---|---|---|
Clean set | TA | TA |
Errors in set | TR | TE |
Warnings in set | TE | TE |
Errors in all sets | TR | TR |
Format of Parameters
-pt824
-s (Strict Processing)
Optional
Use strict 997 or 999 response processing in which:
-
997s or 999s will only show error types 1 and 2, regardless of whether there is also an 824 generated.
-
824s will only show types 3-7 regardless of whether there is also a 997 or 999 generated.
This parameter overrides the default behavior, which is as follows:
If only one of these types of output transactions are generated …
997/999
824
… then ALL errors, regardless of type, are put in the one type generated.
For details, refer Appendix A: Return Codes
Format of Parameters
-s
Example
-i ”C:\Files\HV_Results.txt” -o824 ”C:\Files\EDI_824.txt” -s
-stc (STC override file)
Optional
STC override file for 277CA. For details, refer Appendix G 277CA STC Override File.
Format of Parameters
-stc
Example
RespGen -i “Current_Results.txt” -o277CA “EDI_277CA.txt” -fca277 -stc c:\Foresight\Instream\Bin\stcoverride.csv
-TPA (Invoke TPA File)
Optional
Identifies a Trading Partner Automation lookup file that specifies which trading partners are to use which Response Generator setup files. The TPA lookup file can replace any or all command-line options except the input file.
When using -TPA, do not use other command line parameters.
Before using -TPA:
-
Put all desired options into Response Generator setup file(s).
-
Be sure all trading partners are assigned settings file in the TPA CSV file.
-
Use -TPA to invoke the TPA lookup file.
See TIB_fsp-instream_<n.n>_tpa.pdf. For an example Response Generator setup file that is appropriate for TPA, see TPA_ResponseGen.ini in Instream’s DemoData directory.
Format of Parameters
-TPA "file_path"
Where:
File_path
|
The file path/name of a Trading Partner Automation lookup file. |
Example
RespGen -i ”C:\Files\HV_Results.txt” -o824 ”
C:\Files\EDI_824.txt” -TPA
"C:\lookups\SampleTPA_DS_RG.csv"
-u (use $Dir.ini)
Optional
Use $Dir.ini to find configuration files ErrRespXref.txt and ErrMsgTrans.txt. Response Generator will look for $Dir.ini in its current folder, read the BASEROOT value, and look in the \bin directory under BASEROOT for the configuration files.
Format of Parameters
-u “dir_path”
Where:
dir_path
|
Path to follow to find $Dir.ini. |
Example
Directs RespGen to look in\\Server1\Instream\bin.
RespGen -i ”C:\Files\HV_Results.txt” -o824 ”
C:\Files\EDI_824.txt”
-u \\Server1\Instream
-v (Verbosity)
Optional
Set the output verbosity level.
Format of Parameters
-v
n
Where:
n
|
Verbosity level: 0 = No Output 1 = Errors Only 2 = Warnings and Errors 3 = Info, Warnings (default) 9 = Debug (lots of output) |
Verbosity level:
Example
RespGen -i ”C:\Files\HV_Results.txt” -o824 ”C:\Files\EDI_824.txt” -v
3
-version (Display Version)
Optional
Displays Response Generator version (see Response Generator Version below). Do not use this qualifier with other qualifiers, including -i/-o.
Format
-version
Example
Display the Response Generator version:
"C:\Foresight\Instream\Bin\RespGen.exe" -version
-w (Wait)
Optional
Waits for user to ‘press any key’ upon completion or cancellation. This option is most useful for batch file processing.
Format
-w
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -w
-y (Overwrite OK flag)
Optional
Overwrite OK Flag. The EDI output file, if it exists, will be overwritten without prompting. This option is most useful for batch file processing.
Format
-y
Example
RespGen -i “HV_Results.txt” -o997 “EDI_997.txt” -y
-z (Use Setup File)
Optional
Use a Response Generator setup file. (See TPA-Parameter Setup File Contents on page TPA-Parameter Setup File Contents and RED Segments on page RED Segments).
Format
-z”file_path”
Where:
file_path
|
Is the file path/name of a Response Generator setup file. |
Example
"C:\FS\Bin\respgen.exe"
-i"C:\FS\output\MY837IA_Results.txt"
-o824 "C:\FS\Output\824.txt" -o997 "C:\FS\Output\997.txt"
-z”C:\FS\BIN\RG.INI”
Example Response Generator Commands
Assume these file names:
Validation detail results file |
HV_Results.txt |
---|---|
997 Output |
EDI_997.txt |
824 Output |
EDI_824.txt |
277 Output |
EDI_277.txt |
The example command lines below use all defaults except:
-
Interchange and functional group envelopes will be generated (-ge)
-
Interchange Control Numbers start with 9001 (-dic)
-
Functional Group Control Numbers start at 1001 (-dac)
-
Strict mode will be used (-s)
Windows Example
All files are in the /Files directory.
"C:\Foresight\Instream\Bin\respgen.exe"
-i ”C:\Files\HV_Results.txt” -o824 ”C:\Files\EDI_824.txt”
-o997 ”C:\Files\EDI_997.txt” -o277 ”C:\Files\EDI_277.txt”
-ge -dic 9001 -dac 1001 -s
UNIX Example
All files are in the /Files directory.
/HVInStream/bin/RespGen -i "/Files/HV_Results.txt"
-o824 ”/Files/EDI_824.txt” -o997 ”/Files/EDI_997.txt”
-o277 ”/Files/EDI_277.txt” -ge -dic 9001 -dac 1001 -s