XML User Dictionary

XML User Dictionary

Deadline for State User-Dictionaries

In preparation for implementation of the XML standard for NAACCR v21, central registries with locally defined data items are expected to create and provide user dictionaries to vendors by October 1, 2020

A user dictionary is an XML file that defines key metadata about NAACCR data items as they relate to a NAACCR XML data exchange file, their valid XML parent elements, and processing rules. The user dictionaries should include all registry-specific data items for NAACCR v21, including current registry-specific items as well as any new items planned for implementation in NAACCR v21. This will help vendors prepare customized files and software applications and reduce the chance of delay for deployment of NAACCR v21 software. All central registries with registry-specific data items should do the following:

  1. Review existing registry-specific data items to determine if their reporting needs have changed, remove items that are no longer needed.
  2. Identify and define new registry-specific data items for NAACCR v21 as needed.
  3. Download and fill out the User Dictionary Sample Template with details of all registry-specific data items.
  4. Create an XML User Dictionary with all registry-specific data items, based on the information in the Excel template. According to the XML Data Exchange Standard, the filename for a user dictionary should match the last part of the dictionary URI and follow this pattern: [organization]-naaccr-dictionary[-xxx][-v#.#].xml where xxx is the corresponding NAACCR version, which is only required if the user dictionary depends on a specific NAACCR version. v#.#is your organization’s version of the dictionary(semantic versioning recommended)
  1. Upload the filled-out User Dictionary Sample Template and the XML User Dictionary to the XML Dictionary Submission Portal (MyNAACCR Login Required).

Help with Creating User Dictionaries

NAACCR has established this website as a User Dictionary Clearinghouse to show examples of user dictionaries from other central registries and provide the User Dictionary Sample Template that will help central registries gather information needed to define their own XML User Dictionary. Central registries with registry-specific data items are encouraged to fill out the Excel template and upload it to the XML Dictionary Submission Portal with a corresponding XML User Dictionary so that registry software vendors can get access to these required files and deploy their NAACCR v21 changes in a timely manner.

NOTE: These files will be shared publicly in order to provide it to the widest audience of software vendors and to assist registries in creating XML User Dictionaries as they transition to the XML standard for NAACCR v21. Only registered MyNAACCR account holders can post files, but once posted, they will be available publicly for download.

Once the User Dictionary Sample Template is filled out, it can be uploaded to the XML Dictionary Submission Portal by someone at a central registry with a MyNAACCR account that is responsible for managing registry-specific data items. Once uploaded, these files will be publicly available with the intent of allowing registry software vendors the registry-specific customizations, including codes and definitions, for registry-specific data items in their software. While codes and descriptions are optional and not defined in a user dictionary, central registry-assigned codes and descriptions must be shared with vendors in order to generate look up tables in software displays.

When assigning names to registry-specific data items, the maximum length for a NAACCR Name is 50 characters, and the maximum length for a NAACCR ID is 32 characters. The software tools available for creating user dictionaries will calculate a new NAACCR ID based on the NAACCR Name as long as the names contain 50 characters or less. Additional information can be found in the NAACCR Data Exchange Standard, available at https://www.naaccr.org/xml-data-exchange-standard/.

Please note that these spreadsheet templates do not take the place of a user dictionary. The templates provide a reference with information needed to successfully implement registry-specific data items with the end goal of bringing all of the information together in one place to create a user dictionary file. Once the spreadsheet is filled out, central registries with registry-specific data items must also create and maintain the actual user dictionary file.

We encourage all registries with custom local data items to complete the spreadsheet template and upload their documents.

Additional help can be received by posting to the NAACCR XML Forum, which is monitored by the NAACCR XML Data Exchange Workgroup

Important Links

User Dictionary Sample Template

XML Dictionary Submission Portal (MyNAACCR Login Required)

NAACCR XML Specification Document (NAACCR Volume I)


Organization NameUploaded FilesUpload Date/TimeUser AccountStatus
ACoS Data Dictionary Details2020-09-15Jeff ReedSubmitted
Alaska XML User Dictionary
Data Dictionary Details
2020-09-17 12:00:00David O'BrienSubmitted
Missouri XML User Dictionary
Data Dictionary Details
2020-09-24 10:45:00Nancy RoldSubmitted
Utah XML User Dictionary
Data Dictionary Details
2020-09-02 9:31:00Valerie YoderReviewed

Copyright © 2018 NAACCR, Inc. All Rights Reserved | naaccr-swoosh-only See NAACCR Partners and Sponsors