Product Release Event Guidelines (EPCIS v1.2)
See How To Use this Guide before interpreting the guidelines below.
Message Type: SOM_PRODUCT_RELEASE_EVENT
Info Exchange Display Name: Product Release
- Ex: urn:epc:id:sgtin:415001647778.0.100000000022
- Format: urn:epc:id:sgtin:[company prefix].[indicator digit][item ref].[serial number]
| 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. Must equal 1.2.1 |
||||||||||
| @creationDate | 1…1 1/* |
DateTime | Required. Date the message was created.2 | ||||||||||
| EPCISHeader | 0…1 - |
- | Required. XML file control header
record. The following use cases are supported in this message:
|
||||||||||
| 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. The version number of the
SBDH standard used. The sbdh:HeaderVersion must equal 1.0.3 |
||||||||||
| sbdh:Sender | 1…* - |
- | Required. A unique identification key for the Sender party of the message, representing the organization which created the standard business document. The sbdh: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 SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:
See the MDPartyTypeAttributes enumeration list for valid values. |
||||||||||
| @Authority | 1…1 1/* |
String | Required. The Authority was previously expected to be set to GLN for GS1 XML messages. Update made in December 2016 changed this to take additional values.5See the MDPartyTypeEnums enumeration list for valid values. |
||||||||||
| sbdh:Receiver | 1…* - |
- | Required. A unique identification key for the direct Receiver party of the message, representing the organization which receives the standard business document. The sbdh:Receiver element must be used only once with GS1 XML messages. | ||||||||||
| sbdh:Identifier | 1…* - |
String | Required. The value of the sbdh:Identifier element may be a GLN, SGLN, or any other supported business party type.6 SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:
See the MDPartyTypeAttributes enumeration list for valid values. |
||||||||||
| @Authority | 1…1 1/* |
String | Required. The Authority was previously expected to be set to GLN for GS1 XML messages. Update made in December 2016 changed this to take additional values.7See the MDPartyTypeEnums enumeration list for valid values. |
||||||||||
| sbdh:DocumentIdentification | 1…1 - |
- |
Required. Contains the identification group for the message. |
||||||||||
| sbdh:Standard | 1…1 0/* |
String | Required. The name of the document
standard contained in the payload. The sbdh:Standard value must equal
EPCglobal.8 |
||||||||||
| sbdh:TypeVersion | 1…1 0/* |
String | Required. The version of the document
included in the payload of SBDH. This is the "complete" version of the
document itself and is different than the
sbdh:HeaderVersion. The sbdh:TypeVersion must equal 1.0.9 |
||||||||||
| sbdh:InstanceIdentifier | 1…1 1/* |
String | Required. Description which contains reference information which uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier identifies this document as being distinct from others.10 | ||||||||||
| sbdh:Type | 1…1 0/* |
String | Required. This element identifies the
type of the document. The sbdh:Type must equal Events.11 |
||||||||||
| sbdh:CreationDateAndTime | 1…1 0/* |
DateTime | Required. Date and time of the SBDH document creation.12 | ||||||||||
| extension | 0…1 - |
- | Header extension area with master data attributes. | ||||||||||
| EPCISMasterData | 0…1 - |
- | Master data extension header.
May contain product master data attributes for Commissioning event and/or location address information for Decommissioning and/or Destroy events. Optional. Valid values:
|
||||||||||
| VocabularyList | 1…1 - |
- | Required. Vocabulary list group master data elements. | ||||||||||
| Vocabulary | 0…* - |
- | Looping vocabulary element with discrete item master and/or party master data element groups. Vocabulary will occur only once for all item master entries present in message, if group is populated.
Group is optional. If it does not appear in master data header extension, no error will be thrown. |
||||||||||
| @type | 1…1 0/* |
String | Required. Vocabulary type identifying product master data elements. Product master data is defined by VocabularyElement | @id. Valid value:
|
||||||||||
| VocabularyElementList | 0…1 - |
- | List of vocabulary elements containing master data attributes for each unique product code. | ||||||||||
| VocabularyElement | 0…* - |
- | Looping vocabulary element identifying each unique SGTIN, NTIN, or China Product Code for product master data embedded in the epc serial number in the Commissioning and Transformation events.
SSCC codes not included in VocabularyElement product master data. |
||||||||||
| @id | 1…1 0/* |
String | Required. Identifies the product code for which master data is being sent in the VocabularyElement loop.14 VocabularyElement | @id = SGTIN, NTIN, or China Product Code with GS1-conformant urn or http prefix. These are the only values supported in this element. All other product identifier types will be sent as additional trade item types. SSCC codes are not identified in any part of the VocabularyElement group. Must match the product code embedded within the serial number in the epc code in one or more commissioning events. SGTIN (strongly recommended for GS1-conformance)
|
||||||||||
| attribute(1) | 1…1 1/* |
String | Conditionally required if item master data attributes are sent in VocabularyElement. Instance 1 of attribute for packaging level value identified by @id attribute.15 See the PackagingLevel enumeration list for valid values. |
||||||||||
| @id | 1…1 0/* |
String | Required. Attribute identifying packaging level. Valid value: See the MDAttributes enumeration list for valid values. |
||||||||||
| attribute(2) | 0…1 0/* |
String | Instance 2 of attribute for internal material number in Pharmaceutical Manufacturer's internal system identified by @id attribute. Identified by the value in the next attribute element in the current loop = MANUFACTURER_PART_NUMBER.17 |
||||||||||
| @id | 1…1 0/* |
String | Required. Id attribute identifying internal material code. Valid value:
|
||||||||||
| attribute(3) | 0…1 0/* |
String | Conditionally required if the previous name/value pair attribute(2) | @id is populated. Instance 3 of attribute for internal material number identifier type for the product. Id attribute identifying internal material code. Valid value:
Sequence of fields for internal material number is:
|
||||||||||
| @id | 1…1 0/* |
String | Required. Id attribute identifying internal material code. Valid value:
|
||||||||||
| attribute(4) | 0…1 0/* |
String | Instance 4 of attribute for country drug code for all national drug code types, identified by the enum value in the next attribute element in the current loop and by the attribute @id value as an additional trade item.21 Country drug code type defined by value in next attribute element where @id = |
||||||||||
| @id | 1…1 0/* |
String | Required. Id attribute identifying internal material code. Valid value:
|
||||||||||
| attribute(5) | 0…1 0/* |
String | Conditionally required if the previous name/value pair attribute | @id is populated with the country drug code value. Instance 5 of attribute for Country drug code identifier type. Must follow attribute with country drug value. Id attribute identifying internal material code.23 Sequence of fields for country drug code is: GS1:
TraceLink:
The following qualifiers have been defined by GS1 as additional trade item types:
To identify these material number types, use attribute | @id string:
For all other country drug code types, use attribute | @id string:
See the CountryDrugCode enumeration list for valid values. |
||||||||||
| @id | 1…1 0/* |
String | Required. Id attribute identifying internal material code. Valid values:24
|
||||||||||
| EPCISBody | 1…1 - |
- | Required. Contains all of the EPCIS events for this message. | ||||||||||
| EventList | 1…1 - |
- | Required. The EventList
includes the following events:
|
||||||||||
| choice%1 | 1…* - |
- | Required. Only one of the following
choice options may be selected in any one loop on EPCISBody | EventList:
|
||||||||||
| ObjectEvent | 0…* - |
- | Choice 1 for EventList. Data
= ObjectEvent for the Commissioning Events. EventList = ObjectEvent Commissioning when all of the following is true:
|
||||||||||
| eventTime | 1…1 1/* |
DateTime | Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1] in XML datetime format YYYY-MM-DDTHH:MM:SS.mmZ.25 | ||||||||||
| recordTime | 0…1 0/* |
dateTime | Not used. | ||||||||||
| eventTimeZoneOffset | 1…1 1/* |
String | Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1].26 | ||||||||||
| 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:27 CN EDMC:
SGTIN:
SSCC:
|
||||||||||
| action | 1…1 0/* |
String | Required. The action value must equal ADD.28 |
||||||||||
| bizStep | 0…1 0/* |
AnyURI | Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:commissioning.29 |
||||||||||
| disposition | 0…1 0/* |
AnyURI | Required. The disposition value must equal urn:epcglobal:cbv:disp:active.30 |
||||||||||
| readPoint | 0…1 - |
- | The location where the commissioning event occurred.0.Optional for a commissioning event. |
||||||||||
| 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.31 See the MDPartyTypeAttributes enumeration list for valid values. |
||||||||||
| bizLocation | 1…1 - |
- |
Required. Mandatory for a commissioning event. |
||||||||||
| id | 1…1 1/* |
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.32 | ||||||||||
| extension | 0…1 - |
- | Main extension body for commission event. | ||||||||||
| ilmd | 0…1 - |
- | Instance lot master data specific to product being commissioned. | ||||||||||
| cbvmda:lotNumber | 0…1 0/* |
String | The lot or batch code for the serialized item in an alphanumeric string.33 | ||||||||||
| cbvmda:itemExpirationDate | 0…1 0/* |
Date | The expiration date for the serialized item, formatted in YYYY-MM-DD format.34 | ||||||||||
| tl:commissionEventExtensions | 0…1 - |
- | Extensions used for Commission ObjectEvent. | ||||||||||
| tl:filterValue | 0…1 - |
Integer |
tl:filterValue is used only if it is mandatory by a trade partner to convert SSCC to GS1 HEX or Tag URI format. See the FilterValue enumeration list for valid values. |
||||||||||
| tl:packagingLevel | 0…1 0/* |
String | The packaging level of the
commissioned item using the supported enumeration values.35 See the PackagingLevel enumeration list for valid values. |
||||||||||
| tl:epcAttributes | 0…* - |
- | Supports optional inclusion
of human readable barcode content associated with each epc number in a
commission event. |
||||||||||
| @epc | 1…1 1/* |
String | Required. The EPC serial number to
which the tl:barcodeContent is associated. The epc must be an EPC Pure Identity
URI as specified in Section 6 of [TDS1.5].36
|
||||||||||
| tl:barcodeContent | 1…1 1/* |
String | Required. The human readable barcode contents encoded in the 2D barcode WITH parentheses for the AI keys.37 | ||||||||||
| tl:plantLocationId | 0…1 0/* |
String | Identifier of plant where products were commissioned.38 | ||||||||||
| tl:productionLineId | 0…1 1/* |
String |
|
||||||||||
| tl:lineManagerName | 0…1 0/* |
String |
|
||||||||||
| tl:internalMaterialCode | 0…1 0/* |
String | Internal material number for the product in the
Pharmaceutical Manufacturer's internal systems (e.g. ERP).41 |
||||||||||
| tl:packagingItemCode | 1…1 1/* |
String | The product code for the commissioned item (e.g. GTIN-14).42 | ||||||||||
| @type | 1…1 1/* |
String | Conditionally required if tl:packagingItemCode is populated. The product code type. Valid values:43
See the ItemCode enumeration list for valid values. |
||||||||||
| tl:countryDrugCode | 0…1 0/* |
String | The national drug code for
the commissioned item (e.g. NDC number for US products).44 |
||||||||||
| @type | 0…1 0/* |
String | The national drug code type
using the supported enumeration values and any formatting instructions
provided.45 See the CountryDrugCode enumeration list for valid values. |
||||||||||
| tl:manufacturingDate | 0…1 0/10 |
Date | The date of manufacture for the serialized item, formatted in YYYY-MM-DD format.46 | ||||||||||
| tl:extensionField | 0…* - |
- | Customer extension point to
pass in 1 or more name/value pairs containing additional data attributes not
already supported in this message. If this element group is populated
both tl:fieldName and tl:fieldValue must be populated.
These extensions are not stored by TraceLink and are used only for outbound mapping purposes when there is a requirement to provide additional data to a trade partner for this message, such as when a CMO is required to provide additional data fields to the brand owner. In this case, TraceLink would have a custom map for that trade partner to map these fields outbound. Different trade partners may have different field requirements and may therefore require that tl:extensionField be populated differently per trade partner. |
||||||||||
| tl:fieldName | 1…1 1/* |
String | Conditionally required if the tl:extensionField element group is populated. Populate with the field name provided by the trade partner that will be receiving the mapped outbound message. The field name must match the field name provided by the trade partner exactly, including case, so it is properly detected in the outbound mapping. | ||||||||||
| tl:fieldValue | 1…1 1/* |
String | Conditionally required if the tl:extensionField element group is populated. Populate with the field value content that corresponds to tl:fieldName. | ||||||||||
| ObjectEvent | 0…* - |
- | ObjectEvent describing
decommissioning events.
EventList = ObjectEvent Decommissioning when all of the following is true:
|
||||||||||
| eventTime | 1…1 1/* |
DateTime | Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1] in XML datetime format YYYY-MM-DDTHH:MM:SS.mmZ.47 | ||||||||||
| eventTimeZoneOffset | 1…1 1/* |
String | Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1].48 | ||||||||||
| epcList | 1…1 - |
- | Required. The EPCs of each item, case, and/or pallet decommissioned. | ||||||||||
| epc | 1…* 1/* |
String | Required. The EPC identifier in EPC Pure Identity URI format:49 CN EDMC:
SGTIN:
SSCC:
|
||||||||||
| action | 1…1 0/* |
String | Required. The action value must equal DELETE.50 |
||||||||||
| bizStep | 0…1 0/* |
AnyURI | Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:decommissioning.51 |
||||||||||
| disposition | 0…1 0/* |
AnyURI | Required. The disposition value must equal urn:epcglobal:cbv:disp:inactive.52 |
||||||||||
| readPoint | 1…1 - |
- | Required. Location where event occurred. Defined with GS1-conformant party identifier types with full urn or http prefix. SGLN is strongly preferred but other party types supported as well. Links to location party address data if present in VocabularyElement | @id. If does not link to location identifier in VocabularyElement | @id, readPoint used for master data lookup. | ||||||||||
| id | 1…1 0/* |
AnyURI | Required. This location identifier links to the VocabularyElement | @id if the location address info is populated in the EPCISMasterData header extension. If the location address is not present in VocabularyElement, the TraceLink system uses this identifier for master data lookup.53 See the MDPartyTypeAttributes enumeration list for valid values. |
||||||||||
| bizLocation | 1…1 - |
- | The location where the event occurred. | ||||||||||
| id | 1…1 1/* |
AnyURI | The SGLN EPC of the location of where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier. | ||||||||||
| bizTransactionList | 0…1 - |
- | Conditionally required if at least one Target Market in Product Master Data = RU. Business transaction list group. |
||||||||||
| bizTransaction | 1…* 0/* |
AnyURI | Conditionally required if at least one Target Market in Product Master Data = RU. The transaction identifier associated with the released product.54 |
||||||||||
| @type | 1…1 1/* |
String |
Required. The transaction identifier type. Valid values:
RU , one instance of bizTransaction | @type with a value of http://epcis.tracelink.com/hc/btt/removal must be present. |
||||||||||
| @date | 0…1 0/* |
Date | Conditionally required if at least one Target Market in Product Master Data = RU. Transaction identifier date attribute in XML YYYY-MM-DD format.55 |
||||||||||
| tl:locationId | 0…1 - |
String | Serialized Operations Manager External Partner Location identifier. Type of identifier defined by @type enum below.56 When transactions are submitted by an external Serialized Operations Manager Partner, the system uses the subscriber company integration user to perform the action and log this in the audit trail so that all transactions executed by the external Serialized Operations Manager Partner are attributed to that company. |
||||||||||
| @type | 1…1 1/* |
String | Conditionally required if locationId is populated. Attribute identifies the location types. See the LocationIdType enumeration list for valid values.57 | ||||||||||
| tl:decommissionEventExtensions | 0…1 - |
- | Extensions used for ObjectEvent Decommissioning. | ||||||||||
| tl:transactionDate | 0…1 0/* |
Date | Date associated with the business transaction document in bizTransactionList in XML date format YYYY-MM-DD. This date may or may not be the same as the eventTime.58 | ||||||||||
| tl:disaggregateFromParent | 0…1 - |
Boolean | When set to true,
instructs back end to disaggregate a serial number from its parent container
(if it is aggregated) when setting the PackagingSerialNumberStatus of the
serial number to DECOMMISSIONED or DESTROYED.59If not set, or set to |
||||||||||
| tl:marketCountryCode | 0…1 0/2 |
String | Market country code.60 | ||||||||||
| tl:businessPartyInfo | 0…1 - |
- | The address of the authorizing party for the decommissioning event. The readPoint contains the location. | ||||||||||
| tl:businessId | 0…* 0/* |
String | The identifier associated with the authorizing party. | ||||||||||
| @type | 0…1 0/* |
String | The type of the BusinessId identifier. | ||||||||||
| tl:businessClassification | 0…1 0/* |
String | The classification of the business.
|
||||||||||
| tl:BusinessPartyDetail | 0…1 - |
- | Business name and address of the authorizing business entity. | ||||||||||
| tl:businessName | 1…1 0/* |
String | Required. Business name of the entity that is authorizing the decommission of the serial numbers. | ||||||||||
| tl:street1 | 1…1 0/* |
String | Required. First line of the address for the company indicated in tl:businessName. | ||||||||||
| tl:street2 | 0…1 0/* |
String | Second line of the address for the company indicated in tl:businessName. | ||||||||||
| tl:city | 1…1 0/* |
String | Required. City for the company indicated in tl:businessName. | ||||||||||
| tl:village | 0…1 0/* |
String | Name of the village in which the company is located. | ||||||||||
| tl:houseNumber | 0…1 0/* |
String | Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in tl:street1. | ||||||||||
| tl:township | 0…1 0/* |
String | Name of the township in which the company is located. | ||||||||||
| tl:district | 0…1 0/* |
String |
|
||||||||||
| tl:stateOrRegion | 1…1 0/* |
String | Required. The state, province, or region of the business entity indicated in the businessName field, using the standard two-letter abbreviation specified in the ISO 3166-2:1998 country subdivision code. | ||||||||||
| tl:postalCode | 0…1 1/* |
String | Postal code for the company indicated in tl:businessName. | ||||||||||
| tl:country | 1…1 0/* |
String |
Required. The country where the company indicated in the businessName field is located. The country uses the standard two-letter abbreviation specified in the ISO 3166-1alpha-2:1997 country code. See the ISOCountryCode enumeration list for valid values. |
||||||||||
| tl:corporateFax | 0…1 1/* |
String | Company fax number. | ||||||||||
| tl:addressObjectGUID | 0…1 0/36 |
String | The global identifier assigned by the Russian Federation Information Address System (FIAS).61 |
||||||||||
| tl:houseGUID | 0…1 0/36 |
String | The global house identifier assigned by the Russian Federation Information Address System (FIAS).62 |
||||||||||
| tl:taxRegistrationCode | 0…1 0/* |
String | The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code). | ||||||||||
| tl:premisesCode | 0…1 0/* |
String | Identifier representing a physical area within the company location (e.g. a location's second floor). | ||||||||||
| tl:warehouseOperatorName | 0…1 0/* |
String |
|
||||||||||
| tl:decommissionReasonCode | 0…1 0/* |
String | Conditionally required if at least one Target Market in Product Master Data = RU. Reason code for decommissioning.64See the DecommissionReasonCode enumeration list for valid values. |
||||||||||
| tl:reasonDescription | 0…1 0/* |
String | Description for decommission reason code.65 | ||||||||||
| tl:destructionMethod | 0…1 0/* |
String | Conditionally required if at least one Target Market in Product Master Data = RU. Method of destruction.66See the DestructionMethod enumeration list for valid values. |
||||||||||
| ObjectEvent | 0…* - |
- | ObjectEvent recording
destroying events.
EventList = ObjectEvent Destroy when all of the following is true:
|
||||||||||
| eventTime | 1…1 1/* |
DateTime | Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1] in XML datetime format YYYY-MM-DDTHH:MM:SS.mmZ.67 | ||||||||||
| eventTimeZoneOffset | 1…1 1/* |
String | Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1].68 | ||||||||||
| 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:69 CN EDMC:
SGTIN:
SSCC:
|
||||||||||
| action | 1…1 0/* |
String | Required. The action value must equal DELETE.70 |
||||||||||
| bizStep | 0…1 0/* |
AnyURI | The bizStep value must equal urn:epcglobal:cbv:bizstep:destroying.71 |
||||||||||
| disposition | 0…1 0/* |
AnyURI | The disposition value must equal urn:epcglobal:cbv:disp:destroyed.72 |
||||||||||
| readPoint | 1…1 - |
- | Required. Location where event occurred. Defined with GS1-conformant party identifier types with full urn or http prefix. SGLN is strongly preferred but other party types supported. Links to location party address data if present in VocabularyElement | @id. If does not link to location identifier in VocabularyElement | @id, readPoint used for master data lookup. | ||||||||||
| id | 1…1 0/* |
AnyURI | Required. The party identifier of the location where the decommissioning event occurred. SGLN is strongly preferred for GS1 conformance. This may be a site-level SGLN, or a finer-grain location identifier.73 GS1-conformant supported prefixes are listed in MDPartyTypeAttributes lookup. See the MDPartyTypeAttributes enumeration list for valid values. |
||||||||||
| bizLocation | 0…1 - |
- | The location where the event occurred. | ||||||||||
| id | 1…1 1/* |
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.74 | ||||||||||
| bizTransactionList | 0…1 - |
- | Conditionally required if at least one Target Market in Product Master Data = RU. Business transaction list group. |
||||||||||
| bizTransaction | 1…* 0/* |
AnyURI | Conditionally required if at least one Target Market in Product Master Data = RU. The transaction identifier associated with the destroyed product.75 |
||||||||||
| @type | 1…1 1/* |
String |
Required. The transaction identifier type. Valid values:
RU , one instance of bizTransaction | @type with a value of http://epcis.tracelink.com/hc/btt/removal must be present. |
||||||||||
| @date | 0…1 0/* |
Date | Conditionally required if at least one Target Market in Product Master Data = RU. Transaction identifier date attribute in XML YYYY-MM-DD format.76 |
||||||||||
| tl:locationId | 0…1 - |
String | Serialized Operations Manager External Partner Location identifier. Type of identifier defined by enum below. When messages are submitted by an external Serialized Operations Manager Partner, the system uses the partner company integration user to perform the action. This is logged in the audit trail so that all messages executed by the external Serialized Operations Manager Partner are attributed to that company.77 | ||||||||||
| @type | 1…1 1/* |
String | Conditionally required if tl:locationId is populated. Attribute identifies the
location types.78 See the MessagePartyIDType enumeration list for valid values. |
||||||||||
| tl:destroyEventExtensions | 0…1 - |
- | Extensions used for ObjectEvent Destroying. | ||||||||||
| tl:transactionDate | 0…1 0/* |
Date | Date associated with the business transaction document in bizTransactionList in XML date format YYYY-MM-DD. This date may or may not be the same as the eventTime.79 | ||||||||||
| tl:disaggregateFromParent | 0…1 - |
Boolean | When set to true,
instructs back end to disaggregate a serial number from its parent container
(if it is aggregated) when setting the PackagingSerialNumberStatus of the
serial number to DECOMMISSIONED or DESTROYED.80If not set, or set to |
||||||||||
| tl:marketCountryCode | 0…1 0/2 |
String | Market country code.81 | ||||||||||
| tl:businessPartyInfo | 0…1 0/* |
- | Authorizing party information for the destroying event. | ||||||||||
| tl:businessId | 1…* 0/* |
String | Required. Identifier associated with the authorizing business entity. | ||||||||||
| @type | 1…1 0/* |
String |
Required. The business identifier type. See the BusinessAndLocationId enumeration list for valid values. |
||||||||||
| tl:businessClassification | 0…1 0/* |
String |
The classification of the business. See the BusinessClassification enumeration list for valid values. |
||||||||||
| tl:BusinessPartyDetail | 0…1 - |
- | Business name and address of the authorizing business entity. | ||||||||||
| tl:businessName | 1…1 0/* |
String | Required. Business name of the entity that is authorizing the destruction of the serial numbers. | ||||||||||
| tl:street1 | 1…1 0/* |
String | Required. First line of the address for the company indicated in tl:businessName. | ||||||||||
| tl:street2 | 0…1 0/* |
String | Second line of the address for the company indicated in tl:businessName. | ||||||||||
| tl:city | 1…1 0/* |
String | Required. City for the company indicated in tl:businessName. | ||||||||||
| tl:village | 0…1 0/* |
String | Name of the village in which the company is located. | ||||||||||
| tl:houseNumber | 0…1 0/* |
String | Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in tl:street1. | ||||||||||
| tl:township | 0…1 0/* |
String | Name of the township in which the company is located. | ||||||||||
| tl:district | 0…1 0/* |
String |
|
||||||||||
| tl:stateOrRegion | 1…1 0/* |
String | Required. The state, province, or region of the business entity indicated in the businessName field, using the standard two-letter abbreviation specified in the ISO 3166-2:1998 country subdivision code. | ||||||||||
| tl:postalCode | 0…1 1/* |
String | Postal code for the company indicated in tl:businessName. | ||||||||||
| tl:country | 1…1 0/* |
String |
Required. The country where the company indicated in the businessName field is located. The country uses the standard two-letter abbreviation specified in the ISO 3166-1alpha-2:1997 country code. See the ISOCountryCode enumeration list for valid values. |
||||||||||
| tl:corporateFax | 0…1 1/* |
String | Company fax number. | ||||||||||
| tl:addressObjectGUID | 0…1 0/36 |
String | The global identifier assigned by the Russian Federation Information Address System (FIAS).82 |
||||||||||
| tl:houseGUID | 0…1 0/36 |
String | The global House identifier assigned by the Russian Federation Information Address System (FIAS).83 |
||||||||||
| tl:taxRegistrationCode | 0…1 0/* |
String | The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code). | ||||||||||
| tl:premisesCode | 0…1 0/* |
String | Identifier representing a physical area within the company location (e.g. a location's second floor). | ||||||||||
| tl:warehouseOperatorName | 0…1 0/* |
String |
|
||||||||||
| tl:decommissionReasonCode | 0…1 0/* |
String | Conditionally required if at least one Target Market in Product Master Data = RU. Reason code for decommissioning.85See the DecommissionReasonCode enumeration list for valid values. |
||||||||||
| tl:reasonDescription | 0…1 0/* |
String | Description for destroy reason code.86 | ||||||||||
| tl:destructionMethod | 0…1 0/* |
String | Conditionally required if at least one Target Market in Product Master Data = RU. Method of destruction.87See the DestructionMethod enumeration list for valid values. |
||||||||||
| AggregationEvent | 0…* - |
- | AggregationEvent is option 2
for the EventList choice for the Aggregation events.
EventList = AggregationEvent when all of the following is true:
|
||||||||||
| eventTime | 1…1 1/* |
DateTime | Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1] in XML datetime format YYYY-MM-DDTHH:MM:SS.mmZ.88 | ||||||||||
| eventTimeZoneOffset | 1…1 1/* |
String | Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1].89 | ||||||||||
| parentID | 1…1 1/* |
AnyURI | Required. Identifier of the parent
container in EPC Pure Identity URI format (e.g.
f or an item-to-case aggregation, the EPC of the case.
For a case-to-pallet aggregation, the EPC of the pallet).90 CN EDMC:
SGTIN:
SSCC:
|
||||||||||
| childEPCs | 1…1 - |
- | Required. List of identifiers of the child items in the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPCs of the items; for a case-to-pallet aggregation, the EPCs of the cases). | ||||||||||
| epc | 1…* 1/* |
String | Required. Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys.
Non-GS1 serial numbers (e.g. China) are expressed in native format. See EPC Pure Identifier Format Examples.
Identifier of the child items in the parent container in EPC Pure Identity URI format.91 CN EDMC:
SGTIN:
SSCC:
|
||||||||||
| action | 1…1 1/* |
String | Required. The action value must equal ADD for the aggregation event.92 |
||||||||||
| bizStep | 0…1 0/* |
AnyURI | The bizStep value must equal urn:epcglobal:cbv:bizstep:packing.93 |
||||||||||
| disposition | 0…1 0/* |
AnyURI | The disposition value must equal urn:epcglobal:cbv:disp:in_progress.94 |
||||||||||
| readPoint | 0…1 - |
- | Location where the event occurred.0.Optional for AggregationEvent. |
||||||||||
| id | 1…1 0/* |
AnyURI | Required. The SGLN EPC of the location of where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier.95 | ||||||||||
| bizLocation | 0…1 - |
- | Required. The location where the event occurred. | ||||||||||
| 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.96 | ||||||||||
| tl:aggregationEventExtensions | 0…1 - |
- | Extensions used for Aggregation Event. | ||||||||||
| tl:packedStatus | 0…1 0/* |
String |
The packout of the item or container using the supported enumeration values.97 See the PackedStatus enumeration list for valid values. |
||||||||||
| tl:quantity | 0…1 - |
Integer | The quantity of child serial numbers aggregated to the parent container in this aggregation.98 | ||||||||||
| tl:resetContainerAggregation | 0…1 - |
Boolean | Reset container aggregation flag.99 | ||||||||||
| ObjectEvent | 1…1 - |
- | Required.EventList. Data = ObjectEvent
for Product Release Events. EventList = ObjectEvent Product Release when all of the following is true:
|
||||||||||
| eventTime | 1…1 1/* |
DateTime | Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1] in XML datetime format YYYY-MM-DDTHH:MM:SS.mmZ.100 | ||||||||||
| eventTimeZoneOffset | 1…1 1/* |
String | Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1].101 | ||||||||||
| epcList | 1…1 - |
- | Required. List of the EPCs of top-most containers (e.g. pallets, cases) in the shipment. | ||||||||||
| epc | 1…* 1/* |
String | Required. The EPC identifier in EPC Pure Identity URI format. Will not be populated or processed for product release event. | ||||||||||
| action | 1…1 0/* |
String | Required. The action value must equal OBSERVE.102 |
||||||||||
| bizStep | 0…1 0/* |
AnyURI | Required. The bizStep value must equal http://epcis.tracelink.com/bizstep/releasing.103 |
||||||||||
| disposition | 0…1 0/* |
AnyURI | Required. The disposition value must equal http://epcis.tracelink.com/disp/released.104 |
||||||||||
| readPoint | 0…1 - |
- | Required. Refers to the location of where the commissioning event occurred.0. |
||||||||||
| 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.105 See the MDPartyTypeAttributes enumeration list for valid values. |
||||||||||
| bizTransactionList | 0…1 - |
- | Business transaction list group. |
||||||||||
| bizTransaction | 1…* 0/* |
AnyURI | The transaction identifier associated with the released product.106 | ||||||||||
| @type | 1…1 1/* |
String | Required. The transaction identifier type. Valid values:
|
||||||||||
| @date | 0…1 0/* |
Date | Conditionally required if at least one Target Market in Product Master Data = RU and the lot was commissioned in Russia. Transaction identifier date attribute in XML YYYY-MM-DD format.107 |
||||||||||
| extension | 0…1 - |
- | Main extension body for commission event. | ||||||||||
| ilmd | 1…1 - |
- | Required. Instance lot master data specific to product being commissioned. | ||||||||||
| cbvmda:lotNumber | 1…1 0/* |
String | Required. The lot number associated with the InternalMaterialCode or CountryDrugCode.108 | ||||||||||
| tl:commissionEventExtensions | 0…1 - |
- | Extensions used for Commission ObjectEvent. Not populated in product release event. | ||||||||||
| tl:productReleaseEventExtensions | 1…1 - |
- | Extensions used for TraceLink Product Release event. | ||||||||||
| choice%1 | 1…1 - |
- | Required. Only one of the following choice options must be selected:
An error will be thrown if neither of the two fields are populated. An error will also be thrown if both of the two option fields are populated. |
||||||||||
| tl:internalMaterialCode | 0…1 0/* |
String | Conditionally required if tl:countryDrugCode is not populated. The internal material number configured in Product Master Data associated with the serialized items that are 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.109 | ||||||||||
| tl:countryDrugCode | 0…1 0/* |
String | Conditionally required if tl:internalMaterialCode is not populated. The national drug code (e.g. NDC, Swissmedic, PZN, etc.) 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 | 1…1 1/* |
String |
Required. The national drug code type using the supported enumeration values and any formatting instructions provided. See the CountryDrugCode enumeration list for valid values. |
||||||||||
| tl:qualityControlEntityId | 0…1 0/* |
String | Conditionally required if tl:bizTransactionList in the ObjectEvent for Product Release Events is populated, or at least one Target Market in Product Master Data = RU and the lot was commissioned outside of Russia. Business or location identifier for the entity responsible for quality control.110 |
||||||||||
| @type | 1…1 1/* |
String | Required. Business or location type of the quality control entity identifier.111 See the BusinessAndLocationId enumeration list for valid values. |
||||||||||
| tl:productionQty | 0…* - |
- | Production quantity element group. | ||||||||||
| choice1 | 1…1 - |
Choice | Required. Choice element of either tl:packagingItemCode or tl:companyPrefix. | ||||||||||
| tl:packagingItemCode | 0…1 0/* |
String | Conditionally required if tl:companyPrefix is not populated. Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data.112 | ||||||||||
| @type | 0…1 0/* |
String | Required. Packaging item code type.113 See the ItemCode enumeration list for valid values. |
||||||||||
| tl:companyPrefix | 0…1 0/* |
String | Conditionally required if tl:packagingItemCode is not populated. Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product.114 | ||||||||||
| tl:packagingLevel | 1…1 1/* |
String | Required. The packaging level of the commissioned item.115 See the PackagingLevel enumeration list for valid values. |
||||||||||
| tl:quantityReported | 1…1 - |
Integer | Required. Reported quantity of the released product.116 | ||||||||||
| extension | 0…1 - |
- | EPCIS body event extension point. Contains the TransformationEvent. TransformationEvent is option 3 in the EventList choice. This extension can appear before or after commissioning event. | ||||||||||
| TransformationEvent | 0…1 - |
- | Use the TransformationEvent
to commission repackaged products. It is similar to the CommissioningEvent,
but includes source products as input, and the commissioned serial numbers
are the output repackaged products.
The standard ilmd (instance level master data) captures product attributes, lot, and expiry like in a standard commission event. The TransformationEvent parameters are the same as the CommissioningEvent except there is no action:
|
||||||||||
| eventTime | 1…1 1/* |
DateTime | Required. The date/time when the disposition assigned occurs with a time zone indicator as specified in Section 9.5 of (EPCIS1.0.1) in XML datetime format : YYYY-MM-DDTHH:MM:SS.mmZ.117 | ||||||||||
| recordTime | 0…1 0/* |
DateTime | Not used. | ||||||||||
| eventTimeZoneOffset | 1…1 1/* |
String | Required. The time zone offset in effect at time and place where the disposition assigned occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1].118 | ||||||||||
| inputEPCList | 0…1 - |
- | Conditionally required if inputQuantityList is missing. The input EPC is the
serial number of the source product that is transformed. |
||||||||||
| epc | 0…* 1/* |
String | Required. The EPC identifier in EPC Pure Identity URI format. Only SGTIN and NTIN supported as Transformation input.119 SGTIN:
|
||||||||||
| inputQuantityList | 0…1 - |
- | Conditionally required if inputEPCList is missing. Specifies
non-serialized source products with packaging product code, lot number, and
quantity.
|
||||||||||
| quantityElement | 1…* - |
- | Required. Identifies a quantity of source products that are identified by a specific class-level 940 identifier in urn format. | ||||||||||
| epcClass | 1…1 1/* |
String | Required. A class-level identifier for
the source product in the inputQuantityList for which the quantity is
provided.120 Format:
|
||||||||||
| quantity | 1…1 - |
Integer | Required. A number that specifies how many or how much of the specified epcClass is denoted by this quantityElement.121 | ||||||||||
| uom | 0…1 0/* |
String | Unit of measure for the epcClass quantity. | ||||||||||
| outputEPCList | 1…1 - |
- | Required. Provides the epc serial number for the transformed product.
outputEPCList is mandatory if Transformation Event is populated. |
||||||||||
| epc | 1…* 1/* |
String | Required. Identifier of the child items in the parent container in EPC Pure Identifier URI format as specified in Section 6 of [TDS1.5].122 CN EDMC:
SGTIN:
SSCC:
|
||||||||||
| transformationID | 0…1 0/* |
AnyURI | An identifier that links this event to other Transformation Events using an identical transformationID value. When specified, all inputs to all events sharing the same value of the transformationID may contribute to all outputs of all events sharing that value of transformationID. | ||||||||||
| bizStep | 0…1 0/* |
AnyURI | The bizStep value must be
set to urn:epcglobal:cbv:bizstep:commissioning.123 |
||||||||||
| disposition | 0…1 0/* |
AnyURI | The disposition value must be set to urn:epcglobal:cbv:disp:active.124 |
||||||||||
| readPoint | 0…1 - |
- | Not used in Transformation Event. | ||||||||||
| id | 0…1 0/* |
AnyURI | Not used in Transformation Event.125 | ||||||||||
| bizLocation | 1…1 - |
- | Required. Refers to the location of the product after the Transformation Event has occurred. | ||||||||||
| id | 1…1 1/* |
AnyURI | Required. The SGLN EPC of the location from where the commissioning occurred. This may be a site-level SGLN or a finer-grain location identifier.126 | ||||||||||
| bizTransactionList | 0…* 1/* |
String | An unordered list of 0 or more business transactions that define the context of this event. | ||||||||||
| ilmd | 0…1 - |
- | Instance lot master data specific to product being commissioned. | ||||||||||
| cbvmda:lotNumber | 0…1 1/* |
String | Required. The lot number associated with the tl:internalMaterialCode, tl:packagingItemCode, or tl:countryDrugCode specified above that is used to identify the serial numbers that will be updated.127 | ||||||||||
| cbvmda:itemExpirationDate | 0…1 0/* |
Date | The expiration date for the serialized item in YYYY-MM-DD format.128 | ||||||||||
| tl:commissionEventExtensions | 0…1 - |
- | Required. Extensions used for Commission ObjectEvent. | ||||||||||
| tl:filterValue | 0…1 - |
Integer | Not used. | ||||||||||
| tl:packagingLevel | 1…1 0/* |
String | Conditionally required for GS1 EPCIS conformance. The packaging level of the
commissioned item using the supported enumeration values. Valid value:
|
||||||||||
| tl:epcAttributes | 0…* - |
- | Supports optional inclusion of human readable barcode content associated with each epc number in a commission event. Only included if provided in original commission event. | ||||||||||
| @epc | 1…1 1/* |
String | The EPC serial number to
which the tl:barcodeContent is associated. The epc must be an EPC Pure Identity
URI as specified in Section 6 of [TDS1.5]. Valid value: |
||||||||||
| tl:barcodeContent | 1…1 0/* |
String | The human readable barcode contents encoded in the 2D barcode with parenthesis for the AI keys.131 | ||||||||||
| tl:plantLocationId | 0…1 0/* |
String | Identifier of plant where products are commissioned.132 | ||||||||||
| tl:productionLineId | 0…1 1/* |
String |
|
||||||||||
| tl:lineManagerName | 0…1 0/* |
String |
|
||||||||||
| tl:companyPrefix | 0…1 0/* |
String | The GS1 Company Prefix. | ||||||||||
| tl:internalMaterialCode | 0…1 0/* |
String | Conditionally required for GS1 EPCIS conformance. Internal material number for the product in the Pharmaceutical Manufacturer's internal systems (e.g. ERP).135 |
||||||||||
| tl:packagingItemCode | 0…1 0/* |
String | Conditionally required for GS1 EPCIS conformance. The product code for the
commissioned item (e.g. GTIN-14).136 |
||||||||||
| @type | 1…1 1/* |
String | Conditionally required if tl:packagingItemCode is populated. The product code type. Valid values:137
|
||||||||||
| tl:countryDrugCode | 0…1 0/* |
String | Conditionally required for GS1 EPCIS conformance. The national drug code for
the commissioned item (e.g. NDC number for US products).138 |
||||||||||
| @type | 1…1 1/* |
String | Conditionally required if tl:countryDrugCode is populated. The national drug code type
using the supported enumeration values and any formatting instructions
provided.139 See the CountryDrugCode enumeration list for valid values. |
||||||||||
| tl:manufacturingDate | 0…1 0/10 |
Date | The date of manufacture for the serialized item in YYYY-MM-DD format.140 | ||||||||||
| tl:countryMarket | 0…1 0/3 |
String | Conditionally required for master data reporting for EU countries reporting to EFPIA EMVS Hub. The country using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.141 | ||||||||||
| tl:printedExpirationDate | 0…1 0/10 |
Date | Expiration date printed on the label in YYYY-MM-DD format.142 | ||||||||||
| tl:referenceDocuments | 0…1 - |
- | Reference document identifier associated with the commissioning activity. | ||||||||||
| tl:poNumber | 0…1 0/* |
String | PO Number associated with serial number use. | ||||||||||
| tl:poLine | 0…1 0/* |
String | PO Line number. | ||||||||||
| tl:workOrderNumber | 0…1 0/* |
String | Work Order number associated with serial number use. | ||||||||||
| tl:referenceIdentifier | 0…1 0/* |
String | Reference identifier (e.g. any type of identifier) associated with serial number use. | ||||||||||
| tl:extensionField | 0…* - |
- | Customer extension point to
supply one or more name/value pairs containing additional data attributes not
already supported in this message. |
||||||||||
| tl:fieldName | 1…1 1/* |
String | Required. The field name
provided by the partner that will be receiving the mapped outbound
message.143 |
||||||||||
| tl:fieldValue | 1…1 1/* |
String | Required. The field value content that corresponds to tl:fieldName.144 | ||||||||||
| extension | 0…1 - |
- | TransformationEvent extension. | ||||||||||
| tl:decommissionSourceProduct | 0…1 - |
Boolean | When set to true, instructs
system to implicitly decommission serial numbers used for repackaging. Saves
a step in the repack operation so that separate decommission events do not
need to be sent.145 |
||||||||||
| tl:registerSourceProduct | 0…1 - |
Boolean | Triggers registration of
serial numbers that are not known to the TraceLink system.
Defaults to false if not populated.146If value = |
||||||||||
| tl:repackInputAttributes | 0…1 - |
- | Conditionally required if cmn:registerSourceProduct = true. Repack input common
attributes group with product info for input product.
|
||||||||||
| cbvmda:lotNumber | 1…1 0/* |
String | Required. The lot or batch code for the transformation input product in an alphanumeric string of up to 20 characters.147 | ||||||||||
| cbvmda:itemExpirationDate | 0…1 0/* |
Date | Required. The expiration date for the transformation input product in YYYY-MM-DD format.148 | ||||||||||