Product Master Data Guidelines (XML)
See How To Use this Guide before interpreting the guidelines below.
Message Type: MDX_PRODUCT_MASTER
Info Exchange Display Name: Product Master Data


Data Element | Occurs Length |
Type | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
mdx:MDXProductMasterMessage | - |
1...1- | Required. Root element of message. | ||||||
mdx:ControlFileHeader | - |
1...1- | Required. XML file control header record. | ||||||
cmn:FileSenderNumber | 1/20 |
1...1String | Required. File sender's company identifier.1 | ||||||
cmn:FileReceiverNumber | 1/20 |
1...1String | Required. File recipient's company identifier.2 | ||||||
cmn:FileControlNumber | 1/* |
1...1String | Required. Unique file control ID number.3 | ||||||
cmn:FileDate | 10/10 |
1...1Date | Required. Date file generated in XML YYYY-MM-DD format.4 | ||||||
cmn:FileTime | 9/9 |
1...1Time | Required. Time file generated in XML HH:MM:SSZ format (must be GMT).5 | ||||||
mdx:MessageBody | - |
1...1- | Required. Main body of message. | ||||||
mdx:ProductMasterItem | - |
1...*- | Required. Captures the full master data record for a product. This is a repeating element to enable the ability to provide data for each product in a single message. When providing updates to existing product master data, a full master data dump is not required. Only the product master data records for products whose master data has changed need to be submitted. However, when submitting a change record, the entire product record should be submitted. | ||||||
cmn:PrimaryItemCode | 1/* |
1...1String | Required. Primary product identifier that is used as the key for updating the product master data record. 6 | ||||||
@type | 1/* |
1...1String |
Required. Attribute identifies the item code types and includes same values as above. 7 See the ItemCodeType enumeration list for valid values. |
||||||
cmn:NewPrimaryItemCode | 0/* |
0...1String | New primary product identifier to replace the original primary identifier, which will be used as the new key for updating the product master data. 8 | ||||||
@type | 1/* |
1...1String |
Required. Attribute identifies the item code types and includes same values as above. 9 See the ItemCodeType enumeration list for valid values. |
||||||
cmn:ProductGroupCode | 0/* |
0...1String | Group product code that associates like products together (e.g. group code for all variations of MigraineMed).10 | ||||||
cmn:ProductStatus | 1/* |
1...1String |
Required. Status of product in the marketplace or company. 11 See the ProductStatus enumeration list for valid values. |
||||||
cmn:EffectiveDate | 10/10 |
0...1Date | Date that the master data record became effective in YYYY-MM-DD format.12 | ||||||
cmn:RecordStatus | 1/* |
1...1String |
Required. Indicates if the master data
record status is See the RecordStatus enumeration list for valid values. |
||||||
mdx:AlternateItemCodes | - |
0...1- | A list of one or more alternate item codes used to refer to this product. The regulatory or national drug code should be included if it is not the primary item code. For US NDCs, both the 10-digit NDC and 11-digit NDC542 may be included. If receiving messages from trade partners that could be in different NDC formats, such as ASNs, both NDC formats should be included. Multiple internal material numbers can be provided (useful when different internal systems use different item codes). | ||||||
cmn:AlternateItemCode | 1/* |
1...*String | Required. Alternate product identifier that is used to identify the product.14 | ||||||
@type | 1/* |
1...1String |
Required. Attribute identifies the item code types.15 See the ItemCodeType enumeration list for valid values. |
||||||
@action | 0/* |
0...1String | Attribute defining if the
alternate product identifier should be deleted. The DELETE action will only
occur if explicitly set.16 |
||||||
mdx:TargetMarketList | - |
0...1- |
![]()
|
||||||
mdx:TargetMarket | - |
0...*- |
|
||||||
cmn:CountryMarket | 1/3 |
1...1String |
See the ISOCountryCode enumeration list for valid values. |
||||||
cmn:PointOfDispenseVerificationReqt | - |
0...1Boolean |
![]() true if left blank. |
||||||
cmn:TraceabilityReqt | - |
0...1Boolean |
When cmn:CountryMarket is set to ![]() GB and the product destination is Northern Ireland, this element should be set to true . For compliance purposes, the EU Hub recognizes Northern Ireland as part of the EU.When processing
Transaction History ASNs, the system does not create Transaction Histories
for exempt products if set to ![]() true if left blank. |
||||||
cmn:ProductOrigin | 0/* |
0...1String |
![]() OriginatorExclusiveDistributor indicates that the company that purchased
this product is the Exclusive Distributor of the Product. In this case, the
Exclusive Distributor will set ProductOrigin to be OriginatorExclusiveDistributor ,
and notDirectPurchaseManufacturer , even though the Exclusive Distributor did
purchase from the manufacturer. This will ensure that outbound Transaction
Histories for this product will start with the Exclusive Distributor and not
"continue" the received Transaction History.See the ProductOrigin enumeration list for valid values. |
||||||
cmn:ProductType | 0/* |
0...1String |
![]() When CountryMarket is
For example, only cmn:ProductDescription, cmn:DrugName, and cmn:Manufacturer are required. See the ProductType enumeration list for valid values. |
||||||
cmn:ScheduledDrug | 0/* |
0...1Boolean |
![]() |
||||||
cmn:ManufacturedBy | 0/* |
0...1String |
|
||||||
cmn:ProductionType | 0/* |
0...1String | Identifies the product as an import (Imported ), manufactured locally (LocallyManufactured ), or imported and sub-packed locally (ImportedAndRepackagedLocally ). |
||||||
cmn:MarketingAuthorizationHolderId | 0/* |
0...1String |
![]() ![]() |
||||||
@type | 0/* |
1...1String |
Required. Attribute that identifies the company ID types for the MAH identifier. See the LocationId enumeration list for valid values. |
||||||
cmn:ContractManufacturerId | 0/* |
0...1String | Identifier for the contract manufacturer organization (CMO) in any company identifier type enumerated by the @type attribute. | ||||||
@type | 0/* |
1...1String |
Required. Attribute that identifies the company ID types for the CMO identifier. See the LocationId enumeration list for valid values. |
||||||
cmn:VirtualContractManufacturerId | 0/* |
0...1String | Identifier for the virtual CMO in any company identifier type enumerated by the type attribute. | ||||||
@type | 0/* |
1...1String |
Attribute that identifies the company ID types for the virtual CMO identifier. See the LocationId enumeration list for valid values. |
||||||
cmn:DistributionPartnerId | 0/* |
0...5String |
Identifies the distribution partner. The field is optional as the MAH may not make use of authorized distributors and distribute the products directly in a market. Any Partner Company or Partner Location can be specified but must resolve to a Partner Company or Partner Location configured in Partner Master Data.22 ![]() |
||||||
@type | 1/* |
1...1String |
Required. Identifies the company id types for the distribution partner identifier. See the LocationId enumeration list for valid values. |
||||||
cmn:ProductImage | 0/* |
0...1String | The image of the product, which is uploaded into the DAVA portal, to enable India government to display an image of the product associated with the product data. With a maximum size of 10KB, the image of the product is encoded in base64 format. | ||||||
@mimeType | 0/* |
1...1String |
Mime type of the image from the permitted enumeration list.23 See the ProductImage enumeration list for valid values. |
||||||
@fileName | 0/* |
0...1String | Optional file name of the image.
If the file name is not provided, value defaults to ProductImage.<mimeType> .24 |
||||||
cmn:PCID | 0/* |
0...1String |
Conditionally required if cmn:CountryMarket is an EU country. Packaged Medicinal Product Identifier (PCID). ![]() |
||||||
cmn:ProductCategoryIdentifier | 0/* |
0...1String | Product category identifier. | ||||||
cmn:MAHInternalMaterialCode | 0/* |
0...1String | Internal Material Code that the MAH uses in that Target Market, which may be different than the Internal Material Code on the Item Codes tab. | ||||||
cmn:CMOInternalMaterialCode | 0/* |
0...1String | Internal Material Code that the CMO uses in that Target Market, which may be different than the Internal Material Code on the Item Codes tab. | ||||||
cmn:VCMOInternalMaterialCode | 0/* |
0...1String | Represents the Internal Material Code that the Virtual CMO uses in that Target Market. | ||||||
cmn:ReportingItemCode | 1/* |
0...1String | Reporting item code specified for the product and the associated target market.25 | ||||||
@type | 1/* |
1...1String |
Required. Identifies the reporting code types.26 See the ItemCodeType enumeration list for valid values. |
||||||
cmn:MarketingAuthorizationNumber | 1/* |
0...1String |
The product’s authorization number issued by a government agency. |
||||||
cmn:RegistrationClassification | 1/* |
0...1String |
Registration classification of the product. See the RegistrationClassification enumeration list for valid values. |
||||||
cmn:PrescriptionDrugType | 1/* |
0...1String |
Prescription drug type indicating the nature of the drug, regulations and requirements, accepted medical use, or potential for abuse. See the PrescriptionDrugType enumeration list for valid values. |
||||||
cmn:PermanentImportLicense | 1/* |
0...1String | Registration number of the imported drug license for drugs that cannot be exported and will remain in the country permanently.27 | ||||||
@endDate | 10/10 |
0...1Date | Last valid date for the imported drug license in XML YYYY-MM-DD format.28 | ||||||
cmn:TemporaryImportLicense | 1/* |
0...1String | Registration number of the imported drug license for drugs that will remain in the country temporarily before being re-exported.29 | ||||||
@endDate | 10/10 |
0...1Date | Last valid date for the imported drug license in XML YYYY-MM-DD format.30 | ||||||
cmn:ImporterId | 1/* |
0...1String | Identifier for the company that is importing the product into the target market.31 | ||||||
@type | 1/* |
1...1String |
Required. Attribute identifying the company ID types for the importer identifier. See the CompanyId enumeration list for valid values. |
||||||
cmn:RepackagingLicenseNumber | 1/* |
0...1String | Repackaging license number. For imported drugs, this is the unique proprietary number of a specific drug produced by a domestic manufacturer, then reviewed and approved by regulatory authorities.32 | ||||||
@endDate | 10/10 |
0...1Date | The repackaging license number end date in YYYY-MM-DD format.33 | ||||||
cmn:RepackagerId | 1/* |
0...1String |
Identifier for the drug repackaging organization. Examples of repackaging include:34
|
||||||
@type | 1/* |
1...1String |
Required. Attribute identifying the company ID types for the sub-packager identifier. See the CompanyId enumeration list for valid values. |
||||||
mdx:DeleteTargetMarket | - |
0...1- | Populate this element only to delete one or more entire market entries from the master data record. It deletes the cmn:CountryMarket and the associated cmn:PointOfDispenseVerification and US Traceability requirement elements. | ||||||
cmn:CountryMarket | 1/3 |
1...*String | Required. The country using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.35 | ||||||
mdx:ExportMarketList | - |
0...1- | List of export to and export from countries including any exemption data. | ||||||
mdx:ExportMarket | - |
0...*- | Indicates the cmn:ExportFromCountry and cmn:ExportToCountry along with exemption data and pricing information. | ||||||
cmn:ExportFromCountry | 0/3 |
1...1String |
Required. The country port where the product is shipped (from the seller to a buyer that is abroad). The country is identified using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. See the ISOCountryCode enumeration list for valid values. |
||||||
cmn:ExportToCountry | 0/3 |
0...1String |
The country where the exported products are being received. The country is identified using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. See the ISOCountryCode enumeration list for valid values. |
||||||
cmn:UnitPrice | 1/* |
0...1Decimal | Price per unit of the product in the target market. The currency symbol should not be provided. The decimal separator must be a period (. ). There is no restriction on the number of places after the decimal point to support countries that may use three positions. Thousands separator must be omitted.36 |
||||||
@currencyCode | 3/3 |
1...1String |
Required. The currency code in ISO 4217:2015 format. See the ISOCurrencyCode enumeration list for valid values. |
||||||
cmn:TargetMarketExemption | 0/* |
0...1Boolean | Indicates whether the exported product is exempted from complying with the local regulations of the country of the manufacturer in order to comply with regulations of target market that will be importing the drug. | ||||||
cmn:ExportCountryExemptionCode | 1/* |
0...1String |
Specifies the exemption category code for exempted product with the enumeration values. See the ExportCountryExemptionCode enumeration list for valid values. |
||||||
cmn:TargetMarketExemptionReference | 0/* |
0...1String | The name of the law or regulation in the destination country for which the exporter has obtained exemption permission. | ||||||
cmn:TargetMarketExemptionDate | 0/* |
0...1Date | Specifies the date the exemption request is granted to the exporter by the governing agency of the destination country (can be the date of the published law). | ||||||
cmn:ManufacturedBy | 0/* |
0...1String | Manufacturer of the product. Valid values include CMO (contract manufacturer) and MAH (marketing authorization holder). | ||||||
cmn:ManufacturerId | 0/* |
0...1String | Identifier for the CMO in any company identifier type enumerated by the type attribute. | ||||||
@type | 0/* |
1...1String |
Attribute that identifies the company ID types for the CMO identifier. ![]()
See the CompanyId enumeration list for valid values. |
||||||
mdx:DeleteExportMarket | - |
0...*- | Populate this element only to delete one or more of the entire export market entries from the master data record. The cmn:ExportFromCountry and cmn:ExportToCountry elements are used to identify the record to delete. It will delete the cmn:ExportFromCountry and the associated cmn:ExportToCountry (if there is one), cmn:UnitPrice, cmn:TargetMarketExemption, cmn:TargetMarketExemptionReference, and cmn:TargetMarketExemptionDate elements. | ||||||
cmn:ExportFromCountry | 0/3 |
1...1String |
The country that ships the product (shipped by the seller to a buyer that is abroad). The country is specified using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. See the ISOCountryCode enumeration list for valid values. |
||||||
cmn:ExportToCountry | 0/3 |
0...1String |
The country receiving the exported products. The country is identified using the standard two or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. See the ISOCountryCode enumeration list for valid values. |
||||||
mdx:ItemInfoList | - |
1...1- | Required. Contains product attributes. At least one mdx:ItemInfo attribute must be provided. Additional mdx:ItemInfo attributes can be provided in different languages for products that are distributed in multiple markets. | ||||||
mdx:ItemInfo | - |
1...*- | Required. A list of product attributes in one or more languages. Different countries require different product attributes for regulatory reporting purposes. The country-specific requirements are listed with each data element. | ||||||
cmn:LanguageCode | 1/3 |
1...1String |
Required. The language using the standard two- or three-letter abbreviation specified in ISO 639-1 language code.37 See the Language enumeration list for valid values. |
||||||
cmn:ProductDescription | 1/* |
1...1String | Required. Description of the drug
product (e.g. ALLERGY MED 90 MG CAPS 30 ).38 |
||||||
cmn:Composition | 1/* |
0...1String |
|
||||||
cmn:Remarks | 0/* |
0...1String | Comments or notes about the product. | ||||||
cmn:ProductCode | 0/* |
0...1String |
|
||||||
cmn:DrugName | 1/* |
1...1String | |||||||
cmn:GenericName | 0/* |
0...1String | |||||||
cmn:Manufacturer | 1/* |
1...1String | Required. Name of the manufacturer or re-packager as it appears on the product label. | ||||||
cmn:ManufacturerId | 0/* |
0...1String |
![]() |
||||||
@type | 1/* |
0...1String |
![]()
See the CompanyId enumeration list for valid values. |
||||||
cmn:Strength | 0/* |
0...1String |
Conditionally required for:
Strength of the product (e.g. 30 mg, 50 ml). |
||||||
cmn:DosageForm | 0/* |
0...1String |
RX . |
||||||
cmn:EMVSFormTypeEN | 0/* |
0...1String |
Conditionally required for EU and EU FMD countries. Dosage form of the product (e.g. tablet, capsule) using English version of the EU / EFPIA list. See the EMVSFormTypeEN enumeration list for valid values. |
||||||
cmn:PackageSize | 0/* |
0...1String |
Conditionally required for:
Quantity in the unit package (e.g. 30 count).42 |
||||||
cmn:EMVSPackTypeEN | 0/* |
0...1String |
Conditionally required for EU countries. Package type of the product using English version of EU / EFPIA list.43 See the EMVSPackType enumeration list for valid values. |
||||||
cmn:MinTemperature | 0/* |
0...1String | Indicates the coldest temperature to which the product can be exposed to without compromising its quality and safety. | ||||||
cmn:MaxTemperature | 0/* |
0...1String |
Indicates the hottest temperature to which the product can be exposed to without compromising its quality and safety. |
||||||
cmn:TemperatureScale | 0/* |
0...1String |
The temperature scale.44 See the TemperatureScale enumeration list for valid values. |
||||||
cmn:LightSensitive | - |
0...1Boolean |
Indicates if the product is sensitive to light. Valid values:
|
||||||
cmn:MarketDosageForm | 0/* |
0...1String |
Form in which the product is dispensed.45 See the MarketDosageForm enumeration list for valid values. |
||||||
cmn:ShelfLife | 0/* |
0...1Integer | The time period for which the product remains viable. | ||||||
@shelfLifeUOT | 0/* |
0...1String |
Shelf life unit of time. Valid values:
|
||||||
mdx:DeleteItemInfo | - |
0...1- | Populate this element only to delete one or more entire ItemInfo entries from the master data record. It will delete all ItemInfo data elements associated with the specified language. | ||||||
cmn:LanguageCode | 1/3 |
1...*String |
Required. The language using the standard two- or three-letter abbreviation specified in ISO 639-1 language code.46 See the Language enumeration list for valid values. |
||||||
mdx:PackagingInfoList | - |
0...1- | A list of one or more packaging item codes and associated serialization attributes. This information is used for both serialization management and for populating regulatory reporting. Country specific requirements are identified with each field. | ||||||
mdx:PackagingInfo | - |
0...1- | - | ||||||
cmn:PackagingCode | 1/* |
1...1String | Required. Serialization packaging code identifier value for the unit of measure (e.g. each, inner pack, case).47 | ||||||
@type | 1/* |
1...1String |
Required. Enumeration of serialization packaging code identifier types.48 See the PkgCode enumeration list for valid values. |
||||||
cmn:PackagingUOM | 1/* |
1...1String |
Required. Unit of measure for the packaging code.49 See the UOM enumeration list for valid values. |
||||||
cmn:MaxBatchSize | - |
0...1Integer |
The maximum batch size that is acceptable for the product.50 ![]() EA (each) cmn:PackagingUOM. |
||||||
cmn:AcceptableYield | - |
0...1Decimal |
Conditionally required when cmn:MaxBatchSize is populated. The low end percentage of a standard acceptable range of the Batch size.51 ![]() EA (each) cmn:PackagingUOM. |
||||||
cmn:MinimumYield | - |
0...1Decimal |
Conditionally required when cmn:MaxBatchSize is populated. The lowest end percentage of an acceptable Batch size. Permitted values range from ![]() EA (each) cmn:PackagingUOM. |
||||||
cmn:ContainerAggregationQty | 0/* |
0...1String |
Conditionally required for:
The number of serial numbers that will be aggregated to the Packaging UOM.53 ![]() 0 .
|
||||||
cmn:PackagingRatio | 0/* |
0...1String |
![]() |
||||||
cmn:SerializationType | 0/* |
0...1String |
Indicates the type of serialization required for the product packaging code.55 See the Serialization enumeration list for valid values. |
||||||
cmn:RequiresAggregation | 0/* |
0...1String |
Identifies if the product is configured to be aggregated or not aggregated.56 See the Aggregation enumeration list for valid values. |
||||||
cmn:FilterValue | 0/* |
0...1String | Filter value associated with GTIN-14.57 | ||||||
cmn:CompanyPrefix | 0/* |
0...1String |
|
||||||
cmn:CodeVersion | 0/* |
0...1String |
|
||||||
cmn:CodeLevel | 0/* |
0...1String |
1 being innermost level, per configuration of China
Master Data with China CFDA application.60 |
||||||
cmn:RecordStatus | 1/* |
1...1String |
Required. Indicates if packaging code
master data record is See the RecordStatus enumeration list for valid values. |
||||||
mdx:DeletePackagingInfo | - |
0...1- | Populate this element only to delete one or more entire PackagingInfo entries from the master data record. It will delete all PackagingInfo data elements associated with the packaging code. | ||||||
cmn:PackagingCode | 1/* |
1...*String | Required. Serialization packaging code
identifier value for the unit of measure (e.g. each, inner pack, case).![]() |
||||||
@type | 1/* |
1...1String |
Required. Enumeration of serialization packaging code identifier types.62 See the PkgCode enumeration list for valid values. |