NIEM 5.0 Release (Current)

NIEM 5.0 is a major release, published December 2020. This is the most current NIEM release.

Resources

Highlights

  • Added Controlled Unclassified Information (cui) as auxiliary content

  • Added Statistics (stat) as auxiliary content

  • Added additional Public Health Emergency Operations Center (PH EOC) requirements to the Emergency Management domain

  • Moved Core code elements to code namespaces to break the import dependencies, allowing easy updates in minor releases

  • Harmonized FBI code sets across the NCIC, NDEx, UCR, and Justice namespaces

  • Replaced the full GML external standard with a simplified NIEM profile

  • Re-established the structures:sequenceID attribute allowing explicit ordering of repeated elements

  • Simplified the folder layout in the release package, removing extra nesting and versions.

See the NIEM 5.0 readme for a detailed list of changes.

The following are the NIEM specifications that can be used with this release:

  • NIEM Naming and Design Rules, version 5.0 [published 2020]

    The NIEM Naming and Design Rules specifies the data model XML Schema components and XML data for use with the National Information Exchange Model (NIEM). Learn more...

  • NIEM Information Exchange Package Documentation, version 5.0 [published 2021]

    The NIEM Information Exchange Package Documentation (IEPD) Specification specifies normative rules and non-normative guidance for building NIEM information exchange messages. It defines IEPD artifacts like subset schemas, extension schemas, and MPD catalogs; and recommends how the package should be structured. Learn more...

  • NIEM JSON Specification, version 5.0 [published 2021]

    The NIEM JSON Specification establishes the technical basis for using JavaScript Object Notation (JSON) as a data format for exchange of information consistent with NIEM-conformant schemas and information exchange package documentations (IEPDs). Learn more...

  • NIEM Conformance Specification, version 5.0 [published 2021]

    The NIEM Conformance Specification introduces the idea of NIEM conformance and provides a general normative definition for its meaning, how it applies, and to what it does and does not apply. It describes the benefits of conformance, and refers to sources of information, tools, and help. Learn more...

  • NIEM Code Lists Specification, version 4.0 [published 2017]

    The Code Lists Specification adds support for new capabilities of NIEM code lists beyond the basic enumeration representations provided by XML and JSON schema. Key features include the definition of codes in CSV or Genericode files, dynamic code lists via run-time binding, and multi-column code table support. Learn more...

  • NIEM Conformance Targets Attribute Specification, version 3.0 [published 2014]

    The Conformance Targets Attribute Specification (CTAS) defines how NIEM XML documents indicate what kind of artifact they are through the use of a conformance targets attribute. Learn more...

  • NIEM High-Level Version Architecture Specification, version 3.0 [published 2015]

    The NIEM High-Level Version Architecture (HLVA) Specification identifies the processes, artifacts, and responsibilities required to produce new releases of the NIEM model. It also establishes a regular release cycle for predictable and manageable NIEM updates. Learn more...

Specification Updates

Naming and Design Rules (NDR) 5.0

The NIEM Naming and Design Rules (NDR) specification was updated from version 4.0 to version 5.0.

Key changes include:

  • Simplified folder layout in the release package, removing version folders and unnecessary nesting (#140)

  • Changed the character encoding of the XML schemas from “US-ASCII” to “UTF-8” for better international support (#125)

  • Added attribute xml:lang to reference schemas (#153)

  • Updated structures and appinfo utility schemas to version 5.0 based on NDR updates (#157)

  • Reestablished the structures:sequenceID attribute (#154)

  • Updated the conformance targets to correspond with the new 5.0 version of the NDR

See the NDR 5.0 changes for more.

Release Stats

The following are some basic statistics for the 5.0 release.

NIEM 5.0 has 14 domains and 2 auxiliary namespaces.

Summary Counts

The table below breaks down property, type, and code counts by namespace group.

  • The “Core” group represents a single namespace (NIEM Core).
  • The “Domain” and “Code Set” groups combine the counts from multiple namespaces and are broken out in the subsequent tables.
Group Property Count Type Count Code Count
Core 1810 282 101
Domain 9743 2551 9590
Auxiliary 540 145 168
Code Set 56 1022 80310
Total 12149 4000 90169

Domain Counts

The counts in the following table represent the namespaces that make up the “Domain” group in the summary table above.

NS Property Count Type Count Code Count
ag 64 8
biom 1008 590 1327
cbrn 592 137
em 918 365 1240
hs 806 275 1048
im 445 94 1388
intel 56 14
ip 31 8 3
it 530 90
j 4023 489 361
m 333 47 180
mo 296 130 134
scr 577 253 3731
st 64 51 178

Auxiliary Counts

The counts in the following table represent the namespaces that make up the “Auxiliary” group in the summary table above.

NS Property Count Type Count Code Count
cui 20 12 161
stat 520 133 7

Code Counts

The counts in the following table represent the namespaces that make up the “Code Set” group in the summary table above.

NS Property Count Type Count Code Count
aamva_d20 92 743
ag_codes 62 79
apco 8 206
atf 8 98
bls 5 10 1455
can 3 6 174
cbrncl 131 2435
commodity 5 10 614
dea 3 6 553
edxl_rm 4 24
fips 3 6 9711
genc 4 8 6063
have-codes 24 43
hazmat 1 2 2458
hl7 1 2 82
iso_3166 4 8 5698
iso_4217 1 2 179
iso_639-3 1 2 7867
itcodes 44 2219
jc3iedm 2 4 364
jp2-0 1 2 11
jp3-52 3 5 117
mmucc 146 700
nces 1 2 50
ncic 152 31781
ndex 176 3643
nga 1 4 50
nlets 6 20
occs 5 10 1495
opm 1 2 22
sar 8 76
ucr 44 422
unece 7 14 226
usda_fsa 4 347
usps 3 6 276
xCard 1 2 9