0% found this document useful (0 votes)
179 views88 pages

Tatmeen - WKI-0064 - Technical Guide For Logistics - v3.0

This technical guide provides information on logistics message guidelines and EPCIS message formats for communicating product information within the supply chain in the UAE. It describes business processes and constraints for importation, sampling, transfers, updates, and destruction. It also specifies the API and message specifications required to integrate systems using EPCIS standards.

Uploaded by

Jaweed Sheikh
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
179 views88 pages

Tatmeen - WKI-0064 - Technical Guide For Logistics - v3.0

This technical guide provides information on logistics message guidelines and EPCIS message formats for communicating product information within the supply chain in the UAE. It describes business processes and constraints for importation, sampling, transfers, updates, and destruction. It also specifies the API and message specifications required to integrate systems using EPCIS standards.

Uploaded by

Jaweed Sheikh
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 88

Tatmeen – Technical Guide for Logistics

Technical Guide for Logistics

Document Tatmeen_WKI-0064_Technical Guide for


ID: Logistics_v3.0

Version: 3.0

© EVOTEQ | Confidential Page 1 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

1 Document Control

1.1 Version History


Version Date Description of Change Author / Company

1.0 13-Dec-2021 Initial Release. Movilitas

2.0 17-Mar-2022 Minor updates after MoHAP and 3PL review. Movilitas

3.0 30-May-2022 Additional features added. Movilitas


Table 1 Version History

© EVOTEQ | Confidential Page 2 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Table of Contents
1 Document Control .................................................................................................... 2
1.1 Version History ................................................................................................... 2
2 Introduction............................................................................................................... 7
2.1 Scope of Document ............................................................................................ 7
2.1.1 In Scope ....................................................................................................... 8
2.1.2 Out of Scope ................................................................................................ 8
2.2 Document Structure............................................................................................ 8
2.3 Target Participants ............................................................................................. 9
2.4 Prerequisites ...................................................................................................... 9
3 Message Guidelines ............................................................................................... 11
3.1 Importation to UAE - Initial Receipt of Goods ................................................... 11
3.1.1 Business Process Outline .......................................................................... 12
3.1.2 Constraints and Validations ....................................................................... 13
3.2 Sampling for Customs Release / Market Release ............................................ 14
3.2.1 Business Process Outline .......................................................................... 14
3.2.2 Constraints and Validations ....................................................................... 14
3.3 Product Transfer Between Locations................................................................ 15
3.3.1 Business Process Outline .......................................................................... 15
3.3.2 Constraints and Validations ....................................................................... 16
3.4 Product Hierarchy Update Within UAE ............................................................. 17
3.4.1 Pack New SSCC ........................................................................................ 18
3.4.2 Unpack Existing Hierarchy ......................................................................... 19
3.5 Product status update within the UAE .............................................................. 20
3.5.1 Business Process Outline .......................................................................... 20
3.5.2 Constraints and Validations ....................................................................... 21
3.6 Destruction of product within the UAE .............................................................. 22
3.6.1 Business Process Outline .......................................................................... 23
3.6.2 Constraints and Validations ....................................................................... 23

© EVOTEQ | Confidential Page 3 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

4 API Specification .................................................................................................... 25


4.1 API Subscription ............................................................................................... 25
4.2 API Authentication ............................................................................................ 25
4.2.1 Staging Authentication Endpoints .............................................................. 26
4.2.2 Live Authentication Endpoints .................................................................... 26
4.3 Service APIs ..................................................................................................... 26
4.3.1 Staging Service Endpoints ......................................................................... 26
4.3.2 Live Service Endpoints .............................................................................. 27
4.4 Message Formats ............................................................................................. 27
5 EPCIS Message Format ......................................................................................... 28
5.1 EPCIS: Custom Tatmeen Namespace ............................................................. 28
5.2 EPCIS: Header Attributes ................................................................................. 28
5.3 EPCIS Commissioning Attributes ..................................................................... 29
5.4 EPCIS Hierarchy Update Attributes .................................................................. 30
5.4.1 Aggregation Event: Packing ....................................................................... 30
5.4.2 Aggregation Event: Unpacking................................................................... 32
5.5 EPCIS Shipping Attributes ................................................................................ 34
5.5.1 EPCIS Shipping Event ............................................................................... 34
5.5.2 EPCIS Shipping Return Event ................................................................... 36
5.6 EPCIS Receiving Attributes .............................................................................. 39
5.6.1 EPCIS Receiving Event ............................................................................. 39
5.6.2 EPCIS Receiving Returns Event ................................................................ 41
5.7 EPCIS Status and Destruction Attributes ......................................................... 43
5.7.1 Blocked / Unblocked for Inspection ............................................................ 43
5.7.2 Sampled Product Event ............................................................................. 49
5.7.3 Destroyed Goods Event ............................................................................. 51
5.7.4 Damaged Goods Event .............................................................................. 52
5.7.5 Stolen Goods Event ................................................................................... 53
5.7.6 Exportation Event....................................................................................... 54
5.7.7 Lost/Missing Goods Event ......................................................................... 55
© EVOTEQ | Confidential Page 4 of 88
Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.8 EPCIS Message Technical Response .............................................................. 56


5.9 EPCIS: Examples ............................................................................................. 57
5.9.1 Packing New SSCC Example .................................................................... 57
5.9.2 Unpacking Parent Example ....................................................................... 59
5.9.3 Unpacking Selected Objects Example ....................................................... 60
5.9.4 Shipping Example ...................................................................................... 61
5.9.5 Shipping Returns Example ........................................................................ 62
5.9.6 Receiving Example .................................................................................... 64
5.9.7 Receiving Returns Example ....................................................................... 65
5.9.8 Blocking Batch/Lot Example ...................................................................... 67
5.9.9 Blocking Object IDs Example ..................................................................... 68
5.9.10 Unblocking Batch/Lot Example ............................................................... 69
5.9.11 Unblocking Object IDs Example ............................................................. 71
5.9.12 Sampling Example .................................................................................. 72
5.9.13 Destruction Example............................................................................... 73
5.9.14 Damaged Example ................................................................................. 75
5.9.15 Stolen Example ...................................................................................... 76
5.9.16 Exported Example .................................................................................. 77
5.9.17 Lost Example .......................................................................................... 78
5.10 EPCIS Message Technical Response Examples .......................................... 80
5.10.1 Success .................................................................................................. 80
5.10.2 Connectivity Error ................................................................................... 80
5.10.3 System Error ........................................................................................... 80
5.10.4 Mapping Error ......................................................................................... 81
5.11 EPCIS Message Query Status ...................................................................... 81
5.11.1 Message Status Query ........................................................................... 82
5.11.2 Message Status Query Response .......................................................... 82
5.12 Product Verification Service .......................................................................... 83
5.12.1 SGTIN Product Verification Query .......................................................... 83
5.12.2 SSCC Product Verification Query ........................................................... 83
© EVOTEQ | Confidential Page 5 of 88
Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.12.3 Product Verification Success Response ................................................. 84


5.12.4 Product Verification Error Response....................................................... 84
6 EPCIS Message Summary ..................................................................................... 86
7 Glossary ................................................................................................................. 88

© EVOTEQ | Confidential Page 6 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

2 Introduction
The UAE’s Governmental department for healthcare and prevention - MoHAP has
published legislation that defines the Serialisation and Track and Trace (T&T)
requirements for all participants involved in manufacturing, distributing and dispensing of
pharmaceutical products. This legislation:
• Defines the specific categories of products relevant to the legislation.
• Applies to the entirety of the UAE territory.
• It becomes effective:
o Immediately prior to foreign product importation into the UAE.
o Immediately prior to domestic manufacture release into the UAE.
• Concludes with dispensing to patients/consumers.
• Manages exceptions such as product recalls.
This legislation is driven by the need to maintain and improve patient safety whilst at the
same time reduce counterfeits within the UAE.
Tatmeen is the Information Technology (IT) regulatory system that will support the UAE
T&T legislation to the pharmaceutical industry. All products placed on the UAE market
need to display a serialised unique identifier on the product secondary packaging. Also
aggregated packaging (aggregated homogenous products or logistics unit) must display
a serialised unique identifier. The appropriate serialised identifiers must be used to record
the operational and transactional movements of the products throughout the supply chain
and during dispensing to the patient / consumer.
The information recorded by the participants must be transmitted to the Tatmeen
traceability system where it is stored. The stored data is made available for regulatory
purposes to the authorities of the UAE MoHAP departments.

2.1 Scope of Document


The purpose of this document is to define the information that must be sent under the
MoHAP regulations to the Tatmeen traceability system by logistics supply chain
participants involved in the movement of medical products for the following processes:
1. Importation Into UAE: Initial Receipt of Goods for import clearance and customs
release.
2. Sampling for Import Clearance and Customs Release / Market Release.

© EVOTEQ | Confidential Page 7 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

3. Domestic Manufacturing for UAE, staging for release.


4. Product transfer between stock holding owners and locations within the UAE.
5. Product hierarchy update within the UAE.
6. Product status update within the UAE.
7. Export of product from the UAE.
8. Destruction of product within the UAE.
These processes are the first draft of this technical guide and it is expected that additional
processes will be added in future versions of this document, as appropriate.

2.1.1 In Scope
This guide covers the technical onboarding of organizations to the Tatmeen solution.

2.1.2 Out of Scope


The guide makes reference to systems external to the Tatmeen system and the
onboarding to those external systems is not included in this guide.
Automatic processes within the Tatmeen solution are not covered within this guide.

2.2 Document Structure


The document follows the outline in Table 2.
Section Content

Section 2 Introduction and Context.

Message guidelines and specifications:


Section 3 • EPCIS message events.
• EPCIS message status.

Technical API Guidelines, providing usage guidelines for the technical API to
Section 4
submit data to the Tatmeen traceability system.

Section 5 Message Formats and examples of messages.


Table 2 Document Structure

© EVOTEQ | Confidential Page 8 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

2.3 Target Participants


The following stakeholders / participants for the Section 2.1 in scope processes are
responsible for collecting serialised product item traceability records during the storing
and moving of pharmaceutical products within the UAE market.
Participant Description

The Third Party Logistics (3PL) participant is a logistics partner that is:
• Physically located outside the UAE, and/or
• Located in the UAE Free Trade Zone, and/or
3PL • Registered with GS1 as a 3PL partner.
Similar to a Distributor, they may participate with handling and storing imported
products immediately prior to the customs clearance process. This is based on
the product delivery Incoterms.

A partner providing pharmacy services to provide accurate, timely and


Dispenser
qualitative medical product dispensing services to registered patients.

The Distributor is a supply chain partner representing a location for storing


Distributor medical product and can have a MoHAP license for medical product
importation; distribution storage.

Domestic A domestic manufacture is a manufacturing entity located in the UAE supplying


Manufacturer goods to the UAE market. A domestic manufacturer may also be the MAH.

Marketing Authorisation Holder is the company or other legal entity that has
MAH
the authorization granted by MoHAP to market a medicine in the UAE.
Table 3 Document Stakeholders

2.4 Prerequisites
Please refer to the Technical Onboarding Guide to ensure the following prerequisites are
met:
• Product Registration:
All products subject to the UAE MoHAP legislation (registered drugs; unregistered
drugs) should be known in the appropriate MoHAP / Federal system and these should
also be known in the GS1 BrandSync master data system. This product’s information
is synchronised between the BrandSync system and the Tatmeen solution.

© EVOTEQ | Confidential Page 9 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

• Entity Registration:
o All Distributors (and relevant 3PL’s) involved in the storage or distribution of
medical products should be known as supply chain partners and should be
allocated a GS1 Global Location Number (GLN).

© EVOTEQ | Confidential Page 10 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

3 Message Guidelines
This section describes the messaging responsibilities of the participants for the processes
in Section 2.1 according to the following scenarios.
• Importation to UAE, Initial Receipt of Goods.
• Sampling for Customs Release / Market Release.
• Product transfer between stock holding owners and locations within the UAE.
• Product hierarchy update within the UAE.
• Product status update within the UAE.
• Destruction of product within the UAE.
The following general principles for stakeholders in Section 2.3 reporting to the Tatmeen
solution to meet the MoHAP legislation are:
• Logistics supply chain partners (Distributors) must report the relevant event
serialisation information immediately when the physical event is completed.
• Messages that are sent to the Tatmeen platform must be constructed according to the
GS1 EPCIS standards defined in this technical guide.
• A single event activity is represented by a single GS1 event document with the
exception of scenario of packing into a new SSCC parent.

