DOCSLIB.ORG

NIEM Naming and Design Rules (NDR) Specify NIEM-Conformant Components, Schemas, and Instances

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
NIEM Naming and Design Rules (NDR) Specify NIEM-Conformant Components, Schemas, and Instances October 31, 2008 NIEM NAMING AND DESIGN RULES VERSION 1.3 URI: http://reference.niem.gov/niem/specification/naming-and-design-rules/1.3/ NIEM NIEM Naming and Design Rules Editors: Webb Roberts, Georgia Tech Research Institute Susan Liebeskind, Georgia Tech Research Institute Mark Kindl, Georgia Tech Research Institute Abstract: This document specifies the data model, XML components, and XML data for use with the National Information Exchange Model (NIEM) version 2.0. Status: This document is a specification for NIEM-conformant XML Schema documents, components, and instances. It represents the design that has evolved from the collaborative work of the NIEM Business Architecture Committee (NBAC) and the NIEM Technical Architecture Committee (NTAC) and their predecessors. This specification is a product of the NIEM Program Management Office (PMO). Send comments on this specification via email to [email protected]. i NIEM NIEM Naming and Design Rules Record of Changes Reference: All, Page, A = Add. No. Date Table, Figure, M = Mod. Revised By Change Description Paragraph D = Del. 1.0 06/08/2007 All A Webb Roberts, Initial version Susan Liebeskind, Internal draft Mark Kindl 1.1 06/27/2007 All M Webb Roberts, Internal draft Susan Liebeskind, Mark Kindl 1.2 08/07/2007 All M Webb Roberts, Public draft Susan Liebeskind, Mark Kindl 1.3 10/31/2008 All M NTAC, Final Webb Roberts, Mark Kindl ii NIEM NIEM Naming and Design Rules Contents 1 Introduction .............................................................................................................................. 1 1.1 Scope ................................................................................................................................ 1 1.2 Audience .......................................................................................................................... 2 1.3 Document Conventions ................................................................................................... 2 1.3.1 Document References ......................................................................................... 2 1.3.2 Normative and Informative Content ................................................................... 2 1.3.3 Formatting ........................................................................................................... 3 1.4 Terminology ..................................................................................................................... 4 1.4.1 RFC 2119 Terminology ........................................................................................ 4 1.4.2 XML Information Set Terminology ...................................................................... 4 1.4.3 XML Schema Terminology ................................................................................... 5 1.4.4 XML Namespace Terminology ............................................................................. 5 1.5 Document Organization ................................................................................................... 5 2 NIEM Conformance ................................................................................................................... 6 2.1 Conformance Targets Overview ...................................................................................... 7 2.2 Reference Schemas .......................................................................................................... 7 2.3 IEPD Subset Schemas ....................................................................................................... 8 2.4 IEPD Extension Schemas and Exchange Schemas ............................................................ 9 2.5 IEPD Constraint Schemas ............................................................................................... 11 2.6 NIEM-Conformant XML Documents and Elements ....................................................... 12 3 The NIEM Conceptual Model .................................................................................................. 13 3.1 NIEM and the RDF Model .............................................................................................. 14 3.2 NIEM Properties ............................................................................................................. 16 3.3 Unique Identification of Data Objects ........................................................................... 17 3.4 NIEM Data Model Is Explicit, Not Implicit ...................................................................... 17 3.5 NIEM Data Model Implementation in XML Schema ...................................................... 17 4 Guiding Principles ................................................................................................................... 19 4.1 Specification Guidelines ................................................................................................. 19 4.1.1 Keep Specification to a Minimum ..................................................................... 19 4.1.2 Focus on Rules for Schemas .............................................................................. 20 4.1.3 Use Specific, Concise Rules ............................................................................... 20 4.2 XML Schema Design Guidelines ..................................................................................... 20 4.2.1 Disallow Content Modification With XML Processors ...................................... 20 4.2.2 Use XML Validating Parsers for Content Validation .......................................... 21 4.2.3 Validate for Conformance to Reference Schemas ............................................ 21 4.2.4 Allow Multiple Schemas for XML Constraints ................................................... 21 4.2.5 Define One Reference Schema Per Namespace ............................................... 22 4.2.6 Disallow Mixed Content .................................................................................... 22 4.2.7 Specify Types for All Constructs ........................................................................ 22 4.2.8 Avoid Wildcards in Reference Schemas ............................................................ 22 4.2.9 Provide Default Reference Schema Locations .................................................. 23 iii NIEM NIEM Naming and Design Rules 4.2.10 Use Open Standards .......................................................................................... 23 4.3 Modeling Design Guidelines .......................................................................................... 23 4.3.1 Namespaces Enhance Reuse ............................................................................. 23 4.3.2 Design NIEM for Extensibility ............................................................................ 24 4.4 Implementation Guidelines ........................................................................................... 24 4.4.1 Avoid Displaying Raw XML Data ........................................................................ 24 4.4.2 Leave Implementation Decisions to Implementers .......................................... 25 4.5 Modeling Guidelines ...................................................................................................... 25 4.5.1 Documentation .................................................................................................. 25 4.5.2 Consistent Naming ............................................................................................ 26 4.5.3 Reflect the Real World ...................................................................................... 26 4.5.4 Be Consistent ..................................................................................................... 26 4.5.5 Reserve Inheritance for Specialization .............................................................. 26 4.5.6 Do Not Duplicate Definitions............................................................................. 27 4.5.7 Keep It Simple .................................................................................................... 27 4.5.8 Be Aware of Scope ............................................................................................ 27 4.5.9 Be Mindful of Namespace Cohesion ................................................................. 28 5 Relation to Standards.............................................................................................................. 28 5.1 XML 1.0 .......................................................................................................................... 28 5.2 XML Namespaces ........................................................................................................... 28 5.3 XML Schema ................................................................................................................... 29 5.4 ISO 11179, Part 4 ........................................................................................................... 29 5.5 ISO 11179, Part 5 ........................................................................................................... 31 6 XML Schema Design Rules ...................................................................................................... 32 6.1 Restrictions on XML Schema Constructs ....................................................................... 32 6.1.1 No Mixed Content ............................................................................................. 33 6.1.2 No Notations ....................................................................................................
Load more

