August 8, 2011 MODEL PACKAGE DESCRIPTION SPECIFICATION VERSION 1.0 URI: http://reference.niem.gov/niem/specification/model-package-description/1.0/ NIEM Model Package Description (MPD) Specification ii NIEM Model Package Description (MPD) Specification Change History A = Add. Reference: All, Page, No. Date M = Mod. Change Description Table, Figure, Paragraph Revised By D = Del. 1.0 8/8/2011 All A NTAC Initial release iii NIEM Model Package Description (MPD) Specification Contents 1 Introduction ............................................................................................................................... 1 1.1 Background ..................................................................................................................... 1 1.2 Purpose ............................................................................................................................ 2 1.3 Scope ............................................................................................................................... 3 1.4 Audience ......................................................................................................................... 4 2 Concepts and Terminology ....................................................................................................... 4 2.1 Key Words for Requirement Levels ............................................................................... 4 2.2 Character Case Sensitivity .............................................................................................. 4 2.3 Artifacts .......................................................................................................................... 4 2.4 Schema-Namespace Correspondence in NIEM .............................................................. 5 2.5 Harmonization ................................................................................................................ 5 2.6 Validation ........................................................................................................................ 5 2.7 Reference Schema ........................................................................................................... 6 2.8 Coherence of Schema Sets .............................................................................................. 7 2.9 MPD Types ..................................................................................................................... 9 2.9.1 NIEM Release ..................................................................................................... 9 2.9.2 Domain Update ................................................................................................. 10 2.9.3 Core Update ....................................................................................................... 11 2.9.4 Information Exchange Package Documentation (IEPD)................................... 11 2.9.5 Enterprise Information Exchange Model (EIEM) ............................................. 12 2.10 Similarities and Differences of MPD Classes ............................................................... 15 3 MPD XML Schema Artifacts ................................................................................................. 16 3.1 Reference Schemas ....................................................................................................... 16 3.2 Subset Schemas ............................................................................................................. 17 3.2.1 Basic Subset Concepts ...................................................................................... 18 3.2.2 Subset Namespaces ........................................................................................... 19 3.2.3 Omitting Schemas in Subsets ............................................................................ 19 3.2.4 Multiple Subsets in a Single IEPD or EIEM ..................................................... 20 3.3 Extension Schemas ....................................................................................................... 21 3.4 Exchange Schemas ....................................................................................................... 21 3.5 Constraint Schemas ....................................................................................................... 23 3.6 Classes of IEMs vs. Classes of Schemas ...................................................................... 25 3.7 Sample XML Instances ................................................................................................. 25 4 MPD Documentation Artifacts ............................................................................................... 26 4.1 Catalog .......................................................................................................................... 26 4.2 Metadata Concepts ........................................................................................................ 27 4.2.1 Version Numbering Scheme ............................................................................. 27 4.2.2 URI Scheme for MPDs ..................................................................................... 29 4.2.3 URI Scheme for MPD Artifacts ........................................................................ 30 4.2.3.1 Compact URIs (CURIEs) ...................................................................... 32 4.2.3.2 MPD Artifact URIs Are Not NIEM Namespaces ................................. 32 4.2.4 Artifact Vocabularies: Nature and Purpose ...................................................... 33 4.2.5 MPD Artifact Lineage ....................................................................................... 35 iv NIEM Model Package Description (MPD) Specification 4.3 Change Log ................................................................................................................... 35 4.3.1 NIEM Releases, Core Updates, and Domain Updates ...................................... 35 4.3.2 IEPDs and EIEMs ............................................................................................. 36 4.4 Master Document .......................................................................................................... 37 4.4.1 Master Document Content ................................................................................ 38 5 Optional MPD Artifacts .......................................................................................................... 40 6 Directory Organization, Packaging, Other Criteria ................................................................ 41 6.1 MPD File Name Syntax ................................................................................................ 42 6.2 Artifact Links to Other Resources ................................................................................ 43 6.3 Duplication of Artifacts ................................................................................................ 45 6.4 Non-normative Guidance for Directories ..................................................................... 45 Appendix A: MPD Catalog Schema ........................................................................................... A-1 Appendix B: Catalog Data Dictionary ........................................................................................ B-1 Appendix C: Sample MPD Catalog Instance .............................................................................. C-1 Appendix D: Sample XSLT for a Catalog Index ........................................................................ D-1 Appendix E: Browser Display of Catalog (XSLT 1.0) ................................................................ E-1 Appendix F: MPD Artifacts ......................................................................................................... F-1 Appendix G: MPD Lexicon (Nature and Purpose) ..................................................................... G-1 Appendix H: Rule Summary ....................................................................................................... H-1 Appendix I: Acronyms and Abbreviations ................................................................................... I-1 Appendix J: Glossary of Terms ................................................................................................... J-1 Appendix K: References ............................................................................................................. K-1 Figures Figure 2-1. Incoherent schema set – not closed. ............................................................................ 7 Figure 2-2. Incoherent schema set – incompatible data components. ........................................... 8 Figure 2-3. Examples of NIEM numbered releases ..................................................................... 10 Figure 2-4. BIECs, EIEM, and a small family of IEPDs ............................................................. 14 Figure 4-1. Example versioning system. ...................................................................................... 28 Figure 4-2. An example of IEPD representation. ........................................................................ 34 Figure 6-1. IEPD sample directory structure ............................................................................... 47 Tables Table 2-1. Comparison of MPD classes ................................................................................ 16 Table 3-1. IEM classes vs. schema