3.1 Importation to UAE - Initial Receipt of Goods


This section describes the reporting scenario for UAE Distributors that participate in the
importation of foreign goods into the UAE market. The Distributor is the partner entity that
must report the initial receipt of the goods into the UAE prior to import clearance and
customs release by MoHAP and Federal Customs. All serialised pharmaceutical products
subject to MoHAP legislation must not physically enter the UAE market without having
completed this reporting.

© EVOTEQ | Confidential Page 11 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

CUSTOMS

EPCIS
(1)

MSG
(1) EPCIS
MAH
(2)

Batch Releaser 3PL / Distributor


(e.g. CMO) (Import Clearance
+ Customs Release)
Physical movement

Figure 1 Importing Registered Drugs, Initial Receipt

3.1.1 Business Process Outline


This outline refers to Figure 1, above.
1. The MAH or their delegated technical representative must notify the UAE located
Distributor (or where Incoterms dictate, the 3PL) once the importation EPCIS
message(s) (“EPCIS (1)” in Figure 1) is successfully sent to the Tatmeen solution. The
description of this messaging is described in the Tatmeen Technical Guide for
Manufacturers and is not described in this document.
2. On subsequent receipt of the physical goods and the confirmation in the previous step,
the UAE located Distributor (or where Incoterms dictate, the 3PL) must send an EPCIS
message (“EPCIS (2)” in Figure 1) to the Tatmeen solution to receive the goods into
the UAE market location in preparation of import clearance and customs release.
3. Once the imported product is successfully receipted into the Distributor (or where
Incoterms dictate, the 3PL) location and reported to the Tatmeen solution, then the
goods are sampled and inspected as appropriate at the Distributor (or where Incoterms
dictate, the 3PL) location.
4. The Distributor (or where Incoterms dictate, the 3PL) must send any events for
activities such as sampling and inspecting, that are conducted on behalf of the MoHAP

© EVOTEQ | Confidential Page 12 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

and Federal Customs inspectors during the import clearance and customs release
processes.
5. Note the import clearance and customs release events are not recorded by the
Distributor (or where Incoterms dictate, the 3PL) but instead are recorded by the
relevant MoHAP and/or Federal Customs inspector.

3.1.2 Constraints and Validations


Failure to report this critical event means the goods are blocked to the UAE market
therefore the Tatmeen solution expects to receive from the Distributor:
1. A single EPCIS message for a full / partial delivery receipt that defines the serialised
product items for importation.
2. Each EPCIS message must contain an EPCIS Header, that specifies:
a. A unique message identifier that is generated by the Distributor and is used to
identify each EPCIS message.
b. The message creation date and time.
c. The message sender information, i.e., the Distributor GLN.
d. The identifier for the relevant Tatmeen system that will receive the EPCIS
message.
3. Each EPCIS message must consist of a single GS1 “receiving” EPCIS event recorded
in the message and follows the structure below.
Message Structure: EPCIS (2)

EPCIS HEADER
Cardinality
EPCIS EventList
Multiple

receiving
Single

Figure 2 Importation Receipt EPCIS Message Structure

4. Only the top level hierarchy serialisation ID’s are included in the receipt message.

© EVOTEQ | Confidential Page 13 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

3.2 Sampling for Customs Release / Market Release


There are numerous situations during operational logistics where a Distributor selects a
small number of products items as samples for inspection purposes. These include (but
not limited to):
• Import clearance sampling for product verification.
• Customs release sampling for product verification.
• Quality control.

3.2.1 Business Process Outline


The following steps outline the process for sampling at the Distributor location in the UAE.
1. During the sampling process the Distributor must capture the individual unique top
level serialised tracking identifiers for the samples pharmaceutical product items.
a. Item SGTIN
b. Product Lot/Batch
c. Serial Shipping Container Codes (SSCCs)
2. The Distributor must send an EPCIS document to the Tatmeen solution containing the
serialised identifiers captured in the previous step. This document consists of the
EPCIS event that then registers the specific items as sampled items so they are not
available for dispensing in the UAE market.

3.2.2 Constraints and Validations


1. The Distributor must hold the pharmaceutical stock at their location immediately prior
to changing the status.
2. A single EPCIS message must be sent that defines the sampling activity.
3. Each EPCIS message must contain an EPCIS Header, that specifies:
a. A unique message identifier that is generated by the Distributor and is used to
identify each EPCIS message.
b. The message creation date and time.
c. The message sender information, i.e., the Distributor.
d. The identifier for the relevant Tatmeen system that will receive the EPCIS
message.
© EVOTEQ | Confidential Page 14 of 88
Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

4. Each EPCIS message must consist of a single GS1 “inspecting” EPCIS event
recorded in the message and follows the structure below.

Message Structure: EPCIS (Distributor)

EPCIS HEADER

EPCIS EventList Cardinality

Multiple
inspecting(SGTIN/SSCC)

Single

Figure 3 Sampling EPCIS Message Structure

5. Only the top level hierarchy ID’s (SGTIN/SSCC) are included in the sample inspecting
message.

3.3 Product Transfer Between Locations


Product transfers between locations registers the fundamental shipment and receipt of
serialised products between those locations including any change of ownership. This
transfer registration of the top level serialised product items or logistics unit must be
reported to the Tatmeen system by both the sending and receiving parties.
Product Transfer process covers the following processes:
• Shipment
• Return - when shipment is rejected by the receiver, the receiver should receive the
shipment and then use Return to ship back.

3.3.1 Business Process Outline


The following steps outline the process for transfer between locations in the UAE.
1. The Distributor initiating the product transfer (SENDER) must capture the individual
unique top level serialised tracking identifiers for the pharmaceutical product items to
be transferred.
a. Item SGTIN
b. Serial Shipping Container Codes (SSCCs)
© EVOTEQ | Confidential Page 15 of 88
Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

2. The SENDER must send an EPCIS document to the Tatmeen solution containing the
serialised identifiers captured in the previous step. This document contains the single
EPCIS event that then registers the specific items as shipped items so they are no
longer located at the SENDER location.
3. When the physical product items arrive at the intended destination, the receiving
Distributor (RECEIVER) must capture the same top level tracking identifiers.
4. The RECEIVER must send an EPCIS document to the Tatmeen solution containing
the serialised identifiers captured in the previous step. This document contains the
single EPCIS event that then registers the specific items as received into stock at the
RECEIVER location.

3.3.2 Constraints and Validations


The Tatmeen solution expects to receive a message firstly from the SENDER distributor
and then at some later time the corresponding RECEIVER message. Failure to receive
both messages will block the product items from being dispensed.
1. A single EPCIS message for a full / partial shipment that defines the serialised product
items for transfer to another location.
2. A single EPCIS message for a full / partial receipt that defines the arrival of the
serialised product items at the destination location.
3. Each EPCIS message must contain an EPCIS Header, that specifies:
a. A unique message identifier that is generated by the Distributor and is used to
identify each EPCIS message.
b. The message creation date and time.
c. The message sender information, i.e., the SENDER/RECEIVER GLN.
d. The identifier for the relevant Tatmeen system that will receive the EPCIS
message.
4. Each EPCIS message must consist of either:
a. A single GS1 “shipping” EPCIS event recorded in the message and follows the
structure below.

© EVOTEQ | Confidential Page 16 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Message Structure: EPCIS (Distributor)

EPCIS HEADER

EPCIS EventList Cardinality

Multiple
shipping(SSCC)

Single

Figure 4 SENDER EPCIS Message Format

b. A single GS1 “receiving” EPCIS event recorded in the message and follows the
structure below.
Message Structure: EPCIS (Distributor)

EPCIS HEADER

EPCIS EventList Cardinality

Multiple
receiving(SSCC)

Single

Figure 5 RECEIVER EPCIS Message Structure

5. Only the top level hierarchy serialisation ID’s are included in each of the shipping and
receiving messages.

3.4 Product Hierarchy Update Within UAE


A product hierarchy update consists of one of two operations at a Distributor location.
• Pack (consolidation of new aggregation structure)
• Unpack (deconsolidation of existing aggregation structure)
Aggregation is defined by the relationship between a parent item and children item(s). The
Distributor must note that defining a new parent that has not been previously registered

© EVOTEQ | Confidential Page 17 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

in the Tatmeen solution requires that the top level (parent) identifier must first be
registered before the aggregation activity is recorded. At a Distributor location this is only
allowed for logistics units (SSCC).
Pack and Unpack activities with the supply chain must trigger reporting to inform the
Tatmeen solution of the product hierarchy relationship changes.

3.4.1 Pack New SSCC


3.4.1.1 Business Process Outline
The following steps outline the process for packing product items into a new logistics unit
(SSCC).
1. During the supply chain logistics process to pack serialised product items into a new
logistics units the SSCC label for the serialised logistics unit is generated. The new
SSCC serialised identifier is captured to register the new identifier.
2. During the physical packing activities, the Distributor must capture the serialised
product item serialised items (SGTIN / SSCC) that are associated with the top level
identifier.
3. The Distributor must send an EPCIS document to the Tatmeen solution containing the
serialised identifiers captured in the previous step. This document contains:
a. The EPCIS commissioning event that then registers the new SSCC parent so
it is known to the Tatmeen solution.
b. The EPCIS packing event that then registers the parent/child relationship
between the new SSCC and the captured child identifiers.

3.4.1.2 Constraints and Validations


1. The Distributor must hold the pharmaceutical stock at their location immediately prior
to changing the hierarchy.
2. A pair of EPCIS messages must be sent that defines:
a. The creation of the SSCC identifier.
b. The new parent/child association with the new SSCC as parent.
3. Each EPCIS message must contain an EPCIS Header, that specifies:
a. A unique message identifier that is generated by the Distributor and is used to
identify each EPCIS message.

© EVOTEQ | Confidential Page 18 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

b. The message creation date and time.


c. The message sender information, i.e., the logistics Distributor GLN.
d. The identifier for the relevant Tatmeen system that will receive the EPCIS
message.
4. Each EPCIS document must consist of the pair of EPCIS events recorded according
to the structure below.
Message Structure: EPCIS (Distributor)

EPCIS HEADER

EPCIS EventList
Cardinality
commissioning
Multiple

packing(SSCC)
Single

Figure 6 Pack to New SSCC - EPCIS Document Structure

3.4.2 Unpack Existing Hierarchy


3.4.2.1 Business Process Outline
The following steps outline the process for unpacking product items from an existing
logistics unit (SSCC) or aggregated level SGTIN product item.
1. During the supply chain logistics process to unpack serialised product items from an
existing structure the Distributor must capture the serialised product item identifier of
the top level item.
2. The Distributor must send an EPCIS document to the Tatmeen solution containing the
serialised identifiers captured in the previous step. This document contains a single
EPCIS message that then registers the disassociation of the next level child items from
the parent identifier. The parent identifier may no longer be used.

© EVOTEQ | Confidential Page 19 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

3.4.2.2 Constraints and Validations


1. The Distributor must hold the pharmaceutical stock at their location immediately prior
to changing the hierarchy.
2. Each EPCIS message must contain an EPCIS Header, that specifies:
a. A unique message identifier that is generated by the Distributor and is used to
identify each EPCIS message.
b. The message creation date and time.
c. The message sender information, i.e., the logistics Distributor GLN.
d. The identifier for the relevant Tatmeen system that will receive the EPCIS
message.
3. Each EPCIS document must consist of a single GS1 “unpacking” EPCIS event
recorded in the message and follows the structure below.
Message Structure: EPCIS (Distributor)

EPCIS HEADER

EPCIS EventList Cardinality

Multiple
unpacking(SGTIN/SSCC)

Single

Figure 7 Unpack EPCIS Document Structure

3.5 Product status update within the UAE


Serialised product items can have the item status changed if they are:
• Known to the Tatmeen solution.
• Located at a licensed UAE Distributor.

3.5.1 Business Process Outline


The following steps outline the process for product item status change to restrict
unsuitable product items from dispensing.
© EVOTEQ | Confidential Page 20 of 88
Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