Recommended publications
  • Justice XML Data Model Technical Overview
    Justice XML Data Model Technical Overview April 2003 WhyWhy JusticeJustice XMLXML DataData ModelModel VersionVersion 3.0?3.0? • Aligned with standards (some were not available to RDD) • Model-based Æ consistent • Requirements-based – data elements, processes, and documents • Object-oriented Æ efficient extension and reuse • Expanded domain (courts, corrections, and juvenile) • Extensions to activity objects/processes • Relationships (to improve exchange information context) • Can evolve/advance with emerging technology (RDF/OWL) • Model provides the basis for an XML component registry that can provide • Searching/browsing components and metadata • Assistance for schema development/generation • Reference/cache XML schemas for validation • Interface (via standard specs) to external XML registries April 2003 DesignDesign PrinciplesPrinciples • Design and synthesize a common set of reusable, extensible data components for a Justice XML Data Dictionary (JXDD) that facilitates standard information exchange in XML. • Generalize JXDD for the justice and public safety communities – do NOT target specific applications. • Provide reference-able schema components primarily for schema developers. • JXDD and schema will evolve and, therefore, facilitate change and extension. • Best extension methods should minimize impact on prior schema and code investments. • Implement and represent domain relationships so they are globally understood. • Technical dependencies in requirements, solutions, and the time constraints of national priorities and demands
    [Show full text]
  • Department of the Navy XML Naming and Design Rules
    Department of the Navy XML Naming and Design Rules Office of the DON Final Version 2.0 Chief Information Officer January 2005 Department of the Navy XML Naming and Design Rules January 2005 18 January 2005 MEMORANDUM FOR DISTRIBUTION Subj: EXTENSIBLE MARKUP LANGUAGE (XML) NAMING AND DESIGN RULES OFFICIAL RELEASE To comply with joint requirements as embodied in the DoD Net-Centric Data Strategy and to achieve the FORCEnet requirement for a common structure and language for information handling, the Department of the Navy (DON) is issuing Naming and Design Rules (NDR) that facilitate the discovery and use of common data across the naval enterprise. XML, an open standards based technology, is a key enabler of the Department's net-centric data strategy. The NDR provides additional rigor necessary to efficiently and effectively operate in a net-centric data-sharing environment. These rules move the DON forward to ensure that all XML is based on a consistent set of schema through the application of open standards that align with the Federal Enterprise Architecture Data Reference Model and Global Information Grid. The result will be an environment that is sustainable, responsive, and agile. The NDR is the product of expertise and energies contributed by representatives from 13 key Navy, Marine Corps, and Secretary of the Navy organizations who participated in the DON XML Working Group. To ensure these rules are applicable and current, the DON Chief Information Officer (DON CIO) has established the XML Business Standards Council and is proceeding to charter the Net-Centric Technical Standards Council to serve as liaison to organizations developing national and international standards for XML and Web Services technologies.
    [Show full text]
  • UN/CEFACT – Ebxml Core Components Technical 9 Specification, Part 1 10 11 12 13 8 February 2002 14 Version 1.8
    UN/CEFACT DRAFT United Nations Centre for Trade Facilitation and Electronic Business 1 2 3 4 5 6 7 8 UN/CEFACT – ebXML Core Components Technical 9 Specification, Part 1 10 11 12 13 8 February 2002 14 Version 1.8 UN/CEFACT - ebXML Core Components Technical Specification, Part 1 V1.8 Page 1 of 97 UN/CEFACT DRAFT United Nations Centre for Trade Facilitation and Electronic Business 15 1 Status of This Document 16 This Technical Specification is being developed in accordance with the 17 UN/CEFACT/TRADE/22 Open Development Process for Technical Specifications. It 18 has been approved by the eBTWG for public review as defined in Step 5 of the Open 19 Development Process. 20 This document contains information to guide in the interpretation or implementation 21 of ebXML concepts. 22 Distribution of this document is unlimited. 23 The document formatting is based on the Internet Society’s Standard RFC format. 24 This version: Core Components Technical Specification, Version 1.80 of 8 February 25 2002 26 Previous version: Core Components Technical specification, Version 1.75 of 15 27 January 2002 UN/CEFACT - ebXML Core Components Technical Specification, Part 1 V1.8 Page 2 of 97 Core Components 2002-02-08 28 2 eBTWG - ebXML Core Components Specification 29 Project Team Participants 30 We would like to recognise the following for their significant participation to the 31 development of this document. 32 Project Team Leader: Hartmut Hermes Siemens 33 Lead Editor: Mark Crawford Logistics Management Institute 34 Editing Team Mike Adcock APACS 35 Alan Stitzer Marsh, Inc.
    [Show full text]
  • CEDS Element Naming Conventions 1
    The Consistent Naming of Elements This document describes the principles used in naming CEDS data elements and entities. These naming conventions provide consistency within the standards. Conventions used within CEDS need not restrict how education agencies and system developers implement the standards. Comparability of meaning is most critical for implementation; however, consistent and clear naming can make it easier to compare data across systems and domains of systems. Standard Name The standard name of a data element in CEDS is refined for human readability and understandability, to avoid possible confusion when using an element in a different context or across domains. CEDS elements may also be assigned a “Technical Name,” often the standard name with spaces removed, and/or an alternative name reflecting a commonly used alternative name for the same concept. Based on the ISO 11-179 guidelines, element names have name parts that consist of discrete terms. The name parts are entity terms, property terms, representation terms (optional), and qualifier terms (optional). Consider how these name parts function in the following illustration: Enrollment in Postsecondary Award Type entity qualifier property representation Entity Terms Entity terms provide the context for an element. In the following data element names, the terms Person, Accountability Report, Dental Insurance Coverage, and Advance Placement are entity terms: Person Middle Name Accountability Report Title Dental Insurance Coverage Type Advance Placement Credits Awarded CEDS Element Naming Conventions 1 Property Terms A property is an attribute common to all members of an entity. For example, all persons have a date of birth. In the following data element names, the terms Name, Title, and Credits Awarded are property terms: Person Middle Name Accountability Report Title Dental Insurance Coverage Type Advance Placement Credits Awarded In this list, three of the element names have an Entity – Property structure.
    [Show full text]
  • Georgia DCH Medicaid Enterprise – Data Management Strategy
    Georgia DCH Medicaid Enterprise – Data Management Strategy February 2015 DCH Medicaid Enterprise Data Management Strategy Version Date Document Revision History Document Author/Reviser 1.0 11/21/2014 Draft Deliverable Submission PCG 2.0 1/22/2015 Updates based upon collective feedback PCG from DCH review 3.0 2/27/2015 Finalized and approved by DCH PCG February 2015 DCH Medicaid Enterprise Data Management Strategy INTRODUCTION ....................................................................................................................................1 DATA STRATEGIES AND USAGE ..............................................................................................................1 DCH STRATEGIC PLAN .............................................................................................................................................. 1 Mission Statement ............................................................................................................................................................. 1 Vision Statement ................................................................................................................................................................ 1 Strategies and Initiatives ................................................................................................................................................... 1 HEALTH INFORMATION EXCHANGE ............................................................................................................................... 1 DATA
    [Show full text]
  • Global Justice XML Data Model Naming and Design Rules
    1 2 Global Justice XML Data Model 3 Naming and Design Rules 4 Draft Version 0.4, 23 August 2005 5 Editor: 6 Webb Roberts, Georgia Institute of Technology 7 Contributors: 8 Abstract: 9 This document specifies the data model, XML artifacts, and XML data for use with the 10 Global Justice XML Data Model. 11 Status: 12 This document is an early draft of a specification for GJXDM-conformant XML 13 components. This document is incomplete, and will undergo considerable revision before 14 being approved for use. This document will be updated by GTRI in concert with the 15 Global XML Structure Task Force (XSTF). 16 Please send comments on this specification to member of the XSTF. GJXDM NDR Draft Version 0.4 August 23, 2005 Page 1 of 49 17 Table of Contents 18 1. Introduction ............................................................................................................................. 5 19 1.1. Audience ........................................................................................................................5 20 1.2. The GJXDM XML Reference Architecture (In Brief) ...................................................... 5 21 1.3. Scope ............................................................................................................................. 7 22 1.4. Document Conventions.................................................................................................. 7 23 1.4.1. Logical Quoting...................................................................................................... 7 24
    [Show full text]
  • Common Education Data Standards (CEDS) Version 5 Data Model Guide
    Common Education Data Standards (CEDS) Version 5 Data Model Guide January 2015 CONTENTS Introduction ......................................................................................................................................... 1 About This Document .......................................................................................................................... 2 The Domain Entity Schema (DES) .......................................................................................................... 2 The Normalized Data Schema (NDS) ..................................................................................................... 2 Naming Conventions and Key Terms .................................................................................................... 3 Entity Terms .................................................................................................................................... 4 Property Terms ............................................................................................................................... 4 Representation Terms .................................................................................................................... 4 Qualifiers (Optional) ....................................................................................................................... 5 Element Identifiers ................................................................................................................................ 5 CEDS Domain Entity Schema ...............................................................................................................
    [Show full text]
  • UML Profile for NIEM 3 (NIEM-UML-3)
    UML Profile for NIEM 3 (NIEM-UML-3) Revised Submission OMG Document Number: gov/2015-02-01 Normative Machine Consumable Files: http://www.omg.org/spec/NIEM-UML/20150201/NIEM-UML-Profile.xmi http://www.omg.org/spec/NIEM-UML/20150201/XmlPrimitiveTypes.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-adapters-edxl-cap.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-adapters-edxl-de.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-adapters-edxl-have.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-adapters-geospatial.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-ansi_d20.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-apco_event.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-atf.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-canada_post.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-cbrncl.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-census_commodity.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-census_uscounty.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-core_misc.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-dea_ctlsub.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-dod_jcs-pub2.0.xmi http://www.omg.org/spec/NIEM-UML/20150201/NIEMReference/NIEM-Reference-codes-dol_soc.xmi
    [Show full text]
  • Data Harmonization Guide FC-3.Ai
    Data Harmonization and Modelling Guide FOR SINGLE WINDOW ENVIRONMENT The secretariat of the Economic and Social Commission for Asia and the Pacific (ESCAP) is the regional development arm of the United Nations and serves as the main economic and social development centre for the United Nations in Asia and the Pacific. Its mandate is to foster cooperation between its 53 members and 9 associate members. It provides the strategic link between global and country-level programmes and issues. It supports Governments of countries in the region in consolidating regional positions and advocates regional approaches to meeting the region’s unique socio-eco- nomic challenges in a globalizing world. The ESCAP secretariat is located in Bangkok, Thailand. Please visit the ESCAP website at www.unescap.org for further information. The shaded areas of the map indicate ESCAP members and associate members. UNITED NATIONS NETWORK OF EXPERTS FOR PAPERLESS TRADE IN ASIA AND THE PACIFIC UNITED NATIONS ECONOMIC AND SOCIAL COMMISSION FOR ASIA AND THE PACIFIC UNITED NATIONS ECONOMIC COMMISSION FOR EUROPE In cooperation with WORLD CUSTOMS ORGANIZATION Data Harmonization and Modelling Guide for Single Window Environment i Data Harmonization and Modelling Guide for Single Window Environment United Nations publication Copyright © United Nations 2012 All rights reserved Manufactured in Thailand ST/ESCAP/2619 The designations employed and the presentation of the material in this publication do not imply the expression of any opinion whatsoever on the part of the Secretariat of the United Nations concerning the legal status of any country, territory, city or area, or of its authorities, or concerning the delimitation of its frontiers or boundaries.
    [Show full text]
  • Committee for the Coordination of Statistical Activities Second Session
    Committee for the Coordination of Statistical Activities SA/2003/15/Add.1 Second session 29 August 2003 Geneva, 8-10 September 2003 Item 10(c) of the provisional agenda STATISTICAL DATA AND METADATA EXCHANGE (SDMX) INITIATIVE Overview of the Metadata Common Vocabulary Project Report prepared by OECD Introduction 1. The purpose of this paper is to provide CCSA members with a brief description of the SDMX Metadata Common Vocabulary (MCV) project which is one of the four projects currently being conducted under the umbrella of SDMX. More detailed information about the other projects is available at the SDMX website (www.sdmx.org) 2. There are several different types of metadata covering the statistical production cycle, from data collection through to data dissemination; but there is no universally accepted definition of either metadata or metadata models that outline the different types of metadata. Although there is some commonality between the metadata models developed by national agencies and international organisations, each has a slightly different objective and each describes different methodological issues and stages of the statistical production cycle. Given the diverse requirements of different national agencies and international organisations, reaching agreement on a common metadata model is an almost impossible task. Effective agreement is even harder to achieve if the exercise is conducted in terms of broad metadata items, especially where the item used (e.g. "methodology", or "coverage") in turn also comprises more detailed metadata elements (e.g. "geographical coverage", "activity coverage", "unit coverage", etc). In this case, agreement on a highly aggregated item might hide a serious misunderstanding of the basic metadata components, if a clear definition is not provided.
    [Show full text]
  • Data Elements
    THIS PAGE HAS BEEN LEF T INTENTIONALLY BLANK 4-1 • BRICS USER MANUAL © 2021 National Institutes of Health/CIT – Proprietary and Confidential Chapter 4 Data Dictionary – Data Elements CHAPTER 4 – DATA DICTIONARY he Data Dictionary module is used for defining data elements and form structures. Data Dictionary allows users to search. Create and manage Common Data Elements (CDE) and Unique Data Elements (UDE), create and manage form structures (FS) and electronic forms (eFORMS). The Data Dictionary module is closely related to the Data Repository module which provides long term repository for research data. T 4.1 OBJECTIVE This chapter provides information for users on how to: Browse existing Data Elements Search Data Elements Create Data Elements Import Data Elements Browse existing eForms Search eForms Create eForms 4.2 SYSTEM FUNCTIONS The Data Dictionary module provides the tools for defining the data you submit as well as provide alternate terms (aliasing) and translation rules for the same element. Importantly, the BRICS data dictionary provides those who have access to the data with clear and precise information about what it is they are accessing. 4-1 • BRICS USER MANUAL © 2021 National Institutes of Health/CIT – Proprietary and Confidential 4.3 MODULE NAVIGATION The Data Dictionary module (including sub-modules) are available within the BRICS Workspace. To Access the Data Dictionary Module: Perform the following actions: 1. Login to the system. 2. Navigate to the Workspace landing page 3. Click the Data Dictionary module icon 4.4 DATA DICTIONARY MODULE CAPABILITIES The Data Dictionary Module provides useful features for: Searching Data Elements o Downloading Data Elements Results to XML, CSV and ZIP output formats Creating Data Elements Importing Data Elements 4-4 • BRICS USER MANUAL © 2020 National Institutes of Health/CIT – Proprietary and Confidential DATA ELEMENTS 4.5 Data Element Definition A simple definition of a data element: A data element (DE) is a logical unit of data, pertaining to information of one kind.
    [Show full text]
  • DM Operating Procedures and Guidelines
    Data Management Operating Procedures and Guidelines The full text of operating procedures, guidelines, and standards, including their underlying rationale, and level of enforcement are enclosed for your reference. Numbering schemes follow this format with nnn as a sequence number (e.g., 001): DM OP nnn (Operating Procedure) Operating procedures mandate certain actions that are enforceable for specified IT Project. DM G nnn (guideline) Guidelines provide best practice methods, and are optional. Data Management Operating Procedures DM OP-001 Operating Procedure for Requesting Data Management Services Rationale: The Data Services Manager needs certain information to adequately plan and assign data management service resources in support of CMS projects. That information is collected through the Data Management Service Request Form, which is designed to capture it in a clear and organized format. Operating Procedure: A request for data design services shall be initiated through submission of the Data Management Service Request Form. DM OP-002 Operating Procedure for Identifying System Interfaces Rationale: The System Context Diagram concisely illustrates the system boundary in relation to its environment, and documents the actual or planned data flows into and out of the system. Operating Procedure: Business application interfaces shall be identified using a System Context Diagram. See example. System Context Diagram Other System 1 input data flow 1 Person output data flow 2 System input data flow 2 output data flow 1 Organization 1 Organization 2 DM OP-003: Operating Procedure for Developing the Conceptual Data Model Rationale: The Conceptual Data Model diagram illustrates the major entities about which the business enterprise needs information. This diagram will assist in the identification of existing data sources and help in determining the need for new entities.
    [Show full text]