ASC X12/HIPAA outbound ST SE (Transaction level) envelope properties

These properties are displayed when you view or edit an ASC X12/HIPAA outbound ST SE (Transaction level) envelope. Not all properties can be edited.

Basic properties

For a description of these properties, see General properties.

Control numbers

For a description of these properties, see the General properties topic.

Advanced Properties: 1. Outbound Properties

Next Envelope
The parent group envelope to use as the transaction envelope filter. Optional.

Valid values: Select from the list of available envelopes.

Sender ID Qualifier
Coded qualifier of the sender ID as it appears in the message group header sent to this company or division. Optional.

Valid value: Two standard characters

Receiver ID Qualifier
Coded qualifier of the receiver ID as it appears in the message group header sent to this company or division. Optional.

Valid value: Two standard characters

(ST01) Transaction Set ID Code
Code identifier of the transaction set. Required.

Valid values: Three standard characters, asterisk (*) as wildcard

Use Correlation Overrides
Whether to use correlation overrides. Required.
Valid values:
Never
Never use correlation overrides. Default.
Only when the envelope field has a wildcard value (*)
Only use correlation override values for fields in the envelope definition that are specified with a wildcard (*).
Always
If a correlation override value is provided, use that value instead of the value in the envelope.
Exception: The Sender ID, Receiver ID, and Sender/Receiver Qualifier fields must contain an asterisk as wildcard (*) in the envelope definition to use the correlation override value.
Use the default specified in enveloping properties
Use the default value that is specified in the enveloping.correl_override_default.[standard] property in the enveloping.properties file to determine when to use correlation overrides.
Control Number handing
How this envelope definition uses control numbers to uniquely identify message group headers.
Valid values:
Global
Use an existing global control number that you specify in Assign control number.
Global (and generate name from data)
Use a global number name that you generate using values from the outbound data or envelope definition.
Local
Default. Use a local control number that is owned only by this envelope.
Always start at 1
If Control number handling is set to Global, this Assign control number property is displayed:
(ST02) Global Transaction Set Control Number
Transaction control reference number used globally. Required.

Valid value: Select from the list of available control numbers.

If Control number handling is set to Global (and generate name from data), these Generate control number properties are displayed:
Primary Name Format
Information to include when generating a global control number name.
Valid values:
  • Select all
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code (default)
  • Test Indicator
Use first backup name format
Whether to generate a name using the first backup format when a valid name can not be determined from the Primary Name Format.

Valid values: Yes (default), No

Backup Name Format
Values to include when generating a first backup name.
Valid values:
  • Select all
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator
Use second backup name format
Whether to generate a name using the second backup format when a valid name can not be determined from the Primary Name Format or from the first Backup Name Format.

Valid values: Yes (default), No

Backup Name Format
Values to include when generating a second backup name.
Valid values:
  • Select all
  • (ST01) Transaction Set ID Code
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator
If Control number handling is set to Local, these Assign control number properties are displayed:
Local Transaction Set Control Number
Transaction set control reference number used locally. Required.

Valid value: Select a previously defined number of nine standard characters.

Sequence Type
Type of control number sequencing to use.

Valid values: SPE, Database

If Sequence Type is set to SPE and Control number handling is set to Local, this Locking Mode property is displayed:
Hold locks until commit
Whether to restrict access to the messages until all changes are committed.

Valid values: Yes, No (default)

If Control number handling is set to Always start at one, this Assign control number property is displayed:
Sequence Type
Type of control number sequencing to use.

Valid value: SPE

Transaction Implementation Convention Reference (versions 4012 and above)
Identifier of the implementation convention reference. When this field is present in data input, it is used to select an appropriate implementation of a given transaction set definition. Optional.

Valid value: 35 standard characters