1. During the logistics process to change the status of any serialised product item, the
Distributor must capture the individual unique top level tracking identification
a. Item SGTIN
b. Product Lot/Batch
c. Serial Shipping Container Codes (SSCCs)
2. The Distributor must send an EPCIS document to the Tatmeen solution containing the
serialised identifiers captured in the previous step. This document contains a single
EPCIS message that then registers the specific items for status change so they are
not available for dispensing in the UAE market.

3.5.2 Constraints and Validations


1. The Distributor must hold the pharmaceutical stock at their location immediately prior
to changing the status.
2. A single EPCIS message must be sent that defines the status change.
3. Each EPCIS message must contain an EPCIS Header, that specifies:
a. A unique message identifier that is generated by the Distributor and is used to
identify each EPCIS message.
b. The message creation date and time.
c. The message sender information, i.e., the exporting Distributor GLN.
d. The identifier for the relevant Tatmeen system that will receive the EPCIS
message.
4. Each EPCIS message must consist of a single GS1 status change EPCIS event
recorded in the message and follows the structure below using the Business Step and
Disposition identified in Table 4.

© EVOTEQ | Confidential Page 21 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Message Structure: EPCIS (Distributor)

EPCIS HEADER

EPCIS EventList Cardinality

Multiple
Status Change(LGTIN/SGTIN/SSCC)

Single

Figure 8 Status Change EPCIS Message Structure

Case Business Step Disposition

Block UPDATING BLOCKED

Unblock UPDATING UNBLOCKED

Recalled UPDATING RECALLED

Export DECOMMISSIONING NON_SELLABLE_OTHER


Table 4 Status Change Parameters

5. Only the top level hierarchy ID’s (LGTIN/SGTIN/SSCC) are included in the status
change message.

3.6 Destruction of product within the UAE


Destruction is a logistics operation that removes previously valid and authentic products
from the market for a variety of situations.
• No dispensing of any destroyed products is possible
• Also no transfer is possible when blocked for destruction.
The following destruction scenarios are included for Distributors:
• Destruction: product is identified for destruction for any number of reasons.
• Damaged: product is identified as damaged and unfit for further distribution.
• Stolen: missing product is identified as stolen and must be reported accordingly.

© EVOTEQ | Confidential Page 22 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

• Lost / Missing: previously known items can no longer be located and therefore
missing.

3.6.1 Business Process Outline


The following steps outline the process for exporting from the UAE.
1. During the process to record the destruction/removal of product item identifiers from
record, the Distributor must capture the individual unique top level tracking identifiers
either by scanning or from internal records.
2. The Distributor must send an EPCIS document to the Tatmeen solution containing the
serialised identifiers captured in the previous step. This document contains a single
EPCIS message for the appropriate destruction activity that then registers the specific
items destruction in the Tatmeen system and further blocking the items for dispensing
in the UAE market.

3.6.2 Constraints and Validations


1. The last known location of the serialised product items must be the Distributor reporting
the destruction activity.
2. A single EPCIS document must be sent that reports the relevant destruction scenario
of the identified serialised IDs.
3. Each EPCIS message must contain an EPCIS Header, that specifies:
a. A unique message identifier that is generated by the Distributor and is used to
identify each EPCIS message.
b. The message creation date and time.
c. The message sender information, i.e., the reporting Distributor GLN.
d. The identifier for the relevant Tatmeen system that will receive the EPCIS
message.
4. Each EPCIS message must consist of a single GS1 destruction EPCIS event (see
Table 5 for event context) recorded in the document and follows the structure below.

© EVOTEQ | Confidential Page 23 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Message Structure: EPCIS (Distributor)

EPCIS HEADER

EPCIS EventList Cardinality

Multiple
Destruction (SGTIN/SSCC)

Single

Figure 9 Destruction EPCIS Message Structure

Case Business Step Disposition

Destruction DESTROYING DESTROYED

Damaged DECOMMISSIONING DESTROYED

Stolen DECOMMISSIONING STOLEN

Lost DECOMMISSIONING INACTIVE


Table 5 Destruction Parameters

5. Only the top level hierarchy ID’s (SGTIN/SSCC) are included in the destruction
message.

© EVOTEQ | Confidential Page 24 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

4 API Specification
During the business partner onboarding process, the Single Point of Contact (SPOC) will
be registered and the SPOC then manages the API subscription to enable electronic
submission of messages to the Tatmeen solution. This section describes the following:
• API Subscription
• Service APIs
• Message Formats
• Message Status Formats
• Message Acknowledgements

4.1 API Subscription


To be able to subscribe to the Tatmeen solution APIs, the following steps must be
followed.
1. The business partner (Distributor) SPOC must register a single technical user following
the user registration process in the Tatmeen Technical Onboarding Guide.
2. Once approval for the user is given, the technical user credentials (sign-on ID and
password) are created in the Tatmeen solution and authorised for messages that
reference the business partner GLN.
3. The SPOC provides these credentials to their technical team to subscribe to the
Tatmeen APIs. During subscription the Tatmeen API Application Key and Application
Secret are issued. These must be saved for use during technical messaging with the
Tatmeen system.

4.2 API Authentication


Prior to connecting to any specific API services, the API connection must be authenticated
using OpenID Connect. OpenID Connect is an identity layer that allows the business
partner technical user to be verified against the Tatmeen identity service. The following
considerations are required.
1. The API calls must use OpenID authentication to communicate with the Tatmeen
system.

© EVOTEQ | Confidential Page 25 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

2. Each API technical user must send messages by calling the designated API
Authentication endpoints and must include the Tatmeen API Application Key and
Tatmeen API Application Secret.

4.2.1 Staging Authentication Endpoints


The table below contains the current expected test endpoint. This section shall be updated
once this detail is available for publication.

IP Range Service URL Operations Description

x.x.x.x https://stgapim.tatmeen.ae/v1 /auth Authorization Service


Table 6 Authentication Test Endpoints

4.2.2 Live Authentication Endpoints


The table below contains the current expected live endpoint. This section shall be updated
once this detail is available for publication.

IP Range Service URL Operations Description

x.x.x.x https://apim.tatmeen.ae/v1 /auth Authorization Service


Table 7 Authentication Live Endpoints

4.3 Service APIs


The tables below (Table 8 and Table 9) provide the list of service URLs for the Dispensing
partner activities.

4.3.1 Staging Service Endpoints


IP Range Service URL Operations Description

x.x.x.x https:/stgapim.tatmeen.ae/v1 /scp/SendEPCIS EPCIS Message Events

x.x.x.x https://stgapim.tatmeen.ae/v1 /MsgStatusQuery Check EPCIS Message Status

x.x.x.x https://stgapim.tatmeen.ae/v1 /VerifyProduct Product Verification Service


Table 8 Service Test Endpoints

© EVOTEQ | Confidential Page 26 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

4.3.2 Live Service Endpoints


IP Range Service URL Operations Description

x.x.x.x https://apim.tatmeen.ae/v1 /epcisMsgAsync EPCIS Message Events

x.x.x.x https://apim.tatmeen.ae/v1 /MsgStatusQuery Check EPCIS Message Status

x.x.x.x https://apim.tatmeen.ae/v1 /VerifyProduct Product Verification Service


Table 9 Service Live Endpoints

4.4 Message Formats


The following message formats are to be used.

Data Content-Type Standards

EPCIS Event Messages Application/xml GS1 EPCIS 1.2

EPCIS Message Status Query Application/xml Tatmeen xml

Product Verification Service Application/xml Tatmeen xml


Table 10 Message Formats

For further details about the message formats, please refer to:
• GS1 EPCIS and CBV Implementation guide document
(https://www.gs1.org/docs/epc/EPCIS_Guideline.pdf)
• GS1 Common Business Vocabulary Standard
(https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-2-r-2017-10-
12.pdf)
• GS1 Standard Business Document Header (SBDH) Version 1.3
(https://www.gs1.org/sites/default/files/docs/xml/SBDH_v1_3_Technical_Impleme
ntation_Guide.pdf)
• ISO 8601: Representation of dates and times “Data elements and interchange formats
– Information interchange.”
These documents form the basis for the EPCIS Message Formats described in the next
section.

© EVOTEQ | Confidential Page 27 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5 EPCIS Message Format


This section provides detailed information about the format of the EPCIS documents and
message events that must be sent by the Distributor participant to the Tatmeen system.
It is assumed that the recipient of this document is familiar with the GS1 EPCIS standards
and the technical xml formats described in the subsequent sections.
Current messaging is defined in the section although there are additional messages
anticipated for future scenarios. These shall be updated in future revisions of this
document.

5.1 EPCIS: Custom Tatmeen Namespace


To allow custom Tatmeen vocabulary within the EPCIS messages, some EPCIS
messages contain a custom xml namespace definition at the start of the message
envelope.
This namespace definition is:
xmlns:tatmeen=”http://tatmeen.ae/epcis/”
Although not used in the dispensing request event, this section is retained for general
reference.

5.2 EPCIS: Header Attributes


All EPCIS messages originating from a Distributor must present a standard GS1 EPCIS
header at the start of the message that is structured according to the UN/CEFACT V1.3:
2004 standard business document header (SBDH) specification as described in the GS1
Standard Business Document Header (SBDH) Version 1.3 Technical Implementation
Guide.
This header contains information to uniquely identify:
• Which registered Distributor sent the message.
• The intended destination for the message.
• A unique message identifier identifying a specific message.
Occurrence &
Element Description Example
Format
Constant value representing the <sbdh:HeaderVersion>1.3</sbdh:Hea
<HeaderVersion> Mandatory
header version, being v1.3: (2004). derVersion>

© EVOTEQ | Confidential Page 28 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence &
Element Description Example
Format
The Authority is always “GLN”, <sbdh:Sender>
followed by the GLN representing the <sbdh:Identifier
<Sender><Identifier> Mandatory Sender Application or the GLN for the Authority=“GS1”>Sender
GLN</sbdh:Identifier>
Distributor business partner in
</sbdh:Sender>
standard 13-digit format.

The Authority is always “GLN”, <sbdh:Receiver>


followed by the Receiver GLN. This is <sbdh:Identifier
<Receiver><Identifier> Mandatory always the Tatmeen system GLN. Authority=“GS1”>Tatmeen
GLN</sbdh:Identifier>
Please note: This GLN value will be
</sbdh:Receiver>
provided at a later stage.

<DocumentIdentification <sbdh:Standard>EPCglobal</sbdh:St
Mandatory Constant Value ”EPCGlobal”. andard>
><sbdh:Standard>

Constant Value “1.0” that matches the <sbdh:TypeVersion>1.0</sbdh:TypeV


<sbdh:TypeVersion> Mandatory ersion>
‘xsd:schema’ version for ATTP.

A unique message identifier issued by


<sbdh:InstanceIdentifier>e999f82e78
the Distributor. This is limited to a
<InstanceIdentifier> Mandatory 28a9633d977c64016a8f81</sbdh:Ins
maximum of 40 alphanumeric tanceIdentifier>
characters.

Constant Value ”Events” from GS1


<sbdh:Type> Mandatory <sbdh:Type>Events</sbdh:Type>
standard.

Creation timestamp of this message <sbdh:CreationDateAndTime>2020-


05-
<CreationDateAndTime> Mandatory according to ISO 8601 standard UTC 05T10:04:17Z</sbdh:CreationDateAn
format; indicated by the suffix “Z”. dTime>
Table 11 EPCIS: Header Attributes

5.3 EPCIS Commissioning Attributes


The EPCIS message attributes for the commissioning event for a logistics unit (SSCC) at
a Distributor’s location are listed below. The most common example of a logistics unit is a
pallet. There are several constant values in the definition below that are explained in the
GS1 EPCIS Common Business Vocabulary standard. The assumption of this technical
guide is that this is read in conjunction with the standards on which message formats are
defined.

© EVOTEQ | Confidential Page 29 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence &
Element Description Example
Format
The date and time, in ISO 8601 standard
UTC format, at which the EPCIS <eventTime>2021-05-
<eventTime> Mandatory
Capturing Applications asserts the event 31T12:02:11.000Z</eventTime>
occurred.

The UTC time zone offset, including


<eventTimeZon <eventTimeZoneOffset>+01:00</eventT
Mandatory daylight saving considerations, in effect
eOffset> imeZoneOffset>
at the time and place the event occurred.

A list of one or more SSCC EPCs naming <epcList>


<epcList> Mandatory specific objects to which the event <epc>urn:epc:id:sscc:123456.0
pertained. 2029914567</epc> </epcList>
Standard Fields

Constant Value from “xsd:schema” for


<action> Mandatory <action>ADD</action>
the event type action.

Constant value. The business step


<bizStep>urn:epcglobal:cbv:bizstep:co
<bizStep> Mandatory representing the event activity (see
mmissioning</bizStep>
Section 6 for overview).
<disposition>urn:epcglobal:cbv:disp:acti
<disposition> Mandatory Constant Value. ve</disposition>
<readPoint>
The read point must be the GLN in SGLN <id>urn:epc:id:sgln:123456.789101.0</i
<readPoint> Mandatory d>
format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the same <id>urn:epc:id:sgln:123456.789101.0</i
<bizLocation> Mandatory
GLN as the <readpoint>. d>
</bizLocation>
Table 12 Commissioning – SSCC

5.4 EPCIS Hierarchy Update Attributes


5.4.1 Aggregation Event: Packing
This section provides detailed information about the parent / child relationship between
packaged product items as they progress through logistics preparation of being shipped
to meet demand from customers or supply chain partners.

© EVOTEQ | Confidential Page 30 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
eOffset> at the time and place the event TimeZoneOffset>
occurred.

The parent element to capture the UID


<parentID>urn:epc:id:sscc:0123456.00
<parentID> Mandatory of parent SGTIN/SSCC for the following
01000516</parentID>
packed items.

<childEPCs>
<epc>urn:epc:id:sgtin:0123456.305513
Standard Fields

A list of one or more EPCs of contained


.NN2P266YLXPC</epc>
<childEPCs> Mandatory objects identified by instance-level
identifiers. <epc>urn:epc:id:sgtin:0123456.305513
.NN2P266YYXX2</epc>
</childEPCs>

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>ADD</action>
overview).

