HR Data Dictionary Overview Dallas, October 2003 Kim Bartkus, Paul Kiel Welcome, introductions.

What is the Data Dictionary? Catalogue of all Vocabularies used in HR-XML Schemas. Purpose Allows consistent use of vocabularies Reduces development time due to reuse of components Contains detailed information for Elements and Attributes Global Types are Excluded Includes Generic and Contextual Definitions Provides Tools and Users Guide Continues to Change and Grow

Generic Definitions To eliminate ambiguity, it is recommended that each component have a single general definition. General definitions should be business-process-neutral so they can be reused across the Consortium’s many schemas. For example, the general definition of StartDate is: Contains the (inclusive) date, period, or interval the event becomes active or begins.

Contextual Definitions A contextual definition provides additional information, instructions, or guidance for the use of the component within a specific node of a specific schema. It should not refer to a concept fundamentally different from the component’s general definition. It is recommended only if the general definition is not sufficient for a reader to understand the use of the component from the general definition alone.

Contextual Example The Enrollment schema uses start date in the following structure: Subscriber/Coverage/TierCoverage/StartDate In this instance it might be necessary to add detail and guidance such as: Contains the date that coverage originally began. This original start date does not change as modifications are made to the related subscriber record. The contextual definition refers to the same concept (an inclusive start date), but includes additional, contextual guidance.

Definition Table Sample When the definition tables are generated for the enrollment schema, both definitions will display. / Enrollment/ Organization/ Subscriber/ Coverage/ TierCoverage/ StartDate - LocalDateType - S (1/1) Contains the (inclusive) date, period, or interval the event becomes active or begins. [Contextual] Contains the date that coverage originally began. This original start date does not change as modifications are made to the related subscriber record.

Data Dictionary Tools

www.hr-xml.org Questions? Kim Bartkus, kim@hr-xml.org