Product Release Guidelines (XML)

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

Message Type: SOM_PRODUCT_RELEASE.

Info Exchange Display Name: Product Release

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:SOMProductReleaseMessage [1...1]
[-]		 - Required. This is the root element of the Product Release message.
  som:ControlFileHeader [1...1]
[-]		 - Required. The ControlFileHeader element is where the message document's header information resides.
    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/20]		 String Required. This field indicates the message’s unique file control ID number. A file control ID number is mandatory for all messages. *3
    cmn:FileDate [1...1]
[10/10]		 Date Required. This field indicates the date that the message is sent. The date is in YYYY-MM-DD format when generated in XML. *4
    cmn:FileTime [1...1]
[8/8]		 Time Required. This field indicates the time that the message is sent. The date is in HH:MM:SSZ format when generated in XML. 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 contains the main contents of the message.
    cmn:LocationId [0...1]
[0/34]		 String This value specifies the identifier of the facility/warehouse to scope the Product Release status update for the serial numbers matching the specified item code and lot number, only at the specified location. If the location is omitted, the Product Release status update will be applied globally to all matching serial numbers in the system. *6
    choice%1 - Choice Required. One of the following options must be chosen, but not both.
  • Option 1: cmn:InternalMaterialCode
  • Option 2: cmn:CountryDrugCode
    cmn:InternalMaterialCode [0...1]
[1/*]		 String Conditionally required if cmn:CountryDrugCode is not populated. This is Option 1 for the MessageBody. It is used to identify the product using the internal material number configured in the Product Master Data. Specifying an internal material number will update all serial numbers at all packaging levels (e.g. item, case) that are linked to the internal material number and specified lot number. *7
    cmn:CountryDrugCode [0...1]
[1/*]		 String Conditionally required if cmn:InternalMaterialCode is not populated. Option 2 for the MessageBody. Use to identify the product using the national drug code (e.g. NDC, Swissmedic, PZN) configured in Product Master Data. Specifying a national drug code updates all serial numbers at all packaging levels (e.g. item, case) that are linked to the national drug code and specified lot number. See CountryDrugCode for acceptable country codes. *8
      @type [1...1]
[1/*]		 String Required. The country drug code type.

See the CountryDrugCode enumeration list for valid values.
    cmn:LotNumber [1...1]
[1/*]		 String Required. The lot number associated with the cmn:InternalMaterialCode or cmn:CountryDrugCode specified above to identify the serial numbers to be updated. *9
    cmn:QualityControlEntityId [0...1]
[0/*]		 String Conditionally required if bizTransactionList in the ObjectEvent for Product Release Events is populated, or if at least one Target Market in Product Master Data = "RU" and the lot was commissioned outside of Russia. Business or location identifier for the entity responsible for quality control. *10
      @type [1...1]
[1/*]		 String Required. Business or location type of the quality control entity identifier. *11

See the BusinessAndlocaitonId enumeration list for valid values.
    cmn:TransactionIdentifier [0...*]
[0/*]		 String The transaction identifier associated with the released product. *12
      @type [1...1]
[1/*]		 String Required. The transaction identifier type. Valid values: *13
  • CERTIFICATECONFORMITY
  • CIVILCIRCULATION
  • DECLARATIONCONFORMITY
  • STATECONFIRMATION
      @date [0...1]
[0/*]		 Date Required. The transaction identifier date in YYYY-MM-DD format. *14
    cmn:EventDateTime [0...1]
[0/*]		 DateTime Timestamp of the date and time of the product release with the UTC time zone indicator in XML YYYY-MM-DDTHH:MM:SS:mmZ format. *15
    cmn:ProductionQuantity [0...*]
[-]		 - Production quantity element group.
      choice1 [1...1]
[-]		 Choice Required. Choice element of either cmn:PackagingItemCode or cmn:CompanyPrefix.
      cmn:PackagingItemCode [0...1]
[0/*]		 String Conditionally required if cmn:CompanyPrefix is not populated. Option 1 for choice1. Identifies the product using the packaging level item code configured in Product Master Data. *16
        @type [0...1]
[0/*]		 String Required. Packaging item code type. *17

See the ItemCode enumeration list for valid values.
      cmn:CompanyPrefix [0...1]
[0/*]		 String Conditionally required if cmn:PackagingItemCode is not populated. Option 2 for choice1. Identifies the company prefix assigned by GS1 for the released product. *18
      cmn:PackagingLevel [1...1]
[1/*]		 String Required. The packaging level of the commissioned item. *19

See the PackagingLevel enumeration list for valid values.
      cmn:QuantityReported [1...1]
[-]		 Integer Required. Reported quantity of the released product. *20