Constant value. The business step


<bizStep>urn:epcglobal:cbv:bizstep:pa
<bizStep> Mandatory representing the event activity (see cking</bizStep>
Section 6 for overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101.0</
<readpoint> Mandatory id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.789101.0</
<bizLocation> Mandatory
same GLN as the <readpoint>. id>
</bizLocation>
Table 13 Aggregation Attributes

© EVOTEQ | Confidential Page 31 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.4.2 Aggregation Event: Unpacking


This section provides detailed information about the disaggregation of the parent / child
relationship between packaged product items.

5.4.2.1 Scenario: Unpack Parent


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
eOffset> at the time and place the event TimeZoneOffset>
occurred.

The parent element to capture the UID


<parentID>urn:epc:id:sscc:0123456.00
<parentID> Mandatory of parent SGTIN/SSCC for the following
01000516</parentID>
packed items.
Standard Fields

A list of one or more EPCs of selected


objects to remove from the parent, each
selected object being identified by
<childEPCs> Mandatory <childEPCs></childEPCs>
instance-level identifiers. Only these
selected items are removed from the
hierarchy.

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>DELETE</action>
overview).

Constant value. The business step


<bizStep>urn:epcglobal:cbv:bizstep:un
<bizStep> Mandatory representing the event activity (see packing</bizStep>
Section 6 for overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101.0<
<readpoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>

© EVOTEQ | Confidential Page 32 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.000000.0<
<bizLocation> Mandatory
same GLN as the <readpoint>. /id>
</bizLocation>
Table 14 Aggregation – “Unpacking Parent” Attributes

5.4.2.2 Scenario: Unpack Selected Objects


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
eOffset> at the time and place the event TimeZoneOffset>
occurred.

The parent element to capture the UID


<parentID>urn:epc:id:sscc:0123456.00
<parentID> Mandatory of parent SGTIN/SSCC for the following
01000516</parentID>
packed items.
Standard Fields

This is a mandatory empty list as only <childEPCs>


the top level item is captured to <epc>urn:epc:id:sgtin:0123456.30551
<childEPCs> Mandatory
disassociate the parentID from all the 3.NN2P266YLXPC</epc>
childEPCs. </childEPCs>

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>DELETE</action>
overview).

Constant value. The business step


<bizStep>urn:epcglobal:cbv:bizstep:un
<bizStep> Mandatory representing the event activity (see packing</bizStep>
Section 6 for overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101.0<
<readpoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>

© EVOTEQ | Confidential Page 33 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.000000.0<
<bizLocation> Mandatory
same GLN as the <readpoint>. /id>
</bizLocation>
Table 15 Aggregation – “Unpacking Selected Objects” Attributes

5.5 EPCIS Shipping Attributes


5.5.1 EPCIS Shipping Event
The shipping event is used to control the flow of goods as they are shipped through the
UAE market. Typically, the products are packaged onto pallets (SSCC), prior to shipping.
This aids logistics transactions and logistics movements for Distributor warehouse
efficiency. The transaction based messages therefore:
• Must follow the aggregation events for the top level hierarchy EPC and relevant
packaged product items.
• Must report only the top-level hierarchy EPCs.
Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
Standard Fields

eOffset> at the time and place the event TimeZoneOffset>


occurred.

A list of one or more EPCs naming <epcList>


specific objects to which the event
<epc>urn:epc:id:sscc:123456.
<epcList> Mandatory pertained. Only the highest level
02029914567</epc>
aggregated EPCs in the hierarchy are
listed here. </epcList>

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).

© EVOTEQ | Confidential Page 34 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
Constant value. The business step
<bizStep>urn:epcglobal:cbv:bizstep:sh
<bizStep> Mandatory representing the event activity (see
ipping</bizStep>
Section 6 for overview).

Constant value. The disposition


relevant to the business step <disposition>urn:epcglobal:cbv:disp:
<disposition> Mandatory in_transit</disposition>
representing the event activity (see
Section 6 for overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101.0<
<readPoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>

<bizTransaction A list of business transactions that


List> Optional
define the context of this event.

An identifier that denotes the specific


shipping despatch advice reference
between the Distributor and the
recipient.
Only the “desadv” reference is recorded <bizTransaction
<bizTransaction type="urn:epcglobal:cbv:btt:desadv">u
Optional in the Tatmeen solution when provided
> rn:epcglobal:cbv:bt:0123456999995:01
within the message. Format is: 05</bizTransaction>
bt:<GLN>:<reference>
where <GLN> is the Distributors own
GLN and the <reference> is the
Distributors unique reference.

<extension><so A list of Source elements that provide


urceList> Mandatory
context about the originating endpoint.

Only the Owning Party applies to this <source


Extension

Event and is the same GLN as the type="urn:epcglobal:cbv:sdt:owning_p


<source> Mandatory
<readPoint> represented in urn SGLN arty">urn:epc:id:sgln:123456.789101.0
</source>
format.

A list of Destination elements that


<destinationList
> Mandatory provide context about the terminating
endpoint of a business transfer.

© EVOTEQ | Confidential Page 35 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
<destination
type="urn:epcglobal:cbv:sdt:owning_p
Both the Owning Party (sold-to partner) arty">urn:epc:id:sgln:0333333.00000.0
</destination>
<destination> Mandatory and the Location (ship-to partner) <destination
GLN’s are required in SGLN format. type="urn:epcglobal:cbv:sdt:location">
urn:epc:id:sgln:0356787.00040.0</dest
ination>
Table 16 Shipping Attributes - Shipping Event

Note that the <bizTransaction> is shown as optional as this reference has no significance
to the Tatmeen solution. Recording this allows the Distributor to track event records
against their own business document references.

5.5.2 EPCIS Shipping Return Event


The shipping return event is used to control the flow of goods for a shipment or partial
shipment that is returned to the original SENDER. The transaction based messages
therefore:
• Must follow any disaggregation or aggregation events relevant to the returns
preparation and loading processes.
• Must report only the top-level hierarchy EPCs being returned.
Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


Standard Fields

<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event


Mandatory
eOffset> at the time and place the event TimeZoneOffset>
occurred.

A list of one or more EPCs naming <epcList>


specific objects to which the event <epc>urn:epc:id:sscc:0471234.100123
<epcList> Mandatory pertained. Only the highest level 4569</epc>
aggregated EPCs in the hierarchy are <epc>urn:epc:id:sscc:123456.
listed here. 02029914567</epc>

© EVOTEQ | Confidential Page 36 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
</epcList>

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).

Constant value. The business step


<bizStep>urn:epcglobal:cbv:bizstep:sh
<bizStep> Mandatory representing the event activity (see
ipping</bizStep>
Section 6 for overview).

Constant value. The disposition


relevant to the business step <disposition>urn:epcglobal:cbv:disp:re
<disposition> Mandatory turned</disposition>
representing the event activity (see
Section 6 for overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:0473456.00100.0<
<readPoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>

<bizTransaction A list of business transactions that


List> Optional
define the context of this event.

An identifier that denotes the specific


shipping despatch advice and returns
authorisation references between the <bizTransactionList>
Distributor and the recipient. <bizTransaction
type="urn:epcglobal:cbv:btt:desadv">u
The “desadv” reference and “rma” rn:epcglobal:cbv:bt:0476543000102:01
<bizTransaction reference are recorded in the Tatmeen 05</bizTransaction>
> Optional
solution when provided within the <bizTransaction
message. Format is: type="urn:epcglobal:cbv:btt:rma">urn:
epcglobal:cbv:bt:0476543000102:R01
bt:<GLN>:<reference> 05</bizTransaction>
where <GLN> is the Distributors own </bizTransactionList>
GLN and the <reference> is the
Distributors unique reference.

<extension><so A list of Source elements that provide


urceList> Mandatory
Extension

context about the originating endpoint.


<source
Only the Owning Party applies to this type="urn:epcglobal:cbv:sdt:owning_p
<source> Mandatory arty">urn:epc:id:sgln:0476543.00010.0
Event and is the same GLN as the
</source>

© EVOTEQ | Confidential Page 37 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
<readPoint> represented in urn SGLN
format.

A list of Destination elements that


<destinationList
> Mandatory provide context about the terminating
endpoint of a business transfer.
<destination
type="urn:epcglobal:cbv:sdt:owning_p
arty">urn:epc:id:sgln:0473456.00001.0
Both the Owning Party (sold-to partner)
</destination>
<destination> Mandatory and the Location (ship-to partner)
<destination
GLN’s are required in SGLN format. type="urn:epcglobal:cbv:sdt:location">
urn:epc:id:sgln:0473456.00100.0</dest
ination>

<tatmeen:reaso Custom reason code for shipping <tatmeen:reasonCode>R01</tatmeen:


nCode> Mandatory reasonCode>
return. See Table for possible codes.
Table 17 Shipping Attributes - Shipping Return Event

Note that the <bizTransaction> is shown as optional as this reference has no significance
to the Tatmeen solution. Recording this allows the Distributor to track event records
against their own business document references.
Reason Code Description

R01 Product does not match

R02 Quantity does not match

R03 Permit and Delivery Order mismatch

R04 Serial number mismatch

R05 Seal broken

R06 Packaging damaged

R07 Storage conditions violated

R08 Multiple supporting documents missing


Table 18 Shipping Return Reason Codes

© EVOTEQ | Confidential Page 38 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.6 EPCIS Receiving Attributes


5.6.1 EPCIS Receiving Event
The receiving event is used to control the flow of goods as they arrive at locations
throughout the UAE market. Typically, the products are packaged onto pallets (SSCC),
prior to shipping. This aids logistics transactions and logistics movements for Distributor
warehouse efficiency. The transaction based messages therefore:
• Must follow the shipping events initiating the transfer of the top level hierarchy EPC
and relevant packaged product items.
• Must report only the top-level hierarchy EPCs.
Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
eOffset> at the time and place the event TimeZoneOffset>
occurred.

A list of one or more EPCs naming <epcList>


specific objects to which the event
Standard Fields

<epc>urn:epc:id:sscc:123456.
<epcList> Mandatory pertained. Only the highest level
02029914567</epc>
aggregated EPCs in the hierarchy are
listed here. </epcList>

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).

Constant value. The business step


<bizStep>urn:epcglobal:cbv:bizstep:re
<bizStep> Mandatory representing the event activity (see
ceiving</bizStep>
Section 6 for overview).

Constant value. The disposition


relevant to the business step <disposition>urn:epcglobal:cbv:disp:in
<disposition> Mandatory _progress</disposition>
representing the event activity (see
Section 6 for overview).

