ESM Commission Guidelines (EPCIS v1.0)

See How To Use this Guide before interpreting the guidelines below.

Message Type: SOM_ESM_COMMISSION

Info Exchange Display Name: ESM Commission

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.
NTINs must follow the GS1 Guidance standards as found on the GS1 website.
  • Ex: urn:epc:id:sgtin:415001647778.0.100000000022
  • Format: urn:epc:id:sgtin:[company prefix].[indicator digit][item ref].[serial number]
Information regarding NTINs cannot be exchanged with trade partners unless the specific format outlined above is followed. If using an NTIN without following this format, an outbound error occurs when passing data from TraceLink to a trade partner.
Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1…1]
[–]		 - Required. EPCIS message root element.
  @schemaVersion [1…1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. *1
  @creationDate [1…1]
[1/*]		 DateTime Required. Date the message was created in YYYY-MM-DDTHH:MM:SS:mmZ format. *2
  EPCISHeader [1…1]
[–]		 - Required. The XML file control header.
    sbdh:StandardBusinessDocumentHeader [1…1]
[–]		 - Required. Business header information including EPCIS Header Version, Sender, and Receiver information, along with the document identification.
      sbdh:HeaderVersion [1…1]
[0/*]		 String Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0. *3
      sbdh:Sender [1...*]
[–]		 - Required. A unique identification key for the Sender party of the message, representing the organization that created the standard business document. The Sender element must be used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *4
          @Authority [1…1]
[1/*]		 String Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *5
        sbdh:ContactInformation [0…*]
[–]		 - Not used.
      sbdh:Receiver [1...*]
[–]		 - Required. Indicates a unique identification key for the direct Receiver party of the message, representing the organization that receives the standard business document. The Receiver element is used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type.
          @Authority [1…1]
[1/*]		 String Required. Defines the receiver identifier type as a GLN. The Authority value is set to GLN for GS1 XML messages.
        sbdh:ContactInformation [0…*]
[–]		 - Not used.
      sbdh:DocumentIdentification [1…1]
[–]		 - Required. Contains the identification group for the message.
        sbdh:Standard [1…1]
[0/*]		 String Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal. *6
        sbdh:TypeVersion [1…1]
[0/*]		 String Required. Reflects the version of the document included. This is the complete version of the document itself and is different from the HeaderVersion as these are hard-coded values. The TypeVersion is set to 1.0. *7
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String Required. Reference information that uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier confirms this document as being distinct from others. *8
        sbdh:Type [1…1]
[0/*]		 String Required. The document type. The Type value is set to Events for a commission event. *9
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z. *10
  EPCISBody [1…1]
[–]		 - Required. Contains all of the EPCIS events for the commission message.
    EventList [1…1
][–]		 - Required. The EventList must include one or more ObjectEvent elements for a commissioning event.
      ObjectEvent [1...*]
[–]		 - Required. The message type. Indicates a CommissioningEvent when bizStep = urn:epcglobal:cbv:bizstep:commissioning and action = ADD.
        eventTime [1…1]
[1/*]		 DateTime Required. The time stamp of the date/time when the event occurred in YYYY-MM-DDTHH:MM:SS.mm or YYYY-MM-DDTHH:MM:SS.mmm format. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. The system expects the Z to be appendedif it is not included; however, the system assumes that the time is GMT and therefore appends the Z. *11
        recordTime [0…1]
[0/*]		 DateTime Not used.
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. The time zone offset in the place where the event occurred, consistent with what choice was made for eventTime. A time offset is an amount of time subtracted from or added to UTC (Coordinated Universal Time) to get the current civil time, whether it is standard time or Daylight saving time. Per Section 7.2.8 of [EPCIS1.0.1]. *12
        baseExtension [0…1]
[–]		 - Not used.
        epcList [1…1]
[–]		 - Required. The EPCs of each item, case, and/or pallet commissioned.
          epc [1...*]
[1/*]		 String Required. The EPC identifier in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *13
        action [1…1]
[0/*]		 String Required. The action type of the event. For a commission event, this value must equal ADD. *14
        bizStep [1…1]
[0/*]		 AnyURI Required. Business step taken in the event. For a commission event, this value must equal urn:epcglobal:cbv:bizstep:commissioning. *15
        disposition [1…1]
[0/*]		 AnyURI Required. Indicates the status of the transaction. The bizStep and disposition fields define the message event and are grouped together under the GS1 EPCIS guidelines. The disposition value must equal urn:epcglobal:cbv:disp:active. *16
        readPoint [0…1]
[–]		 - Location where the event occurred, that is, the warehouse GLN location ID and storage location (e.g. shelf, bin) in URN format.
          id [1…1]
[0/*]		 AnyURI Required. The SGLN EPC of the location from where the event occurred. This may be a site-level SGLN or a finer-grain location identifier. *17
          extension [0…1]
[–]		 - Not used - GS1 Reserved.
        bizLocation [1…1]
[–]		 - Required. The SGLN EPC of the location from where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier.
          id [1…1]
[1/*]		 AnyURI Required. The SGLN EPC of the location from where the event occurred. *18
          extension [0…1]
[–]		 - Not used - GS1 Reserved.
        bizTransactionList [0…1]
[–]		 - Not used.
        extension [0…1]
[–]		 - Not used - GS1 Reserved.
        tl:locationId [0…1]
[0/*]		 String Location. *19
          @type [0…1]
[0/*]		 String Required. Identifies the location types. *20

See the LocationIdType enumeration list for valid values.
        tl:commissionEventExtensions [0…1]
[–]		 - Required. Contains the extensions used for the commission ObjectEvent.
          tl:filterValue [0…1]
[–]		 Int Not used.
          tl:packagingLevel [0…1]
[0/*]		 - Conditionally required for non-SSCC encodings (optional for SSCC-commissioned serial numbers). The packaging level of the commissioned item. *21

See the ESM Commission Overview for complete description of use cases. Do not send an empty tag pair as this triggers a validation error.

See the PackagingLevel enumeration list for valid values.
          tl:epcAttributes [0…*]
[–]		 - Supports optional inclusion of human readable barcode content that is associated with each epc number in a commission event. This information is included only if provided in the original commission event.
            @epc [1…1]
[1/*]		 String Required. The identifier of the child items in the parent container in EPC Pure Identity URI format as specified in Section 6 of (TDS1.5). See EPC Pure Identifier Format Examples. *22
            tl:barcodeContent [1…1]
[1/*]		 String Required. Reflects the human readable barcode contents encoded in the 2D barcode with parenthesis for the AI keys. *23
          tl:plantLocationId [0…1]
[0/*]		 String Identifier of plant where products were commissioned.
          tl:productionLineId [0…1]
[1/*]		 String Conditionally required for China. Identifier of the production line where products were commissioned. *24
          tl:lineManagerName [0…1]
[0/*]		 String Conditionally required for China. Name of the person responsible as the production line manager for the commissioned products. *25
          tl:companyPrefix [0…1]
[0/*]		 String Not used.
          tl:itemDetail [0…1]
[–]		 - The product attributes associated with the commissioned serial number(s).
            tl:internalMaterialCode [0…1]
[0/*]		 String Internal material number for the product in the pharmaceutical manufacturer's internal systems (e.g. ERP). *26
The message may include either tl:internalMaterialCode, tl:countryDrugCode, or both, but all packaging levels must be consistent.
            tl:packagingItemCode [1…1]
[1/*]		 String Required. The product code for the commissioned item. *27
              @type [1…1]
[1/*]		 String

Required. ItemCode type with the provided enumerators.

See the ItemCode enumeration list for valid values.
            tl:countryDrugCode [0…1]
[1/*]		 String National drug code for the commissioned item. *28
The message may include either tl:internalMaterialCode, tl:countryDrugCode, or both, but all packaging levels must be consistent.
              @type [1…1]
[1/*]		 String

Required. Indicates the countryDrugCode with the provided enumerators (excluding IN_PRODUCT_CODE, which is not used for a commission message).

See the CountryDrugCode enumeration list for valid values.
            tl:lot [1…1]
[1/*]		 String Required. The lot or batch code for the serialized item. *29
            tl:expiry [1…1]
[10/10]		 Date Required. Expiration date for the serialized item, formatted in YYYY-MM-DD format. *30
            tl:manufacturingDate [0…1]
[0/10]		 Date Date of manufacture for the serialized item, formatted in YYYY-MM-DD format. *31
          tl:referenceDocuments [0…1]
[–]		 - Reference document identifier associated with the commissioning activity.
            tl:poNumber [0…1]
[0/*]		 String Conditionally required for transaction type PO. Purchase order number associated with the serial number indicated. *32
            tl:poLine [0…1]
[0/*]		 String Purchase order line number. *33
            tl:workOrderNumber [0…1]
[0/*]		 String Work order number associated with serial number use. *34
            tl:referenceIdentifier [0…1]
[0/*]		 String The reference identifier (such as any type of identifier) associated with serial number use. *35