https://docs.oasis-open.org/niemopen/niem-model/v6.0/psd01/niem-model-v6.0-psd01.md
(Authoritative)
https://docs.oasis-open.org/niemopen/niem-model/v6.0/psd01/niem-model-v6.0-psd01.html
https://docs.oasis-open.org/niemopen/niem-model/v6.0/psd01/niem-model-v6.0-psd01.pdf
N/A
https://docs.oasis-open.org/niemopen/niem-model/v6.0/niem-model-v6.0.md
(Authoritative)
https://docs.oasis-open.org/niemopen/niem-model/v6.0/niem-model-v6.0.html
https://docs.oasis-open.org/niemopen/niem-model/v6.0/niem-model-v6.0.pdf
Katherine Escobar (katherine.b.escobar.civ@mail.mil), Joint Staff J6
Kamran Atri (katri@a4safe.com),
A4SAFE
Thomas Krul (thomas.krul@ecn.forces.gc.ca),
Public Safety Canada
Christina Medlin (christina.medlin@gtri.gatech.edu), Georgia Tech Research Institute
This prose specification is one component of a Work Product that also includes:
Complete XML Schema:
NIEM Documentation files:
Other artifacts:
This specification replaces or supersedes:
This specification is related to:
NIEM Naming and Design Rules Specification Version 6.0. Work in progress.
NIEM Code Lists Specification Version 6.0. Work in progress.
NIEM Conformance Specification Version 6.0. Work in progress.
NIEM Conformance Targets Attribute Specification Version 6.0. Work in progress.
NIEM is a data model that enables efficient information exchange across diverse public and private organizations. NIEM can improve interoperability among message exchange partners by providing consistent rules, reusable data components, and repeatable processes.
This document was last revised or approved by the Project Governing Board of the OASIS NIEMOpen OP on the above date. The level of approval is also listed above. Check the "Latest stage" location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Open Project (OP) are listed at http://www.niemopen.org/.
Comments on this work can be provided by opening issues in the model repository or by sending email to the project's public comment list: niemopen-comment@lists.oasis-open-projects.org. List information is available at https://lists.oasis-open-projects.org/g/niemopen-comment.
Note that any machine-readable content (Computer Language Definitions) declared Normative for this Work Product is provided in separate plain text files. In the event of a discrepancy between any such plain text file and display content in the Work Product's prose narrative document(s), the content in the separate plain text file prevails.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] and [RFC8174] when, and only when, they appear in all capitals, as shown here.
When referencing this specification the following citation format should be used:
[NIEM-Model-v6.0]
NIEM Model Version 6.0. Edited by Christina Medlin. 26 October 2023. OASIS Project Specification Draft 01. https://docs.oasis-open.org/niemopen/niem-model/v6.0/psd01/niem-model-v6.0-psd01.html. Latest stage: https://docs.oasis-open.org/niemopen/niem-model/v6.0/niem-model-v6.0.html.
Copyright © OASIS Open 2023. All Rights Reserved.
This specification is published under Attribution 4.0 International (CC BY 4.0). Code associated with this specification is provided under Apache License 2.0.
Distributed under the terms of the OASIS IPR Policy.
For complete copyright information please see Appendix D. Notices.
The NIEM model is a data model made up of a collection of properties and types defined within a set of namespaces, organized by governance authority. NIEM components can be leveraged as reusable building blocks in information exchanges, providing consistency and well-defined semantics that support interoperability among various exchange partners.
Significant changes to the NIEM model in version 6.0 from previous version 5.2 include:
Core and cross-domain harmonization
Updates to support the transition of NIEM to an OASIS Open Project, including namespace URI changes.
Updates to support upcoming [NIEM-NDR-v6.0] changes, including:
structures:uri attribute to relate
different roles of the same entity in a message together, replacing the
previous RoleOf construct.Updates related to new digital identity requirements led by the Emergency Management domain, including:
nc:IdentificationType and related augmentation
typesnc:LicenseType (new) to support other kinds of
licenses with NIEMj:DriverLicenseType and related typesnc:PassportType, which now extends
nc:IdentificationTypeem:PersonIDCardType, which has been refactored to
augment nc:IdentificationTypem:SeamanLicenseType, which can now be represented by
the new nc:LicenseTypem:MerchantMarinerDocumentType, which can now be
represented by the new nc:LicenseTypeCode set updates, including:
Synchronized the Justice domain version number with the rest of the model
Changes to version 6.0 are described in more detail in
README.md.
| Term | Definition |
|---|---|
| NDR | The NIEM Naming and Design Rules is a technical specification managed by the NTAC which governs the architecture of the model. |
| Term | Literal |
|---|---|
| NBAC | NIEM Business Architectures Committee TSC |
| NDR | NIEM Naming and Design Rules Specification |
| NIEM | NIEMOpen, the NIEM Open Project under OASIS |
| NMO | NIEM Management Office TSC |
| NTAC | NIEM Technical Architecture Committee TSC |
| PGB | NIEM Project Governing Board |
| TSC | Technical Steering Committee |
Properties and types in NIEM are defined in namespaces, which are organized by governance or authoritative source:
NIEM Core is the collection of general-purpose content that does not belong to any one authoritative source. As such, this content is managed collaboratively by the NBAC, which includes representatives from the NIEM domain subcommittees.
NIEM domains are namespaces for communities of interest that have stood up their own formal governance bodies as NBAC subcommittees within NIEM.
While code sets can be defined in NIEM Core, domains, and other namespaces, code namespaces are almost exclusively comprised of code sets. Some NIEM code namespaces are actively managed by domain subcommittees or authoritative sources which work directly with NIEM. Other NIEM code namespaces are managed by the NBAC or domain subcommittees and reflect publicly available code sources, modified to conform to NIEM NDR rules.
Adapters are provided by the NDR as the mechanism to support non-conformant external standards in NIEM schemas and instances without triggering conformance violations. Like code sets, while adapters can be defined in other namespaces, adapter namespaces are for namespaces that exclusively define adapters for external standards.
Auxiliary namespaces define content representing communities of interest or standards. Unlike domains, they do not require formal governance bodies within NIEM.
External namespaces in NIEM are non-conformant external standards. These are provided for when the use of other standards defined outside of NIEM would provide greater interoperability than to create NIEM-conformant components representing those standards. Properties from external standards are wrapped by NIEM adapter types, which prevent NDR conformance rules from triggering errors on their use.
Utility namespaces in NIEM provide architectures support from the NDR and other NIEM technical specifications. They provide mechanisms to support such things as ids and references, linked data, IC-ISM and NTK security markup, dynamic code list support and code list support for codes defined in CSVs, Genericode, and other non-schema enumeration formats.
The architecture of the NIEM model is governed by the NDR, which provides:
general-purpose rules for naming, defining, and modeling components
special constructs and techniques to represent features including:
language-specific syntax rules
an RDF interpretation of the underlying data model
rules for extending the NIEM model to meet local requirements
Initially, NIEM has been limited to XML-based exchanges. NIEM is working to provide similar levels of support for JSON-LD, and mechanisms to support other languages as well.
Major versions of the NIEM Model correspond to major versions of the NDR. The architecture of the NIEM Model v6.0 is defined by [NIEM-NDR-v6.0].
This specification normatively defines NIEM Model Version 6.0 with a set of reference XML schemas.
The NIEM Naming and Design Rules [NIEM-NDR-v6.0] defines conformance targets, Schematron and text rules, and guidance for the conformant use of NIEM in messages and message specifications.
The NIEM Conformance Specification [NIEM-Conformance-v6.0] describes NIEM conformance.
NIEM Conformance Specification Version 6.0. Work in progress.
NIEM Naming and Design Rules Specification Version 6.0. Work in progress.
Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, http://www.rfc-editor.org/info/rfc2119.
Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, http://www.rfc-editor.org/info/rfc8174.
Substantial contributions to this document from the following individuals are gratefully acknowledged:
Special thanks are given to the following individuals for their assistance in reviewing and resolving harmonization and other content issues affecting the model:
NBAC Harmonization Subcommittee Members:
| First Name | Last Name | Domain Subcommittee or COI |
|---|---|---|
| Kamran | Atri | Emergency Management; NBAC co-chair |
| Aubrey | Beach | NIEMOpen |
| Chuck | Chipman | MilOps |
| Kelly | Cullinane | OASIS |
| Chet | Ensign | OASIS |
| Katherine | Escobar | Joint Staff J6; PGB Chair |
| Vamsi | Kondannagari | Biometrics |
| Thomas | Krul | NBAC co-chair |
| Shunda | Louis | NIEMOpen |
| Christina | Medlin | NIEMOpen |
| April | Mitchell | Justice |
| Ashok | Singal | Biometrics |
| Beth | Smalley | NIEMOpen |
| Duncan | Sparrell | Cyber |
| Satish | Sripada | Biometrics |
| Jennifer | Stathakis | Biometrics |
| Stephen | Sullivan | NIEMOpen |
| Cynthia | Sun | International Human Services |
| Josh | Wilson | Biometrics |
Special thanks are also given to the following individuals for their guidance and expertise on architectural-related changes to the model:
NTAC Members:
| First Name | Last Name | Domain Subcommittee or COI |
|---|---|---|
| Aubrey | Beach | BAH |
| Jim | Cabral | InfoTrack US; NTAC Co-Chair |
| Tom | Carlson | GTRI |
| Mike | Douklias | Joint Staff J6 |
| Katherine | Escobar | Joint Staff J6; PGB Chair |
| Mike | Hulme | Unisys |
| Eric | Jahn | Alexandria Consulting |
| Dave | Kemp | NSA |
| Vamsi | Kondannagari | DHS |
| Peter | Madruga | GTRI |
| Christina | Medlin | GTRI |
| Scott | Renner | MITRE; NTAC Co-Chair |
| Duncan | Sparrell | sFractal Consulting |
| Jennifer | Stathakis | FBI |
| Stephen | Sullivan | BAH; NBAC Secretary |
The following individuals have participated in the creation of this specification and are gratefully acknowledged:
NBAC Members:
| First Name | Last Name | Company | Domain Subcommittee or COI |
|---|---|---|---|
| Meher | Alam | USDOT | Surface Transportation |
| Kamran | Atri | A4SAFE | Emergency Management; NBAC Co-Chair |
| Aubrey | Beach | BAH/Joint Staff J6 | NMO |
| Ernesto | Broderson | NTAC | |
| Jim | Cabral | InfoTech | NTAC Co-Chair, PGB |
| Maria | Cardiellos | IJIS | PGB |
| Tom | Carlson | GTRI/Joint Staff J6 | NTAC |
| Chuck | Chipman | GTRI/Joint Staff J6 | NTAC |
| Kelly | Cullinane | OASIS | OASIS |
| Mark | Dotson | GTRI/Joint Staff J6 | NMO, PGB alternate |
| Mike | Douklias | Joint Staff J6 | NTAC |
| Gary | Egner | Equivant | PGB |
| Chet | Ensign | OASIS | OASIS |
| Katherine | Escobar | Joint Staff J6 | PGB Chair |
| Taraneh | Etemadi | OBIM | NBAC, Biometrics |
| Lavdjola | Farrington | Joint Staff J6 | MilOps Co-Chair |
| Bob | Greeves | NCJA | Justice, PGB |
| Dave | Hardy | BAH/Joint Staff J6 | NBAC |
| Eric | Jahn | Alexandria Consulting | NTAC |
| Ashwini | Jarral | IJIS | NBAC, PGB alternate |
| Luke | Johnson | USDOT/National Highway Traffic Safety Administration (NHTSA) |
Surface Transportation |
| David | Kemp | NSA | NTAC |
| Vamsi | Kondannagari | Integral Consulting/OBIM | Biometrics |
| Thomas | Krul | Public Safety Canada | NBAC Co-Chair |
| Payton | Lamb | Commonwealth of Virginia Office of Data Governance and Analytics (ODGA) |
PGB |
| Shunda | Louis | BAH/Joint Staff J6 | NMO, Harmonization SC Co-Chair |
| Christina | Medlin | GTRI/Joint Staff J6 | Harmonization SC Co-chair |
| April | Mitchell | FBI | Justice Co-Chair; PGB |
| Scott | Renner | MITRE/Joint Staff J6 | NTAC Co-Chair |
| Beth | Smalley | Joint Staff J6 | MilOps Co-Chair |
| Duncan | Sparrell | sFractal | NTAC, PGB |
| Satish | Sripada | OBIM | Biometrics |
| Jennifer | Stathakis | FBI CJIS | Biometrics |
| Stephen | Sullivan | BAH/Joint Staff J6 | NBAC Secretary |
| Ryan | Triplett | Defense Forensic and Biometrics Agency | Biometrics |
| Josh | Wilson | FBI CJIS | Biometrics |
| Paul | Wormeli | Wormeli Consulting | NMO Communication and Outreach SC |
More detailed change descriptions are included in the README file in this package.
Revision tracking is managed by GitHub.
Commit history:
Updates to working drafts are made to the dev branch.
The full commit history can be found at https://github.com/niemopen/niem-model/commits/dev.
6.0 pull requests:
The following are links to the GitHub pull requests merged into the model for 6.0:
| Milestone | GitHub link |
|---|---|
| 6.0 PSD 01 | https://github.com/niemopen/niem-model/pulls?q=is%3Apr+milestone%3A6.0-psd01 |
Note that file diffs are available from each pull request.
6.0 issues:
The following are links to issues documenting the changes that have been made:
| Milestone | GitHub link |
|---|---|
| 6.0 PSD 01 model issues | niemopen/niem-model repo, issues with
milestone:6.0-psd01 https://github.com/niemopen/niem-model/issues?q=is%3Aissue+milestone%3A6.0-psd01 |
| 6.0 PSD 01 NDR-related issues | niemopen/niem-naming-design-rules repo, issues with
milestone:6.0-psd01 and label:model https://github.com/niemopen/niem-naming-design-rules/issues?q=is%3Aissue+milestone%3A6.0-psd01+label%3Amodel |
Copyright © OASIS Open 2023. All Rights Reserved.
All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
This specification is published under Attribution 4.0 International (CC BY 4.0). Code associated with this specification is provided under Apache License 2.0.
All contributions made to this project have been made under the OASIS Contributor License Agreement (CLA).
For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the NIEMOpen IPR Statement page.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Open Project (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. OASIS AND ITS MEMBERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THIS DOCUMENT OR ANY PART THEREOF.
As stated in the OASIS IPR Policy, the following three paragraphs in brackets apply to OASIS Standards Final Deliverable documents (Project Specifications, OASIS Standards, or Approved Errata).
[OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Open Project that produced this deliverable.]
[OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Open Project that produced this OASIS Standards Final Deliverable. OASIS may include such claims on its website, but disclaims any obligation to do so.]
[OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this OASIS Standards Final Deliverable or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Open Project can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Standards Final Deliverable, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.]
The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark/ for above guidance.