Serialized Operations Manager 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.

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
The Serialized Operations Manager messages supported by Processing Response are Product Release, Sales Shipment, Receipt, Void Shipment, Update Serial Number Status, Take Product Sample, and Country Clearance.
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
  • SOM_AGGREGATE_UPDATE
  • SOM_COUNTRY_CLEARANCE
  • SOM_ESM_UPDATE_SN_STATUS
  • SOM_ESM_VOID_SHIPMENT
  • SOM_MARKET_RELEASE
  • SOM_PRODUCT_RELEASE
  • SOM_RECEIPT
  • SOM_REGISTRATION
  • SOM_RETURN_RECEIPT
  • SOM_SALES_SHIPMENT
  • SOM_TAKE_SAMPLE
  • SOM_TAKE_SAMPLE_EVENT
  • SOM_TAKE_SAMPLE_EVENT_IB
  • SOM_UPDATE_SN_STATUS
  • SOM_UPDATE_SN_STATUS_EVENT
  • SOM_UPDATE_SN_STATUS_EVENT_IB
  • SOM_VOID_SHIPMENT

  • SOM_END_OF_BATCH_EVENT

  • SOM_PRODUCT_RELEASE_EVENT

  • SOM_SHIPMENT_EVENT
      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:
  • Total number of items updated.
  • Total items (of the updated) processed with no warning.
  • Total items (of the updated) processed with warning.
  • Total failed items.

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:
  • Total number of items updated.
  • Total (of the updated) processed with no warning.
  • Total (of the updated) processed with warning.
  • The total failed items. 
        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, the ie:ProcessedNoWarning element 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, the ie:ProcessedWithWarning element 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 TotalProcessedNoWarning. If TotalProcessedNoWarning = 0,  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:
  • Option 1 within choice%1 is the Serialized Operations Manager Product Release Spec, used for Serialized Operations Manager Product Release message.
  • Option 2 within choice%1 is the Serialized Operations Manager Sales Shipment Spec, used for Serialized Operations Manager Sales Shipment message.
  • Option 3 within choice%1 is the Serialized Operations Manager Receipt Spec, used for a Serialized Operations Manager Receipt message.
  • Option 4 within choice%1 is the Serialized Operations Manager Void Shipment Spec, used for the Serialized Operations Manager Void Shipment message.
  • Option 5 within choice%1 is the Serialized Operations Manager Update Serial Number Status Spec, used for the Serialized Operations Manager Update Serial Number Status message.
  • Option 6 within choice%1 is the Serialized Operations Manager Take Sample Spec, used for the Serialized Operations Manager Take Product Sample message.
  • Option 7 within choice%1 is the Serialized Operations Manager Country Clearance Spec, used for the Serialized Operations Manager Country Clearance message.
  • Option 8 within choice%1 is the Serialized Operations Manager Aggregation Update Spec, used for the Serialized Operations Manager Aggregation Update message.
  • Option 9 within choice%1 is the Serialized Operations Manager Registration Spec, used for the Serialized Operations Manager Registration message.
  • Option 10 within choice%1 is the Serialized Operations Manager Market Release Spec, used for the Serialized Operations Manager Market Release message.
  • Option 11 within choice%1 is the Serialized Operations Manager End of Batch Event Spec, used for the Serialized Operations Manager end-of-batch event message sent outbound to downstream systems.
  • Option 12 within choice%1 is the Serialized Operations Manager Product Release Event Spec, used for the Serialized Operations Manager end-of-batch event message sent outbound to downstream systems.
  • Option 13 within choice%1 is the Serialized Operations Manager Shipment Event Spec, used for the Serialized Operations Manager end-of-batch event message sent outbound to downstream systems.
          ie:SOM_ProductReleaseSpec [0...1] - - - O Option 1 for choice%1 group. Used for Serialized Operations Manager Product Release message.
            cmn:LocationId [0...1] String [0/*] - O Specifies identifier of facility/warehouse to scope the Sales Shipment Status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Sales Shipment status update is applied globally to all matching serial numbers in the system. *12
            choice1 [1...1] Choice - - M One, and only one, of the three following item code data elements must be present:
  • cmn:CountryDrugCode
  • cmn:InternalMaterialCode
  • cmn:PackagingItemCode
            cmn:InternalMaterialCode [0...1] String [0/*] - O Option 1 of choice1. The internal material number configured in Product Master Data associated with the serialized items that will be updated with the Product Release status. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number.
            cmn:PackagingItemCode [0...1] String [0/*] - O Option 2 of choice1. The packaging level item code (e.g. GTIN-14, CN-ResCode) associated with the serialized items that will be updated with the Product Release status. Specifying a packaging item code will update all serial numbers that are linked to only the specified packaging item code and lot number. *13
The status update will be applied only to the serial numbers matching the specified packaging code and not related packaging codes (e.g. if a GTIN-14 for the Cases is specified, only the Case serial numbers will be updated and not the Eaches; if a GTIN-14 for the Eaches is specified, only the Each serial numbers will be updated and not the Case serial numbers).
              @type [0...1] String [0/*] PackagingItemCode M Packaging item code type is a GTIN-14 for all countries except China.
For China, this is CN-RESCODE.
            cmn:CountryDrugCode [0...1] String [1/*] - O Option 3 of choice1. The national drug code (e.g. NDC, Swissmedic, PZN) associated with the serialized items that will be updated with the Product Release status. Specifying a country drug code will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the country drug code and specified lot number. *14
              @type [0...1] String [0/*] CountryDrugCode C Country drug type identifying national drug code system.
            cmn:LotNumber [0...1] String [0/*] - O Bach or lot number for product.
            cmn:QualityControlEntityId [0...1] String [0/*] - O The business or location identifier for the entity responsible for quality control. *15
              @type [1...1] String [1/*] BusinessAndLocationId M The business or location identifier type for the entity responsible for quality control. *16
            cmn:TransactionIdentifier [0...*] String [0/*] - O The transaction identifier associated with the released product. *17
              @type [1...1] String [1/*] - M The transaction identifier type of the release product. Valid values: *18
  • CERTIFICATECONFORMITY
  • CIVILCIRCULATION
  • DECLARATIONCONFORMITY
  • STATECONFIRMATION
              @date [0...1] Date [0/*] - O The transaction identifier date attribute in YYYY-MM-DD format. *19
            cmn:EventDateTime [0...1] DateTime [0/*] - O Timestamp of the date/time of the product release with the UTC time zone indicator in XML YYYY-MM-DD format. *20
            cmn:ProductionQuantity [0...*] - - - O The production quantity group.
              choice1 [1...1] Choice - - M Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
              cmn:PackagingItemCode [0...1] String [0/*] - C Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *21
Mandatory if cmn:CompanyPrefix is not present.
                @type [0...1] String [0/*] PackagingItemCode M Packaging item code type. *22
              cmn:CompanyPrefix [1...1] String [0/*] - C Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *23
Mandatory if cmn:PackagingItemCode is not present.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *24
              cmn:QuantityReported [1...1] Integer - - M Reported quantity of the released product. *25
          ie:SOM_SalesShipmentSpec [0...1] - - - O Option 2 for choice%1 group. Used for Serialized Operations Manager Sales Shipment message.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery.
            cmn:SalesDistributionType [0...1] String [0/*] SalesDistType O This value will be referenced to advise the application of sale (i.e. change of ownership of the product) and transfer (i.e. no change of ownership of product, but physical movement of product) for application and regulatory reporting purposes. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application.  
            cmn:TransactionIdentifier [0...*] String [1/*] - O The transaction identifier associated with the picked serial numbers, for regulatory reporting purposes. At least one is required, and depending on the country more than one transaction id may be required.
Country Requirements:
  • Argentina will provide Packing Slip Number.
  • China will provide Sales Order Number.
  • US will provide PO Number, ASN Number, and Invoice Number if available.
              @type [1...1] String [1/*] TransactionIdentifier C The transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:Serial [0...*] String [0/*] - O 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.
For China, this is the 20 digit China EDMC Code. 81591390000000005716.
              @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:SOM_ReceiptSpec [0...1] - - - O Option 3 for choice%1 group. Used for a Serialized Operations Manager Shipment Receipt message.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery.
            cmn:ReceiptDistributionType [0...1] String [0/*] ReceiptDistributionType O Type of Receipt Distribution.
            cmn:TransactionIdentifier [0...*] String [1/*] - O The transaction identifier associated with the picked serial numbers, for regulatory reporting purposes. At least one is required, and depending on country more than one transaction id may be required.
Country Requirements:
  • Argentina will provide Packing Slip Number.
  • China will provide Sales Order Number.
  • US will provide PO Number, ASN Number, and Invoice Number if available.
              @type [1...1] String [1/*] TransactionIdentifier C The transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:Serial [0...*] String [0/*] - O 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.
For China, this is the 20 digit China EDMC Code. 81591390000000005716.
              @format [0...1] String [0/*] Format O The attribute identifies format of serial numbers.
              @packedStatus [0...1] String [0/*] PackedStatus O Packed status.
          ie:SOM_VoidShipmentSpec [0...1] - - - O Option 4 for choice%1 group. Used for Serialized Operations Manager Void Shipment message. Contains information required to cancel a delivery or to inform that a delivery will be corrected.
            cmn:DeliveryLocation [0...1] String [0/*] - O Specifies identifier of facility/warehouse to scope the Sales Shipment Status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Sales Shipment status update will be applied globally to all matching serial numbers in the system. *26
              @type [1...1] String [1/*] Location C Location identifier type. *27
Mandatory if cmn:DeliveryLocation is populated.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery. Identifies the delivery document that will be voided or corrected. *28
            cmn:DeliveryDirection [1...1] String [1/*] - M Describes direction of delivery - whether the delivery was sent to or received by the partner. *29

Valid values:

  • Sent
  • Received
            cmn:PartnerId [0...1] String [0/*] - C Partner ID for the delivery document. *30
Mandatory if cmn:DeliveryDirection = "Received".
              @type [1...1] String [1/*] Location C Partner identifier type. *31
Mandatory if cmn:DeliveryDirection = "Received".
            cmn:TransactionDate [0...1] Date [1/*] - O Date of void shipment in partner's business system. *32
            cmn:OrderCancelled [0...1] Boolean [0/*] - O Replaces CorrectShipment. Tracks whether the order is canceled rather than intent to correct, aligning better with future government reporting and ERP functionality. Default value is "false". Must be either "true" of "false" (lower case) if populated. *33
          ie:SOM_UpdateSNStatusSpec [0...1] - - - O Option 5 for choice%1 group. Use for Serialized Operations Manager update serial number status transaction message. Contains information required to update the status of one or more serial numbers. Also reports serial numbers that fail to update their status.
            cmn:SerialNumberStatus [1...1] String [1/*] SerialNumberStatus M The status of the serial number. *34
            cmn:ItemStatus [0...1] String [0/*] ItemStatus C The status of the item.
Mandatory when cmn:SerialNumberStatus equals "COMMISSIONED" or "REGISTERED". Do not populate if cmn:SerialNumberStatus equals any other value.
            cmn:UpdateSNStatusReasonCode [0...1] String [0/*] StatusReasonCode O Reason identifying why a serial number status is being updated. *35
            cmn:SerialNumberList [1...1] - - - O A list of one or more serial numbers that are not having their statuses updated.
              cmn:SerialNumber [1...*] String [1/*] - M Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. Format serial numbers for GTINs in AI (01) (21) format. Format serial numbers for SSCCs in AI (00) format. Express non-GS1 serial numbers (e.g. China) in native format. *36
          ie:SOM_TakeSampleSpec [0...1] String - - O Option 6 for choice%1 group. Contains processing information for Take Product Sample messages.
            cmn:SerialNumberList [1...1] String - - M The list of serial numbers having their statuses updated.
              cmn:SerialNumber [1...*] String [1/*] - M Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs. Non-GS1 serial numbers (e.g. China) are expressed in native format. *37
            cmn:TakeSampleReasonCode [0...1] String [0/*] TakeSampleReasonCode O Identifies the reason why a serial number status is updated. *38
            cmn:ReasonDescription [0...1] String [0/*] - O A text description of the reason for the status update. *39
            cmn:InspectionCountryCode [0...1] String [1/*] CountryCode O The country where the inspection is being performed using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *40
            cmn:SamplingPartyId [0...1] String [0/*] - O The business or location identifier for the entity performing the sampling. *41
              @type [1...1] String [1/*] BusinessAndLocationId M The business or location identifier type for the quality control entity identifier. *42
          ie:SOM_CountryClearanceSpec [0...1] - - - O Option 7 for the choice%1 group. Contains processing information for Serialized Operations Manager Country Clearance messages.
            cmn:ClearanceType [0...1] String [0/*] ClearanceType O Identifies the clearance type. Valid values: *43
  • CUSTOMS – Customs declaration of goods that are being transferred between countries.
  • TRADE – Declaration of goods that are being transferred between countries that have a cooperative trade agreement.
            cmn:EventLocation [0...1] String [0/*] - O The business or location identifier for the entity where the declaration occurs. *44
            cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId O The business or location type for the entity where the declaration occurs. *45
            cmn:ImportFromCountry [0...1] String [0/*] CountryCode O The country the product is being imported from using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *46
            cmn:ImportToCountry [0...1] String [0/*] CountryCode O The country the product is being imported into using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *47
            cmn:ImportingPartyId [0...1] String [0/*] - O Importing party identifier. *48
              @type [0...1] String [0/*] BusinessAndLocationId O Importing party identifier type. *49
            cmn:EventDateTime [0...1] DateTime [0/*] - O Timestamp of the date and time when the serial number is assigned (i.e. commissioned) to the product with the UTC timezone indicator in YYYY-MM-DDThh:mm:ss.sZ format. *50
            cmn:RegistrationDate [0...1] Date [0/*] - O Registration date in YYYY-MM-DD format. *51
            cmn:CustomsAuthorityCode [0...1] String [0/*] - C Customs authority code. *52
Mandatory if cmn:ImportToCountry = RU.
            cmn:DeclarationReleaseNumber [0...1] String [0/*] - C Declaration release number for the product. *53
Mandatory if cmn:ImportToCountry = RU.
            cmn:ActionCode [0...1] String [0/*] ActionCode C The clearance action that is taken. *54
Mandatory if cmn:ImportToCountry = RU.
          ie:SOM_AggregationUpdateSpec [0...1] - - - O Contains processing information for Serialized Operations Manager Aggregation Update messages.
            choice%1 [1...*] - - - M Looping choice element.
            ie:Aggregation [0...*] String - - O Aggregation group header for serial numbers being aggregated into a parent container.
              cmn:EventLocation [0...1] String [0/*] - O Business or location identifier for the entity aggregating the product. *55
              cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId O Business or location type for the entity aggregating the product. *56
              cmn:ParentSerial [0...1] String [0/*] - O Parent serial number for aggregation expressed in GS1 Application Identifier format, without parentheses, for the AI keys. AI(01)AI(21) formatted serial numbers for GTINs or AI(00) formatted serial number for SSCCs, without parentheses. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format. *57
                @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                @format [0...1] String [0/*] Format O Identifies the serial number format.
                @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
              cmn:NumberList [1...1] - - - M List of serial numbers for the items packed within the container serial number.
                cmn:Serial [1...*] String [1/*] - M Serial number 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. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format. *58
                  @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                  @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                  @format [0...1] String [0/*] Format O Identifies the serial number format.
                  @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
            ie:Disaggregation [0...*] - - - O Disaggregation group header for serial numbers being disaggregated from a parent container.
              cmn:EventLocation [0...1] String [0/*] - O Business or location identifier for the entity disaggregating the product. *59
              cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId O Business or location type for the entity disaggregating the product. *60
              cmn:ParentSerial [0...1] String [0/*] - O Parent serial number for aggregation expressed in GS1 Application Identifier format, without parentheses, for the AI keys. AI(01)AI(21) formatted serial numbers for GTINs or AI(00) formatted serial number for SSCCs, without parentheses. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format. *61
                @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                @format [0...1] String [0/*] Format O Identifies the serial number format.
                @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
              cmn:NumberList [1...1] - - - M List of serial numbers being disaggregated from the parent container. *62
                cmn:Serial [1...*] String [1/*] - M Serial number 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. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format.
                  @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                  @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                  @format [0...1] String [0/*] Format O Identifies the serial number format.
                  @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
          ie:SOM_RegistrationSpec [0...1] - - -   Registration group header for registering serial numbers.
            cmn:EventLocation [0...1] String [0/*] - O The business or location identifier for the entity where the declaration occurs. *63
              @type [0...1] String [1/*] BusinessAndLocationId O Business or location identifier type. *64
            cmn:ItemCode [0...1] String [1/*] - O Packaging level item code. *65
              @type [1...1] String [0/*] PackagingItemCode M Packaging item code type *66
            cmn:LotNumber [0...1] String [0/*] - C

Lot Number associated with the serial number at time of registration. *67

Mandatory if Serial | @format = AI(01)+AI(21)
            cmn:ExpirationDate [0...1] Date [0/*] - C

Expiration date associated with serial number at time of registration in xsd:date YYYY-MM-DD format. *68

Mandatory if Serial | @format = AI(01)+AI(21)
            cmn:NumberList [1...1] String [1/*] - M List of one or more serial numbers to be registered.
              cmn:Serial [1...*] String [1/*] - M Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. Format serial numbers for GTINs in AI (01) (21) format. Format serial numbers for SSCCs in AI (00) format. Express non-GS1 serial numbers (e.g. China) in native format. *69
                @companyPrefix [0...1] String [0/*] - O Identifies the company prefix assigned by GS1 for the registered product. *70
                @filterValue [0...1] String [0/*] - O Filter value associated with the serial number. *71
                @format [1...1] String [1/*] Format O Identifies the serial number format. *72
          ie:SOM_MarketReleaseSpec [0...1] - - - O Contains processing information for Serialized Operations Manager Market Release messages.
            cmn:EventLocation [0...1] String [0/*] - O Business or location identifier for the facility or warehouse scoping the Market Release status update for the serial numbers matching the specified item code and lot number. *73

If the location is omitted, the Market Release status update is applied globally to all matching serial numbers in TraceLink.
            cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId C Business or location type for the entity scoping the Market Release status. *74
Mandatory if cmn:EventLocation is present.
            choice%1 [1...1] - - - M

One and only one of the following item code data elements may be present at a time:

  • cmn:InternalMaterialCode
  • cmn:PackagingItemCode
  • cmn:CountryDrugCode
            cmn:InternalMaterialCode [0...1] String [0/*] - C Updates the status of the serialized items with the associated internal material code to now be Product Release. *75

Specifying an internal material number updates all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and the specified lot number.

Mandatory if both cmn:PackagingItemCode and cmn:CountryDrugCode are empty or null.
            cmn:PackagingItemCode [0...1] String [0/*] - C Updates the status of the serialized items with the associated packaging level item code to now be Product Release. *76

Specifying a packaging item code updates all serial numbers that are linked to only the specified packaging item code and lot number.

The status update is applied only to the serial numbers matching the specific packaging code and not related packaging codes (e.g. if a GTIN-14 for the cases are specified, only the case serial numbers are updated and not the eaches).

Mandatory if both cmn:InternalMaterialCode and cmn:CountryDrugCode are empty or null.
              @type [1...1] String [1/*] PackagingItemCode M Packaging item code type. *77
            cmn:CountryDrugCode [0...1] String [0/*] - C Updates the status of the serialized items with the associated national drug code to now be Product Release. *78

Specifying a country drug code updates all serial numbers at all packaging levels that are linked to the country drug code and the specified lot number.

Mandatory if both cmn:InternalMaterialCode and cmn:PackagingItemCode are empty or null.
              @type [1...1] String [1/*] CountryDrugCode M The country drug code type. *79
            cmn:LotNumber [1...1] String [0/*] - M The lot number associated with cmn:InternalMaterialCode, cmn:PackagingItemCode, or cmn:CountryDrugCode used to identify the serial numbers to be updated. *80
            cmn:FullLot [1...1] Boolean - - M Flags that the processing report is for a full or partial lot.

Valid vaues:

  • true – full lot is processed
  • false – partial lot is processed
            cmn:TransactionIdentifier [0...*] String [0/*] - O The transaction identifier associated with the released product. This may be a certificate or declaration of conformity. *81
              @type [1...1] String [1/*] - M The transaction identifier type for the market release.

Valid values: *82

  • CIVILCIRCULATION – Number of permission from a government agency for introduction of medicine into circulation. Used for immunobiological medicine only. Only valid for Product Release (XML) and Market Release (XML) messages.
  • STATECONFIRMATION – Number of document confirming the medicine compliance with state registration requirements.
              @date [0...1] Date [0/*] - O The transaction identifier date attribute. *83
            cmn:EventDateTime [0...1] DateTime [0/*] - O The date and time of the product release with the UTC time zone indicator in YYYY-MM-DDThh:mm:ss.ssZ format. *84
            cmn:MarketCountryCode [1...1] String [1/*] CountryCode M The 2 character ISO code for the market country. *85
            cmn:ProductionQuantity [0...*] - - - O Looping production quantity group.
              choice%1 [1...1] - - - M Either cmn:PackagingItemCode or cmn:CompanyPrefix must be present.
              cmn:PackagingItemCode [0...1] String [0/*] - C Identifies the product using the packaging level item code configured in Product Master Data. *86
Mandatory if cmn:CompanyPrefix is empty or null.
                @type [0...1] String [0/*] PackagingItemCode M Packaging item code type.

Valid values: *87

  • CN-RESCODE
  • GTIN-14
              cmn:CompanyPrefix [0...1] String [0/*] - C The GS1 company prefix for the released product. *88
Mandatory if cmn:PackagingItemCode is empty or null.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *89
              cmn:QuantityReported [1...1] Integer - - M Quantity reported for the released product. *90
          ie:SOM_EndOfBatchEventSpec [0...1] - - - O Option 11 for choice%1 group. Contains processing information for Serialized Operations Manager Market End of Batch Event OB message.
            choice1 [1...1] Choice - - M Choice element. If the value for choice%1 is SOM end of batch. One, and only one, of the following item code data elements may be present:
  • cmn:InternalMaterialCode
  • cmn:CountryDrugCode
            cmn:InternalMaterialCode [0...1] String [1/*] - O Option 1 of choice1. The internal material number configured in Product Master Data associated with the serialized items that will be updated with the Product Release status. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number.
            cmn:CountryDrugCode [0...1] String [0/*] - O Option 2 of choice1. The national drug code (e.g. NDC, Swissmedic, PZN) associated with the serialized items that will be updated with the Product Release status. Specifying a country drug code will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the country drug code and specified lot number.
              @type [0...1] String [0/*] CountryDrugCode O Country drug type identifying national drug code system.
            cmn:LotNumber [1...1] String [0/*] - M Batch or lot number for product.
            cmn:ProductionQuantity [1...*] - - - M The production quantity group. Minimum of 1 entry required, for the each packaging level. All other packaging levels are optional.
              choice1 [1...1] Choice - - M Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
              cmn:PackagingItemCode [0...1] String [0/*] - O Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *91
Mandatory if cmn:CompanyPrefix is not present.
                @type [1...1] String [1/*] PackagingItemCode C Packaging item code type is GTIN-14.
              cmn:CompanyPrefix [0...1] String [0/*] - 0 Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *92
Mandatory if cmn:PackagingItemCode is not present.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *93
              cmn:QuantityReported [1...1] Integer - - M Reported quantity of the released product.
              cmn:QuantityCommissioned [1...1] Integer - - M The total number of serial numbers assigned and commissioned at a specific packaging location for the reported packaging level in the TraceLink system. It is required field, and the system will generate an error if this value is not provided.
              cmn:BatchYieldVerifield [1...1] Boolean - - M Indicates whether batch verification was performed. This field can display a successful outcome even if no batch yield verification was conducted. Valid values are: true: Verification was performed. false: Verification was not performed.
              cmn:MaxBatchSize [0...1] Integer - - O Quantity of maximum batch size.
              cmn:AcceptableYield [0...1] Integer - - C Indicates the quantity of acceptable serial numbers yielded. This field is required if BatchYieldVerified is set to true. An error will be generated if BatchYieldVerified is true and this field is not populated.
                @acceptableYieldPercentage [1...1] Decimal [1/*] - C Percentage value of the acceptable yield field.
              cmn:MinimumYield [0...1] Integer - - C Indicates the quantity of serial numbers reported at the packaging location for the specified packaging level. This field is required if BatchYieldVerified is true. An error will be generated if BatchYieldVerified is true and MinimumYield is not populated.
                @minimumYieldPercentage [1...1] Decimal [1/*] - C Percentage value of the minimum yield field.
          ie:SOM_ProductReleaseEventSpec [0...1] - - - O Option 12 for choice%1 group. Used for Serialized Operations Manager Product Release.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            choice1 [1...1] Choice - - M Required, if the value for choice%1 is SOM product release. Choice element of either cmn:InternalMaterialCode or cmn:PackagingItemCode or cmn:CountryDrugCode.
            cmn:InternalMaterialCode [0...1] String [0/*] - O Option 1 of choice1. The internal material number configured in Product Master Data associated with the serialized items that will be updated with the Product Release status. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number.
            cmn:PackagingItemCode [0...1] String [0/*] - O Option 2 of choice1. The packaging level item code (e.g. GTIN-14, CN-ResCode) associated with the serialized items that will be updated with the Product Release status. Specifying a packaging item code will update all serial numbers that are linked to only the specified packaging item code and lot number. *94
The status update will be applied only to the serial numbers matching the specified packaging code and not related packaging codes (e.g. if a GTIN-14 for the Cases is specified, only the Case serial numbers will be updated and not the Eaches; if a GTIN-14 for the Eaches is specified, only the Each serial numbers will be updated and not the Case serial numbers).
              @type [0...1] String [0/*] PackagingItemCode M Packaging item code type is a GTIN-14 for all countries except China.
For China, this is CN-RESCODE.
            cmn:CountryDrugCode [0...1] String [1/*] - O Option 3 of choice1. The national drug code (e.g. NDC, Swissmedic, PZN) associated with the serialized items that will be updated with the Product Release status. Specifying a country drug code will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the country drug code and specified lot number. *95
              @type [0...1] String [0/*] CountryDrugCode O Country drug type identifying national drug code system.
            cmn:LotNumber [0...1] String [0/*] - O Bach or lot number for product.
            cmn:QualityControlEntityId [0...1] String [0/*] - O The business or location identifier for the entity responsible for quality control. *96
              @type [1...1] String [1/*] BusinessAndLocationId C The business or location identifier type for the entity responsible for quality control. *97
            cmn:TransactionIdentifier [0...*] String [0/*] - O The transaction identifier associated with the released product. *98
              @type [1...1] String [1/*] TransactionIdentifier C The transaction identifier type of the release product. Valid values: *99
  • CERTIFICATECONFORMITY
  • DECLARATIONCONFORMITY
              @date [0...1] Date - - O The transaction identifier date attribute in YYYY-MM-DD format. *100
Added to support Russia compliance.
            cmn:EventDateTime [0...1] DateTime [0/*] - O Timestamp of the date/time of the product release with the UTC time zone indicator in XML YYYY-MM-DD format. *101
            cmn:ProductionQuantity [0...*] - - - O The production quantity group.
              choice1 [1...1] Choice - - M Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
              cmn:PackagingItemCode [0...1] String [0/*] - O Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *102
Mandatory if cmn:CompanyPrefix is not present.
                @type [0...1] String [0/*] PackagingItemCode C Packaging item code type. *103
              cmn:CompanyPrefix [0...1] String [0/*] - O Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *104
Mandatory if cmn:PackagingItemCode is not present.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *105
              cmn:QuantityReported [1...1] Integer - - M Reported quantity of the released product. *106
          ie:SOM_ShipmentEventSpec [0...1] - - - O Option 13 for choice%1 group. Used for Serialized Operations Manager Shipment Event Message.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery.
            cmn:SalesDistributionType [0...1] String [0/*] SalesDistType
 		O

Defines the nature of the product's movement and its purpose for application and regulatory reporting. It identifies whether the movement is a sale (indicating a change in ownership) or a transfer (physical movement without change in ownership). Note that simply setting this value does not trigger regulatory reporting; regulatory reporting is controlled by customer administrative configurations in the TraceLink application. The valid values are as follows:

  • INCOUNTRYSALE: Indicates a sale and distribution made within the same country.

  • EXPORTSALE: Represents a sale and distribution from one country to another.

  • INCOUNTRYTRANSFER: Denotes a warehouse transfer, including transactions with CMOs/CMOs or 3PL partners, made within the same country.

  • EXPORTTRANSFER: Specifies a warehouse transfer, including transactions with CMOs/CMOs or 3PL partners, made from one country to another.

  • INCOUNTRYRETURN: Refers to a return shipment made within the same country.

  • EXPORTRETURN: Describes a return shipment made from one country to another.

INCOUNTRYTRANSFER and EXPORTTRANSFER include intra-company warehouse transfers, transfers between Manufacturer (Brand Owner) and 3PL, transfers between Manufacturer (Brand Owner) and CMO/CPO, and transfers between CMO/CPO and the 3PL of the Manufacturer (Brand Owner).
            cmn:TransactionIdentifier [0...*] String [1/*] - O The transaction identifier associated with the picked serial numbers, for regulatory reporting purposes. At least one is required, and depending on country more than one transaction id may be required.
Country Requirements:
  • Argentina will provide Packing Slip Number.
  • China will provide Sales Order Number.
  • US will provide PO Number, ASN Number, and Invoice Number if available.
              @type [1...1] String [1/*]
TransactionIdentifierProdRelease 		C The transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:Serial [0...*] String [0/*] - O 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.
For China, this is the 20 digit China EDMC Code. 81591390000000005716.
              @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: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:
  • Option 1 within choice%2 is the Serialized Operations Manager Product Release Spec, used for Serialized Operations Manager Product Release message.
  • Option 2 within choice%2 is the Serialized Operations Manager Sales Shipment Spec, used for Serialized Operations Manager Sales Shipment message.
  • Option 3 within choice%2 is the Serialized Operations Manager Receipt Spec, used for a Serialized Operations Manager Shipment Receipt message.
  • Option 4 within choice%2 is the Serialized Operations Manager Void Shipment Spec, used for the Serialized Operations Manager Void Shipment message.
  • Option 5 within choice%2 is the Serialized Operations Manager Update Serial Number Status Spec, used for the Serialized Operations Manager Update Serial Number Status message.
  • Option 6 within choice%2 is the Serialized Operations Manager Take Sample Spec, used for the Serialized Operations Manager Take Product Sample message.
  • Option 7 within choice%2 is the Serialized Operations Manager Country Clearance Spec, used for the Serialized Operations Manager Country Clearance message.
  • Option 8 within choice%2 is the Serialized Operations Manager Aggregation Update Spec, used for the Serialized Operations Manager Aggregation Update message.
  • Option 9 within choice%2 is the Serialized Operations Manager Registration Spec, used for the Serialized Operations Manager Registration message.
  • Option 10 within choice%2 is the Serialized Operations Manager Market Release Spec, used for the Serialized Operations Manager Market Release message.
  • Option 11 within choice%2 is the Serialized Operations Manager End of Batch Event Spec, used for the Serialized Operations Manager end-of-batch event message sent outbound to downstream systems.
  • Option 12 within choice%2 is the Serialized Operations Manager Product Release Event Spec, used for the Serialized Operations Manager end-of-batch event message sent outbound to downstream systems.
  • Option 13 within choice%2 is the Serialized Operations Manager Shipment Event Spec, used for the Serialized Operations Manager end-of-batch event message sent outbound to downstream systems.
          ie:SOM_ProductReleaseSpec [0...1] - - - O Option 1 for choice%2 group. Used for Serialized Operations Manager Product Release message.
            cmn:LocationId [0...1] String [0/*] - O Specifies the identifier of a facility/warehouse to scope the Sales Shipment Status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Sales Shipment status update will be applied globally to all matching serial numbers in the system.
            choice1 [1...1] - - - M Choice element. One, and only one, of the following item code data elements may be present:
  • cmn:CountryDrugCode
  • cmn:InternalMaterialCode
  • cmn:PackagingItemCode
            cmn:InternalMaterialCode [0...1] String [0/*] - O Option 1 of choice1. The internal material number configured in Product Master Data associated with the serialized items that will be updated with the Product Release status. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number.
            cmn:PackagingItemCode [0...1] String [0/*] - O Option 2 of choice1. The packaging level item code (e.g. GTIN-14, CN-ResCode) associated with the serialized items that will be updated with the Product Release status. Specifying a packaging item code will update all serial numbers that are linked to only the specified packaging item code and lot number.
The status update will be applied only to the serial numbers matching the specified packaging code and not related packaging codes (e.g. if a GTIN-14 for the Cases is specified, only the Case serial numbers will be updated and not the Eaches; if a GTIN-14 for the Eaches is specified, only the Each serial numbers will be updated and not the Case serial numbers).
              @type [0...1] String [0/*] PackagingItemCode M Packaging item code type is GTIN-14 for all countries except China.
Mandatory for China: CN-RESCODE.
            cmn:CountryDrugCode [0...1] String [1/*] - O Option 3 of choice1. The national drug code (e.g. NDC, Swissmedic, PZN) associated with the serialized items that will be updated with the Product Release status. Specifying a country drug code will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the country drug code and specified lot number.
              @type [0...1] String [0/*] CountryDrugCode O Country drug type identifying national drug code system.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for product.
            cmn:QualityControlEntityId [0...1] String [0/*] - O The business or location identifier for the entity responsible for quality control. *107
              @type [1...1] String [1/*] BusinessAndLocationId M The business or location identifier type for the entity responsible for quality control. *108
            cmn:TransactionIdentifier [0...*] String [0/*] - O The transaction identifier associated with the released product. *109
              @type [1...1] String [1/*] - M The transaction identifier type of the release product. Valid values: *110
  • CERTIFICATECONFORMITY
  • CIVILCIRCULATION
  • DECLARATIONCONFORMITY
  • STATECONFIRMATION
              @date [0...1] Date [0/*] - O The transaction identifier date attribute in YYYY-MM-DD format. *111
            cmn:EventDateTime [0...1] DateTime [0/*] - O Timestamp of the date/time of the product release with the UTC time zone indicator in XML YYYY-MM-DD format. *112
            cmn:ProductionQuantity [0...*] - - - O The production quantity group.
              choice1 [1...1] Choice - - M Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
              cmn:PackagingItemCode [0...1] String [0/*] - C Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *113
Mandatory if cmn:CompanyPrefix is not present.
                @type [0...1] String [0/*] PackagingItemCode M Packaging item code type. *114
              cmn:CompanyPrefix [0...1] String [0/*] - C Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *115
Mandatory if cmn:PackagingItemCode is not present.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *116
              cmn:QuantityReported [1...1] Integer - - M Reported quantity of the released product. *117
          ie:SOM_SalesShipmentSpec [0...1] - - - O Option 2 for choice%2 group. Used for Serialized Operations Manager Sales Shipment message.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery.
            cmn:SalesDistributionType [0...1] String [0/*] SalesDistType O This value will be referenced to advise the application of sale (i.e. change of ownership of the product) and transfer (i.e. no change of ownership of product, but physical movement of product) for application and regulatory reporting purposes. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink Network.
            cmn:TransactionIdentifier [0...*] String [1/*] - O The transaction identifier associated with the picked serial numbers, for regulatory reporting purposes. At least one is required, and depending on country more than one transaction id may be required.
Country Requirements:
  • Argentina will provide Packing Slip Number.
  • China will provide Sales Order Number.
  • US will provide PO Number, ASN Number, and Invoice Number if available.
              @type [1...1] String [1/*] TransactionIdentifier C The transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:Serial [0...*] String [0/*] - O 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.
For China, this is the 20 digit China EDMC Code. 81591390000000005716.
              @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:SOM_ReceiptSpec [0...1] - - - O Option 3 for choice%2 group. Used for Serialized Operations Manager Shipment Receipt message.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery.
            cmn:ReceiptDistributionType [0...1] String [0/*] ReceiptDistributionType O Type of Receipt Distribution.
            cmn:TransactionIdentifier [0...*] String [1/*] - O The transaction identifier associated with the picked serial numbers, for regulatory reporting purposes. At least one is required, and depending on country more than one transaction id may be required.
Country Requirements:
  • Argentina will provide Packing Slip Number.
  • China will provide Sales Order Number.
  • US will provide PO Number, ASN Number, and Invoice Number if available.
              @type [1...1] String [1/*] TransactionIdentifier C The transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:Serial [0...*] String [0/*] - O 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.
For China, this is the 20 digit China EDMC Code. 81591390000000005716.
              @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:SOM_VoidShipmentSpec [0...1] - - - O Option 4 for choice%2 group. Used for Serialized Operations Manager Void Shipment message. Contains information required to cancel a delivery or to inform that a delivery will be corrected.
            cmn:DeliveryLocation [0...1] String [0/*] - O Specifies identifier of facility/warehouse to scope the Sales Shipment Status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Sales Shipment status update will be applied globally to all matching serial numbers in the system. *118
              @type [1...1] String [1/*] Location C Location identifier type. *119
Mandatory if cmn:DeliveryLocation is populated.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery. Identifies the delivery document that will be voided or corrected. *120
            cmn:DeliveryDirection [1...1] String [1/*] - M Describes direction of delivery - whether the delivery was sent to or received by the partner. *121

Valid values:

  • Sent
  • Received
            cmn:PartnerId [0...1] String [0/*] - C Partner ID for the delivery document. *122
Mandatory if cmn:DeliveryDirection = "received".
              @type [1...1] String [1/*] Location C Partner identifier type. *123
Mandatory if cmn:PartnerId is populated.
            cmn:TransactionDate [0...1] Date [1/*] - O Date of void shipment in partner's business system. *124
            cmn:OrderCancelled [0...1] Boolean [0/*] - O Replaces CorrectShipment. Tracks whether the order is cancelled rather than intent to correct, aligning better with future government reporting and ERP functionality. Default value is "false". Must be either "true" of "false" (lower case) if populated. *125
          ie:SOM_UpdateSNStatusSpec [0...1] - - - O Option 5 for choice%2 group. Use for Serialized Operations Manager update serial number status transaction message. Contains information required to update the status of one or more serial numbers. Also reports serial numbers that fail to update their status.
            cmn:SerialNumberStatus [1...1] String [1/*] SerialNumberStatus M The status of the serial number. *126
            cmn:ItemStatus [0...1] String [0/*] ItemStatus C The status of the item.
Mandatory when cmn:SerialNumberStatus equals "COMMISSIONED" or "REGISTERED". Do not populate if cmn:SerialNumberStatus equals any other value.
            cmn:UpdateSNStatusReasonCode [0...1] String [0/*] StatusReasonCode O Reason identifying why a serial number status is being updated. *127
            cmn:SerialNumberList [1...1] - - - O A list of one or more serial numbers that are not having their statuses updated.
              cmn:SerialNumber [1...*] String [1/*] - M Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. Format serial numbers for GTINs in AI (01) (21) format. Format serial numbers for SSCCs in AI (00) format. Express non-GS1 serial numbers (e.g. China) in native format. *128
          ie:SOM_TakeSampleSpec [0...1] String - - O Option 6 for choice%2 group. Contains processing information for Take Product Sample messages.
            cmn:SerialNumberList [1...1] String - - M The list of serial numbers having their statuses updated.
              cmn:SerialNumber [1...*] String [1/*] - M Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs. Non-GS1 serial numbers (e.g. China) are expressed in native format. *129
            cmn:TakeSampleReasonCode [0...1] String [0/*] TakeSampleReasonCode O Identifies the reason why a serial number status is updated. *130
            cmn:ReasonDescription [0...1] String [0/*] - O A text description of the reason for the status update. *131
            cmn:InspectionCountryCode [0...1] String [1/*] CountryCode O The country where the inspection is being performed using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *132
            cmn:SamplingPartyId [0...1] String [0/*] - O The business or location identifier for the entity performing the sampling. *133
              @type [1...1] String [1/*] BusinessAndLocationId M The business or location identifier type for the quality control entity identifier. *134
          ie:SOM_AggregationUpdateSpec [0...1] - - - O Contains processing information for Serialized Operations Manager Aggregation Update messages.
            choice%1 [1...*] - - - M Looping choice element.
            ie:Aggregation [0...*] String - - O Aggregation group header for serial numbers being aggregated into a parent container.
              cmn:EventLocation [0...1] String [0/*] - O Business or location identifier for the entity aggregating the product. *135
              cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId O Business or location type for the entity aggregating the product. *136
              cmn:ParentSerial [0...1] String [0/*] - O Parent serial number for aggregation expressed in GS1 Application Identifier format, without parentheses, for the AI keys. AI(01)AI(21) formatted serial numbers for GTINs or AI(00) formatted serial number for SSCCs, without parentheses. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format. *137
                @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                @format [0...1] String [0/*] Format O Identifies the serial number format.
                @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
              cmn:NumberList [1...1] - - - M List of serial numbers for the items packed within the container serial number.
                cmn:Serial [1...*] String [1/*] - M Serial number 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. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format. *138
                  @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                  @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                  @format [0...1] String [0/*] Format O Identifies the serial number format.
                  @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
            ie:Disaggregation [0...*] - - - O Disaggregation group header for serial numbers being disaggregated from a parent container.
              cmn:EventLocation [0...1] String [0/*] - O Business or location identifier for the entity disaggregating the product. *139
              cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId O Business or location type for the entity disaggregating the product. *140
              cmn:ParentSerial [0...1] String [0/*] - O Parent serial number for aggregation expressed in GS1 Application Identifier format, without parentheses, for the AI keys. AI(01)AI(21) formatted serial numbers for GTINs or AI(00) formatted serial number for SSCCs, without parentheses. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format. *141
                @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                @format [0...1] String [0/*] Format O Identifies the serial number format.
                @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
              cmn:NumberList [1...1] - - - M List of serial numbers being disaggregated from the parent container. *142
                cmn:Serial [1...*] String [1/*] - M Serial number 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. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format.
                  @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                  @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                  @format [0...1] String [0/*] Format O Identifies the serial number format.
                  @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
          ie:SOM_RegistrationSpec [0...1] - - - O Registration group header for registering serial numbers.
            cmn:EventLocation [0...1] String [0/*] - O The business or location identifier for the entity where the declaration occurs. *143
              @type [0...1] String [1/*] BusinessAndLocationId O Business or location identifier type. *144
            cmn:ItemCode [0...1] String [1/*] - O Packaging level item code. *145
              @type [1...1] String [0/*] PackagingItemCode M Packaging item code type *146
            cmn:LotNumber [0...1] String [0/*] - C

Lot Number associated with the serial number at time of registration. *147

Mandatory if Serial | @format = AI(01)+AI(21)
            cmn:ExpirationDate [0...1] Date [0/*] - C

Expiration date associated with serial number at time of registration in xsd:date YYYY-MM-DD format. *148

Mandatory if Serial | @format = AI(01)+AI(21)
            cmn:NumberList [1...1] String [1/*] - M List of one or more serial numbers to be registered.
              cmn:Serial [1...*] String [1/*] - M Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. Format serial numbers for GTINs in AI (01) (21) format. Format serial numbers for SSCCs in AI (00) format. Express non-GS1 serial numbers (e.g. China) in native format. *149
                @companyPrefix [0...1] String [0/*] - O Identifies the company prefix assigned by GS1 for the registered product. *150
                @filterValue [0...1] String [0/*] - O Filter value associated with the serial number. *151
                @format [1...1] String [1/*] Format O Identifies the serial number format. *152
          ie:SOM_MarketReleaseSpec [0...1] - - - O Contains processing information for Serialized Operations Manager Market Release messages.
            cmn:EventLocation [0...1] String [0/*] - O Business or location identifier for the facility or warehouse scoping the Market Release status update for the serial numbers matching the specified item code and lot number. *153

If the location is omitted, the Market Release status update is applied globally to all matching serial numbers in TraceLink.
            cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId C Business or location type for the entity scoping the Market Release status. *154
Mandatory if cmn:EventLocation is present.
            choice%1 [1...1] - - - M

One and only one of the following item code data elements may be present at a time:

  • cmn:InternalMaterialCode
  • cmn:PackagingItemCode
  • cmn:CountryDrugCode
            cmn:InternalMaterialCode [0...1] String [0/*] - C Updates the status of the serialized items with the associated internal material code to now be Product Release. *155

Specifying an internal material number updates all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and the specified lot number.

Mandatory if both cmn:PackagingItemCode and cmn:CountryDrugCode are empty or null.
            cmn:PackagingItemCode [0...1] String [0/*] - C Updates the status of the serialized items with the associated packaging level item code to now be Product Release. *156

Specifying a packaging item code updates all serial numbers that are linked to only the specified packaging item code and lot number.

The status update is applied only to the serial numbers matching the specific packaging code and not related packaging codes (e.g. if a GTIN-14 for the cases are specified, only the case serial numbers are updated and not the eaches).

Mandatory if both cmn:InternalMaterialCode and cmn:CountryDrugCode are empty or null.
              @type [1...1] String [1/*] PackagingItemCode M Packaging item code type. *157
            cmn:CountryDrugCode [0...1] String [0/*] - C Updates the status of the serialized items with the associated national drug code to now be Product Release. *158

Specifying a country drug code updates all serial numbers at all packaging levels that are linked to the country drug code and the specified lot number.

Mandatory if both cmn:InternalMaterialCode and cmn:PackagingItemCode are empty or null.
              @type [1...1] String [1/*] CountryDrugCode M The country drug code type. *159
            cmn:LotNumber [1...1] String [0/*] - M The lot number associated with cmn:InternalMaterialCode, cmn:PackagingItemCode, or cmn:CountryDrugCode used to identify the serial numbers to be updated. *160
            cmn:FullLot [1...1] Boolean - - M Flags that the processing report is for a full or partial lot.

Valid vaues:

  • true – full lot is processed
  • false – partial lot is processed
            cmn:TransactionIdentifier [0...*] String [0/*] - O The transaction identifier associated with the released product. This may be a certificate or declaration of conformity. *161
              @type [1...1] String [1/*] - M The transaction identifier type for the market release.

Valid values: *162

  • CIVILCIRCULATION – Number of permission from a government agency for introduction of medicine into circulation. Used for immunobiological medicine only. Only valid for Product Release (XML) and Market Release (XML) messages.
  • STATECONFIRMATION – Number of document confirming the medicine compliance with state registration requirements.
              @date [0...1] Date [0/*] - O The transaction identifier date attribute. *163
            cmn:EventDateTime [0...1] DateTime [0/*] - O The date and time of the product release with the UTC time zone indicator in YYYY-MM-DDThh:mm:ss.ssZ format. *164
            cmn:MarketCountryCode [1...1] String [1/*] CountryCode M The 2 character ISO code for the market country. *165
            cmn:ProductionQuantity [0...*] - - - O Looping production quantity group.
              choice%1 [1...1] - - - M Either cmn:PackagingItemCode or cmn:CompanyPrefix must be present.
              cmn:PackagingItemCode [0...1] String [0/*] - C Identifies the product using the packaging level item code configured in Product Master Data. *166
Mandatory if cmn:CompanyPrefix is empty or null.
                @type [0...1] String [0/*] PackagingItemCode M Packaging item code type.

Valid values: *167

  • CN-RESCODE
  • GTIN-14
              cmn:CompanyPrefix [0...1] String [0/*] - C The GS1 company prefix for the released product. *168
Mandatory if cmn:PackagingItemCode is empty or null.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *169
              cmn:QuantityReported [1...1] Integer - - M Quantity reported for the released product. *170
          ie:SOM_EndOfBatchEventSpec [0...1] - - - O Option 11 for choice%2 group. Contains processing information for Serialized Operations Manager Market End of Batch Event OB message.
            choice1 [1...1] Choice - - M Choice element. If the value for choice%2 is SOM end of batch. One, and only one, of the following item code data elements may be present:
  • cmn:InternalMaterialCode
  • cmn:CountryDrugCode
            cmn:InternalMaterialCode [0...1] String [1/*] - O Option 1 of choice1. The internal material number configured in Product Master Data associated with the serialized items that will be updated with the Product Release status. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number.
            cmn:CountryDrugCode [0...1] String [0/*] - O Option 2 of choice1. The national drug code (e.g. NDC, Swissmedic, PZN) associated with the serialized items that will be updated with the Product Release status. Specifying a country drug code will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the country drug code and specified lot number.
              @type [0...1] String [0/*] CountryDrugCode C Country drug type identifying national drug code system.
            cmn:LotNumber [1...1] String [0/*] - M Batch or lot number for product.
            cmn:ProductionQuantity [1...*] - - - M The production quantity group. Minimum of 1 entry required, for the each packaging level. All other packaging levels are optional.
              choice1 [1...1] Choice - - M Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
              cmn:PackagingItemCode [0...1] String [0/*] - O Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *171
Mandatory if cmn:CompanyPrefix is not present.
                @type [1...1] String [1/*] PackagingItemCode C Packaging item code type is GTIN-14.
              cmn:CompanyPrefix [0...1] String [0/*] - 0 Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *172
Mandatory if cmn:PackagingItemCode is not present.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *173
              cmn:QuantityReported [1...1] Integer - - M Reported quantity of the released product.
              cmn:QuantityCommissioned [1...1] Integer - - M The total number of serial numbers assigned and commissioned at a specific packaging location for the reported packaging level in the TraceLink system. It is required field, and the system will generate an error if this value is not provided.
              cmn:BatchYieldVerifield [1...1] Boolean - - M Indicates whether batch verification was performed. This field can display a successful outcome even if no batch yield verification was conducted. Valid values are: true: Verification was performed. false: Verification was not performed.
              cmn:MaxBatchSize [0...1] Integer - - O Quantity of maximum batch size.
              cmn:AcceptableYield [0...1] Integer - - C Indicates the quantity of acceptable serial numbers yielded. This field is required if BatchYieldVerified is set to true. An error will be generated if BatchYieldVerified is true and this field is not populated.
                @acceptableYieldPercentage [1...1] Decimal [1/*] - C Percentage value of the acceptable yield field.
              cmn:MinimumYield [0...1] Integer - - C Indicates the quantity of serial numbers reported at the packaging location for the specified packaging level. This field is required if BatchYieldVerified is true. An error will be generated if BatchYieldVerified is true and MinimumYield is not populated.
                @minimumYieldPercentage [1...1] Decimal [1/*] - C Percentage value of the minimum yield field.
          ie:SOM_ProductReleaseEventSpec [0...1] - - - O Option 12 for choice%2 group. Used for Serialized Operations Manager Product Release.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            choice1 [1...1] Choice - - M Required, if the value for choice%2 is SOM product release. Choice element of either cmn:InternalMaterialCode or cmn:PackagingItemCode or cmn:CountryDrugCode.
            cmn:InternalMaterialCode [0...1] String [0/*] - O Option 1 of choice1. The internal material number configured in Product Master Data associated with the serialized items that will be updated with the Product Release status. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number.
            cmn:PackagingItemCode [0...1] String [0/*] - O Option 2 of choice1. The packaging level item code (e.g. GTIN-14, CN-ResCode) associated with the serialized items that will be updated with the Product Release status. Specifying a packaging item code will update all serial numbers that are linked to only the specified packaging item code and lot number. *174
The status update will be applied only to the serial numbers matching the specified packaging code and not related packaging codes (e.g. if a GTIN-14 for the Cases is specified, only the Case serial numbers will be updated and not the Eaches; if a GTIN-14 for the Eaches is specified, only the Each serial numbers will be updated and not the Case serial numbers).
              @type [0...1] String [0/*] PackagingItemCode M Packaging item code type is a GTIN-14 for all countries except China.
For China, this is CN-RESCODE.
            cmn:CountryDrugCode [0...1] String [1/*] - O Option 3 of choice1. The national drug code (e.g. NDC, Swissmedic, PZN) associated with the serialized items that will be updated with the Product Release status. Specifying a country drug code will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the country drug code and specified lot number. *175
              @type [0...1] String [0/*] CountryDrugCode O Country drug type identifying national drug code system.
            cmn:LotNumber [0...1] String [0/*] - O Bach or lot number for product.
            cmn:QualityControlEntityId [0...1] String [0/*] - O The business or location identifier for the entity responsible for quality control. *176
              @type [1...1] String [1/*] BusinessAndLocationId C The business or location identifier type for the entity responsible for quality control. *177
            cmn:TransactionIdentifier [0...*] String [0/*] - O The transaction identifier associated with the released product. *178
              @type [1...1] String [1/*] - C The transaction identifier type of the release product. Valid values: *179
  • CERTIFICATECONFORMITY
  • DECLARATIONCONFORMITY
              @date [0...1] Date - - O The transaction identifier date attribute in YYYY-MM-DD format. *180
Added to support Russia compliance.
            cmn:EventDateTime [0...1] DateTime [0/*] - O Timestamp of the date/time of the product release with the UTC time zone indicator in XML YYYY-MM-DD format. *181
            cmn:ProductionQuantity [0...*] - - - O The production quantity group.
              choice1 [1...1] Choice - - M Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
              cmn:PackagingItemCode [0...1] String [0/*] - O Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *182
Mandatory if cmn:CompanyPrefix is not present.
                @type [0...1] String [0/*] PackagingItemCode C Packaging item code type. *183
              cmn:CompanyPrefix [0...1] String [0/*] - O Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *184
Mandatory if cmn:PackagingItemCode is not present.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *185
              cmn:QuantityReported [1...1] Integer - - M Reported quantity of the released product. *186
          ie:SOM_ShipmentEventSpec [0...1] - - - O Option 13 for choice%2 group. Used for Serialized Operations Manager Shipment Event Message.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery.
            cmn:SalesDistributionType [0...1] String [0/*] SalesDistType O

Defines the nature of the product's movement and its purpose for application and regulatory reporting. It identifies whether the movement is a sale (indicating a change in ownership) or a transfer (physical movement without change in ownership). Note that simply setting this value does not trigger regulatory reporting; regulatory reporting is controlled by customer administrative configurations in the TraceLink application. The valid values are as follows:

  • INCOUNTRYSALE: Indicates a sale and distribution made within the same country.

  • EXPORTSALE: Represents a sale and distribution from one country to another.

  • INCOUNTRYTRANSFER: Denotes a warehouse transfer, including transactions with CMOs/CMOs or 3PL partners, made within the same country.

  • EXPORTTRANSFER: Specifies a warehouse transfer, including transactions with CMOs/CMOs or 3PL partners, made from one country to another.

  • INCOUNTRYRETURN: Refers to a return shipment made within the same country.

  • EXPORTRETURN: Describes a return shipment made from one country to another.

INCOUNTRYTRANSFER and EXPORTTRANSFER include intra-company warehouse transfers, transfers between Manufacturer (Brand Owner) and 3PL, transfers between Manufacturer (Brand Owner) and CMO/CPO, and transfers between CMO/CPO and the 3PL of the Manufacturer (Brand Owner).
            cmn:TransactionIdentifier [0...*] String [1/*] - O The transaction identifier associated with the picked serial numbers, for regulatory reporting purposes. At least one is required, and depending on country more than one transaction id may be required.
Country Requirements:
  • Argentina will provide Packing Slip Number.
  • China will provide Sales Order Number.
  • US will provide PO Number, ASN Number, and Invoice Number if available.
              @type [1...1] String [1/*] TransactionIdentifier C The transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:Serial [0...*] String [0/*] - O 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.
For China, this is the 20 digit China EDMC Code. 81591390000000005716.
              @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:ProcessingCode [1...1] String [1/*] - M The processing code assigned by the system to indicate success, failure, or warning. *187
          ie:ProcessingMessage [0...*] String [1/*] - O The processing message with detail on why the item in the item spec incurred a warning or failure. *188
      ie:FailedItem [0...1] - - - O This element contains one item spec with processing code and processing message for each item that failed to be updated. 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:
  • Option 1 within choice%3 is the Serialized Operations Manager Product Release Spec, used for Serialized Operations Manager Product Release message.
  • Option 2 within choice%3 is the Serialized Operations Manager Sales Shipment Spec, used for Serialized Operations Manager Sales Shipment message.
  • Option 3 within choice%3 is the Serialized Operations Manager Receipt Spec, used for a Serialized Operations Manager Shipment Receipt message.
  • Option 4 within choice%3 is the Serialized Operations Manager Void Shipment Spec, used for the Serialized Operations Manager Void Shipment message.
  • Option 5 within choice%3 is the Serialized Operations Manager Update Serial Number Status Spec, used for the Serialized Operations Manager Update Serial Number Status message.
  • Option 6 within choice%3 is the Serialized Operations Manager Take Sample Spec, used for the Serialized Operations Manager Take Product Sample message.
  • Option 7 within choice%3 is the Serialized Operations Manager Country Clearance Spec, used for the Serialized Operations Manager Country Clearance message.
  • Option 8 within choice%3 is the Serialized Operations Manager Aggregation Update Spec, used for the Serialized Operations Manager Aggregation Update message.
  • Option 9 within choice%3 is the Serialized Operations Manager Registration Spec, used for the Serialized Operations Manager Registration message.
  • Option 10 within choice%3 is the Serialized Operations Manager Market Release Spec, used for the Serialized Operations Manager Market Release message.
  • Option 11 within choice%3 is the Serialized Operations Manager End of Batch Event Spec, used for the Serialized Operations Manager end-of-batch event message sent outbound to downstream systems.
  • Option 12 within choice%3 is the Serialized Operations Manager Product Release Event Spec, used for the Serialized Operations Manager end-of-batch event message sent outbound to downstream systems.
  • Option 13 within choice%3 is the Serialized Operations Manager Shipment Event Spec, used for the Serialized Operations Manager end-of-batch event message sent outbound to downstream systems.
          ie:SOM_ProductReleaseSpec [0...1] - - - O Option 1 for choice%3 group. Used for Serialized Operations Manager Product Release message.
            cmn:LocationId [0...1] String [0/*] - O Specifies identifier of facility/warehouse to scope the Sales Shipment Status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Sales Shipment status update will be applied globally to all matching serial numbers in the system
            choice1 [1...1] - - - M Choice element. One, and only one, of the following item code data elements may be present:
  • cmn:CountryDrugCode
  • cmn:InternalMaterialCode
  • cmn:PackagingItemCode
            cmn:InternalMaterialCode [0...1] String [0/*] - O Option 1 of choice1. The internal material number configured in Product Master Data associated with the serialized items that will be updated with the Product Release status. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number.
            cmn:PackagingItemCode [0...1] String [0/*] - O Option 2 of choice1. The packaging level item code (e.g. GTIN-14, CN-ResCode) associated with the serialized items that will be updated with the Product Release status. Specifying a packaging item code will update all serial numbers that are linked to only the specified packaging item code and lot number.
The status update will be applied only to the serial numbers matching the specified packaging code and not related packaging codes (e.g. if a GTIN-14 for the Cases is specified, only the Case serial numbers will be updated and not the Eaches; if a GTIN-14 for the Eaches is specified, only the Each serial numbers will be updated and not the Case serial numbers).
              @type [0...1] String [0/*] PackagingItemCode M Packaging item code type is a GTIN-14 for all countries except for China.
Mandatory for China: CN-RESCODE.
            cmn:CountryDrugCode [0...1] String [1/*] - O Option 3 of choice1. The national drug code (e.g. NDC, Swissmedic, PZN) associated with the serialized items that will be updated with the Product Release status. Specifying a country drug code will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the country drug code and specified lot number.
              @type [0...1] String [0/*] CountryDrugCode O Country drug type identifying national drug code system.
            cmn:LotNumber [0...1] String [0/*] - O Batch or lot number for product.
            cmn:QualityControlEntityId [0...1] String [0/*] - O The business or location identifier for the entity responsible for quality control. *189
              @type [1...1] String [1/*] BusinessAndLocationId M The business or location identifier type for the entity responsible for quality control. *190
            cmn:TransactionIdentifier [0...*] String [0/*] - O The transaction identifier associated with the released product. *191
              @type [1...1] String [1/*] - M The transaction identifier type of the release product. Valid values: *192
  • CERTIFICATECONFORMITY
  • CIVILCIRCULATION
  • DECLARATIONCONFORMITY
  • STATECONFIRMATION
              @date [0...1] Date [0/*] - O The transaction identifier date attribute in YYYY-MM-DD format. *193
            cmn:EventDateTime [0...1] DateTime [0/*] - O Timestamp of the date/time of the product release with the UTC time zone indicator in XML YYYY-MM-DD format. *194
            cmn:ProductionQuantity [0...*] - - - O The production quantity group.
              choice1 [1...1] Choice - - M Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
              cmn:PackagingItemCode [0...1] String [0/*] - C Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *195
Mandatory if cmn:CompanyPrefix is not present.
                @type [0...1] String [0/*] PackagingItemCode M Packaging item code type. *196
              cmn:CompanyPrefix [0...1] String [0/*] - C Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *197
Mandatory if cmn:PackagingItemCode is not present.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *198
              cmn:QuantityReported [1...1] Integer - - M Reported quantity of the released product. *199
          ie:SOM_SalesShipmentSpec [0...1] - - - O Option 2 for choice%3 group. Used for Serialized Operations Manager Sales Shipment message.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery.
            cmn:SalesDistributionType [0...1] String [0/*] SalesDistType O This value will be referenced to advise the application of sale (i.e. change of ownership of the product) and transfer (i.e. no change of ownership of product, but physical movement of product) for application and regulatory reporting purposes. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink Network.
            cmn:TransactionIdentifier [0...*] String [1/*] - O The transaction identifier associated with the picked serial numbers, for regulatory reporting purposes. At least one is required, and depending on country more than one transaction id may be required.
Country Requirements:
  • Argentina will provide Packing Slip Number.
  • China will provide Sales Order Number.
  • US will provide PO Number, ASN Number, and Invoice Number if available.
              @type [1...1] String [1/*] TransactionIdentifier C The transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:Serial [0...*] String [0/*] - O 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.
For China, this is the 20 digit China EDMC Code. 81591390000000005716.
              @format [0...1] String [0/*] Format O The attribute identifies format of serial numbers.
              @packedStatus [0...1] String [0/*] PackedStatus O Packed status.
          ie:SOM_ReceiptSpec [0...1] - - - O Option 3 for choice%3 group. Used for Serialized Operations Manager Shipment Receipt message.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery.
            cmn:ReceiptDistributionType [0...1] String [0/*] ReceiptDistributionType O Type of Receipt Distribution.
            cmn:TransactionIdentifier [0...*] String [1/*] - O The transaction identifier associated with the picked serial numbers, for regulatory reporting purposes. At least one is required, and depending on country more than one transaction id may be required.
Country Requirements:
  • Argentina will provide Packing Slip Number.
  • China will provide Sales Order Number.
  • US will provide PO Number, ASN Number, and Invoice Number if available.
              @type [1...1] String [1/*] TransactionIdentifier C The transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:Serial [0...*] String [0/*] - O 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.
For China, this is the 20 digit China EDMC Code. 81591390000000005716.
              @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:SOM_VoidShipmentSpec [0...1] - - - O Option 4 for choice%3 group. Used for Serialized Operations Manager Void Shipment message. Contains information required to cancel a delivery or to inform that a delivery will be corrected.
            cmn:DeliveryLocation [0...1] String [0/*] - O Specifies identifier of facility/warehouse to scope the Sales Shipment Status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Sales Shipment status update will be applied globally to all matching serial numbers in the system. *200
              @type [1...1] String [1/*] Location C Location identifier type. *201
Mandatory if cmn:DeliveryLocation is populated.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery. Identifies the delivery document that will be voided or corrected. *202
            cmn:DeliveryDirection [1...1] String [1/*] - M Describes direction of delivery - whether the delivery was sent to or received by the partner. *203

Valid values

  • Sent
  • Received
            cmn:PartnerId [0...1] String [0/*] - C Partner ID for the delivery document. *204
Mandatory if cmn:DeliveryDirection = "received".
              @type [1...1] String [1/*] Location C Partner identifier type. *205
Mandatory if cmn:PartnerId is populated.
            cmn:TransactionDate [0...1] Date [1/*] - O Date of void shipment in partner's business system. *206
            cmn:OrderCancelled [0...1] Boolean [0/*] - O Replaces CorrectShipment. Tracks whether the order is cancelled rather than intent to correct, aligning better with future government reporting and ERP functionality. Default value is "false". Must be either "true" of "false" (lower case) if populated. *207
          ie:SOM_UpdateSNStatusSpec [0...1] - - - O Option 5 for choice%3 group. Use for Serialized Operations Manager update serial number status transaction message. Contains information required to update the status of one or more serial numbers. Also reports serial numbers that fail to update their status.
            cmn:SerialNumberStatus [1...1] String [1/*] SerialNumberStatus M The status of the serial number. *208
            cmn:ItemStatus [0...1] String [0/*] ItemStatus C The status of the item.
Mandatory when cmn:SerialNumberStatus equals "COMMISSIONED" or "REGISTERED". Do not populate if cmn:SerialNumberStatus equals any other value.
            cmn:UpdateSNStatusReasonCode [0...1] String [0/*] StatusReasonCode O Reason identifying why a serial number status is being updated. *209
            cmn:SerialNumberList [1...1] - - - O A list of one or more serial numbers that are not having their statuses updated.
              cmn:SerialNumber [1...*] String [1/*] - M Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. Format serial numbers for GTINs in AI (01) (21) format. Format serial numbers for SSCCs in AI (00) format. Express non-GS1 serial numbers (e.g. China) in native format. *210
          ie:SOM_TakeSampleSpec [0...1] String - - O Option 6 for choice%3 group. Contains processing information for Take Product Sample messages.
            cmn:SerialNumberList [1...1] String - - M The list of serial numbers having their statuses updated.
              cmn:SerialNumber [1...*] String [1/*] - M Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs. Non-GS1 serial numbers (e.g. China) are expressed in native format. *211
            cmn:TakeSampleReasonCode [0...1] String [0/*] TakeSampleReasonCode O Identifies the reason why a serial number status is updated. *212
            cmn:ReasonDescription [0...1] String [0/*] - O A text description of the reason for the status update. *213
            cmn:InspectionCountryCode [0...1] String [1/*] CountryCode O The country where the inspection is being performed using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *214
            cmn:SamplingPartyId [0...1] String [0/*] - O The business or location identifier for the entity performing the sampling. *215
              @type [1...1] String [1/*] BusinessAndLocationId M The business or location identifier type for the quality control entity identifier. *216
          ie:SOM_CountryClearanceSpec [0...1] - - - O Option 7 for choice%3 group. Contains processing information for Serialized Operations Manager Country Clearance messages.
            cmn:ClearanceType [0...1] String [0/*] ClearanceType O Identifies the clearance type. Valid values: *217
  • CUSTOMS – Customs declaration of goods that are being transferred between countries.
  • TRADE – Declaration of goods that are being transferred between countries that have a cooperative trade agreement.
            cmn:EventLocation [0...1] String [0/*] - O The business or location identifier for the entity where the declaration occurs. *218
            cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId O The business or location type for the entity where the declaration occurs. *219
            cmn:ImportFromCountry [0...1] String [0/*] CountryCode O The country the product is being imported from using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *220
            cmn:ImportToCountry [0...1] String [0/*] CountryCode O The country the product is being imported into using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *221
            cmn:ImportingPartyId [0...1] String [0/*] - O

Importing party identifier. *222
              @type [0...1] String [0/*] BusinessAndLocationId O Importing party identifier type. *223
            cmn:EventDateTime [0...1] DateTime [0/*] - O Timestamp of the date and time when the serial number is assigned (i.e. commissioned) to the product with the UTC timezone indicator in YYYY-MM-DDThh:mm:ss.sZ format. *224
            cmn:RegistrationDate [0...1] Date [0/*] - O Registration date in YYYY-MM-DD date format. *225
            cmn:CustomsAuthorityCode [0...1] String [0/*] - C Customs authority code. *226
Mandatory if cmn:ImportToCountry = RU.
            cmn:DeclarationReleaseNumber [0...1] String [0/*] - C Declaration release number for the product. *227
Mandatory if cmn:ImportToCountry = RU.
            cmn:ActionCode [0...1] String [0/*] ActionCode C The clearance action that is taken. *228
Mandatory if cmn:ImportToCountry = RU.
            cmn:ItemList [0...1] - - - O A list of loose items, with each item being a single product (e.g. sampled serial numbers).
              cmn:Items [1...*] - - - M Products that are being imported. One item is present for each unique product.
                cmn:NumberList [1...1] String [1/*] - M Contains the list of serial numbers of eaches.
                  cmn:Serial [1...*] String [1/*] - M The serial number or numbers that are being imported. *229
            cmn:HomogeneousContainersList [0...1] - - - O List of homogeneous containers. Each container represents one or more batches of the same product.
              cmn:HomogeneousContainer [1...*] - - - M Cases or pallets containing the same product.
                  cmn:NumberList [1...1] String [1/*] - M Contains the list of serial numbers of eaches.
                  cmn:Serial [1...*] String [1/*] - M Contains the serial number(s) that are imported. *230
            cmn:HeterogenousContainersList [0...1] - - - O List of heterogeneous containers. Each container is a case or pallet with different products inside.
              cmn:HeterogenousContainer [1...*] - - - M Case or pallet containing a mix of different products.
                cmn:Serial [1...1] String - - M Contains the serial number or numbers that are being imported. *231
                cmn:ContainerContents [1...*] String - - M Contents of heterogeneous containers.
                  cmn:PackagingItemCode [1...1] String - - M The packaging level item code (e.g. GTIN-14, CN-RESCODE) associated with the serialized items that are imported.
                    @type [1...1] String - PackagingItemCode M The product code type for the packaging item code.
                  cmn:LotNumber [1...1] String - - M The lot number associated with the updated serial numbers.
          ie:SOM_AggregationUpdateSpec [0...1] - - - O Contains processing information for Serialized Operations Manager Aggregation Update messages.
            choice%1 [1...*] - - - M Looping choice element.
            ie:Aggregation [0...*] String - - O Aggregation group header for serial numbers being aggregated into a parent container.
              cmn:EventLocation [0...1] String [0/*] - O Business or location identifier for the entity aggregating the product. *232
              cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId O Business or location type for the entity aggregating the product. *233
              cmn:ParentSerial [0...1] String [0/*] - O Parent serial number for aggregation expressed in GS1 Application Identifier format, without parentheses, for the AI keys. AI(01)AI(21) formatted serial numbers for GTINs or AI(00) formatted serial number for SSCCs, without parentheses. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format. *234
                @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                @format [0...1] String [0/*] Format O Identifies the serial number format.
                @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
              cmn:NumberList [1...1] - - - M List of serial numbers for the items packed within the container serial number.
                cmn:Serial [1...*] String [1/*] - M Serial number 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. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format. *235
                  @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                  @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                  @format [0...1] String [0/*] Format O Identifies the serial number format.
                  @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
            ie:Disaggregation [0...*] - - - O Disaggregation group header for serial numbers being disaggregated from a parent container.
              cmn:EventLocation [0...1] String [0/*] - O Business or location identifier for the entity disaggregating the product. *236
              cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId O Business or location type for the entity disaggregating the product. *237
              cmn:ParentSerial [0...1] String [0/*] - O Parent serial number for aggregation expressed in GS1 Application Identifier format, without parentheses, for the AI keys. AI(01)AI(21) formatted serial numbers for GTINs or AI(00) formatted serial number for SSCCs, without parentheses. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format. *238
                @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                @format [0...1] String [0/*] Format O Identifies the serial number format.
                @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
              cmn:NumberList [1...1] - - - M List of serial numbers being disaggregated from the parent container. *239
                cmn:Serial [1...*] String [1/*] - M Serial number 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. Express non-GS1 serial numbers (e.g. CN-EDMC) in native format.
                  @companyPrefix [0...1] String [0/*] - O The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
                  @filterValue [0...1] String [0/*] - O The filter value used in GTIN-14 and SSCC serial numbers.
                  @format [0...1] String [0/*] Format O Identifies the serial number format.
                  @packedStatus [0...1] String [0/*] PackedStatus O The packed status of the item or container.
          ie:SOM_RegistrationSpec [0...1] - - - O Registration group header for registering serial numbers.
            cmn:EventLocation [0...1] String [0/*] - O The business or location identifier for the entity where the declaration occurs. *240
              @type [0...1] String [1/*] BusinessAndLocationId O Business or location identifier type. *241
            cmn:ItemCode [0...1] String [1/*] - O Packaging level item code. *242
              @type [1...1] String [0/*] PackagingItemCode C Packaging item code type *243
Mandatory if cmn:ItemCode is present.
            cmn:LotNumber [0...1] String [0/*] - C

Lot Number associated with the serial number at time of registration. *244

Mandatory if Serial | @format = AI(01)+AI(21)
            cmn:ExpirationDate [0...1] Date [0/*] - C

Expiration date associated with serial number at time of registration in xsd:date YYYY-MM-DD format. *245

Mandatory if Serial | @format = AI(01)+AI(21)
            cmn:NumberList [1...1] String [1/*] - M List of one or more serial numbers to be registered.
              cmn:Serial [1...*] String [1/*] - M Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. Format serial numbers for GTINs in AI (01) (21) format. Format serial numbers for SSCCs in AI (00) format. Express non-GS1 serial numbers (e.g. China) in native format. *246
                @companyPrefix [0...1] String [0/*] - O Identifies the company prefix assigned by GS1 for the registered product. *247
                @filterValue [0...1] String [0/*] - O Filter value associated with the serial number. *248
                @format [1...1] String [1/*] Format O Identifies the serial number format. *249
          ie:SOM_MarketReleaseSpec [0...1] - - - O Contains processing information for Serialized Operations Manager Market Release messages.
            cmn:EventLocation [0...1] String [0/*] - O Business or location identifier for the facility or warehouse scoping the Market Release status update for the serial numbers matching the specified item code and lot number. *250

If the location is omitted, the Market Release status update is applied globally to all matching serial numbers in TraceLink.
            cmn:EventLocationType [0...1] String [0/*] BusinessAndLocationId C Business or location type for the entity scoping the Market Release status. *251
Mandatory if cmn:EventLocation is present.
            choice%1 [1...1] - - - M

One and only one of the following item code data elements may be present at a time:

  • cmn:InternalMaterialCode
  • cmn:PackagingItemCode
  • cmn:CountryDrugCode
            cmn:InternalMaterialCode [0...1] String [0/*] - C Updates the status of the serialized items with the associated internal material code to now be Product Release. *252

Specifying an internal material number updates all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and the specified lot number.

Mandatory if both cmn:PackagingItemCode and cmn:CountryDrugCode are empty or null.
            cmn:PackagingItemCode [0...1] String [0/*] - C Updates the status of the serialized items with the associated packaging level item code to now be Product Release. *253

Specifying a packaging item code updates all serial numbers that are linked to only the specified packaging item code and lot number.

The status update is applied only to the serial numbers matching the specific packaging code and not related packaging codes (e.g. if a GTIN-14 for the cases are specified, only the case serial numbers are updated and not the eaches).

Mandatory if both cmn:InternalMaterialCode and cmn:CountryDrugCode are empty or null.
              @type [1...1] String [1/*] PackagingItemCode M Packaging item code type. *254
            cmn:CountryDrugCode [0...1] String [0/*] - C Updates the status of the serialized items with the associated national drug code to now be Product Release. *255

Specifying a country drug code updates all serial numbers at all packaging levels that are linked to the country drug code and the specified lot number.

Mandatory if both cmn:InternalMaterialCode and cmn:PackagingItemCode are empty or null.
              @type [1...1] String [1/*] CountryDrugCode M The country drug code type. *256
            cmn:LotNumber [1...1] String [0/*] - M The lot number associated with cmn:InternalMaterialCode, cmn:PackagingItemCode, or cmn:CountryDrugCode used to identify the serial numbers to be updated. *257
            cmn:FullLot [1...1] Boolean - - M Flags that the processing report is for a full or partial lot.

Valid vaues:

  • true – full lot is processed
  • false – partial lot is processed
            cmn:TransactionIdentifier [0...*] String [0/*] - O The transaction identifier associated with the released product. This may be a certificate or declaration of conformity. *258
              @type [1...1] String [1/*] - M The transaction identifier type for the market release.

Valid values: *259

  • CIVILCIRCULATION – Number of permission from a government agency for introduction of medicine into circulation. Used for immunobiological medicine only. Only valid for Product Release (XML) and Market Release (XML) messages.
  • STATECONFIRMATION – Number of document confirming the medicine compliance with state registration requirements.
              @date [0...1] Date [0/*] - O The transaction identifier date attribute. *260
            cmn:EventDateTime [0...1] DateTime [0/*] - O The date and time of the product release with the UTC time zone indicator in YYYY-MM-DDThh:mm:ss.ssZ format. *261
            cmn:MarketCountryCode [1...1] String [1/*] CountryCode M The 2 character ISO code for the market country. *262
            cmn:ProductionQuantity [0...*] - - - O Looping production quantity group.
              choice%1 [1...1] - - - M Either cmn:PackagingItemCode or cmn:CompanyPrefix must be present.
              cmn:PackagingItemCode [0...1] String [0/*] - C Identifies the product using the packaging level item code configured in Product Master Data. *263
Mandatory if cmn:CompanyPrefix is empty or null.
                @type [0...1] String [0/*] PackagingItemCode M Packaging item code type.

Valid values: *264

  • CN-RESCODE
  • GTIN-14
              cmn:CompanyPrefix [0...1] String [0/*] - C The GS1 company prefix for the released product. *265
Mandatory if cmn:PackagingItemCode is empty or null.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *266
              cmn:QuantityReported [1...1] Integer - - M Quantity reported for the released product. *267
          ie:SOM_EndOfBatchEventSpec [0...1] - - - O Option 11 for choice%3 group. Contains processing information for Serialized Operations Manager Market End of Batch Event OB message.
            choice1 [1...1] Choice - - M Choice element. If the value for choice%3 is SOM end of batch. One, and only one, of the following item code data elements may be present:
  • cmn:InternalMaterialCode
  • cmn:CountryDrugCode
            cmn:InternalMaterialCode [0...1] String [1/*] - O Option 1 of choice1. The internal material number configured in Product Master Data associated with the serialized items that will be updated with the Product Release status. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number.
            cmn:CountryDrugCode [0...1] String [0/*] - O Option 2 of choice1. The national drug code (e.g. NDC, Swissmedic, PZN) associated with the serialized items that will be updated with the Product Release status. Specifying a country drug code will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the country drug code and specified lot number.
              @type [0...1] String [0/*] CountryDrugCode C Country drug type identifying national drug code system.
            cmn:LotNumber [1...1] String [0/*] - M Batch or lot number for product.
            cmn:ProductionQuantity [1...*] - - - M The production quantity group. Minimum of 1 entry required, for the each packaging level. All other packaging levels are optional.
              choice1 [1...1] Choice - - M Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
              cmn:PackagingItemCode [0...1] String [0/*] - O Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *268
Mandatory if cmn:CompanyPrefix is not present.
                @type [1...1] String [1/*] PackagingItemCode C Packaging item code type is GTIN-14.
              cmn:CompanyPrefix [0...1] String [0/*] - 0 Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *269
Mandatory if cmn:PackagingItemCode is not present.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *270
              cmn:QuantityReported [1...1] Integer - - M Reported quantity of the released product.
              cmn:QuantityCommissioned [1...1] Integer - - M The total number of serial numbers assigned and commissioned at a specific packaging location for the reported packaging level in the TraceLink system. It is required field, and the system will generate an error if this value is not provided.
              cmn:BatchYieldVerifield [1...1] Boolean - - M Indicates whether batch verification was performed. This field can display a successful outcome even if no batch yield verification was conducted. Valid values are: true: Verification was performed. false: Verification was not performed.
              cmn:MaxBatchSize [0...1] Integer - - O Quantity of maximum batch size.
              cmn:AcceptableYield [0...1] Integer - - C Indicates the quantity of acceptable serial numbers yielded. This field is required if BatchYieldVerified is set to true. An error will be generated if BatchYieldVerified is true and this field is not populated.
                @acceptableYieldPercentage [1...1] Decimal [1/*] - C Percentage value of the acceptable yield field.
              cmn:MinimumYield [0...1] Integer - - C Indicates the quantity of serial numbers reported at the packaging location for the specified packaging level. This field is required if BatchYieldVerified is true. An error will be generated if BatchYieldVerified is true and MinimumYield is not populated.
                @minimumYieldPercentage [1...1] Decimal [1/*] - C Percentage value of the minimum yield field.
          ie:SOM_ProductReleaseEventSpec [0...1] - - - O Option 12 for choice%3 group. Used for Serialized Operations Manager Product Release.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            choice1 [1...1] Choice [0/*] - M Required, if the value for choice%1 is SOM product release. Choice element of either cmn:InternalMaterialCode or cmn:PackagingItemCode or cmn:CountryDrugCode.
            cmn:InternalMaterialCode [0...1] String - - O Option 1 of choice1. The internal material number configured in Product Master Data associated with the serialized items that will be updated with the Product Release status. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number.
            cmn:PackagingItemCode [0...1] String [0/*] - O Option 2 of choice1. The packaging level item code (e.g. GTIN-14, CN-ResCode) associated with the serialized items that will be updated with the Product Release status. Specifying a packaging item code will update all serial numbers that are linked to only the specified packaging item code and lot number. *271
The status update will be applied only to the serial numbers matching the specified packaging code and not related packaging codes (e.g. if a GTIN-14 for the Cases is specified, only the Case serial numbers will be updated and not the Eaches; if a GTIN-14 for the Eaches is specified, only the Each serial numbers will be updated and not the Case serial numbers).
              @type [0...1] String [0/*] PackagingItemCode M Packaging item code type is a GTIN-14 for all countries except China.
For China, this is CN-RESCODE.
            cmn:CountryDrugCode [0...1] String [1/*] - O Option 3 of choice1. The national drug code (e.g. NDC, Swissmedic, PZN) associated with the serialized items that will be updated with the Product Release status. Specifying a country drug code will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the country drug code and specified lot number. *272
              @type [0...1] String [0/*] CountryDrugCode O Country drug type identifying national drug code system.
            cmn:LotNumber [0...1] String [0/*] - O Bach or lot number for product.
            cmn:QualityControlEntityId [0...1] String [0/*] - O The business or location identifier for the entity responsible for quality control. *273
              @type [1...1] String [1/*] BusinessAndLocationId C The business or location identifier type for the entity responsible for quality control. *274
            cmn:TransactionIdentifier [0...1] String [0/*] - O The transaction identifier associated with the released product. *275
              @type [1...1] String [1/*] TransactionIdentifier C The transaction identifier type of the release product. Valid values: *276
  • CERTIFICATECONFORMITY
  • DECLARATIONCONFORMITY
              @date [0...1] Date - - O The transaction identifier date attribute in YYYY-MM-DD format. *277
Added to support Russia compliance.
            cmn:EventDateTime [0...1] DateTime [0/*] - O Timestamp of the date/time of the product release with the UTC time zone indicator in XML YYYY-MM-DD format. *278
            cmn:ProductionQuantity [0...*] - - - O The production quantity group.
              choice1 [1...1] Choice - - M Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
              cmn:PackagingItemCode [0...1] String [0/*] - O Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *279
Mandatory if cmn:CompanyPrefix is not present.
                @type [0...1] String [0/*] PackagingItemCode C Packaging item code type. *280
              cmn:CompanyPrefix [0...1] String [0/*] - O Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *281
Mandatory if cmn:PackagingItemCode is not present.
              cmn:PackagingLevel [1...1] String [1/*] PackagingLevel M The packaging level of the commissioned item. *282
              cmn:QuantityReported [1...1] Integer - - M Reported quantity of the released product. *283
          ie:SOM_ShipmentEventSpec [0...1] - - - O Option 13 for choice%3 group. Used for Serialized Operations Manager Shipment Event Message.
            cmn:LocationId [0...1] String [0/*] - O Identifies facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system.
            cmn:DeliveryNumber [1...1] String [1/*] - M Delivery number that links the order information to the serialized pick information for this customer delivery.
            cmn:SalesDistributionType [0...1] String [0/*] SalesDistType O

Defines the nature of the product's movement and its purpose for application and regulatory reporting. It identifies whether the movement is a sale (indicating a change in ownership) or a transfer (physical movement without change in ownership). Note that simply setting this value does not trigger regulatory reporting; regulatory reporting is controlled by customer administrative configurations in the TraceLink application. The valid values are as follows:

  • INCOUNTRYSALE: Indicates a sale and distribution made within the same country.

  • EXPORTSALE: Represents a sale and distribution from one country to another.

  • INCOUNTRYTRANSFER: Denotes a warehouse transfer, including transactions with CMOs/CMOs or 3PL partners, made within the same country.

  • EXPORTTRANSFER: Specifies a warehouse transfer, including transactions with CMOs/CMOs or 3PL partners, made from one country to another.

  • INCOUNTRYRETURN: Refers to a return shipment made within the same country.

  • EXPORTRETURN: Describes a return shipment made from one country to another.

INCOUNTRYTRANSFER and EXPORTTRANSFER include intra-company warehouse transfers, transfers between Manufacturer (Brand Owner) and 3PL, transfers between Manufacturer (Brand Owner) and CMO/CPO, and transfers between CMO/CPO and the 3PL of the Manufacturer (Brand Owner).
            cmn:TransactionIdentifier [0...*] String [1/*] - O The transaction identifier associated with the picked serial numbers, for regulatory reporting purposes. At least one is required, and depending on country more than one transaction id may be required.
Country Requirements:
  • Argentina will provide Packing Slip Number.
  • China will provide Sales Order Number.
  • US will provide PO Number, ASN Number, and Invoice Number if available.
              @type [1...1] String [1/*] TransactionIdentifierProdRelease C The transaction identifier type.
Mandatory if cmn:TransactionIdentifier is populated.
            cmn:Serial [0...*] String [0/*] - O 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.
For China, this is the 20 digit China EDMC Code. 81591390000000005716.
              @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: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.