Accepter Lookup Alias
Identifying string used with the sender ID and the receiver ID to look up this envelope with the encoder service. This alias associates a document with the service it requires. Required.
Format: For 997 or 999 documents, the Accepter Lookup Alias format must be entered in the format as defined by the Inbound GS/GE envelope. For example, if an inbound 004030 document is received and the Accepter Lookup Alias for generated 997/999s is set to use the 99X_[group version] format, then the Accepter Lookup Alias must be entered as 99X_004030.

Valid value: At least one standard character.

Limit Interchange Size
Maximum size allowed for an interchange before a single interchange is split into multiple interchanges. Required.
Valid values:
No
Specify size limit
Use transaction set default in enveloping.properties
Default. Requires that you also specify the size limit in one of two ways:
  • Specify a value in the Maximum Interchange Size parameter
  • Set the applicable properties in the enveloping.properties file. This file contains a property for each supported standard and more specific properties for each message type (for example, 810 and 850 for the ASC X12 standard). These values override the standard property.

If Limit Interchange Size is set to Specify size limit, this Limit Interchange Size property is displayed:

Maximum Interchange Size (bytes)
Maximum size of each individual interchange. Optional.
Note: For performance reasons, size is estimated for some components of the interchange (for example, control numbers) when determining the size. For this reason, the actual enforced size limit is slightly smaller than the value you specify.

Valid value: At least 249 bytes, based on the header and trailer size for X12 standard.

Advanced Properties: 2. Compliance Settings

Perform HIPAA compliance check
Whether to check the document for HIPAA compliance.

Valid values: Yes, No (default)

If Perform HIPAA compliance check is set to Yes, this HIPAA Compliance Check Validation Settings property is displayed:
Check Companion Guide Rules (Type 7)
Allow Companion Guide Rules to override default WEDI/SNIP Type 1-6 HIPAA validation behavior.

Valid values: Yes, No (default)

