Registration Guidelines (XML)
See How To Use this Guide before interpreting the guidelines below.
Message Type: SOM_REGISTRATION
Info Exchange Display Name: Serialized Operations Manager - Registration
When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.| Data Element | Occurs Length |
Type | Description | |||||
|---|---|---|---|---|---|---|---|---|
| som:SOMRegistrationMessage | 1...1 - |
- | Required. Root data element | |||||
| som:ControlFileHeader | 1...1 - |
- | Required. The message document's header information. | |||||
| cmn:FileSenderNumber | 1...1 1/20 |
String | Required. The company identifier of the file’s sender.1 | |||||
| cmn:FileReceiverNumber | 1...1 1/20 |
String | Required. The company identifier of the file’s recipient.2 | |||||
| cmn:FileControlNumber | 1...1 1/* |
String | Required. The message’s unique file control ID number. A file control ID number is mandatory for all messages.3 | |||||
| cmn:FileDate | 1...1 1/* |
Date | Required. The date that the message is sent in YYYY-MM-DD format. Date and times must be in GMT.4 | |||||
| cmn:FileTime | 1...1 1/* |
Time | Required. Time file generated in XML in HH:MM:SSZ format. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z.5 |
|||||
| som:MessageBody | 1...1 - |
- | Required. The Message Body includes all of the Serialized Operations Manager Registration message details including, but not restricted to, location, packaging level, and item status. | |||||
| cmn:ItemRegistration | 1...* - |
- | Required. Looping element group in which one or more products are submitted for registration. | |||||
| cmn:EventDateTime | 0...1 0/* |
DateTime |
Timestamp of the date and time of the registration event with the UTC time zone indicator in YYYY-MM-DDThh:mm:ss.sZ format. 6 If not present, the system defaults to the current GMT date/time. |
|||||
| cmn:EventTimeZoneOffset | 0...1 6/6 |
String | The time zone offset in effect where the registration occurs.7 If not present, the system defaults to the current GMT date/time. |
|||||
| cmn:EventLocation | 0...1 0/* |
String | Business or location identifier for the entity where the registration occurs.8 | |||||
| cmn:EventLocationType | 0...1 0/* |
String | Business or location type for the entity where the registration occurs.9 See the BusinessAndLocationId enumeration list for valid values. |
|||||
| cmn:PackagingLevel | 0...1 0/* |
String | The packaging level associated with the serial number.10 See the PackagingLevel enumeration list for valid values. |
|||||
| cmn:InternalMaterialCode | 0...1 1/* |
String | The internal material code for the product.11 | |||||
| cmn:ItemCode | 0...1 1/* |
String | The packaging level item code for the product.12 | |||||
| @type | 1...1 0/* |
String | Required. Identifies the packaging level item code type.13 See the ItemCode enumeration list for valid values. |
|||||
| cmn:MarketCountryCode | 0...1 2/2 |
String | The country in which the product is being registered using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.14 See the ISOCountryCode enumeration list for valid values. |
|||||
| cmn:CountryDrugCode | 0...1 1/* |
String | The national drug code associated with the serial number at the time of registration.15 | |||||
| @type | 0...1 0/* |
String | Required. The national drug code type using the supported enumeration values and any formatting instructions provided. 16 See the CountryDrugCode enumeration list for valid values. |
|||||
| cmn:LotNumber | 0...1 0/* |
String | Conditionally required if Serial | @format= "AI(01)+AI(21)". The lot number associated with the serial number at the time of registration.17 | |||||
| cmn:ExpirationDate | 0...1 0/* |
Date | Conditionally required if Serial | @format= "AI(01)+AI(21)". The expiration date associated with the serial number at the time of registration in YYYY-MM-DD format. 18 | |||||
| cmn:ManufacturingDate | 0...1 0/* |
Date | The manufacturing date associated with the serial number at the time of registration in YYYY-MM-DD format.19 | |||||
| cmn:ReferenceDocuments | 0...1 - |
- | The reference document identifier associated with the registering activity. | |||||
| cmn:PONumber | 0...1 0/* |
String | The PO number associated with the serial number.20 | |||||
| cmn:POLine | 0...1 0/* |
String | The PO line number associated with the serial number.21 | |||||
| cmn:WorkOrderNumber | 0...1 0/* |
String | The work order number associated with the serial number. | |||||
| cmn:ReferenceIdentifier | 0...1 0/* |
String | The reference identifier associated with the serial number.22 | |||||
| cmn:NumberList | 1...1 - |
– | The list of one or more serial numbers to be registered. | |||||
| cmn:Serial | 1...* 1/* |
String | Required. The serial number to be registered expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs. Non-GS1 serial numbers (e.g. CN-EDMC) are expressed in native format.23 | |||||
| @companyPrefix | 0...1 0/* |
String | The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.24 | |||||
| @filterValue | 0...1 0/* |
String | The filter value used in GTIN-14 and SSCC serial numbers.25 | |||||
| @format | 0...1 0/* |
String | Identifies the serial number format. Valid values includes:26
|
|||||
| cmn:ItemStatus | 0...1 0/* |
String | The status of the product being registered. 27 See the ItemStatus enumeration list for valid values. |
|||||
| cmn:ExtensionField | 0...* - |
- | Extension to pass one or more name value pairs containing additional data attributes that are not already supported in this message. | |||||
| cmn:FieldName | 1...1 1/* |
String | Required. The field name provided by the trade partner that receives the outbound message. 28 | |||||
| cmn:FieldValue | 1...1 1/* |
String | Required. The field value that corresponds to the cmn:FieldName.29 | |||||
