Artifacts

NIEM artifacts are individual files or packages relating to NIEM releases or information exchanges.


Release Artifacts

Some of the artifacts below are specific to NIEM releases; others show how NIEM releases implement common kinds of artifacts like documentation spreadsheets and change logs.

Click on the Release Artifacts... section in the sidebar for more or jump directly to a NIEM release artifact below:

  • Release
    A release is a versioned set of schemas and supporting artifacts published by the NIEM Management Office. Release schemas include NIEM Core, domains and code tables.
  • Core Supplement
    A Core Supplement is an incremental NIEM release that contains new or updated components for the NIEM Core namespace. These changes are published in separate schemas that can be used in addition to the original Core namespace. Core Supplements are used as a way of 'adjusting' Core content while it is locked between major releases.
  • Domain Update
    A domain update is one or more schemas that constitute changes to a NIEM domain outside of the standard NIEM release cycle.
  • NIEM XML Schemas
    The NIEM release XML Schemas define the model content and the internal constructs needed to support the model. Schemas include Core, domains, codes, external standards, structures and appinfo.
  • README
    The release README file is a text file that provides a high-level overview of the changes made in the release, and in particular any changes that might affect Core.
  • Model Spreadsheet
    The NIEM model spreadsheet provides user documentation for the properties and types of Core and the domain namespaces.
  • Code Spreadsheet
    The NIEM Code spreadsheet provides user documentation for the codes defined in a NIEM release.
  • Change Log Spreadsheet
    The NIEM change log spreadsheet documents the changes between the given release and the previous one.
  • CSVs
    NIEM CSVs provide an alternate, non-authoritative representation of the NIEM schema content in a tabular format. They are made available to support developers who wish to import the model content without having to parse the schemas.

IEPD Artifacts

These artifacts are specific to NIEM messages.

Click on the IEPD Artifacts... section in the sidebar for more or jump directly to an IEPD artifact below:

  • Information Exchange Package Documentation (IEPD)
    An Information Exchange Package Documentation (IEPD) is a collection of NIEM artifacts. They define and describe the context, content, semantics, and structure of one or more implementable information exchanges.
  • Information Exchange Package (IEP)
    An Information Exchange Package (IEP) is an actual NIEM message exchanged between stakeholders. The format for this message is defined by the schemas and artifacts in its corresponding Information Exchange Package Documentation (IEPD).
  • Subset Schema
    A subset schema is a customized version of a NIEM schema that contains only the properties, types, and codes that are needed for a particular information exchange, plus any of their required dependencies.
  • Extension Schema
    In an extension schema, an IEPD developer can create new NIEM-conformant properties and types to represent message data requirements that are not available in a NIEM release. Extensions schemas are used in combination with NIEM subset schemas to define the structure and meaning of a message.
  • MPD Catalog
    A MPD Catalog is an XML document that contains basic information about the package (name, description, purpose, etc.) and a listing of the package's key artifacts. It is a required artifact in an IEPD.
  • Conformance Report
    A conformance report specifies how and to what degree the IEPD is NIEM-conformant.

General NIEM Artifacts

The artifacts below can be used with either NIEM releases or IEPDs.

  • Code Lists
    NIEM Code Lists are special files that support the use of enhanced code lists in NIEM, beyond the basic capabilities provided by XML and JSON schema enumerations.

Other Artifacts

The artifacts below are used by NIEM but are defined by outside specifications or sources.

  • JSON-LD Context
    A JSON-LD context file is a file that can be used to associate namespace prefixes with the full URIs that they represent.
  • XML Catalog
    An XML catalog is a XML document that assigns locations to files. This can be used to override the file locations assigned by NIEM XML schema import statements without having to modify the original schema itself.