© EVOTEQ | Confidential Page 39 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:0356787.00040.0<
<readpoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:0356787.00040.0<
<bizLocation> Mandatory
same GLN as the <readpoint>. /id>
</bizLocation>

<bizTransaction A list of business transactions that


List> Optional
define the context of this event.

An identifier that denotes the specific


shipping despatch advice reference
between the Distributor and the
recipient.
<bizTransaction
Only the “desadv” reference is recorded type="urn:epcglobal:cbv:btt:desadv">u
<bizTransaction
Optional in the Tatmeen solution when provided rn:epcglobal:cbv:bt:
>
within the message. Format is: 0356787000406:GR8015694</bizTran
saction>
bt:<GLN>:<reference>
where <GLN> is the Distributors own
GLN and the <reference> is the
Distributors unique reference.

Only the Owning Party applies to this <source


Event and is the same GLN as the type="urn:epcglobal:cbv:sdt:owning_p
<source> Mandatory
<readPoint> represented in urn SGLN arty">urn:epc:id:sgln:123456.789101.0
</source>
format.

A list of Destination elements that


<destinationList
> Mandatory provide context about the terminating
endpoint of a business transfer.
<destination
type="urn:epcglobal:cbv:sdt:owning_p
Both the Owning Party (sold-to partner) arty">urn:epc:id:sgln:0333333.00000.0
</destination>
<destination> Mandatory and the Location (ship-to partner) <destination
GLN’s are required in SGLN format. type="urn:epcglobal:cbv:sdt:location">
urn:epc:id:sgln:0356787.00040.0</dest
ination>
Table 19 Receiving Attributes – Receiving Event

© EVOTEQ | Confidential Page 40 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Note that the <bizTransaction> is shown as optional as this reference has no significance
to the Tatmeen solution. Recording this allows the Distributor to track event records
against their own business document references.

5.6.2 EPCIS Receiving Returns Event


The receiving returns event is used to control the flow of goods as they are returned at
locations throughout the UAE market. Typically, the products are packaged onto pallets
(SSCC), prior to returned shipping. This aids logistics transactions and logistics
movements for Distributor warehouse efficiency. The transaction based messages
therefore:
• Must follow the shipping events initiating the transfer of the top level hierarchy EPC
and relevant packaged product items.
• Must report only the top-level hierarchy EPCs.
Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
eOffset> at the time and place the event TimeZoneOffset>
occurred.
Standard Fields

<epcList>
A list of one or more EPCs naming
<epc>urn:epc:id:sscc:0471234.100123
specific objects to which the event
4569</epc>
<epcList> Mandatory pertained. Only the highest level
<epc>urn:epc:id:sscc:123456.
aggregated EPCs in the hierarchy are
02029914567</epc>
listed here.
</epcList>

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).

Constant value. The business step


<bizStep>urn:epcglobal:cbv:bizstep:re
<bizStep> Mandatory representing the event activity (see
ceiving</bizStep>
Section 6 for overview).

© EVOTEQ | Confidential Page 41 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
Constant value. The disposition
relevant to the business step <disposition>urn:epcglobal:cbv:disp:re
<disposition> Mandatory turned</disposition>
representing the event activity (see
Section 6 for overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:0356787.00040.0<
<readpoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:0473456.00100.0<
<bizLocation> Mandatory
same GLN as the <readpoint>. /id>
</bizLocation>

<bizTransaction A list of business transactions that


List> Optional
define the context of this event.

An identifier that denotes the specific


shipping despatch advice reference
between the Distributor and the
recipient.
<bizTransaction
Only the “recadv” reference is recorded type="urn:epcglobal:cbv:btt:recadv">ur
<bizTransaction
Optional in the Tatmeen solution when provided n:epcglobal:cbv:bt:
>
within the message. Format is: 0473456001004:GR8015694</bizTran
saction>
bt:<GLN>:<reference>
where <GLN> is the Distributors own
GLN and the <reference> is the
Distributors unique reference.

<extension><so A list of Source elements that provide


urceList> Mandatory
context about the originating endpoint.

Only the Owning Party applies to this <source


Event and is the same GLN as the type="urn:epcglobal:cbv:sdt:owning_p
<source> Mandatory
<readPoint> represented in urn SGLN arty">urn:epc:id:sgln:0476543.00010.0
</source>
format.

A list of Destination elements that


<destinationList
> Mandatory provide context about the terminating
endpoint of a business transfer.

© EVOTEQ | Confidential Page 42 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
<destination
type="urn:epcglobal:cbv:sdt:owning_p
arty">urn:epc:id:sgln:0473456.00001.0
Both the Owning Party (sold-to partner)
</destination>
<destination> Mandatory and the Location (ship-to partner)
<destination
GLN’s are required in SGLN format. type="urn:epcglobal:cbv:sdt:location">
urn:epc:id:sgln:0473456.00100.0</dest
ination>
Table 20 Receiving Attributes – Receiving Returns Event

Note that the <bizTransaction> is shown as optional as this reference has no significance
to the Tatmeen solution. Recording this allows the Distributor to track event records
against their own business document references.

5.7 EPCIS Status and Destruction Attributes


This section covers all update definitions:
• Blocked/Unblocked – for inspection
• Sampled Product Event
• Product Destruction Event
• Damaged Goods Event
• Stolen Goods Event
• Exportation Event
• Lost/Missing Goods Event

5.7.1 Blocked / Unblocked for Inspection


During the importation processes the import clearance or customs release inspectors may
request that products are blocked for inspection by the logistics operators. Once the
inspection is complete, then the products should be unblocked to release them for further
logistics activities.

© EVOTEQ | Confidential Page 43 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.7.1.1 Scenario: Block LGTIN


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601 standard
UTC format, at which the EPCIS <eventTime>2021-05-
<eventTime> Mandatory
Capturing Applications asserts the event 31T12:02:11.000Z</eventTime>
occurred.

The UTC time zone offset, including


<eventTimeZon <eventTimeZoneOffset>+01:00</eventT
Mandatory daylight saving considerations, in effect
eOffset> imeZoneOffset>
at the time and place the event occurred.

An empty list representing all objects


<epcList> Mandatory <epcList/>
within the batch/lot.

Constant Value from “xsd:schema” for


Standard Fields

<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).

Constant value. The business step For Inactive Case:


<bizStep> Mandatory representing the event activity (see <bizStep>urn:tatmeen:cbv:bizstep:upda
Section 6 for overview). ting</bizStep>

Constant Value (see Section 6 for <disposition>urn:tatmeen:cbv:disp:bloc


<disposition> Mandatory ked</disposition>
overview).
<readPoint>
The read point must be the GLN in SGLN <id>urn:epc:id:sgln:123456.789101.0</i
<readpoint> Mandatory d>
format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the same <id>urn:epc:id:sgln:123456.789101.0</i
<bizLocation> Mandatory
GLN as the <readpoint>. d>
</bizLocation>

This element contains the Batch / Lot


reference for the product and is <quantityList>
represented in the form of an LGTIN, i.e., <quantityElement>
Extension

<quantityEleme a serialized LOT. The LGTIN does not <epcClass>urn:epc:class:lgtin:0123456.


nt> Mandatory 305512.LOTTEST1</epcClass>
contain any quantity as this message is
intended to apply to ALL of the available </quantityElement>
product for this event and is stock at the </quantityList>
location represented by the ReadPoint.

© EVOTEQ | Confidential Page 44 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
This LGTIN represents:
• GTIN: 3012345055123
• LOT: LOTTEST1

<tatmeen.reaso Custom reason code for blocking. See <tatmeen.reasonCode>B01</tatmeen.r


nCode> Mandatory easonCode>
Table for possible codes.

<tatmeen:blocke Custom status indicator ‘X’ to mark the <tatmeen:blocked>X</tatmeen:blocked


d> Mandatory >
LGTIN as blocked.
Table 21 EPCIS Blocked LGTIN Attributes

Reason Code Description

B01 License Expired

B02 Storage conditions violated

B03 Market release issue

B04 Federal Customs Release issue

B05 MoHAP Import clearance issue

B06 Suspicious origin

B07 Criminal Investigation

B08 Random Quality Check

B09 Product recalled

B10 Batch recalled

B11 Destruction issue

B12 Destruction

B13 Legislative Violation


Table 22 Blocking Reason Codes

© EVOTEQ | Confidential Page 45 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.7.1.2 Scenario: Block Object ID


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601 standard
UTC format, at which the EPCIS <eventTime>2021-05-
<eventTime> Mandatory
Capturing Applications asserts the event 31T12:02:11.000Z</eventTime>
occurred.

The UTC time zone offset, including


<eventTimeZon <eventTimeZoneOffset>+01:00</eventT
Mandatory daylight saving considerations, in effect
eOffset> imeZoneOffset>
at the time and place the event occurred.

A list of one or more EPCs naming


specific objects to which the event <epcList>
<epcList> Mandatory pertained. <epc>urn:epc:id:sgtin:123456.0202991.
Only the highest level aggregated EPCs AFA0UM128F4C</epc> </epcList>
in the hierarchy are listed here.
Standard Fields

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).

Constant value. The business step For Inactive Case:


<bizStep> Mandatory representing the event activity (see <bizStep>urn:tatmeen:cbv:bizstep:upda
Section 6 for overview). ting</bizStep>

Constant Value (see Section 6 for <disposition>urn:tatmeen:cbv:disp:bloc


<disposition> Mandatory ked</disposition>
overview).
<readPoint>
The read point must be the GLN in SGLN <id>urn:epc:id:sgln:123456.789101.0</i
<readpoint> Mandatory d>
format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the same <id>urn:epc:id:sgln:123456.789101.0</i
<bizLocation> Mandatory
GLN as the <readpoint>. d>
</bizLocation>

<tatmeen.reaso Custom reason code for blocking. See <tatmeen.reasonCode>B01</tatmeen.r


Extension

nCode> Mandatory easonCode>


Table for possible codes.

<tatmeen:blocke Custom status indicator ‘X’ to mark the <tatmeen:blocked>X</tatmeen:blocked


d> Mandatory >
specified Object IDs are blocked.
Table 23 EPCIS Blocked Object ID Attributes

© EVOTEQ | Confidential Page 46 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.7.1.3 Scenario: Unblock LGTIN


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications 31T12:02:11.000Z</eventTime>
asserts the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in <eventTimeZoneOffset>+01:00</ev
Mandatory
eOffset> effect at the time and place the event entTimeZoneOffset>
occurred.

An empty list representing all


<epcList> Mandatory <epcList/>
objects within the batch/lot.

Constant Value from “xsd:schema”


Standard Fields

<action> Mandatory for the event type action (see <action>OBSERVE</action>


Section 6 for overview).

Constant value. The business step For Inactive Case:


<bizStep> Mandatory representing the event activity (see <bizStep>urn:tatmeen:cbv:bizstep:
Section 6 for overview). updating</bizStep>

Constant Value (see Section 6 for <disposition>urn:tatmeen:cbv:disp:


<disposition> Mandatory unblocked</disposition>
overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101
<readpoint> Mandatory .0</id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.789101
<bizLocation> Mandatory
same GLN as the <readpoint>. .0</id>
</bizLocation>
<quantityList>
This element contains the Batch /
<quantityElement>
Lot reference for the product and is
Extension

<epcClass>urn:epc:class:lgtin:0123
<quantityEleme represented in the form of an LGTIN,
Mandatory 456.305512.LOTTEST1</epcClass
nt> i.e., a serialized LOT. The LGTIN >
does not contain any quantity as this </quantityElement>
message is intended to apply to ALL </quantityList>

© EVOTEQ | Confidential Page 47 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
of the available product for this event
and is stock at the location
represented by the ReadPoint.
This LGTIN represents:
• GTIN: 3012345055123
• LOT: LOTTEST1

<tatmeen:blocke Custom status indicator ‘N’ to mark <tatmeen:blocked>N</tatmeen:bloc


d> Mandatory ked>
the LGTIN as unblocked.
Table 24 EPCIS Unblocked LGTIN Attributes

5.7.1.4 Scenario: Unblock Object ID


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
eOffset> at the time and place the event TimeZoneOffset>
occurred.
Standard Fields

A list of one or more EPCs naming


specific objects to which the event <epcList>
<epcList> Mandatory pertained. <epc>urn:epc:id:sgtin:123456.020299
Only the highest level aggregated 1.AFA0UM128F4C</epc> </epcList>
EPCs in the hierarchy are listed here.

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).

