Set Event Response Guidelines

companyID

1...1
1/*

String

Required. The TraceLink-generated company identifier of the user reporting the supply chain activity. In a multi-tenant system, this represents the identifier of the company that owns, can report, and can query the Smart Event Manager request and response data.

userId

1...1
1/*

String

Required. The TraceLink-generated user identifier of the operator user reporting the supply chain activity. This user is authenticated in order to report and query Smart Event Manager request and response data.

eventQueryResponseId

1...1
1/*

String

Required. The TraceLink-generated identifier from the Set Event Response providing the search criteria for the Get Result Request.

eventTime

1...1
1/*

String

Required. The date/time the Set Event occurred. Specifically, this may indicate when the physical scan is performed or the date and time provided by the calling application.

serialNumberList

1...1
1/*

String

Required. The serialized product associated with the Smart Event Manager event request. The Set Event request API supports the reporting of either one serial number (processed synchronously) or multiple serial numbers (processed asynchronously).

At minimum, the Smart Event Manager Event Request API requires the following:

packagingCode
serialNumber
lotNumber
expirationDate

packagingCode

1...1
1/*

String

Required. The packaging code of the serialized product. Supports GTIN-14, NTIN, or CN-RESCODE.

This may correspond to the GS1 Application Identifier 01 if the packagingCode represents a GTIN-14 or NTIN.

packagingCodeType

0...1
0/*

String

The type of the serialized product packagingCode. The default value is GTIN-14.

See the PackagingCodeType enumeration list for valid values.

serialNumber

1...1
1/*

String

Required. The serial number associated with the serialized product. This is specified in the GS1 Application Identifier format without parentheses for the AI keys. AI (01) (21) formatted serial numbers for GTINs. Non-GS1 serial numbers (e.g. China) are expressed in native format.

This corresponds to the GS1 Application Identifier 21.

lotNumber

1...1
1/*

String

Required. The lot or batch code associated with the serialized product.

This corresponds to the GS1 Application Identifier 10.

expirationDate

1...1
1/*

String

Required. Indicates the expiration date of the serialized product in YYMMDD format and corresponds to the GS1 Application Identifier 17 as originally reported in the request message. The element supports the value 00 for the DD element.

adjustedExpirationDate

1...*
1/*

String

Required. Provides a normalized expiration date with the day value set to the last day of the month.

productionDate

0...1
0/*

Date

The production date associated with the serialized product. This is specified in YYMMDD format.

This corresponds to the GS1 Application Identifier 11.

variant

0...1
0/*

String

The internal product variant associated with the serialized product.

This corresponds to the GS1 Application Identifier 20.

activePotency

0...1
0/*

String

The active potency associated with the serialized product.

This corresponds to the GS1 Application Identifier 7004.

nhrnPZN

0...1
0/*

String

The National Healthcare Reimbursement Number for the Germany PZN associated with the serialized product.

This corresponds to the GS1 Application Identifier 710.

nhrnCIP

0...1
0/*

String

The National Healthcare Reimbursement Number for the French CIP associated with the serialized product.

This corresponds to the GS1 Application Identifier 711.

nhrnCN

0...1
0/*

String

The National Healthcare Reimbursement Number for the Spain Codigo Nacional associated with the serialized product.

This corresponds to the GS1 Application Identifier 712.

nhrnDRN

0...1
0/*

String

The National Healthcare Reimbursement Number for the Brasil ANVISA associated with the serialized product.

This corresponds to the GS1 Application Identifier 713.

nhrnAIM

0...1
0/*

String

The National Healthcare Reimbursement Number for the Portugal AIM associated with the serialized product.

This corresponds to the GS1 Application Identifier 714.

barcode

0...1
0/*

String

The full 2D barcode content of the product scan. At minimum this contains:

packagingCode
serialNumber
lotNumber
expirationDate

This field should include the full raw DataMatrix content in the native GS1 Element String, with FNC1 (codeword 232) symbol character separators preserved so the system can parse variable length data elements accurately. For more information, see Section 2.2. GS1 Element Strings of GS1 Data Matrix Guide — Introduction and Implementation Guideline, version 2.2, published May 2015.

containerID

0...1
0/*

String

The container identifier for the relevant serialNumber.

containerType

0...1
0/*

String

Conditionally required if containerID is present. The type of the serialized product containerId. This may be one of the following:

GTIN-14
SSCC

eventId

1...*
1/*

String

Required. TraceLink-generated identifier relating to the Smart Event Manager Set Event Request. Use this ID in the Get Event or Query Event (not in the Get Result message) to return all of the information related to the request.

responseEventId

1...*
1/*

String

Required. TraceLink-generated identifier relating to the Smart Event Manager Set Event Response. TraceLink use only.

status

1...*
1/*

String

Required. TraceLink-generated status name/value pair indicating the status of the request as determined by a called service. For example, an NMVS Service may indicate that the serial number is successfully verified. This service uses the status name/value pair to convey this result. The called service always returns a status.

See the SerialNumberStatus enumeration list for valid values.

message

1...*
1/*

String

Required. TraceLink-generated message name/value pair indicating additional information associated with the status. For example, an NMVS Service may indicate that the serial number was not successfully verified. This service uses the message name/value pair to further describe the result.

state

1...*
1/*

String

Required. TraceLink-generated state name/value pair indicating the state of the serial number included in the request. For example, an NMVS Service may indicate that the serial number is in a SUPPLIED state. Expect that the called service will always return a state.

respondingCompany

0...1
1/*

String

The GLN identifier of the company that provides the verification response.

eventType

1...1
1/*

String

Required. The nature of the Smart Event Manager event request. As a generic observation API, the Smart Event Manager message captures a variety of supply chain and compliance activities.

See the EventType enumeration list for valid values.

locationType

1...1
1/*

String

Required. The type of the associated locationValue for the serialized product event.

See the LocationType enumeration list for valid values.

locationValue

1...1
1/*

String

Required. The location where the reported supply chain activity takes place.

extensionData

1...1
1/*

String

Required. Supports a number of name/value pairs for reporting various supply chain and compliance activities.

The extensionData section may contain 0-n name/value pairs. TraceLink reserves these name/value pairs for use in the subsequent synchronous processing for the event. The extensionData is stored in the Smart Event Manager repository.

market

1...1
1/*

String

Required. A name/value pair that indicates the country where the reported event activity occurs. Must be a 2-letter ISO Code of thecountry where event occurs.

See the CountryCode enumeration list for valid values.

supplyType

0...1
0/*

String

A name/value pair that indicates a description of the compliance/supply chain activity. Use this to describe shipment activity.

See the SupplyType enumeration list for valid values.

po

0...1
0/*

String

The Purchase Order associated with the serial numbers in serialNumberList.

salesOrder

0...1
0/*

String

The Sales Order associated with the serial numbers in serialNumberList.

return

0...1
0/*

String

The Return Order associated with the serial numbers in serialNumberList.

transfer

0...1
0/*

String

The Transfer Order associated with the serial numbers in serialNumberList.

asn

0...1
0/*

String

The Advance Shipped Notice associated with the serial numbers in serialNumberList.

bol

0...1
0/*

String

The Bill of Lading associated with the serial numbers in serialNumberList.

packslip

0...1
0/*

String

The Packing Slip associated with the serial numbers in serialNumberList.

invoice

0...1
0/*

String

The Invoice associated with the serial numbers in serialNumberList.

destruction

0...1
0/*

String

The Destruction Order associated with the serial numbers in serialNumberList.

notaFiscal

0...1
0/*

String

The Nota Fiscal associated with the serial numbers in serialNumberList.

scriptId

0...1
0/*

String

The Script ID associated with the serial numbers in serialNumberList.

fromBusinessParty

0...1
0/*

String

Conditionally required if fromBusinessPartyType is present. The identifier of the company where the serialized product ships to. Use with fromBusinessPartyType, which provides the identifier type.

The fromBusinessParty element is typically used with a SHIPPED, UNDO_SHIPPED, RECEIVED, or UNDO_RECEIVED event.

fromBusinessPartyType

0...1
0/*

String

Conditionally required if fromBusinessParty is present. A name/value pair that indicates the identifier type of the fromBusinessParty.

See the CompanyType enumeration list for valid values.

toBusinessParty

0...1
0/*

String

Conditionally required if toBusinessPartyType is present. A name/value pair that indicates the identifier of the company that receives serialized product. Use with the toBusinessPartyType, which provides the identifier type.

The toBusinessParty element is typically used with a SHIPPED, UNDO_SHIPPED, RECEIVED, or UNDO_RECEIVED event.

toBusinessPartyType

0...1
0/*

String

Conditionally required if toBusinessParty is present. A name/value pair that indicates the identifier type of the toBusinessParty.

See the CompanyType enumeration list for valid values.

userID

0...1
0/*

String

A name/value pair that indicates the email address of the user reporting the event.

status

0...1
0/*

String

TraceLink-generated status name/value pair indicating the status of the request as determined by a called service. For example, an NMVS Service indicates that the serial number is successfully verified. This service uses the status name/value pair to convey this result. Expect that the called service always returns a status.

See the ExtensionStatus enumeration list for valid values.

customData

0...*
0/*

String

The customData section supports a number of name/value pairs to support the reporting of various supply chain and compliance activities.

The customData section may contain 0-n name/value pairs. These name/value pairs are user-defined and is not used in the subsequent synchronous or asynchronous processing for the event. The data in the customData section is stored in the Smart Event Manager repository.

contactPoint

1...1
1/*

String

Required. The responding company's verification contact information who can be contacted if the company requesting the product verification has questions about that response.

TraceLink automatically includes this information in all response messages.

email

1...1
1/*

String

Required. The email address of the verification contact.

This information is displayed only in the Response section of the Product Information Exchange's Verify Product screen.

TraceLink automatically includes this information in all response messages.

telephone

1...1
1/*

String

Required. The phone number of the verification contact.

This information is displayed only in the Response section of the Product Information Exchange's Verify Product screen.

TraceLink automatically includes this information in all response messages.