Get Event Response Guidelines

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

The following is the Get Event Response guidelines table:

Data Element Occurs
Length
Type Description
eventTime [1...1]
[1/*]
DateTime Required. The date/time when the Set Event occurred. Specifically, this may indicate when the physical scan is performed or may indicate the date and time that the calling application has provided.
packagingCode [1...1]
[1/*]
String

Required. The packaging code of the serialized product. This is specified as a string formatted to support 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 associated packagingCode of the serialized product. If this is not specified, the value defaults to 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 [0...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 CN CIP 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 DRN 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 populated. The type of the associated containerID of the serialized product. This may be one of the following:

  • GTIN-14
  • SSCC
status [0...1]
[0/*]
String

Required. The status name/value pair indicates 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 Status enumeration list for valid values.

message [0...1]
[0/*]
String A name/value pair that indicates 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 [0...1]
[0/*]
String

Required. A name/value pair that indicates 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 always returns a state.

See the State enumeration list for valid values.

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.

Valid value: VERIFYING

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.
market [1...1]
[1/*]
String

Required. A name/value pair that indicates the country where the reported event activity occurs. This element must be a 2 letter ISO Code of country where the 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 supply chain/compliance activity. This element typically describes 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 populated. The identifier of the company where the serialized product ships to. Use with fromBusinessPartyType, which provides the identifier type.

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

fromBusinessPartyType [0...1]
[0/*]
String

Conditionally required if fromBusinessParty is populated. The identifier type of the fromBusinessParty.

See the CompanyType enumeration list for valid values.

toBusinessParty [0...1]
[0/*]
String

Conditionally required if toBusinessPartyType is populated. The identifier of the company that receives serialized product. Use with toBusinessPartyType, which provides the identifier type.

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

toBusinessPartyType [0...1]
[0/*]
String

Conditionally required if toBusinessParty is populated. The identifier type of the toBusinessParty.

See the CompanyType enumeration list for valid values.

userID [0...1]
[0/*]
String The email address of the user reporting the event.