Constant value. The business step For Inactive Case:


<bizStep> Mandatory representing the event activity (see <bizStep>urn:tatmeen:cbv:bizstep:upd
Section 6 for overview). ating</bizStep>

© EVOTEQ | Confidential Page 48 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
Constant Value (see Section 6 for <disposition>urn:tatmeen:cbv:disp:unb
<disposition> Mandatory locked</disposition>
overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101.0<
<readpoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.789101.0<
<bizLocation> Mandatory
same GLN as the <readpoint>. /id>
</bizLocation>

<tatmeen:blocke Custom status indicator ‘N’ to mark the <tatmeen:blocked>N</tatmeen:blocke


Ext.

d> Mandatory d>


specified Object IDs are unblocked.
Table 25 EPCIS Unblocked Object IDs Attributes

5.7.2 Sampled Product Event


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.
The UTC time zone offset, including
<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
eOffset> at the time and place the event TimeZoneOffset>
Standard Fields

occurred.
A list of one or more EPCs naming
specific objects to which the event <epcList>
<epcList> Mandatory pertained. <epc>urn:epc:id:sgtin:123456.020299
Only the highest level aggregated 1.AFA0UM128F4C</epc> </epcList>
EPCs in the hierarchy are listed here.
Constant Value from “xsd:schema” for
<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).
Constant value. The business step For Inactive Case:
<bizStep> Mandatory representing the event activity (see <bizStep>urn:epcglobal:cbv:bizstep:in
Section 6 for overview). specting</bizStep>

