Data Element Type Constants indicate the special data
elements in the standard that are used while a document is being processed.It is important that the data element IDs are known for these data
elements specially if the document being processed use them.The data element ID must also be properly defined in the schema so that
the value can be extracted from the document and properly identified.
When
generating an acknowledgment, this data element in the interchange control
header (ISA) data segment is processed as follows:
The
I05 that qualifies the Interchange Sender ID (I06) of the subject
interchange will have its value assigned to the I05 that qualifies the
Interchange Receiver ID (I07) of the interchange header in the
acknowledgment.
The
I05 that qualifies the Interchange Receiver ID (I07) of the subject
interchange will have its value assigned to the I05 that qualifies the
Interchange Sender ID (I06) of the interchange header in the
acknowledgment.
When
generating a new document, the value of this data element is set to
ZZ in the interchange control header (ISA), for both data elements
that qualify the sender ID and receiver ID.This means that the trading partners mutually define both Ids.
When
translating a document, the value of this data element is verified for
existence in the control header (ISA).If the qualifiers for the sender and receiver ID does not exist,
then the following errors will be reported respectively:
Interchange
sender ID not specified in data element I05 data segment ISA
(code: 13225).
Interchange
receiver ID not specified in data element I05 data segment
ISA (code: 13226).
When
generating an acknowledgment, the value of the Interchange Receiver ID
(I07) in the control header of the subject interchange is assigned to the
Interchange Sender ID (I06) in the interchange control header in the
acknowledgment.
When
translating a document, the value of this data element is verified for
existence in the control header (ISA), and if the sender ID does not exist
then the following error is reported:
Interchange
sender not specified in data element I06 data segment ISA
(code: 13216).
When
generating an acknowledgment, the value of the Interchange Sender ID (I06)
in the control header of the subject interchange is assigned to the
Interchange Receiver ID (107) in the interchange control header in the
acknowledgment.
When
translating a document, the value of this data element is verified for
existence in the control header (ISA), and if the receiver ID does not
exist then the following error is reported:
Interchange
receiver not specified in data element I07 data segment ISA
(code: 13217).
When
generating, the version read from the schema is assigned to this data
element in the interchange control header (ISA).
When
translating, the version extracted from this data element in the
interchange control header (ISA) is used to determine the best schema to
use to reference the syntactical correctness of the interchange header.
When
generating the interchange acknowledgment, the control number of the
interchange control header of the subject interchange is assigned to
interchange control number of the interchange acknowledgment (TA1).
When
generating a new document, the control number is calculated using the
running count of the current interchange and is then assigned to the data
element of the control header and control trailer of the new interchange.
When
translating, the value extracted from the document is used as the control
number property of the interchange.If
the value does not exist the following error is reported:
When
generating acknowledgments, this data element is assigned the same Usage
Indicator value of the subject interchange.
When
generating a new document, this data element is assigned a value T
to indicate that the interchange is a test interchange.
When
translating, the value extracted from the document for this data element
in the control header is used as the usage indicator property of the
interchange.
When
generating a new document, the value set by the client as the composite
element terminator is assigned to this data element in the interchange
control header (ISA).
When
translating, the value extracted in the control header from the document
is used as the component element terminator for the interchange.The character is then used to determine separation of component
element values in the document.
When
generating a new document, the number of functional groups created under
the interchange is assigned to the value of this data element in the
interchange control trailer (IEA) segment.
When
translating, the value extracted from the document in the interchange
control trailer is compared to the actual count of the functional groups
in the interchange, and if there is a discrepancy an error is reported.
When
generating interchange acknowledgments, the interchange acknowledgment
code is assigned a value indicating the error status of the interchange
control header (ISA) and trailer (IEA).As of this writing, the following is currently used:
A
No errors in the interchange control segments.
E
Errors in the interchange control segments were discovered but the
segments are accepted anyways.
R
Errors were discovered in the interchange control segments and the
segment are consequently rejected.
When
generating interchange acknowledgments, the value assigned to this data
element is a numeric value code indicating the type of error that was
discovered in the interchange control header and trailer.
When
generating a new document, this data element is assigned a value X
in the functional group control header (GS).The X indicates the agency ASC/X12.
DataElement_X12_Application_Sender_Code
(18) Application Senders Code (default ID: 142) in the Functional
Group Control Header.Applicable
to ASC/X12 only.
When
generating functional acknowledgments, the application receivers code
(124) in the functional group control header of the subject interchange is
assigned to this data element.
When
translating, the value is verified for existence.If this value does not exist then the following error is reported:
Functional
group application sender not specified in data element I42 data
segment GS (code: 13218).
When
generating functional acknowledgments, the application senders code
(142) in the functional group control header of the subject interchange is
assigned to this data element.
When
translating, the value is verified for existence.If this value does not exist then the following error is reported:
Functional
group application recipient not specified in data element 124 data
segment GS (code: 13219).
DataElement_X12_Version_Release_Industry_Code
(20) Version / Release / Industry Identifier Code (default ID: 480) in
the Functional Group Control Header. Applicable to ASC/X12 only.
When
generating a new document, this value is assigned a version, read from the
schema that will be used by the functional group and underlying
transaction set(s).
When
translating, the value extracted from the document is used to determine
the best schema to use as syntactical reference for the functional group
control header and all underlying transaction sets and data segments.
When
generating functional acknowledgments, this data element in the Functional
Group Response Header (AK1) data segment is assigned the group control
number of the functional group that it is reporting syntactical errors to.
When
translating a document, this value in this document is stored as the Group
Control Number property in the ediGroup object.Also, this value is verified for existence in both the functional
group control header and trailer data segment.An error will be generated if the value is missing.
When
generating a document, the default control number assigned to this data
element is the running count of the functional groups in the interchange.
The
data element in the Functional Group Control Header of the interchange
will be assigned the Group ID property value of the ediAcknowldegment
object.
Also,
the data element in the Function Group Response Header (AK1) data
segment will have the group ID of the functional group that is reporting
syntactical errors from.
When
generating functional acknowledgments, the data element in the Functional
Group Response Trailer (AK9) will have the value of the total number of
transaction sets in the functional group it is reporting syntactical
errors from.
When
generating a document, the data element in the Functional Group Trailer
(GE) will contain the value of the number of transaction set(s) that the
functional group contains.
When
translating, the value extracted from the document is compared against the
actual number of transaction sets that are determined to have been in the
document.If there is a
discrepancy an error is reported.
When
generating functional acknowledgments, the data element in the Transaction
Set Response Header (AK2) will be assigned the same transaction set
control number of the transaction set it is reporting errors for.
When
generating documents, the data element in the Transaction Set Control
Header (ST) will be assigned a default value of the running count of
transaction set(s) in the functional group.
When
translating,
The
data element value determined from the document is stored as the control
header property value of the ediTransactionSet object.
The
data element value is verified for existence.If absent an error is reported.
The
data element value in the Transaction Set Control Header (ST) is
compared against the Transaction Set Control Trailer (SE) of the same
transaction set.If there
is a discrepancy an error is reported.
Whenever
a new transaction set object is created the data element in the
Transaction Set Control Header (ST) will be assigned the transaction set
ID that it was created for (example, 850 for purchase order, 997 for
functional acknowledgment, etc.).
When
translating, the data element value is verified for existence in the
Transaction Set Control Header (ST); and if missing an error will be
reported.
When
generating, the total number of data segments created in the transaction
set is stored in this data element of the Transaction Set Control Trailer
(SE) data segment.
When
translating, the data element value extracted from the document is
compared against the actual number determined after having read the entire
transaction set.If there is
a discrepancy an error is reported.
When
a file is imported into a data element, the entire file content becomes
the value of the data element.If
within the same data element collection, the Length Of Binary Data data
element exists, then the size of the file imported is assigned to the
value of the data element.
When
translating a document that contains a data segment that use this data
element, the value of the data element is used to determine how much
binary of the binary data is to be extracted from the document.
When
translating, the binary content in the document, whose size has been
determined by the Length Of Binary Data (784) data element, is imported
and becomes the value of the Binary Data (785) data element.
Security
Recipient Name property that can be assigned or retrieved from the
ediSecurity object.The value
is used as the name of the key container that contains the public key to
sign or encrypt the document.
When
generating functional acknowledgments, the value assigned to this data
element indicates the acceptance condition of the functional group after
syntactical check.Currently
the following values are stored by default:
When
generating acknowledgments, the value assigned to this data element in the
Functional Group Response Trailer (AK9) is the number of transaction sets
in the functional group that was checked for syntactical errors.
When
generating acknowledgments, the value assigned to this data element in the
Functional Group Response Trailer (AK9) is the number of transaction sets
in the functional group that was accepted whether there were errors or no
errors found.
When
generating acknowledgments, the value assigned to this data element is the
error code indicating the type of error discovered in the functional group
semantic level.
When
generating functional acknowledgments, the value assigned to this data
element in the Transaction Set Response Trailer (AK5) data segment
indicates the acceptance condition of the transaction set after
syntactical check.Currently
only the following values are stored by default:
When
generating acknowledgments, the value assigned to this data element in the
Transaction Set Response Trailer (AK5) is the error code indicating the
type of error discovered in the transaction set semantic level.
When
generating acknowledgments, the value assigned to this data element in the
Data Segment Note (AK3) is the segment count of the data segment within
the transaction set that an error was being reported from.
When
generating acknowledgments, the value assigned to this data element in the
Data Segment Note (AK3) is the error code indicating the type of error
discovered in the data segment.
When
generating acknowledgments, the value assigned to this data element in the
Data Segment Note (AK3) is the segment ID of the data segment that an
error was being reported from.
When
generating acknowledgments, the value assigned to this data element in the
Data Element Note (AK4) is the relative position of the data element that
an error was being reported from within the data segment or composite
element.
When
generating acknowledgments, the value assigned to this data element in the
Data Element Note (AK4) is the value of the data element where an error
was being reported.
When
generating acknowledgments, the value assigned to this data element in the
Data Element Note (AK4) is the ID of the data element where an error was
being reported.
When
generating acknowledgments, the value assigned to this data element in the
Data Segment Note (AK4) is the loop ID that the data segment reporting the
error is directly nested under.
When
generating acknowledgments, the values assigned to this composite element
in the Data Element Note (AK4) segment points to the relative position of
the data element in the data segment or composite element reporting the
syntax error.
When
generating acknowledgments, the values assigned to this data element in
the Data Element Note (AK4) segment or Position In Segment (C030)
composite points to the position of the data element reporting the error.
When
generating a document, the character specified as the repeating element
separator for the document is assigned to the value of the data element in
the interchange control header (ISA).
When
translating, the value determined for this data element from the document
is used as the default repeating element separator for translating and
saving the file.
When
generating acknowledgments, the control number of the interchange control
header of the subject interchange is assigned to interchange control
reference of the Interchange Response (UCI).
When
generating a new document, the control number is calculated using the
running count of the current interchange and is then assigned to the data
element of the control header and control trailer of the new interchange.
When
translating, the value extracted from the document is used as the control
number property of the interchange.If
the value does not exist an error is reported.
When
generating a new document, the number of message, packages or functional
groups created under the interchange is assigned to the value of this data
element in the interchange control trailer (UNB) segment.
When
translating, the value extracted from the document in the interchange
control trailer (UNB) is compared to the actual count of messages,
packages or functional groups in the interchange.If there is a discrepancy an error is reported.
When
generating acknowledgments, the data element in the Group Response (UCF)
is assigned the same application sender value of the functional group
control header in the subject functional group.
When
translating, the existence of a value in the data element is verified.If no value exists an error is reported.
When
generating acknowledgments, the data element in the Group Response (UCF)
is assigned the same application receiver value of the functional group
control header in the subject functional group.
When
translating, the existence of a value in the data element is verified.If no value exists an error is reported.
When
generating, the data element in the functional group control header is
assigned the version value of the schema used for syntax verification of
the functional group.
When
translating, the value of the data element in the functional group (UNG),
together with release number (0054), and association code (0057), are used
to determine the best schema to use to translate the functional group and
underlying messages.
When
generating, the data element in the functional group is assigned the
release value of the schema used for syntax verification of the functional
group.
When
translating, the value of the data element in the functional group (UNG),
together with version number (0052) and association code (0057), is used
to determine the best schema to use to translate the functional group and
underlying messages.
When
generating, the data element in the functional group is assigned the
association value or industry code from the schema used for syntax
verification of the functional group.
When
translating, the value of the data element in the functional group (UNG),
together with version number (0052) and release number (0054), is used to
determine the best schema to use to translate the functional group and
underlying messages.
When
generating acknowledgments, the data element in the Group Response (UCF)
segment is assigned the group reference number of the control header
belonging to the functional group reporting the error.
When
translating,
The
value determined as the group reference number from the document is
assigned as a group reference number property to the ediGroup object.
The
data element value is verified for existence and if it does not exist an
error is reported.
The
group reference number extracted from the group control header is
compared to the group reference number extracted from the group control
trailer; and if they are not equal, an error is reported.
When
generating documents, the data element is assigned the running count of
the current group in the interchange.
The
data element in the message control header (UNH) is assigned the version
value from the schema that is used to generate the acknowledgment.
The
data element in the message / package response segment (UCM) is assigned
the same version as the message / package that is being checked.
When
generating documents, the data element in the message / package header
will be assigned the version value from the schema that is used to
generate the message.
When
translating,
The
version extracted from the document is verified for existence, and if
missing an error is reported.
The
version together with the release and associated code is used to
determine the best schema to use to translate the message.
The
data element in the message control header (UNH) is assigned the release
value from the schema that is used to generate the acknowledgment.
The
data element in the message / package response segment (UCM) is assigned
the same release as the message / package that is being checked.
When
generating documents, the data element in the message / package header
will be assigned the release value from the schema that is used to
generate the message.
When
translating,
The
release extracted from the document is verified for existence, and if
missing an error is reported.
The
release together with the version and associated code is used to determine
the best schema to use to translate the message.
The
data element in the message control header (UNH) is assigned the
associated / industry code value from the schema that is used to
generate the acknowledgment.
The
data element in the message / package response segment (UCM) is assigned
the same associated code as the message / package that is being checked.
When
generating documents, the data element in the message / package header
will be assigned the associated code value from the schema that is used to
generate the message.
When
generating acknowledgments, the data element in the Message Response
segment (UCM) is assigned the same message reference number from the
subject message that is being checked for errors.
When
translating,
The
message control number extracted from the document is assigned to the
ediTransactionSet object as a property.
The
value is checked for existence and if missing an error is reported.
The
value in the message control header is compared to the message control
trailer; and if not the same an error is reported.
When
generating, the control number calculated and assigned to the data element
in the message control header is the running count number of messages
created.
When
generating, the number of total messages created in the functional group
is stored in the data element of the functional group control trailer (UNE);
or, the total messages created in the interchange is stored in the data
element of the interchange control trailer (UNZ).
When
translating, the value extracted from the document is compared to the
actual number of messages read in the functional group or interchange; and
if not equal an error is reported.
When
generating acknowledgments, the data element in the relevant response
segment (UCI, UCF, UCM) is assigned a value indicating the acceptance of
the acknowledged semantic level.The
following default values are assigned under the following conditions:
When
generating acknowledgments, the data element value in the response segment
(UCI, UCF, UCM and UCD) is assigned an error code indicating the error
discovered.
When
generating acknowledgments, the value assigned to this data element in the
Segment Response (UCS) is the segment count of the data segment within the
message that an error was being reported from.
When
generating acknowledgments, the value assigned to this data element in the
Element Response (UCD) segment is the relative position of the data
element that an error was being reported from within the data segment.
When
generating acknowledgments, the values assigned to this composite element
in the Element Response (UCD) segment points to the relative position of
the data element in the data segment or composite element reporting the
syntax error.
When
generating acknowledgments, the data element in the Message Response
segment (UCM) is assigned the same package reference number from the
subject message that is being checked for errors.
When
translating,
The
package control number extracted from the document is assigned to the
message object as a property.
The
value is checked for existence and if missing an error is reported.
The
value in the package control header is compared to the package control
trailer; and if not the same an error is reported.
When
generating, the control number calculated and assigned to the data element
in the message control header is the running count number of messages
created.
When translating, the data element in the interchange header (UNB) is
checked for the value "1", and, if present, generates a CONTRL
acknowledgment for the subject document.
When generating acknowledgments, the data element in the interchange header
(UNB) is assigned the same
value as the corresponding data element value from the subject document.
When generating, the data element in the interchange header (UNB) is assigned the default value
"1".
When translating, the data element value in the interchange header (UNB) is retrieved to be later
assigned to the in the interchange header (UNB) of the acknowledgment, if an acknowledgment document is to be
generated.
The component element value in the recipient composite (S003) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the sender
composite (S002) in the interchange header (UNB) of the acknowledgment.
The component element value in the recipient composite (S003) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the recipient
composite (S003) of interchange response control segment (UCI) of the acknowledgment.
The component element value in the sender composite (S002) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the recipient
composite (S003) in the interchange header (UNB) of the acknowledgment.
The component element value in the sender composite (S002) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the sender composite
(S002) of interchange response control segment (UCI) of the acknowledgment.
The component element value in the sender composite (S002) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the recipient
composite (S003) in the interchange header (UNB) of the acknowledgment.
The component element value in the sender composite (S002) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the sender
composite (S002) of interchange response control segment (UCI) of the acknowledgment.
The component element value in the sender composite (S002) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the recipient
composite (S003) in the interchange header (UNB) of the acknowledgment.
The component element value in the sender composite (S002) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the sender
composite (S002) of interchange response control segment (UCI) of the acknowledgment.
The component element value in the recipient composite (S003) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the sender
composite (S002) in the interchange header (UNB) of the acknowledgment.
The component element value in the recipient composite (S003) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the recipient
composite (S003) of interchange response control segment (UCI) of the acknowledgment.
The component element value in the recipient composite (S003) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the sender
composite (S002) of the acknowledgment.
The component element value in the recipient composite (S003) in the interchange header
(UNB) is
retrieved from the subject document and is assigned to the recipient
composite (S003) of interchange response control segment (UCI) of the acknowledgment.
The component element value in the application recipient composite
(S007) in the interchange header (UNB) is
retrieved from the subject document and is assigned to the
application sender
composite (S006) in the interchange header (UNB) of the acknowledgment.
The component element value in the application recipient composite
(S007) in the interchange header (UNB) is
retrieved from the subject document and is assigned to the
application recipient
composite (S007) of group response control segment (UCF) of the acknowledgment.
The component element value in the application sender composite
(S006) in the interchange header (UNB) is
retrieved from the subject document and is assigned to the
application recipient
composite (S007) in the interchange header (UNB) of the acknowledgment.
The component element value in the application sender composite
(S006) in the interchange header (UNB) is
retrieved from the subject document and is assigned to the
application sender composite (S006) of group response control segment
(UCF) of the acknowledgment.
