Serial Number Exchange Processing Response Guidelines
See How To Use this Guide before interpreting the guidelines below.
Message Type: IE_PROCESSING_RESPONSE
Info Exchange Display Name: Processing Response
These fields are sent by TraceLink back to the sender of the initiating message.


Data Element | Occurs | Format | Length | Enum | Req | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ie:IEProcessingAckMessage | 1...1 | - | - | - | M | Root element of message. | |||||||||||
ie:ControlFileHeader | 1...1 | - | - | - | M | XML file control header record. | |||||||||||
cmn:FileSenderNumber | 1...1 | String | 1/20 | - | M | File sender's company identifier.1 | |||||||||||
cmn:FileReceiverNumber | 1...1 | String | 1/20 | - | M | File recipient's company identifier.2 | |||||||||||
cmn:FileControlNumber | 1...1 | String | 1/* | - | M | Unique file control ID number.3 | |||||||||||
cmn:FileDate | 1...1 | Date | 10/10 | - | M | Date file generated in XML YYYY-MM-DD format.4 | |||||||||||
cmn:FileTime | 1...1 | Time | 9/9 | - | M | Time file generated in XML HH:MM:SSZ format (must be GMT).5 | |||||||||||
ie:MessageBody | 1...1 | - | - | - | M | Main body of message. | |||||||||||
ie:ProcessingResultsHeader | 1...1 | - | - | - | M | Provides identification of the processed message with information from the original message header including message type, original message identifier, message sender and receiver identifiers, and original message date and time. | |||||||||||
ie:InputFileTransactionType | 1...1 | String | 1/* | TransactionType | M | Transaction type of the processed
message. Valid values:6
|
|||||||||||
ie:InputFileSenderNumber | 1...1 | String | 1/20 | - | M | FileSenderNumber that was provided in the processed message.7 | |||||||||||
ie:InputFileReceiverNumber | 1...1 | String | 1/20 | - | M | FileReceiverNumber that was provided in the processed message.8 | |||||||||||
ie:InputFileControlNumber | 1...1 | String | 1/* | - | M | FileControlNumber that was provided in the processed message.9 | |||||||||||
ie:InputFileDate | 1...1 | Date | 10/10 | - | M | FileDate that was provided in the processed message in XML YYYY-MM-DD format.10 | |||||||||||
ie:InputFileTime | 1...1 | Time | 9/9 | - | M | FileTime that was provided in the processed message in XML HH:MM:SSZ format.11 | |||||||||||
ie:ProcessingResults | 1...1 | - | - | - | M | Provides the processing results of
the message with a summary of:
For each of these categories, the system returns an "item spec" with identifying information about each item processed, the processing code, and the processing message. |
|||||||||||
ie:ProcessingSummary | 1...1 | - | - | - | M | Provides the processing results of
the message with a summary of:
|
|||||||||||
ie:TotalUpdated | 1...1 | Integer | - | - | M | The total number of items from the originating message that were updated by the system. | |||||||||||
ie:TotalProcessedNoWarning | 1...1 | Integer | - | - | M | The total number of updated items from the originating message that were updated without warning. This is a subset of ie:TotalUpdated. If this value is greater than zero, ie:ProcessedNoWarning will be populated with the item spec containing identifying information about each item processed including the processing code. | |||||||||||
ie:TotalProcessedWithWarning | 1...1 | Integer | - | - | M | The total number of updated items from the originating message that were updated with warning. This is a subset of ie:TotalUpdated. If this value is greater than zero, ie:ProcessedWithWarning will be populated with the item spec containing identifying information about each item that had a warning, including the processing code and processing message. | |||||||||||
ie:TotalFailed | 1...1 | Integer | - | - | M | The total number of updated items from the originating message that were not updated as a result of errors. If this value is greater than zero, the FailedItem element will be populated with the item spec containing identifying information about each item that failed, including the processing code and processing message. | |||||||||||
ie:ProcessedNoWarning | 0...1 | - | - | - | C | This element contains one item spec with the processing code for each item updated without warning. The item spec contains identifying information about each item processed. The number of item specs will be equal to the value of ie:TotalProcessedNoWarning. If ie:TotalProcessedNoWarning = 0, ie: ProcessedNoWarning will not be populated. | |||||||||||
ie:ProcessedItem | 1...* | - | - | - | M | List of one or more item specs with the processing code for each item updated without warning. | |||||||||||
choice%1 | 0...1 | Choice | - | - | O | The choice%1 element is optional, but one of the following choices can be optionally provided:
|
|||||||||||
ie:SNX_DispositionAssignedSpec | 0...1 | - | - | - | O | Option 1 for choice%1 group. Used for Serial Number Exchange Disposition Assigned messages submitted to the system to identify product that has been serialized (commissioned) and packed (aggregated). Incoming messages can include only commissioning events or both commissioning and aggregation events. | |||||||||||
ie:Commission | 0...1 | String | 1/* | - | O | Event details group populated for the "commission only" and "commission + aggregation" scenarios. Contains commission event detail data for a serial number. For the "commission + aggregation" scenario, EventDetail for the ParentSerialNumber must be included in the SerializedObjectInfo list. To include a list of commission events for multiple serial numbers, the SerializedObjectInfo element is repeated. | |||||||||||
cmn:EventLocation | 1...1 | String | 1/* | - | M | Site-level SGLN of the location where commissioning occurred. SGLN format will be numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).12 | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains the serial number of the commissioned product. SerialNumber expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. The SerialNumber group may be repeated to include a list of serial numbers.13 | |||||||||||
ie:Aggregation | 0...1 | String | 1/* | - | O | Aggregation (packing) event details. Contains packing event data for a parent serial number and linked child serial number list. | |||||||||||
cmn:EventLocation | 1...1 | String | 1/* | - | M | Site-level SGLN of the location where packing occurred. This is required by Serial Number Manager applications to track the plant to which serial numbers were packed into containers. SGLN format will be numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events). | |||||||||||
cmn:ParentSerialNumber | 1...1 | String | 1/* | - | M | Serial number of the parent container that is represented in the aggregation in this message.14 | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Populated for the "aggregation only" scenario. Contains the serial number of the child item contained in ContainerInfo/ParentSerialNumber. SerialNumber is expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers. | |||||||||||
ie.Transformation Event | 0...1 | String | 1/* | - | O | The event
details group populated for the transformation event. The TransformationEvent is presented either:
Transformation event captures data related to pharmaceutical repackaging scenarios where a source product is repackaged into a new commissioned item. ![]() |
|||||||||||
cmn:EventLocation | 1...1 | String | 1/* | - | M | The site-level SGLN of the location where packing occurred. This is required by Serial Number Manager applications to track the plant where the serial numbers were packed into containers. SGLN format will be numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).15 | |||||||||||
ie.SourceProductDetail | 1...1 | - | - | - | M | The source product in repackaging operations. One of either InputQuantityList or InputSerialNumber is required. | |||||||||||
cmn:InputQuantityList | 0...1 | - | - | - | C | Specifies the
source product by product code, lot number, and quantity. ![]() |
|||||||||||
cmn:QuantityElement | 1...* | - | - | - | M | Groups the product code, lot number, and quantity values. | |||||||||||
cnm:ItemCode | 1...1 | String | 1/* | - | M | The product code for the commissioned item (e.g. GTIN-14). | |||||||||||
@type | 0...1 | String | 0/* | - | C | The
product code type using the supported enumeration values (e.g. GTIN-14).![]() |
|||||||||||
cmn:LotNumber | 1...1 | String |
0/* |
- | M | The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters. | |||||||||||
cmn:Quantity | 1...1 | Integer | 1/* | - | M | The quantity of the source product used to create the repackaged product. TraceLink uses this quantity to match the quantity of serial numbers found for the item code and lot in the system to verify that quantity used for repackaging matches the quantity of expected serial numbers in system. If the quantities do not match, an error generates with the return quantity found in the system including the specific serial numbers found. | |||||||||||
cmn:InputSerialNumberList | 0...1 | - | - | - | C | Specifies the
source product by serial number.![]() |
|||||||||||
cmn:InputSerialNumber | 1...1 | - | - | - | M | The input serial number header container. | |||||||||||
cmn:SerialNumberList | 1...1 | - | - | - | M | List of the serial numbers commissioned for the output product produced in the transformation. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains the input serial number for the transformation event. SerialNumber is expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI (01) (21) formatted serial number for GTINs-or-AI (00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include the list of serial numbers.16 | |||||||||||
cmn:RegisterSourceProduct | 0...1 | Boolean | - | - | O | Triggers the registration of serial numbers that are not known to TraceLink system. Defaults to false if not populated. If value = true, the group RepackInputAttributes must be populated.17 | |||||||||||
cmn:RepackInputAttributes | 0...1 | - | - | - | C | Repack
input common attributes group with product info for input product.
![]() |
|||||||||||
cmn:LotNumber | 1...1 | String | 0/* | - | M | The lot or batch code for the transformation input product in an alphanumeric string of up to 20 characters.18 | |||||||||||
cmn:ExpirationDate | 1...1 | Date | 0/* | - | M | The expiration date for the transformation input product, formatted in YYYY-MM-DD format.19 | |||||||||||
cmn:DecommissionSourceProduct | 0...1 | Boolean | - | - | O | When set to true, instructs TraceLink to implicitly decommission serial numbers used for repackaging. This saves a step in the repack operation so that separate decommission events are not needed.20 | |||||||||||
ie:CommissionedSerialNumbers | 1...1 | - | - | - | M | Commissioned serial numbers for output in the transformation event. | |||||||||||
cmn:SerialNumberList | 1...1 | - | - | - | M | List of serial numbers commissioned for output product that were produced in the transformation. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains output serial number for the transformation event. SerialNumber expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI (01) (21) formatted serial number for GTINs-or-AI (00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers.21 | |||||||||||
ie:Error | 0...1 | - | - | - | O | List of the serial numbers that were part of an error in the transformation event. | |||||||||||
cmn:FailedSerialNumberList | 1...1 | - | - | - | M | List of failed serial numbers in the error group. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains output serial number for the transformation event. SerialNumber expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI (01) (21) formatted serial number for GTINs-or-AI (00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers. | |||||||||||
ie:SNX_DispositionUpdatedSpec | 0...1 | - | - | - | O | Option 2 for choice%1 group. Used for Serial Number Exchange disposition updated messages submitted to the system to identify updates to serialized product. | |||||||||||
cmn:EventLocation | 1...1 | String | 1/34 | - | M | Site-level SGLN of the location where status update event occurred. SGLN format will be numeric component only, with urn prefix stripped (e.g. 7777776.06734.0 instead of urn:epc:id:sgln:7777776.06734.0 typically found in EPCIS events). Conversion of GLN to SGLN format is <CompanyPrefix>.<LocationReference>.0 (e.g. 7777776067348 -> 7777776.06734.0). | |||||||||||
cmn:PackagingSerialNumberStatus | 1...1 | String | 1/* | PackagingSerialNumberStatus | M | New status that will be assigned to the serial numbers. | |||||||||||
cmn:Serial | 1...* | String | 1/* | - | M | Serial number expressed in
the barcode readable format.
For GS1 numbers, this is the Application Identifier format without parentheses
for the AI keys.
![]() |
|||||||||||
@format | 0...1 | String | 0/* | Format | O | The attribute identifies format of serial numbers. | |||||||||||
@packedStatus | 0...1 | String | 0/* | PackedStatus | O | Packed status. | |||||||||||
ie:SNX_DisaggregatedSpec | 0...1 | - | - | - | O | Option 3 for choice%1 group. Used for Serial Number Exchange Disaggregated messages submitted to the system to identify product that has been unpacked. | |||||||||||
cmn:EventLocation | 0...1 | String | 0/* | - | M | Site-level SGLN of the location where status update event occurred. SGLN format will be numeric component only, with urn prefix stripped (e.g. 7777776.06734.0 instead of urn:epc:id:sgln:7777776.06734.0 typically found in EPCIS events). Conversion of GLN to SGLN format is <CompanyPrefix>.<LocationReference>.0 (e.g. 7777776067348 -> 7777776.06734.0). | |||||||||||
cmn:ParentSerialNumber | 1...1 | String | 1/* | - | M | Serial number of the parent container that is represented in the disaggregation in this message. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains the serial number of the child item contained in cmn:ParentSerialNumber. cmn:SerialNumber is expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI (01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers. | |||||||||||
ie:SNX_ProductionOrderSpec | 0...1 | - | - | - | O | Option 4 for choice%1 group. Used for the Serial Number Exchange Production Order message. | |||||||||||
cmn:InternalMaterialCode | 0...1 | String | 0/* | - | C | Internal material number for the product in the planned batch. | |||||||||||
cmn:CountryDrugCode | 0...1 | String | 1/* | - | C | The national drug code for the product in the planned batch.
Must be populated if product has a country code.22![]() |
|||||||||||
@type | 0...1 | String | 0/* | CountryDrugCode | M | Country drug type identifying the national drug code system. Valid values:
|
|||||||||||
cmn:LotNumber | 1...1 | String | 0/20 | - | M | The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters. | |||||||||||
cmn:BatchStatus | 1...1 | String | 1/* | BatchStatus | M | Status of the planned batch using the supported enumeration values. | |||||||||||
ie:SNX_EndOfBatchSpec | 0...1 | - | - | - | O | Choice option for choice%1 group. Used for the Serial Number Exchange End of Batch message. | |||||||||||
choice1 | 1...1 | Choice | - | - | M | Mandatory choice1 within the MessageBody. ![]() |
|||||||||||
cmn:InternalMaterialCode | 0...1 | String | 1/* | - | C | The internal material number for the product in the planned batch.23![]() |
|||||||||||
cmn:CountryDrugCode | 0...1 | String | 0/* | - | C | The national drug code (NDC) for the product in the planned batch.
Must be populated if product has one.24![]() |
|||||||||||
@type | 0...1 | String | 0/* | CountryDrugCode | C | The country drug type identifying national drug code system using one of the valid enumerator values. ![]() |
|||||||||||
cmn:LotNumber | 1...1 | String | 0/20 | - | M | The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters.25 | |||||||||||
cmn:ProductionQuantity | 1...* | - | - | - | M | The production quantities for the batch. This is a looping group with reported production quantities. A minimum of 1 entry is required for the "Each" packaging level. All other packaging levels are optional. An error results if this group is not populated. | |||||||||||
choice1 | 1...1 | Choice | - | - | M | Mandatory choice1 within the cmn:ProductionQuantity. ![]() |
|||||||||||
cmn:PackagingItemCode | 0...1 | String | 0/* | - | C | Option 1 within the required choice1. The packaging level product code (e.g. GTIN-14) for the packaging level.26![]() |
|||||||||||
@type | 1...1 | String | 1/* | PackagingItemCode | M | The product code type using the supported enumeration values (e.g. GTIN-14). ![]() |
|||||||||||
cmn:CompanyPrefix | 0...1 | String | 0/* | - | C | Option 2 within the required choice%1. This indicates the GS1 company prefix.27![]() |
|||||||||||
cmn:PackagingLevel | 1...1 | String | 1/* | PackagingLevel | M | The packaging level associated with the cmn:PackagingItemCode using the supported enumeration values. | |||||||||||
cmn:QuantityReported | 1...1 | Integer | - | - | M | The quantity of serial numbers at the packaging location that are commissioned for the packaging level.28 | |||||||||||
cmn:QuantityCommissioned | 1...1 | Integer | - | - | M | The quantity of serial numbers commissioned from packaging location for the packaging level reported in the TraceLink system.29 | |||||||||||
cmn:BatchYieldVerifield | 1...1 | Boolean | - | - | M | This indicates if the Batch Yield was verified successfully. A success can be generated even when no batch yield verification is performed.30 | |||||||||||
cmn:MaxBatchSize | 0...1 | Integer | - | - | O | The quantity of the maximum batch size.31 | |||||||||||
cmn:AcceptableYield | 0...1 | Integer | - | - | C | The low end percentage (value between 1-100) of a standard acceptable range of the Batch size.32![]() |
|||||||||||
@acceptableYieldPercentage | 1...1 | Decimal | 1/* | - | M | The percentage value of the acceptable yield field.33![]() |
|||||||||||
cmn:MinimumYield | 0...1 | Integer | - | - | C | The lowest end percentage (value between 1-100) of an acceptable Batch size.34![]() |
|||||||||||
@minimumYieldPercentage | 1...1 | Decimal | 1/* | - | M | The percentage value of the minimum yield field.35![]() |
|||||||||||
ie:ProcessingCode | 1...1 | String | 1/* | - | M | The processing code assigned by the system to indicate the success, failure, or warning. | |||||||||||
ie:ProcessingMessage | 0...* | String | 1/* | - | O | The processing message with detail on why the item in the item spec incurred a warning or failure. | |||||||||||
ie:ProcessedWithWarning | 0...1 | - | - | - | O | This element contains one item spec with processing code and processing message for each item updated without warning. The item spec contains identifying information about each item processed. The number of item specs will be equal to the value of ie:TotalProcessedWithWarning. If ie:TotalProcessedWithWarning = 0, ie:ProcessedWithWarning will not be populated. The items specs that follow use the exact same item specs as described in rows | 24-128 .|||||||||||
ie:ProcessedItem | 1...* | - | - | - | M | List of one or more item specs with processing code for each item updated WITH warning. | |||||||||||
choice%2 | 0...1 | Choice | - | - | O | The choice%2 element is optional, but one of the following choices can be optionally provided:
|
|||||||||||
ie:SNX_DispositionAssignedSpec | 0...1 | - | - | - | O | Option 1 for choice%2 group. Used for Serial Number Exchange disposition assigned messages submitted to the system to identify product that has been serialized (commissioned) and packed (aggregation). Incoming messages can include only commissioning events or both commissioning and aggregation events. | |||||||||||
ie:Commission | 0...1 | String | 1/* | - | O | Event details group populated for the "commission only" and "commission + aggregation" scenarios. Contains commission event detail data for a serial number. For the "commission + aggregation" scenario, EventDetail for cmn:ParentSerialNumber MUST be included in the SerializedObjectInfo list. To include a list of commission events for multiple serial numbers, repeat the SerializedObjectInfo element. | |||||||||||
cmn:EventLocation | 1...1 | String | 1/* | - | M | Site-level SGLN of the location where commissioning occurred. SGLN format will be a numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events). | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains the serial number of the commissioned product. SerialNumber is expressed in the GS1 Application Identifier format without parentheses for the AI keys. Use AI(01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. The cmn:SerialNumber group can be repeated to include a list of serial numbers. | |||||||||||
ie:Aggregation | 0...1 | String | 1/* | - | O | Aggregation (packing) event details. Contains packing event data for a parent serial number and linked child serial number list. | |||||||||||
cmn:EventLocation | 1...1 | String | 1/* | - | M | Site-level SGLN of the location where packing occurred. This is required by Serial Number Manager applications to track the plant to which serial numbers were packed into containers. SGLN format will be a numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events). | |||||||||||
cmn:ParentSerialNumber | 1...1 | String | 1/* | - | M | Serial number of the parent container that is represented in the aggregation in this message. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Populated for the "aggregation only" scenario. Contains the serial number of the child item contained in ContainerInfo/ ParentSerialNumber. SerialNumber is expressed in the GS1 Application Identifier format without parentheses for the AI keys. Use AI(01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers. | |||||||||||
ie.Transformation Event | 0...1 | String | 1/* | - | O | The event
details group populated for the transformation event. The TransformationEvent is presented either:
Transformation event captures data related to pharmaceutical repackaging scenarios where a source product is repackaged into a new commissioned item. ![]() |
|||||||||||
cmn:EventLocation | 1...1 | String | 1/* | - | M | The site-level SGLN of the location where packing occurred. This is required by Serial Number Manager applications to track the plant where the serial numbers were packed into containers. SGLN format will be numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).36 | |||||||||||
ie.SourceProductDetail | 1...1 | - | - | - | M | The source product in repackaging operations. One of either InputQuantityList or InputSerialNumber is required. | |||||||||||
cmn:InputQuantityList | 0...1 | - | - | - | C | Specifies the
source product by product code, lot number, and quantity. ![]() |
|||||||||||
cmn:QuantityElement | 1...* | - | - | - | M | Groups the product code, lot number, and quantity values. | |||||||||||
cnm:ItemCode | 1...1 | String | 1/* | - | M | The product code for the commissioned item (e.g. GTIN-14). | |||||||||||
@type | 0...1 | String | 0/* | - | C | The
product code type using the supported enumeration values (e.g. GTIN-14).![]() |
|||||||||||
cmn:LotNumber | 1...1 | String | 0/* | - | M | The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters. | |||||||||||
cmn:Quantity | 1...1 | Integer | 1/* | - | M | The quantity of the source product used to create the repackaged product. TraceLink uses this quantity to match the quantity of serial numbers found for the item code and lot in the system to verify that quantity used for repackaging matches the quantity of expected serial numbers in system. If the quantities do not match, an error generates with the return quantity found in the system including the specific serial numbers found. | |||||||||||
cmn:InputSerialNumberList | 0...1 | - | - | - | C | Specifies the
source product by serial number.![]() |
|||||||||||
cmn:InputSerialNumber | 1...1 | - | - | - | M | The input serial number header container. | |||||||||||
cmn:SerialNumberList | 1...1 | - | - | - | M | List of the serial numbers commissioned for the output product produced in the transformation. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains the input serial number for the transformation event. SerialNumber is expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI (01) (21) formatted serial number for GTINs-or-AI (00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include the list of serial numbers.37 | |||||||||||
cmn:RegisterSourceProduct | 0...1 | Boolean | - | - | O | Triggers the registration of serial numbers that are not known to TraceLink system. Defaults to false if not populated. If value = true, the group RepackInputAttributes must be populated.38 | |||||||||||
cmn:RepackInputAttributes | 0...1 | - | - | - | C | Repack
input common attributes group with product info for input product.
![]() |
|||||||||||
cmn:LotNumber | 1...1 | String | 0/* | - | M | The lot or batch code for the transformation input product in an alphanumeric string of up to 20 characters.39 | |||||||||||
cmn:ExpirationDate | 1...1 | Date | 0/* | - | M | The expiration date for the transformation input product, formatted in YYYY-MM-DD format.40 | |||||||||||
cmn:DecommissionSourceProduct | 0...1 | Boolean | - | - | O | When set to true, instructs TraceLink to implicitly decommission serial numbers used for repackaging. This saves a step in the repack operation so that separate decommission events are not needed.41 | |||||||||||
ie:CommissionedSerialNumbers | 1...1 | - | - | - | M | Commissioned serial numbers for output in the transformation event. | |||||||||||
cmn:SerialNumberList | 1...1 | - | - | - | M | List of serial numbers commissioned for output product that were produced in the transformation. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains output serial number for the transformation event. SerialNumber expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI (01) (21) formatted serial number for GTINs-or-AI (00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers.42 | |||||||||||
ie:Error | 0...1 | - | - | - | O | List of the serial numbers that were part of an error in the transformation event. | |||||||||||
cmn:FailedSerialNumberList | 1...1 | - | - | - | M | List of failed serial numbers in the error group. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains output serial number for the transformation event. SerialNumber expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI (01) (21) formatted serial number for GTINs-or-AI (00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers. | |||||||||||
ie:SNX_DispositionUpdatedSpec | 0...1 | - | - | - | O | Option 2 for choice%2 group. Used for Serial Number Exchange Disposition Updated messages which are submitted to the system to identify updates to serialized product. | |||||||||||
cmn:EventLocation | 1...1 | String | 1/34 | - | M | Site-level SGLN of the location where the status update event occurred. SGLN format will be a numeric component only, with urn prefix stripped (e.g. 7777776.06734.0 instead of urn:epc:id:sgln:7777776.06734.0 typically found in EPCIS events). Conversion of GLN to SGLN format is <CompanyPrefix>.<LocationReference>.0 (e.g. 7777776067348 -> 7777776.06734.0). | |||||||||||
cmn:PackagingSerialNumberStatus | 1...1 | String | 1/* | PackagingSerialNumberStatus | M | New status that will be assigned to the serial numbers. | |||||||||||
cmn:Serial | 1...* | String | 1/* | - | M | Serial number expressed in
the barcode readable format.
For GS1 numbers, this is the Application Identifier format without parentheses
for the AI keys.
Use AI(01)(21) formatted serial number for GTINs: ![]() |
010030069422066221100000127837 .
AI(00) formatted serial number for SSCCs:
00008820200001000012 .
|||||||||||
@format | 0... | String | 0/* | Format | O | The attribute identifies the format of serial numbers. | |||||||||||
@packedStatus | 0...1 | String | 0/* | PackedStatus | O | Packed status. | |||||||||||
ie:SNX_DisaggregatedSpec | 0...1 | - | - | - | O | Option 3 for choice%2 group. Used for Serial Number Exchange Disaggregated messages submitted to the system to identify product that has been unpacked. | |||||||||||
cmn:EventLocation | 0...1 | String | 0/* | - | M | Site-level SGLN of the location where the status update event occurred. SGLN format will be a numeric component only, with urn prefix stripped (e.g. 7777776.06734.0 instead of urn:epc:id:sgln:7777776.06734.0 typically found in EPCIS events). Conversion of GLN to SGLN format is <CompanyPrefix>.<LocationReference>.0 (e.g. 7777776067348 -> 7777776.06734.0). | |||||||||||
cmn:ParentSerialNumber | 1...1 | String | 1/* | - | M | Serial number of the parent container that is represented in the disaggregation in this message. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains the serial number of the child item contained in cmn:ParentSerialNumber. cmn:SerialNumber expressed in the GS1 Application Identifier format without parentheses for the AI keys. Use AI (01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers. | |||||||||||
ie:SNX_ProductionOrderSpec | 0...1 | - | - | - | O | Option 4 for choice%2 group. Used for the Serial Number Exchange Production Order message. | |||||||||||
cmn:InternalMaterialCode | 0...1 | String | 0/* | - | C | Internal material number for the product in the planned batch. | |||||||||||
cmn:CountryDrugCode | 0...1 | String | 1/* | - | C | The national drug code for the product in the planned batch. ![]() ![]() |
|||||||||||
@type | 0...1 | String | 0/* | CountryDrugCode | M | Country drug type identifying the national drug code system. Valid values:
|
|||||||||||
cmn:LotNumber | 1...1 | String | 0/20 | - | M | The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters. | |||||||||||
cmn:BatchStatus | 1...1 | String | 1/* | BatchStatus | M | Status of the planned batch using the supported enumeration values. | |||||||||||
ie:SNX_EndOfBatchSpec | 0...1 | - | - | - | O | Choice option for choice1 group. Used for the Serial Number Exchange End of Batch message | |||||||||||
choice1 | 1...1 | Choice | - | - | M | Mandatory choice1 within the MessageBody. ![]() |
|||||||||||
cmn:InternalMaterialCode | 0...1 | String | 1/* | - | C | The internal material number for the product in the planned batch.43![]() |
|||||||||||
cmn:CountryDrugCode | 0...1 | String | 0/* | - | C | The national drug code (NDC) for the product in the planned batch.44![]()
|
|||||||||||
@type | 0...1 | String | 0/* | CountryDrugCode | C | The country drug type identifying national drug code system using one of the valid enumerator values. ![]() |
|||||||||||
cmn:LotNumber | 1...1 | String | 0/20 | - | M | The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters.45 | |||||||||||
cmn:ProductionQuantity | 1...* | - | - | - | M | The production quantities for the batch. This is a looping group with reported production quantities. A minimum of 1 entry is required for the "Each" packaging level. All other packaging levels are optional. An error results if this group is not populated. | |||||||||||
choice1 | 1...1 | Choice | - | - | M | A required choice1 within cmn:ProductionQuantity. ![]() |
|||||||||||
cmn:PackagingItemCode | 0...1 | String | 0/* | - | C | Option 1 within the required choice1. The packaging level product code (e.g. GTIN-14) for the packaging level.46![]() |
|||||||||||
@type | 1...1 | String | 1/* | PackagingItemCode | M | The product code type.
![]() |
|||||||||||
cmn:CompanyPrefix | 0...1 | String | 0/* | - | C | Option 2 within the required choice1. This indicates the GS1 company prefix.47![]() |
|||||||||||
cmn:PackagingLevel | 1...1 | String | 1/* | PackagingLevel | M | The packaging level associated with the cmn:PackagingItemCode using the supported enumeration values. | |||||||||||
cmn:QuantityReported | 1...1 | Integer | - | - | M | The quantity of serial numbers at the packaging location that are commissioned for the packaging level.48 | |||||||||||
cmn:QuantityCommissioned | 1...1 | Integer | - | - | M | The quantity of serial numbers commissioned from packaging location for the packaging level reported in the TraceLink system.49 | |||||||||||
cmn:BatchYieldVerifield | 1...1 | Boolean | - | - | M | This indicates if the Batch Yield was verified successfully. A success can be generated even when no batch yield verification is performed.50 | |||||||||||
cmn:MaxBatchSize | 0...1 | Integer | - | - | O | The quantity of the maximum batch size.51 | |||||||||||
cmn:AcceptableYield | 0...1 | Integer | - | - | C | The low end percentage (value between 1-100) of a standard acceptable range of the Batch size.52![]() |
|||||||||||
@acceptableYieldPercentage | 1...1 | Decimal | 1/* | - | M | The percentage value of the acceptable yield field.53![]() |
|||||||||||
cmn:MinimumYield | 0...1 | Integer | - | - | C | The lowest end percentage (value between 1-100) of an acceptable Batch size.54![]() |
|||||||||||
@minimumYieldPercentage | 1...1 | Decimal | 1/* | - | M | The percentage value of the minimum yield field.55![]() |
|||||||||||
ie:ProcessingCode | 1...1 | String | 1/* | - | M | The processing code assigned by the system to indicate the success, failure, or warning. | |||||||||||
ie:ProcessingMessage | 0...* | String | 1/* | - | O | The processing message with detail on why the item in the item spec incurred a warning or failure. | |||||||||||
ie:FailedItem | 0...1 | - | - | - | O | This element contains one item spec with processing code and processing message for each item that failed to update. The item spec contains identifying information about each item that failed. The number of item specs will be equal to the value of TotalFailed. If TotalFailed = 0, FailedItem will not be populated. | |||||||||||
ie:ProcessedItem | 1...* | - | - | - | M | List of one or more item specs with processing code for each item updated WITH warning. | |||||||||||
choice%3 | 0...1 | Choice | - | - | O | The choice%3 group is optional. ie:FailedItem may include only an error code and message if the inbound failure occurs before the incoming message is translated. One of the following choice options can be provided:
|
|||||||||||
ie:SNX_DispositionAssignedSpec | 0...1 | - | - | - | O | Option 1 for choice%3 group. Used for Serial Number Exchange Disposition Assigned messages submitted to the system to identify product that has been serialized (commissioned) and packed (aggregation). Incoming messages can include only commissioning events or both commissioning and aggregation events. | |||||||||||
ie:Commission | 0...1 | String | 1/* | - | O | Event details group populated for the "commission only" and "commission + aggregation" scenarios. Contains commission event detail data for a serial number. For the "commission + aggregation" scenario, EventDetail for the ParentSerialNumber MUST be included in the SerializedObjectInfo list. To include a list of commission events for multiple serial numbers, repeat the SerializedObjectInfo element. | |||||||||||
cmn:EventLocation | 1...1 | String | 1/* | - | M | Site-level SGLN of the location where commissioning occurred. SGLN format will be a numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events). | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains the serial number of the commissioned product. cmn:SerialNumber expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. The cmn:SerialNumber group can be repeated to include a list of serial numbers. | |||||||||||
ie:Aggregation | 0...1 | String | 1/* | - | O | Aggregation (packing) event details. Contains packing event data for a parent serial number and linked child serial number list. | |||||||||||
cmn:EventLocation | 1...1 | String | 1/* | - | M | Site-level SGLN of the location where packing occurred. This is required by Serial Number Manager applications to track the plant to which serial numbers were packed into containers. SGLN format will be numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events). | |||||||||||
cmn:ParentSerialNumber | 1...1 | String | 1/* | - | M | Serial number of the parent container that is represented in the aggregation in this message. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Populated for the "aggregation only" scenario. Contains the serial number of the child item contained in ContainerInfo/cmn:ParentSerialNumber. cmn:SerialNumber is expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. The SerializedObjectInfo/cmn:SerialNumber group is repeated to include a list of serial numbers. | |||||||||||
ie.Transformation Event | 0...1 | String | 1/* | - | O | The event
details group populated for the transformation event. The TransformationEvent is presented either:
Transformation event captures data related to pharmaceutical repackaging scenarios where a source product is repackaged into a new commissioned item. ![]() |
|||||||||||
cmn:EventLocation | 1...1 | String | 1/* | - | M | The site-level SGLN of the location where packing occurred. This is required by Serial Number Manager applications to track the plant where the serial numbers were packed into containers. SGLN format will be numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).56 | |||||||||||
ie.SourceProductDetail | 1...1 | - | - | - | M | The source product in repackaging operations. One of either InputQuantityList or InputSerialNumber is required. | |||||||||||
cmn:InputQuantityList | 0...1 | - | - | - | C | Specifies the
source product by product code, lot number, and quantity. ![]() |
|||||||||||
cmn:QuantityElement | 1...* | - | - | - | M | Groups the product code, lot number, and quantity values. | |||||||||||
cnm:ItemCode | 1...1 | String | 1/* | - | M | The product code for the commissioned item (e.g. GTIN-14). | |||||||||||
@type | 0...1 | String | 0/* | - | C | The
product code type using the supported enumeration values (e.g. GTIN-14).![]() |
|||||||||||
cmn:LotNumber | 1...1 | String | 0/* | - | M | The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters. | |||||||||||
cmn:Quantity | 1...1 | Integer | 1/* | - | M | The quantity of the source product used to create the repackaged product. TraceLink uses this quantity to match the quantity of serial numbers found for the item code and lot in the system to verify that quantity used for repackaging matches the quantity of expected serial numbers in system. If the quantities do not match, an error generates with the return quantity found in the system including the specific serial numbers found. | |||||||||||
cmn:InputSerialNumberList | 0...1 | - | - | - | C | Specifies the
source product by serial number.![]() |
|||||||||||
cmn:InputSerialNumber | 1...1 | - | - | - | M | The input serial number header container. | |||||||||||
cmn:SerialNumberList | 1...1 | - | - | - | M | List of the serial numbers commissioned for the output product produced in the transformation. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains the input serial number for the transformation event. SerialNumber is expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI (01) (21) formatted serial number for GTINs-or-AI (00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include the list of serial numbers.57 | |||||||||||
cmn:RegisterSourceProduct | 0...1 | Boolean | - | - | O | Triggers the registration of serial numbers that are not known to TraceLink system. Defaults to false if not populated. If value = true, the group RepackInputAttributes must be populated.58 | |||||||||||
cmn:RepackInputAttributes | 0...1 | - | - | - | C | Repack
input common attributes group with product info for input product.
![]() |
|||||||||||
cmn:LotNumber | 1...1 | String | 0/* | - | M | The lot or batch code for the transformation input product in an alphanumeric string of up to 20 characters.59 | |||||||||||
cmn:ExpirationDate | 1...1 | Date | 0/* | - | M | The expiration date for the transformation input product, formatted in YYYY-MM-DD format.60 | |||||||||||
cmn:DecommissionSourceProduct | 0...1 | Boolean | - | - | O | When set to true, instructs TraceLink to implicitly decommission serial numbers used for repackaging. This saves a step in the repack operation so that separate decommission events are not needed.61 | |||||||||||
ie:CommissionedSerialNumbers | 1...1 | - | - | - | M | Commissioned serial numbers for output in the transformation event. | |||||||||||
cmn:SerialNumberList | 1...1 | - | - | - | M | List of serial numbers commissioned for output product that were produced in the transformation. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains output serial number for the transformation event. SerialNumber expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI (01) (21) formatted serial number for GTINs-or-AI (00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers.62 | |||||||||||
ie:Error | 0...1 | - | - | - | O | List of the serial numbers that were part of an error in the transformation event. | |||||||||||
cmn:FailedSerialNumberList | 1...1 | - | - | - | M | List of failed serial numbers in the error group. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains output serial number for the transformation event. SerialNumber expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI (01) (21) formatted serial number for GTINs-or-AI (00) formatted serial number for SSCCs. The SerializedObjectInfo/SerialNumber group is repeated to include a list of serial numbers. | |||||||||||
ie:SNX_DispositionUpdatedSpec | 0...1 | - | - | - | O | Option 2 for choice%3 group. Used for Serial Number Exchange disposition updated messages submitted to the system to identify updates to serialized product. | |||||||||||
cmn:EventLocation | 1...1 | String | 1/34 | - | M | Site-level SGLN of the location where status update event occurred. SGLN format will be numeric component only, with urn prefix stripped (e.g. 7777776.06734.0 instead of urn:epc:id:sgln:7777776.06734.0 typically found in EPCIS events). Conversion of GLN to SGLN format is <CompanyPrefix>.<LocationReference>.0 (e.g. 7777776067348 -> 7777776.06734.0). | |||||||||||
cmn:PackagingSerialNumberStatus | 1...1 | String | 1/* | PackagingSerialNumberStatus | M | New status that will be assigned to the serial numbers. | |||||||||||
cmn:Serial | 1...* | String | 1/* | - | M | Serial number expressed in
the barcode readable format.
For GS1 numbers, this is the Application Identifier format without parentheses
for the AI keys.
AI(01)(21) formatted serial number for GTINs: ![]() |
010030069422066221100000127837
AI(00) formatted serial number for SSCCs:
00008820200001000012 .
|||||||||||
@format | 0...1 | String | 0/* | Format | O | The attribute identifies the format of serial numbers. | |||||||||||
@packedStatus | 0...1 | String | 0/* | PackedStatus | O | Packed status. | |||||||||||
ie:SNX_DisaggregatedSpec | 0...1 | - | - | - | O | Option 3 for choice%3 group. Used for Serial Number Exchange Disaggregated messages submitted to the system to identify product that has been unpacked. | |||||||||||
cmn:EventLocation | 0...1 | String | 0/* | - | M | Site-level SGLN of the location where status update event occurred. SGLN format will be a numeric component only, with urn prefix stripped (e.g. 7777776.06734.0 instead of urn:epc:id:sgln:7777776.06734.0 typically found in EPCIS events). Conversion of GLN to SGLN format is <CompanyPrefix>.<LocationReference>.0 (e.g. 7777776067348 -> 7777776.06734.0). | |||||||||||
cmn:ParentSerialNumber | 1...1 | String | 1/* | - | M | Serial number of the parent container that is represented in the disaggregation in this message. | |||||||||||
cmn:SerialNumber | 1...* | String | 1/* | - | M | Contains the serial number of the child item contained in cmn:ParentSerialNumber. cmn:SerialNumber expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI (01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. The SerializedObjectInfo/cmn:SerialNumber group is repeated to include a list of serial numbers. | |||||||||||
ie:SNX_ProductionOrderSpec | 0...1 | - | - | - | O | Option 4 for choice%3 group. Used for the Serial Number Exchange Production Order message. | |||||||||||
cmn:InternalMaterialCode | 0...1 | String | 0/* | - | C | Internal material number for the product in the planned batch. | |||||||||||
cmn:CountryDrugCode | 0...1 | String | 1/* | - | C | The national drug code for the product in the planned batch.63![]() ![]() |
|||||||||||
@type | 0...1 | String | 0/* | CountryDrugCode | M | Country drug type identifying the national drug code system. Valid values:
|
|||||||||||
cmn:LotNumber | 1...1 | String | 0/20 | - | M | The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters. | |||||||||||
cmn:BatchStatus | 1...1 | String | 1/* | BatchStatus | M | Status of the planned batch. | |||||||||||
ie:SNX_EndOfBatchSpec | 0...1 | - | - | - | O | Choice option for choice%1 group. Used for the Serial Number Exchange End of Batch message | |||||||||||
choice1 | 1...1 | Choice | - | - | M |
Required choice1 within the MessageBody. |
|||||||||||
cmn:InternalMaterialCode | 0...1 | String | 1/* | - | C | The internal material number for the product in the planned batch.64![]() |
|||||||||||
cmn:CountryDrugCode | 0...1 | String | 0/* | - | C | The national drug code (NDC) for the product in the planned batch.65![]()
|
|||||||||||
@type | 0...1 | String | 0/* | CountryDrugCode | C | The country drug type identifying national drug code system. ![]() |
|||||||||||
cmn:LotNumber | 1...1 | String | 0/20 | - | M | The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters.66 | |||||||||||
cmn:ProductionQuantity | 1...* | - | - | - | M | The production quantities for the batch. This is a looping group with reported production quantities. A minimum of 1 entry is required for the "Each" packaging level. All other packaging levels are optional. | |||||||||||
choice1 | 1...1 | Choice | - | - | M | A required choice1 within cmn:ProductionQuantity. ![]() |
|||||||||||
cmn:PackagingItemCode | 0...1 | String | 0/* | - | C | Option 1 within the required choice1. The packaging level product code (e.g. GTIN-14) for the packaging level.67![]() |
|||||||||||
@type | 1...1 | String | 1/* | PackagingItemCode | M | The product code type. ![]() |
|||||||||||
cmn:CompanyPrefix | 0...1 | String | 0/* | - | C | Option 2 within the required choice1. This indicates the GS1 company prefix.68![]() |
|||||||||||
cmn:PackagingLevel | 1...1 | String | 1/* | PackagingLevel | M | The packaging level associated with cmn:PackagingItemCode. | |||||||||||
cmn:QuantityReported | 1...1 | Integer | - | - | M | The quantity of serial numbers at the packaging location that are commissioned for the packaging level.69 | |||||||||||
cmn:QuantityCommissioned | 1...1 | Integer | - | - | M | The quantity of serial numbers commissioned from packaging location for the packaging level reported in the TraceLink system.70 | |||||||||||
cmn:BatchYieldVerifield | 1...1 | Boolean | - | - | M | This indicates if the Batch Yield was verified successfully. A success can be generated even when no batch yield verification is performed.71 | |||||||||||
cmn:MaxBatchSize | 0...1 | Integer | - | - | O | The quantity of the maximum batch size.72 | |||||||||||
cmn:AcceptableYield | 0...1 | Integer | - | - | C | The low end percentage (value between 1-100) of a standard acceptable range of the Batch size.73![]() |
|||||||||||
@acceptableYieldPercentage | 1...1 | Decimal | 1/* | - | M | The percentage value of the acceptable yield field.74![]() |
|||||||||||
cmn:MinimumYield | 0...1 | Integer | - | - | C | The lowest end percentage (value between 1-100) of an acceptable Batch size.75![]() |
|||||||||||
@minimumYieldPercentage | 1...1 | Decimal | 1/* | - | M | The percentage value of the minimum yield field.76![]() |
|||||||||||
ie:ProcessingCode | 1...1 | String | 1/* | - | M | The processing code assigned by the system to indicate the success, failure, or warning. | |||||||||||
ie:ProcessingMessage | 0...* | String | 1/* | - | O | The processing message with detail on why the item in the item spec incurred a warning or failure. |