© EVOTEQ | Confidential Page 49 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
Constant Value (see Section 6 for <disposition>urn:epcglobal:cbv:disp:de
<disposition> Mandatory stroyed</disposition>
overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101.0<
<readpoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.789101.0<
<bizLocation> Mandatory
same GLN as the <readpoint>. /id>
</bizLocation>
Extensiio

Custom reason code for the sample.


<tatmeen.reaso <tatmeen.reasonCode>S01</tatmeen.
n

nCode> Mandatory Possible sampling reason codes are reasonCode>


listed in Table .

Table 26 Decommission Attributes

Reason Code Description

S01 Sample for Doctors

S02 Packaging Review

S03 Laboratory Sample

S04 Criminal Investigation

S05 Prequalification

S06 Retention for future testing

S07 Consumer Report

S08 Product Documentation

S09 Sampling through PMS (Posta Marketing Surveillance)

S10 Suspect activity

S11 Storing condition


Table 27 Sampling Reason Codes

© EVOTEQ | Confidential Page 50 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.7.3 Destroyed Goods Event


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications 31T12:02:11.000Z</eventTime>
asserts the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in <eventTimeZoneOffset>+01:00</ev
Mandatory
eOffset> effect at the time and place the event entTimeZoneOffset>
occurred.

A list of one or more EPCs naming


specific objects to which the event <epcList>
pertained. <epc>urn:epc:id:sgtin:123456.0202
<epcList> Mandatory
Only the highest level aggregated 991.AFA0UM128F4C</epc>
EPCs in the hierarchy are listed </epcList>
Standard Fields

here.

Constant Value from “xsd:schema”


<action> Mandatory for the event type action (see <action>DELETE</action>
Section 6 for overview).

Constant value. The business step For Inactive Case:


<bizStep> Mandatory representing the event activity (see <bizStep>urn:epcglobal:cbv:bizstep
Section 6 for overview). :destroying</bizStep>

Constant Value (see Section 6 for <disposition>urn:epcglobal:cbv:disp


<disposition> Mandatory :destroyed</disposition>
overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101
<readpoint> Mandatory .0</id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.789101
<bizLocation> Mandatory
same GLN as the <readpoint>. .0</id>
</bizLocation>
Table 28 Destroyed Attributes

© EVOTEQ | Confidential Page 51 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.7.4 Damaged Goods Event


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications 31T12:02:11.000Z</eventTime>
asserts the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in <eventTimeZoneOffset>+01:00</ev
Mandatory
eOffset> effect at the time and place the event entTimeZoneOffset>
occurred.

A list of one or more EPCs naming


specific objects to which the event <epcList>
pertained. <epc>urn:epc:id:sgtin:1234
<epcList> Mandatory
Only the highest level aggregated 56.0202991.AFA0UM128F4C</epc
EPCs in the hierarchy are listed > </epcList>
Standard Fields

here.

Constant Value from “xsd:schema”


<action> Mandatory for the event type action (see <action>DELETE</action>
Section 6 for overview).

Constant value. The business step For Inactive Case:


<bizStep> Mandatory representing the event activity (see <bizStep>urn:epcglobal:cbv:bizstep
Section 6 for overview). :Decommissioning</bizStep>

Constant Value (see Section 6 for <disposition>urn:epcglobal:cbv:disp


<disposition> Mandatory :destroyed</disposition>
overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101
<readpoint> Mandatory .0</id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.789101
<bizLocation> Mandatory .0</id>
same GLN as the <readpoint>.
</bizLocation>

Ext. <tatmeen:reaso Custom reason code for reported <tatmeen:reasonCode>D01</tatme


Mandatory en:reasonCode>
nCode> damage, see Table .
Table 29 Damaged Attributes

© EVOTEQ | Confidential Page 52 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Reason Code Description

D01 Broken

D02 Unfolded

D03 Torn

D04 2D Matrix not readable

D05 Smashed

D06 Damage due To liquid spill

D07 Other
Table 30 Damage Reason Codes

5.7.5 Stolen Goods Event


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZon daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
eOffset> at the time and place the event TimeZoneOffset>
occurred.
Standard Fields

A list of one or more EPCs naming


specific objects to which the event <epcList>
<epcList> Mandatory pertained. <epc>urn:epc:id:sgtin:123456.020299
Only the highest level aggregated 1.AFA0UM128F4C</epc> </epcList>
EPCs in the hierarchy are listed here.

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>DELETE</action>
overview).

Constant value. The business step For Inactive Case:


<bizStep> Mandatory representing the event activity (see <bizStep>urn:epcglobal:cbv:bizstep:de
Section 6 for overview). commissioning</bizStep>

© EVOTEQ | Confidential Page 53 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
Constant Value (see Section 6 for <disposition>urn:epcglobal:cbv:disp:st
<disposition> Mandatory olen</disposition>
overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101.0<
<readpoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.789101.0<
<bizLocation> Mandatory
same GLN as the <readpoint>. /id>
</bizLocation>
Table 31 Stolen Attributes

5.7.6 Exportation Event


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZo daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
neOffset> at the time and place the event TimeZoneOffset>
occurred.
Standard Fields

A list of one or more EPCs naming


specific objects to which the event <epcList>
<epcList> Mandatory pertained. <epc>urn:epc:id:sgtin:123456.020299
Only the highest level aggregated 1.AFA0UM128F4C</epc> </epcList>
EPCs in the hierarchy are listed here.

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).

Constant value. The business step For Inactive Case:


<bizStep> Mandatory representing the event activity (see <bizStep>urn:epcglobal:cbv:bizstep:de
Section 6 for overview). commissioning</bizStep>

© EVOTEQ | Confidential Page 54 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
Constant Value (see Section 6 for <disposition>urn:epcglobal:cbv:disp:no
<disposition> Mandatory n_sellable_other</disposition>
overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101.0<
<readpoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.789101.0<
<bizLocation> Mandatory
same GLN as the <readpoint>. /id>
</bizLocation>
Table 32 Export Attributes

5.7.7 Lost/Missing Goods Event


Occurrence
Element Description Example
& Format
The date and time, in ISO 8601
standard UTC format, at which the <eventTime>2021-05-
<eventTime> Mandatory
EPCIS Capturing Applications asserts 31T12:02:11.000Z</eventTime>
the event occurred.

The UTC time zone offset, including


<eventTimeZo daylight saving considerations, in effect <eventTimeZoneOffset>+01:00</event
Mandatory
neOffset> at the time and place the event TimeZoneOffset>
occurred.
Standard Fields

A list of one or more EPCs naming


specific objects to which the event <epcList>
<epcList> Mandatory pertained. <epc>urn:epc:id:sgtin:123456.020299
Only the highest level aggregated 1.AFA0UM128F4C</epc> </epcList>
EPCs in the hierarchy are listed here.

Constant Value from “xsd:schema” for


<action> Mandatory the event type action (see Section 6 for <action>OBSERVE</action>
overview).

Constant value. The business step For Inactive Case:


<bizStep> Mandatory representing the event activity (see <bizStep>urn:epcglobal:cbv:bizstep:de
Section 6 for overview). commissioning</bizStep>

© EVOTEQ | Confidential Page 55 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Occurrence
Element Description Example
& Format
Constant Value (see Section 6 for <disposition>urn:epcglobal:cbv:disp:in
<disposition> Mandatory active</disposition>
overview).
<readPoint>
The read point must be the GLN in <id>urn:epc:id:sgln:123456.789101.0<
<readpoint> Mandatory /id>
SGLN format of the Distributor.
</readPoint>
<bizLocation>
The business location must be the <id>urn:epc:id:sgln:123456.789101.0<
<bizLocation> Mandatory
same GLN as the <readpoint>. /id>
</bizLocation>
Table 33 Lost Attributes

5.8 EPCIS Message Technical Response


The following technical responses will provide immediate confirmation regarding delivery
of the EPCIS event list message described in the previous sections, to the Tatmeen
solution. The Tatmeen system returns standard HTTP/HTTPS codes to the Distributor.
The response codes follow the general standard where:
• 200-299 indicate success / information,
• 300-399 indicate redirection,
• 400-499 are technical errors, and
• 500-599 are application errors.
Solution example codes are shown in the table below with custom messages codes also
provided for efficient error handling. Once the complete set of solution technical and
application codes are finalised, this document shall be updated and reissued.
The messages detailing the errors and rejections on data will be sent from Tatmeen
Systems to the Distributor when using the message status query service.

Code Message Code Type Action Description

404 Standard Service Error Retry Service Not Found

401 Standard Auth Error Retry Authorization Error

202 I001 Information N/A OK

500 E001 Internal Error Retry Tatmeen applications not reachable

© EVOTEQ | Confidential Page 56 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Code Message Code Type Action Description

500 E002 Internal Error No Retry Invalid Import Permit

500 E003 Internal Error No Retry Message Validation Error


Table 34 Technical Acknowledgments

5.9 EPCIS: Examples


This following examples include the possible supply chain logistic operations.
• Packing new SSCC
• Shipping
• Receiving
• Decommissioning

5.9.1 Packing New SSCC Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda">
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>

© EVOTEQ | Confidential Page 57 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<EPCISBody>
<EventList>
<ObjectEvent>
<!--Commissioning of SSCC/PALLET-->
<eventTime>2021-05-31T12:02:20.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sscc:0123456.0001000516</epc>
</epcList>
<action>ADD</action>
<bizStep>urn:epcglobal:cbv:bizstep:commissioning</bizStep>
<disposition>urn:epcglobal:cbv:disp:active</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
</ObjectEvent>
<AggregationEvent>
<!-- AGGREGATION OF 2 FULL CASES INTO A PALLET-->
<eventTime>2021-05-31T12:02:22.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<parentID>urn:epc:id:sscc:0123456.0001000516</parentID>
<childEPCs>
<epc>urn:epc:id:sgtin:0123456.305512.Y4QOQBH0VVW1</epc>
<epc>urn:epc:id:sgtin:0123456.305512.A4QIY780KL6M</epc>
</childEPCs>
<action>ADD</action>
<bizStep>urn:epcglobal:cbv:bizstep:packing</bizStep>
<disposition>urn:epcglobal:cbv:disp:in_progress</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
</AggregationEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 35 EPCIS Packing New SSCC Example

© EVOTEQ | Confidential Page 58 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.9.2 Unpacking Parent Example


<epcis:EPCISDocument
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1"
xmlns:cbvmda="urn:epcglobal:cbv:mda"
schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z">
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2020-05-
05T10:04:17Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<AggregationEvent>
<!--Unpacking Parent Event-->
<eventTime>2021-05-29T07:47:40.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<parentID>urn:epc:id:sscc:0123456.0001018244</parentID>
<childEPCs></childEPCs>
<action>DELETE</action>
<bizStep>urn:epcglobal:cbv:bizstep:unpacking</bizStep>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
</AggregationEvent>

© EVOTEQ | Confidential Page 59 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 36 EPCIS Unpacking Parent Example

5.9.3 Unpacking Selected Objects Example


<epcis:EPCISDocument
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1"
xmlns:cbvmda="urn:epcglobal:cbv:mda"
schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z">
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2020-05-
05T10:04:17Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<AggregationEvent>
<!--Unpacking Objects Event-->
<eventTime>2021-05-29T07:47:40.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<parentID>urn:epc:id:sscc:0123456.0001018244</parentID>
<childEPCs>
<epc>urn:epc:id:sgtin:0123456.305513.NN2P266YLXPC</epc>
<epc>urn:epc:id:sgtin:0123456.305513.NN2P266YYXX2</epc>
</childEPCs>

© EVOTEQ | Confidential Page 60 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<action>DELETE</action>
<bizStep>urn:epcglobal:cbv:bizstep:unpacking</bizStep>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
</AggregationEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 37 EPCIS Unpacking Selected Objects Example

5.9.4 Shipping Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda">
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!--Shipping Event-->

© EVOTEQ | Confidential Page 61 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<eventTime>2021-05-31T12:02:25.000Z</eventTime>
<eventTimeZoneOffset>+03:00</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sscc:0123456.0001000516</epc>
</epcList>
<action>OBSERVE</action>
<bizStep>urn:epcglobal:cbv:bizstep:shipping</bizStep>
<disposition>urn:epcglobal:cbv:disp:in_transit</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizTransactionList>
<bizTransaction
type="urn:epcglobal:cbv:btt:desadv">urn:epcglobal:cbv:bt:0123456999995:0105</bizTransaction>
</bizTransactionList>
<extension>
<sourceList>
<source
type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:0123456.99999.1</source>
<source
type="urn:epcglobal:cbv:sdt:location">urn:epc:id:sgln:0123456.99999.1</source>
</sourceList>
<destinationList>
<destination
type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:0333333.00000.0</destination>
<destination
type="urn:epcglobal:cbv:sdt:location">urn:epc:id:sgln:0356787.00040.0</destination>
</destinationList>
</extension>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 38 EPCIS Shipping Example

5.9.5 Shipping Returns Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen="http://tatmeen.ae/epcis/">
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>

© EVOTEQ | Confidential Page 62 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!--Shipping Returns Event-->
<eventTime>2021-05-31T12:02:25.000Z</eventTime>
<eventTimeZoneOffset>+03:00</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sscc:0123456.0001000516</epc>
</epcList>
<action>OBSERVE</action>
<bizStep>urn:epcglobal:cbv:bizstep:shipping</bizStep>
<disposition>urn:epcglobal:cbv:disp:returned</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizTransactionList>
<bizTransaction
type="urn:epcglobal:cbv:btt:desadv">urn:epcglobal:cbv:bt:0123456999995:0105</bizTransaction>
<bizTransaction
type="urn:epcglobal:cbv:btt:rma">urn:epcglobal:cbv:bt:0123456999995:R0602</bizTransaction>
</bizTransactionList>
<extension>
<sourceList>
<source
type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:0123456.99999.1</source>
<destinationList>

© EVOTEQ | Confidential Page 63 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<destination
type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:0333333.00000.0</destination>
<destination
type="urn:epcglobal:cbv:sdt:location">urn:epc:id:sgln:0356787.00040.0</destination>
</destinationList>
</extension>
<tatmeen:reasonCode>R06</tatmeen:reasonCode>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 39 EPCIS Shipping Returns Example

5.9.6 Receiving Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda">
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!-- Receiving Event-->
<eventTime>2019-12-19T11:50:09.000Z</eventTime>

© EVOTEQ | Confidential Page 64 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<eventTimeZoneOffset>+03:00</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sscc:0123456.0001000516</epc>
</epcList>
<action>OBSERVE</action>
<bizStep>urn:epcglobal:cbv:bizstep:receiving</bizStep>
<disposition>urn:epcglobal:cbv:disp:in_progress</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
<bizTransactionList>
<bizTransaction
type="urn:epcglobal:cbv:btt:recadv">urn:epcglobal:cbv:bt:0123456999995:GR1230105</bizTransaction>
</bizTransactionList>
<extension>
<sourceList>
<source
type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:0123456.99999.1</source>
<destinationList>
<destination
type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:0333333.00000.0</destination>
<destination
type="urn:epcglobal:cbv:sdt:location">urn:epc:id:sgln:0356787.00040.0</destination>
</destinationList>
</extension>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 40 EPCIS Receiving Example

5.9.7 Receiving Returns Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda">
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>

© EVOTEQ | Confidential Page 65 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!-- Receiving Returns Event-->
<eventTime>2019-12-19T11:50:09.000Z</eventTime>
<eventTimeZoneOffset>+03:00</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sscc:0123456.0001000516</epc>
</epcList>
<action>OBSERVE</action>
<bizStep>urn:epcglobal:cbv:bizstep:receiving</bizStep>
<disposition>urn:epcglobal:cbv:disp:returned</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
<bizTransactionList>
<bizTransaction
type="urn:epcglobal:cbv:btt:recadv">urn:epcglobal:cbv:bt:0123456999995:GR1230456</bizTransaction>
</bizTransactionList>
<extension>
<sourceList>
<source
type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:0123456.99999.1</source>
<destinationList>

© EVOTEQ | Confidential Page 66 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<destination
type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:0333333.00000.0</destination>
<destination
type="urn:epcglobal:cbv:sdt:location">urn:epc:id:sgln:0356787.00040.0</destination>
</destinationList>
</extension>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 41 EPCIS Receiving Returns Example

5.9.8 Blocking Batch/Lot Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!—Blocking Batch/Lot Event-->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>

© EVOTEQ | Confidential Page 67 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<eventTimeZoneOffset>+03:00</eventTimeZoneOffset>
<epcList/>
<action>OBSERVE</action>
<bizStep>urn:tatmeen:cbv:bizstep:updating</bizStep>
<disposition>urn:tatmeen:cbv:disp:blocked</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
<extension>
<quantityList>
<quantityElement>
<epcClass>
urn:epc:class:lgtin:123456.0000000.TSLT151201
</epcClass>
</quantityElement>
</quantityList>
</extension>
<tatmeen:reasonCode>B05</tatmeen:reasonCode>
<tatmeen:blocked>X</tatmeen:blocked>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 42 EPCIS Blocking LGTIN Example

5.9.9 Blocking Object IDs Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>

© EVOTEQ | Confidential Page 68 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!—Blocking Object IDs Event-->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>
<eventTimeZoneOffset>+03:00</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P2236YDY7</epc>
<epc>urn:epc:id:sscc:0123456.0001018330</epc>
</epcList>
<action>OBSERVE</action>
<bizStep>urn:tatmeen:cbv:bizstep:updating</bizStep>
<disposition>urn:tatmeen:cbv:disp:blocked</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
<tatmeen:reasonCode>B05</tatmeen:reasonCode>
<tatmeen:blocked>X</tatmeen:blocked>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 43 EPCIS Blocking Object IDs Example

5.9.10 Unblocking Batch/Lot Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"

© EVOTEQ | Confidential Page 69 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!—Unblocking Batch/Lot Event-->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>
<eventTimeZoneOffset>+03:00</eventTimeZoneOffset>
<epcList/>
<action>OBSERVE</action>
<bizStep>urn:tatmeen:cbv:bizstep:updating</bizStep>
<disposition>urn:tatmeen:cbv:disp:unblocked</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
<extension>
<quantityList>
<quantityElement>
<epcClass>
urn:epc:class:lgtin:123456.0000000.TSLT151201
</epcClass>
</quantityElement>

© EVOTEQ | Confidential Page 70 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

</quantityList>
</extension>
<tatmeen:blocked>N</tatmeen:blocked>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 44 EPCIS Unblocking LGTIN Example

5.9.11 Unblocking Object IDs Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!—Unblocking Object IDs Event-->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>
<eventTimeZoneOffset>+03:00</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P2236YDY7</epc>

© EVOTEQ | Confidential Page 71 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<epc>urn:epc:id:sscc:0123456.0001018330</epc>
</epcList>
<action>OBSERVE</action>
<bizStep>urn:tatmeen:cbv:bizstep:updating</bizStep>
<disposition>urn:tatmeen:cbv:disp:blocked</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
<tatmeen:blocked>N</tatmeen:blocked>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 45 EPCIS Unblocking Object IDs Example

5.9.12 Sampling Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>

© EVOTEQ | Confidential Page 72 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!-- Decommission - Sample -->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P22376C9A</epc>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P2236YDY7</epc>
<epc>urn:epc:id:sscc:0123456.0001018329</epc>
<epc>urn:epc:id:sscc:0123456.0001018330</epc>
</epcList>
<action>OBSERVE</action>
<bizStep>urn:epcglobal:cbv:bizstep:inspecting</bizStep>
<disposition>urn:epcglobal:cbv:disp:destroyed</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
<tatmeen:reasonCode>S01</tatmeen:reasonCode>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 46 EPCIS Sampling Example

5.9.13 Destruction Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>

© EVOTEQ | Confidential Page 73 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!-- Decommission - Destroyed -->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P22376C9A</epc>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P2236YDY7</epc>
<epc>urn:epc:id:sscc:0123456.0001018329</epc>
<epc>urn:epc:id:sscc:0123456.0001018330</epc>
</epcList>
<action>DELETE</action>
<bizStep>urn:epcglobal:cbv:bizstep:destroying</bizStep>
<disposition>urn:epcglobal:cbv:disp:destroyed</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 47 EPCIS Destruction Example

© EVOTEQ | Confidential Page 74 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.9.14 Damaged Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!-- Decommission - Damaged -->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P22376C9A</epc>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P2236YDY7</epc>
<epc>urn:epc:id:sscc:0123456.0001018329</epc>
<epc>urn:epc:id:sscc:0123456.0001018330</epc>
</epcList>
<action>DELETE</action>
<bizStep>urn:epcglobal:cbv:bizstep:decommissioning</bizStep>
<disposition>urn:epcglobal:cbv:disp:destroyed</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>

© EVOTEQ | Confidential Page 75 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
<tatmeen:reasonCode>D01</tatmeen:reasonCode>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 48 EPCIS Damaged Example

5.9.15 Stolen Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!-- Decommission - Stolen -->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<epcList>

© EVOTEQ | Confidential Page 76 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<epc>urn:epc:id:sgtin:0123456.305512.NP2P22376C9A</epc>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P2236YDY7</epc>
<epc>urn:epc:id:sscc:0123456.0001018329</epc>
<epc>urn:epc:id:sscc:0123456.0001018330</epc>
</epcList>
<action>DELETE</action>
<bizStep>urn:epcglobal:cbv:bizstep:decommissioning</bizStep>
<disposition>urn:epcglobal:cbv:disp:stolen</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 49 EPCIS Stolen Example

5.9.16 Exported Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>
<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>

© EVOTEQ | Confidential Page 77 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!-- Decommission - Exported -->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P22376C9A</epc>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P2236YDY7</epc>
<epc>urn:epc:id:sscc:0123456.0001018329</epc>
<epc>urn:epc:id:sscc:0123456.0001018330</epc>
</epcList>
<action>OBSERVE</action>
<bizStep>urn:epcglobal:cbv:bizstep:decommissioning</bizStep>
<disposition>urn:epcglobal:cbv:disp:non_sellable_other</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 50 EPCIS Exported Example

5.9.17 Lost Example


<epcis:EPCISDocument schemaVersion="1.2" creationDate="2021-01-28T07:21:26Z"
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:cbvmda="urn:epcglobal:cbv:mda"
xmlns:tatmeen=”http://tatmeen.ae/epcis/”>
<EPCISHeader>
<sbdh:StandardBusinessDocumentHeader>
<sbdh:HeaderVersion>1.3</sbdh:HeaderVersion>
<sbdh:Sender>
<sbdh:Identifier Authority="GS1">0123456789005</sbdh:Identifier>
</sbdh:Sender>
<sbdh:Receiver>

© EVOTEQ | Confidential Page 78 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<sbdh:Identifier Authority="GS1">7894561230005</sbdh:Identifier>
</sbdh:Receiver>
<sbdh:DocumentIdentification>
<sbdh:Standard>EPCglobal</sbdh:Standard>
<sbdh:TypeVersion>1.0</sbdh:TypeVersion>

<sbdh:InstanceIdentifier>2f1bdabdfaee464c87e1aeb7e586e6ab</sbdh:InstanceIdentifier>
<sbdh:Type>Events</sbdh:Type>
<sbdh:CreationDateAndTime>2021-05-
31T12:02:05.000Z</sbdh:CreationDateAndTime>
</sbdh:DocumentIdentification>
</sbdh:StandardBusinessDocumentHeader>
</EPCISHeader>
<EPCISBody>
<EventList>
<ObjectEvent>
<!-- Decommission Lost -->
<eventTime>2021-05-31T12:02:11.000Z</eventTime>
<eventTimeZoneOffset>+05:30</eventTimeZoneOffset>
<epcList>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P22376C9A</epc>
<epc>urn:epc:id:sgtin:0123456.305512.NP2P2236YDY7</epc>
<epc>urn:epc:id:sscc:0123456.0001018329</epc>
<epc>urn:epc:id:sscc:0123456.0001018330</epc>
</epcList>
<action>DELETE</action>
<bizStep>urn:epcglobal:cbv:bizstep:decommissioning</bizStep>
<disposition>urn:epcglobal:cbv:disp:inactive</disposition>
<readPoint>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</readPoint>
<bizLocation>
<id>urn:epc:id:sgln:0123456.99999.0</id>
</bizLocation>
</ObjectEvent>
</EventList>
</EPCISBody>
</epcis:EPCISDocument>
Table 51 EPCIS Lost Example

© EVOTEQ | Confidential Page 79 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

5.10 EPCIS Message Technical Response Examples


5.10.1 Success
<?xml version="1.0" encoding="UTF-8" ?>
<Response>
<statustype>I</statustype>
<code>202</code>
<date>2021-07-20T09:36:47.127Z</date>
<messageid>660d45b4-360c-51b5-8645-1192e09ac44c</messageid>
<status>
<reason> Message accepted for Tatmeen Processing, the message status can be viewed in the message
status query</reason>
<code>I001</code>
</status>
</Response>
Table 52 Success Example

5.10.2 Connectivity Error


<?xml version="1.0" encoding="UTF-8" ?>
<Response>
<statustype>E</statustype>
<code>500</code>
<date>2021-07-20T09:36:47.127Z</date>
<messageid>660d45b4-360c-51b5-8645-1192e09ac44c</messageid>
<status>
<reason>Tatmeen applications not reachable, try later </reason>
<code>E001</code>
</status>
</Response>
Table 53 Connectivity Error Example

5.10.3 System Error


<?xml version="1.0" encoding="UTF-8" ?>
<Response>
<statustype>E</statustype>
<code>500</code>
<date>2021-07-20T09:36:47.127Z</date>
<messageid>660d45b4-360c-51b5-8645-1192e09ac44c</messageid>
<status>
<reason>Invalid Import Permit</reason>

© EVOTEQ | Confidential Page 80 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<code>E003</code>
</status>
</Response>
Table 54 System Error Example

5.10.4 Mapping Error


<?xml version="1.0" encoding="UTF-8" ?>
<Response>
<statustype>E</statustype>
<code>500</code>
<date>2021-07-20T09:36:47.127Z</date>
<messageid>660d45b4-360c-51b5-8645-1192e09ac44c</messageid>
<status>
<reason>Message Validation Error</reason>
<code>E003</code>
</status>
<status>
<reason>Mandatory field SSCC – XXXX length not valid</reason>
<code>E003</code>
</status>
</Response>
Table 55 Mapping Error Example

5.11 EPCIS Message Query Status


The intention is for the Tatmeen system to provide the message status for EPCIS
messages technically accepted by the Tatmeen.
The Distributor sends a query message to the Tatmeen solution to determine the status
they have sent to the Tatmeen solution.
The response from the Tatmeen solution provides a series of system log entries that are
shared with the technical user of the sending party.
The response is an overall status for the messages, followed by a list of the log responses
from the Tatmeen solution. These response are organised into a response list to publish
the Tatmeen solution responses to the message received by that system.
There are two elements in each entry of the status log response:
• Log type
• Log Message

© EVOTEQ | Confidential Page 81 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

Type Meaning

S Successful

W Successful with Warnings

E Application Error

A Technical Error

C Cancelled

U Unknown
Table 56 Message Status Query Types

5.11.1 Message Status Query


<?xml version="1.0" encoding="utf-8"?>
<tatmeenMsgStatusQuery>
<language>E</language>
<instanceIdentifier>52540081D8101edA8FA0FF68B3CA74E3</instanceIdentifier>
</tatmeenMsgStatusQuery>
Table 57 Message Status Query Example

5.11.2 Message Status Query Response


<?xml version="1.0" encoding="UTF-8" ?>
<tatmeenResponse>
<instanceIdentifier>52540081D8101edA8FA0FF68B3CA74E3</instanceIdentifier>
<messagestatus>A - Technical Error</messagestatus>
<logList>
<log>
<type>A</type>
<message>Object Event failed, all changes in the event have been reverted</message>
</log>
<log>
<type>E</type>
<message>Event on 18.11.2021 12:02:11 failed. (1)</message>
</log>
<log>
<type>E</type>
<message>Activity packing is invalid as object does not exist</message>
</log>
<log>

© EVOTEQ | Confidential Page 82 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<type>I</type>
<message>Invalid object: 123456.3111113.ASADSFSDSRT(SGTIN)</message>
</log>
</logList>
</tatmeenResponse>
Table 58 Message Query Response Example

5.12 Product Verification Service


The Tatmeen system provides a product verification service where the Distributor sends
a query message to the Tatmeen solution to determine the status of an object (SGTIN or
SSCC) that are located at the Distributor’s facility.
The response from the Tatmeen solution provides a confirmation of the object ID and the
current status of the successfully queried object.

5.12.1 SGTIN Product Verification Query


<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
<env:Header/>
<env:Body>
<ProductVerificationRequest>
<GeoLatitude/>
<GeoLongitude/>
<Language>E</Language>
<ProductID>urn:epc:id:sgtin:6295000041.055.01118926886313825</ProductID>
</ProductVerificationRequest>
</env:Body>
</env:Envelope>
Table 59 SGTIN Product Verification Query Example

5.12.2 SSCC Product Verification Query


<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
<env:Header/>
<env:Body>
<ProductVerificationRequest>
<GeoLatitude/>
<GeoLongitude/>
<Language>E</Language>
<ProductID> urn:epc:id:sscc:6033923.1189268863</ProductID>
</ProductVerificationRequest>
© EVOTEQ | Confidential Page 83 of 88
Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

</env:Body>
</env:Envelope>
Table 60 SGTIN Product Verification Query Example

5.12.3 Product Verification Success Response


<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap:Header/>
<soap:Body>
<ProductVerificationResponse>
<ProductDetails>
<ProductID>(01)06295000041557(21)01118926886313825</ProductID>
<GLN>6295000041663</GLN>
<LocationName>AL Taweelah Medical Center</LocationName>
<LocationNumber>
<RegulationAuthority>DHCC</RegulationAuthority>
<RegulationLicense>132</RegulationLicense>
</LocationNumber>
<GeoLongitude>25.111144586569</GeoLongitude>
<GeoLatitude>55.280821232987</GeoLatitude>
<ProductDescription>LacArte Splash EDO 100mg LacArte Splash EDO 100mg</ProductDescription
>
<LotNumber>PKY11417</LotNumber>
<DateOfManufacture>2023-05-24</DateOfManufacture>
<DateOfExpiry>2022-01-15</DateOfExpiry>
</ProductDetails>
<ProductStatusList>
<ProductStatus>
<Status>Active</Status>
</ProductStatus>
<ProductStatus>
<Status>Status 2</Status>
</ProductStatus>
</ProductStatusList>
</ProductVerificationResponse>
</soap:Body>
</soap:Envelope>
Table 61 Product Verification Success Response Example

5.12.4 Product Verification Error Response


<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">

© EVOTEQ | Confidential Page 84 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version : 3.0

<soap:Header/>
<soap:Body>
<ProductVerificationResponse>
<LogList>
<Log>
<Type>E</Type>
<code>E016</code>
<Message>ID urn:epc:id:sgtin:6295000041.055.01118926886314825 is not verified successfully!.
</Message>
</Log>
</LogList>
</ProductVerificationResponse>
</soap:Body>
</soap:Envelope>
Table 62 Product Verification Error Response Example

© EVOTEQ | Confidential Page 85 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version: 3.0

6 EPCIS Message Summary


Action Business Transaction Business
Field Event Type EPC(List) Business Step Disposition Read Point
Type Type Location
Activity
XML Tag variable <action> variable <bizstep> <disposition> <bizTransactionType> <readPoint> <bizLocation>
Dimension EVENT WHAT WHY WHERE
Registering serialised <epc>
<ObjectEvent> ADD commissioning active sgln sgln
object sgtin; sscc
<parentID>
sgtin; sscc
Aggregation - packing <AggregationEvent> ADD packing sgln sgln
<epc>
sgtin; sscc
<parentID>
Aggregation -
<AggregationEvent> DELETE sgtin; sscc unpacking sgln sgln
unpacking
<epc> null
<epc>
Shipping <ObjectEvent> OBSERVE shipping in_transit desadv sgln
sgtin; sscc
<epc> desadv
Shipping Return <ObjectEvent> OBSERVE shipping returned sgln
sgtin; sscc rma
<epc>
Receiving <ObjectEvent> OBSERVE receiving in_progress recadv sgln sgln
sgtin; sscc
<epc>
Receiving Returns <ObjectEvent> OBSERVE receiving returned recadv sgln sgln
sgtin; sscc
<epc>
Blocking <ObjectEvent> OBSERVE sgtin; sscc updating blocking sgln sgln
lgtin
<epc>
Unblocking <ObjectEvent> OBSERVE updating unblocking sgln sgln
sgtin; sscc

© EVOTEQ | Confidential Page 86 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version: 3.0

Action Business Transaction Business


Field Event Type EPC(List) Business Step Disposition Read Point
Type Type Location
Activity
XML Tag variable <action> variable <bizstep> <disposition> <bizTransactionType> <readPoint> <bizLocation>
Dimension EVENT WHAT WHY WHERE
lgtin
<epc>
Sample <ObjectEvent> OBSERVE inspecting destroyed sgln sgln
sgtin; sscc
<epc>
Destroyed <ObjectEvent> DELETE destroying destroyed sgln sgln
sgtin; sscc
<epc>
Damaged <ObjectEvent> DELETE decommissioning destroyed sgln sgln
sgtin; sscc
<epc>
Stolen <ObjectEvent> DELETE decommissioning stolen sgln sgln
sgtin; sscc
<epc>
Export <ObjectEvent> OBSERVE decommissioning non_sellable_other sgln sgln
sgtin; sscc
<epc>
Lost <ObjectEvent> OBSERVE decommissioning inactive sgln sgln
sgtin; sscc
Table 63 Summary of EPCIS Message Constant Values

NOTES:
1. The Action Types apply to the actions being applied to the EPCs in the ‘WHAT’ dimension above.
2. The ‘WHEN’ and ‘EXTENSION’ dimensions are omitted from this table for simplicity.

© EVOTEQ | Confidential Page 87 of 88


Technical Guide for Logistics

Document ID : Tatmeen_WKI-0064_Technical Guide for Logistics_v3.0

Version: 3.0

7 Glossary
General short terms and abbreviations can be found in the Global Glossary (see
references).
Short Term Description

3PL 3rd Party Logistics

API Application Programming Interface

EPCIS Electronic Product Code Information Services

ESB Enterprise Service Bus

GTIN Global Trade Item Number

HTTP(s) Hypertext Transfer Protocol

Item Level Master Data is the GS1 EPCIS master data extension segment within
ILMD
the product item commissioning event.

MAH Marketing Authorization Holder

REST Representational State Transfer

SC Supply Chain

SGTIN Serialized Global Trade Item Number

Single Point of Contact, being the individual in a business partner organisation


SPOC
responsible for managing the interactions with the Tatmeen system.

SSCC Serial Shipping Container Code

Coordinated Universal Time, which is the time standard commonly used across the
UTC
world.

VPN Virtual Private Network

WSDL Web Service Definition Language

XML Extensible Markup Language


Table 64 Glossary

© EVOTEQ | Confidential Page 88 of 88

You might also like