If Check Companion Guide Rules (Type 7 is set to Yes, this Companion guide rules will be checked property is displayed:
Companion Guide Rule Group
How to determine the rule group to use.
Valid values:
None (use global rules)
Default
Use Envelope Name
Assign Rule Group Identifier
If Companion Guide Rule Group is set to Assign Rule Group Identifier, this Companion guide Rule Group Identifier will be applied property is displayed:
Companion Guide Rule Group Identifier
Enter a Companion Guide Business Rule Group as defined in the companion business rules that you configured.

Valid values: Upper-case string

Type 7 Custom User Exit Language
Language that is used for any user-defined rule extensions that override existing HIPAA Type 1-4 rules with more restrictive rules, or that override the default WEDI/SNIP Type 1-6 HIPAA validation behavior.

Valid values: None (default), C program, Java program

If Type 7 Custom User Exit Language is set to C program, these C program will be run properties are displayed:
Type 7 exit library name
C library that contains the Type 7 custom exit. Required.

Valid value: String

Type 7 exit function name
Name of the Type 7 custom exit function. Required.

Valid value: String

If Type 7 Custom User Exit Language is set to Java program, these Java program will be run properties are displayed:
Type 7 exit class name
Java library that contains the Type 7 custom exit. Required.

Valid value: String

Type 7 exit method name
Name of the Type 7 custom exit method. Required.

Valid value: String

Exception Handling for Type 7
How to process exceptions to Type 7 validation:
Valid values:
  • Error (Report exceptions as errors and reject the data). Default.
  • Warning (Report exceptions as warnings and accept the data)
Check Line of Service Rules (Type 6)
Whether to enable HIPAA Level 6 validation.

Valid values: Yes, No (default)

If Check Line of Service Rules (Type 6) is set to Yes, these Line of Service rules and MultiSegment HIPAA rules will be checked properties are displayed:
Exception Handling for Type 6
Valid values:
  • Error (Report exceptions as errors and reject the data). Default.
  • Warning (Report exceptions as warnings and accept the data)
Check Referenced Code Set Rules (Type 5)

Valid values: Yes, No (default)

If Check Referenced Code Set Rules (Type 5) is set to No, these Additional compliance settings properties are displayed:

Validation Method
Valid values:
  • Map (Use pass-through maps to bypass compliance steps where possible)
  • Compliance (Do not bypass any compliance steps)
  • Both Map and Compliance (Reserved for debugging)
Allow Relaxed Type 2 Structure Checking

Valid values: Yes, No (default)

Validate XML Data in BIN Segments
  • Never (Do not validate XML content)
  • XML (Validate XML formatting only)
  • Schema (Validate against HL7 CDA requirements)
Generate the Translated Acknowledgment Report

Valid values: Yes, No

If Generate the Translated Acknowledgment Report is set to Yes, these Translated Acknowledgment Trigger properties are displayed:
Translated Acknowledgment Trigger
Circumstances when a translated acknowledgment report should be generated.
Valid values:
  • Always (For all valid and invalid data)
  • Exceptions (Only when errors or warnings are encountered). Default.
Unique File Names for Translated Acknowledgment
Set a unique file name for translated acknowledgment EDI report that is passed to the compliance check application. It replaces the TAck_EDI.html file name, which gets overwritten when multiple files are run.

Valid values: Yes, No (default)

Compliance Check Page Count
Page count to be used for the execution of most maps from within compliance check.

Valid value: Integer from 1 through 9999. Default: 8 pages

Compliance Check Page Size
Page size in Kb to be used for map execution from within compliance check. In general, larger page size and count settings improve overall compliance check performance when the transaction sets being processed are large.

Valid value: Even integer 2 - 1024. Default: 64 Kb

Advanced Properties: 3. Map Name Mode

Map Name Mode
Mode in which to specify the map to use to perform outbound translation.
Valid values:
  • Specify
  • Generate from data
  • Use pass-through mode for transformation
If Map Name Mode is set to Specify, these Map Name properties are displayed:
Map Name
Map to use to for translation.

Valid value: Select from the list of available maps.

Validation translation input

Valid values: Yes (default), No

Validation translation output

Valid values: Yes (default), No

If Map Name Mode is set to Generate from data, these Map Name properties are displayed:

Primary Name Format
Information to include when generating a map name.
Valid values:
  • Select all
  • EDI Standard (default)
  • Sender ID Code Qualifier (default)
  • Sender ID (default)
  • Recipient ID Code Qualifier (default)
  • Recipient ID (default)
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code (default)
  • Test Indicator
Use first backup name format
Whether to generate a name using the first backup format when a valid name can not be determined from the Primary Name Format.

Valid values: Yes (default), No

Backup Name Format
Values to include as the first backup name.
Valid values:
  • Select all
  • EDI Standard (default)
  • Sender ID Code Qualifier (default)
  • Sender ID (default)
  • Recipient ID Code Qualifier (default)
  • Recipient ID (default)
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator
Use second backup name format
Whether to generate a name using the second backup format when a valid name can not be determined from the Primary Name Format or from the first backup name format.

Valid values: Yes (default), No

Backup Name Format
Values to include as the second backup name.
Valid values:
  • Select all
  • EDI Standard (default)
  • Sender ID Code Qualifier
  • Sender ID
  • Recipient ID Code Qualifier
  • Recipient ID
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator
Generate an error if no generated map name exists in the system
Generate an error message if the translator cannot locate the specified map name. Required.

Valid values: Yes (default), No

Validate translation input
Whether to validate input. Required.

Valid values: Yes (default), No

Validate translation output
Whether to validate translated output (that is, documents sent to trading partners). Required.

Valid values: Yes (default), No

Advanced properties: 4. User data parameters

User data name n

A user-supplied name that is set in the process data of an envelope as part of a name-value pair for use in later steps of the process flow.

Valid value: String

User data value n
A user-supplied value that is set in the process data of an envelope as part of a name-value pair for use in later steps of the process flow.

Valid value: String

Versions

See Working with versions.

Usage

See Viewing the usage of an envelope.