FAQs
The GJXDM consists primarily of object classes and properties. The Object classes are converted into XML Schema types. They eache represent a specific syntax and structure for a set of values. The properties are converted into XML Schema attributes and elements. They each represent characteristics, or values of things.
The GJXDM is a reference model that is based on a class hierarchy of many specific objects (xsd:type) derived from one very general object (SuperType). Each object contains any number of properties (xsd:element or xsd:attribute). These properties may be simple or complex elements (containing sub-elements). The highest level object classes (under the SuperType) are PersonType, OrganizationType, PropertyType (i.e., things), LocationType, ContactInformationType (i.e., electronic means of contact), ActivityType, DocumentType, and other smaller supporting types.
There is also a special class of RelationshipType used to specify meaning to a link between two object instances. On many of these objects, there are metadata properties (xsd:element or xsd:attribute) that supplement meaning. For example, all properties of MeasureType have a mandatory "units" attribute.
The components were chosen from a variety of legal and technical sources that preceded Global Justice XML Data Model (GJXDM). Data components were built from approximately 35 data dictionaries, XML schema documents, and XML data models under development or in use by various law enforcement and judicial organizations.
These sources yielded approximately 16,000 data components (elements, attributes, and types). Through study and analysis of the similarities and differences among these components, approximately 2,200 properties (xsd:element, xsd:attribute) and 550 types (xsd:type) were synthesized to represent a common set of elements and types, the GJXDM.
It is important to realize that the authors did not invent the content. Instead, the GJXDM tries to capture the requirements of the 35 data sources as completely and accurately as possible. However, compromises were necessary in order to follow the basic design principles and criteria set forth by the XML Structure Task Force (XSTF).
The source data requirements analyzed by the XML Structure Task Force (XSTF) were not consistent in their use of codes. For components with the same meaning, some sources used codes; others used literals. When codes were used, they were not always drawn from the same code table, and some code tables are specific to local jurisdictions.
In order to provide maximum flexibility, the GJXDM usually provides both a code type element and a text type element (that may contain a literal). There are particular code tables that are always common; for example National Criminal Information Center (NCIC)-2000 and the American Association of Motor Vehicle Administrators (AAMVA). Therefore, the XSTF provided a mechanism to use codes from other namespaces. This enables the use of standards without restriction to a single internal set of values.
This also does not require a change to the GJXDM namespace every time external standards change. For example, the XSTF has created an NCIC-2000 schema in its own namespace that contains the NCIC code tables. Temporarily, the XSTF refers to this as the NCIC-2000 proxy schema because it is external to the GJXDM namespace and can be updated without causing the GJXDM to change. The XSTF anticipates that local jurisdictions will want to create their own proxy schemas for their local code tables as well.
NISS Clearinghouse
Reference elements exist to allow schema designs with multiple occurrences of the same information object or instance to reference a single content-filled object rather than to repeat it in different locations.
This ensures that the same information object does not repeat multiple times and mislead the receiver into thinking there are multiple (different) objects. If an object is recorded once and referenced from everywhere else it is used, then there is a lower risk of misunderstanding or inconsistency. This requires one XML element of type ReferenceType for each element in the model. That is, for every element named "X" in GJXDM, there is a second element named "XReference" that is intended to reference, or "point to", an element named X appearing elsewhere in the instance.
While this technique makes the GJXDM somewhat redundant, the use of separate elements for bearing content and content references makes it easier for applications to know immediately if and when they are looking at the information object itself or a reference to it.
A GJXDM or NIEM reference Information Exchange Package Documentation (IEPD) is a specification for a model document or transaction that has been derived from and uses the GJXDM / NIEM. It is currently considered a suggested model for a particular kind of document.
For example, an Arrest Warrant reference Information Exchange Package Documentation (IEPD) uses the GJXDM, is specified in XML Schema, and is a reference for building an Arrest Warrant. This means that it can be used as is, or extended for a more specific or local purpose, or to guide construction of another similar document specification. There also some examples of reference IEPDs that use the NIEM such as, SAR for Local and State Entities IEPD v1.1.
A "reference" is a starting point for a standard, not a rigid, fixed standard. For more information on reference Information Exchange Packages, see Reference Information Exchange Package Schemas.
GJXDM versions are numbered by three integers X, Y, and Z delimited by periods (X.Y.Z).
Each integer represents a particular class of change:
X = Major revisions to the model or representations of the model as rendered in a schema (as XML or other markup)
Y = Minor changes that do not maintain forward compatibility
Z = Minor changes that maintain forward compatibility
A version number should NOT be confused with decimal numbers. X, Y, and Z are integers, not digits, and may become greater than 9. For example, 4.89.113 is a legitimate release number (though not likely to ever be used).
GJXDM version 3.0 is the first operational release. Version 3.0 instances will be forward compatible with and validate using the version 3.0.2 schema or appropriate 3.0.2 schema subsets. See the question on compatibility for more details. Prereleases used four numbers to designate versions. There were only four prereleases: 3.0.0.0, 3.0.0.1, 3.0.0.2, and 3.0.0.3. Except for 3.0.0.2, prereleases are still available, but are no longer maintained or supported.
"NIEM provides a standardize set of reusable data components and XML representation for enabling interoperable information sharing for law enforcement at all levels of government. These components, a well-defined architectural framework, and set of tools provide for the consistent and efficient implementation of information exchange specifications. Additionally, the NIEM program and governance structures provide a consensus framework for participation of stakeholders at all levels of government which is essential in the identification of requirements and harmonization of components to support the information sharing mission."
Associations, roles, and metadata implement the ID and IDREF XML mechanisms. Through the use of ID and IDREF XML data becomes less redundant; ID and IDREF also allow us to take a relational approach for defining data. This results in a less hierarchical and flatter XML file which moves away from using only element inclusion to associate objects.
Although it may not be readily obvious, associations, roles, and metadata do somehow exist in most sets of business requirements. In many cases these may not be easily noticeable in their native form, so the tricky part is being able to pick these out and translate them to NIEM constructs. This underscores the importance of having an experienced and NIEM-cognizant facilitator to assist during the domain modeling phase of the IEPD process. The facilitator's job is to keep in mind the NIEM while considering the input from subject matter experts (SMEs). It should not be assumed that SMEs have previous knowledge of the NIEM so it is up to facilitator to serve as a mediator between business concepts and NIEM concepts. The result should be an agreed upon domain model that represents the business requirements while leveraging concepts set forth by NIEM. A precise and accurately defined domain model will result in more straightforward mapping.
Augmentation is a NIEM-specific methodology that allows for re-use of extensions that occur within a particular domain for use elsewhere. Augmentation does not implement ID and IDREF; instead it relies on element inclusion for associating the augmentation information to the base object, so essentially the augmentation becomes a property of the base object. Mapping to elements that exist in NIEM augmentation structures should not be any different than traditional mapping.
The National Information Exchange Model (NIEM) is a Federal, State, Local and Tribal interagency initiative providing a foundation for seamless information exchange. NIEM is a framework to:
- Bring stakeholders and Communities of Interest together to identify information sharing requirements in day-to-day operational and emergency situations;
- Develop standards, a common lexicon and an on-line repository of information exchange package documents to support information sharing;
- Provide technical tools to support development, discovery, dissemination and re-use of exchange documents; and
- Provide training, technical assistance and implementation support services for enterprise-wide information exchange.
NIEM was launched on February 28, 2005, through a partnership agreement between the U.S. Department of Justice (DOJ) and the U.S. Department of Homeland Security (DHS) and signed by Chief Information Officers. It leverages the data exchange standards efforts successfully implemented by the Global Justice Information Sharing Initiative (Global) and extends the Global Justice XML Data Model (GJXDM) to facilitate timely, secure information sharing across the whole of the justice, public safety, emergency and disaster management, intelligence, and homeland security enterprise.
NIEM Website: https://niem.gov
The NIEM mission is to assist in developing a unified strategy, partnerships, and technical implementations for national information sharing—laying the foundation for local, state, tribal, and federal interoperability by joining together communities of interest. That foundation consists of three parts: core data components, reusable XML exchange packages, and business process models for information sharing.
The goal of the NIEM is to prevent fragmentation and semantic non-interoperability in Extensible Markup Language (XML) standards within and across agencies through a proactive collaborative initiative, to develop and implement common XML information sharing standards that meet critical homeland security data exchange needs.
The NIEM has the following objectives:
- Develop a unified strategy within the U.S. Departments of Homeland Security (DHS) and Justice (DOJ) for an XML-based information sharing capability.
- Develop an initial implementation of the NIEM that satisfies Executive Order (EO) 13356 and Homeland Security Presidential Directive (HSPD)-11.
- Develop an exchange layer for the XML profile implementation of the Federal Enterprise Architecture Data Reference Model (FEA DRM).
- Develop an XML profile of NIEM that implements the FEA DRM.
- Provide technical assistance and training to local, state, tribal, and federal organizations seeking to implement revisions to the GJXDM and support the new national standards emerging from joint efforts under this Memorandum of Understanding (MOU).
- Develop and demonstrate an application of the NIEM for the Bureau of Border and Transportation Security (BTS) operational domain involving customs and border patrol agent data exchange as the first pilot.
- Build out a framework for many pilot use cases under the umbrella of the NIEM.
External components are encapsulated in NIEM-conformant components. This introduces the concept of “external adapter” types. An external adapter type is a NIEM conformant XML Schema complex type that wraps a set of external content.
These adapter types and container elements are XML Schema components, and so are defined within the namespace of the schema currently being defined.
This article specifies two constructs, which contain external content. The first is the external adapter type. This type is a NIEM-conformant type that contains attributes and elements from external namespaces. The second is the external container element. The container element is used when an external namespace provides top-level types for use, but does not provide appropriate top-level elements. In such a case, create a container element of the externally-provided type. Container elements are defined in NIEM conformant namespaces, are named differently than regular NIEM-conformant elements, and are used in a more restricted way.
Consistent with the fundamentals of NIEM, XML elements are used for semantics, and XML Schema types are used to contain necessary structures. Specific rules for definition of adapter components will take this approach, focusing on encapsulating external structures as NIEM-conformant types, within strongly-defined elements with specific semantics.
If an external type needs to be extended for use, such extension should be done outside a NIEM-conformant namespace. These structures are intended to encapsulate external content. They are not indented to introduce extensions and modifications to external content into NIEM-conformant namespaces. If an application schema needs to be constructed to conform to an external standard, the schema should be created in a user defined namespace, outside the NIEM-conformant namespaces. Then, those external components should be referenced by NIEM-conformant external adapter types and external container elements.
The NIEM is a collaborative development initiative with the initial development principally supported by DHS and DOJ. The NIEM development strategy will leverage DOJ’s GJXDM as the principal baseline data model. The pilot project will develop the NIEM as a re-branded version of the GJXDM, extending its scope and aligning its structure and associated processes to include the concept of core data types.
NIEM is an ambitious undertaking that faces numerous technical and logistical challenges and associated risks. The development strategy will mitigate these risks by leveraging the proven technologies and processes of the GJXDM; revising and extending the GJXDM architecture, components, and processes for the NIEM based on an extensive GJXDM knowledge base of successful applications and lessons learned; applying industry best practices; and scoping the initial NIEM release to a small high priority set of core components.
NIEM's strategy will provide core value propositions in several respects:
- Facilitate growth of data model through harmonization of new data components
- Coordinate independent project teams within DOJ and DHS
- Separate core entities and attributes from domain specific components
- Produce multiple modular schemas (universal core, community-of-interest core, and domain specific)
- Facilitate discovery of reusable data components
- Facilitate assembly of reusable exchange packages
- Adopt a standard for assigning context
- Maintain compatibility with GJXDM for future work
- Demonstrate use of core in federated query, and
- Coordinate joint development and joint governance of core entities and exchanges
The NIEM's development strategy revises and extends the GJXDM architecture, components, and processes for the NIEM based on an extensive GJXDM knowledge base of successful applications, lessons learned, and apply industry best practices. NIEM's strategy will provide core value propositions in several respects:
- Facilitate growth of data model through harmonization of new data components
- Coordinate independent project teams within DOJ and DHS
- Separate core entities and attributes from domain specific
- Produce multiple modular schemas (universal core, community-of-interest core, and domain specific)
- Facilitate discovery of reusable data components
- Facilitate assembly of reusable exchange packages
- Adopt a standard for assigning context
- Maintain compatibility with GJXDM for future work
- Demonstrate use of core in federated query
- Coordinate joint development and joint governance of core entities and exchanges
Source: https://www.niem.gov
Rather than nationwide integration of all local, state, tribal, and federal databases, NIEM focuses on cross‑domain information exchanges between communities of interest (COIs), across all levels of government—whether that is between individual local law enforcement agencies, law enforcement and emergency service agencies and other domains, or between local, state, tribal, regional, and federal agencies. As a consequence, not all data needs to be
NIEM‑compliant, only that data that is being shared across domains.
.NIEM is a framework to:
- Bring stakeholders and Communities of Interest together to identify information sharing requirements in day-to-day operational and emergency situations;
- Develop standards, a common lexicon and an on-line repository of information exchange package documents to support information sharing;
- Provide technical tools to support development, discovery, dissemination and re-use of exchange documents; and
- Provide training, technical assistance and implementation support services for enterprise-wide information exchange.
The National Information Exchange Model (NIEM) is identified by the ISE as a standards body, which provides a set of reusable common information standards. To effectively exchange information across domains, there must be a common semantic understanding of data among participating agencies, and the data must be formatted in a semantically consistent manner. For example, two agencies may each gather information about persons charged with committing a crime. If the agencies share information regarding these persons, there must be a common understanding of the terminology each agency uses. One agency, for example, may refer to the person as the "offender," while another refers to them as the "defendant." Agencies do not necessarily need to entirely retool their information systems or adopt standards and coding schemes that impose an artificial uniformity in data collection that fails to meet their operational business needs, but there must be common understanding and semantic consistency in the structure of the data that crosses agency lines if it is to be successfully shared.
Information that is exchanged between agencies can be broken down into individual components—for example, information about people, places, material things, and events. Data components within an information exchange commonly shared and understood among all domains are identified as universal components (e.g., person, address, and organization), while components used in exchanges between multiple domains, but not universally shared, are identified
as common components (e.g., offense, sentence, and disposition). Components managed by a specific COI (e.g., appellate case decision and arrest agency) are considered domain specific.
When working with the National Information Exchange Model (NIEM), information that is exchanged is broken down into the following components:
Universal
Common, and
Domain-specific
Data components within an information exchange commonly shared and understood among all domains are identified as universal components (e.g., person, address, and organization), while components used in exchanges between multiple domains, but not universally shared, are identified as common components (e.g., offense, sentence, and disposition). Components managed by a specific COI (e.g., appellate case decision and arrest agency) are considered domain specific.
NIEM IEPD development steps overview:
Conduct Business Analysis and Requirements Review: This step defines the business requirements associated with an information exchange for which NIEM is used. It incorporates scenario-based planning, which is the
recommended methodology for elaborating the business context of events, incidents, or circumstances in which information exchange takes place.
Complete Information Exchange Mapping and Data Modeling: This uses established methodologies to map and model operational information exchanges. Moreover, it describes the process a COI follows to map its data sources to NIEM and identify IEPDs available for reuse and/or gaps between its data source and NIEM. COIs can use the NIEM repository to search and discover existing data components to decrease the time needed to construct IEPDs.
Build and Validate IEPDs: This step addresses the importance of using common documentation standards, such as IEPDs, to ensure there is consistency in the way information is captured, stored, and exchanged and that uniform methodologies exist to support the generation of the IEPDs. Once the COI validates its IEPD, it may submit the IEPD to its domain specific area (proceed to Step 5) or nominate data components for inclusion into universal or common (proceed to Step 4).
Data Harmonization and Promotion: The appropriate NIEM governance stakeholders form a team to review an IEPD submission and determine whether any of the data components should be included in universal or common. The team evaluates the submission and makes a recommendation regarding which, why, how, and when to integrate the proposed changes into NIEM.
Publish and Implement IEPDs: Once an IEPD is approved, it is stored in the NIEM repository. Other stakeholders or COIs can then search and discover published IEPDs for reuse or extend for a specific instance of the information exchange.
Garner Feedback and Enhance and Expand IEPDs: This step describes how the COIs work with the NIEM Program Management Office (PMO) to ensure existing IEPDs remain up to date and compliant with NIEM.
NIEM includes a set of operational processes and procedures, standards, documentation, tools, training, and technical assistance which support each step in the NIEM IEPD life cycle.
- Documentation includes the NIEM Concept of Operations (CONOPS), User Guide, and NIEM Naming and Design Rules (NDR).
- Standards include IEPDs and other process standards identified in supporting documentation.
- Training and Technical Assistance is facilitated by the NIEM Web site, training materials, in person instruction, executive materials, as well as a help desk.
- Tools include those used for activities such as scenario‑based planning, information exchange mapping and modeling, and IEPD generation.
- Governance and Processes include the structure to manage and maintain NIEM and the processes and procedures behind its operations.
NIEM documentation and standards include a data dictionary, data model, and IEPDs. The data dictionary is a well‑defined vocabulary of data names and structures. The data model is the body of concepts and rules that underlie the structure of the data dictionary, including data components arranged by domain, the type of data being represented (date, integer, Boolean, string, etc.), and a semantically precise, context‑rich definition of each component. Together the data dictionary and model become a database, from which XML schemas are generated. These schemas contain the data components that are reused to construct the IEPDs.
NIEM standardizes the artifacts necessary for interagency information exchange into an IEPD. NIEM makes available reusable IEPD content used in data exchanges; creates and disseminates tools to support rapid IEPD development and deployment; and provides managed processes for the creation, support, dissemination, and implementation of information exchanges. In order to support these exchanges, NIEM provides a:
- Central place that allows for the registration and discovery of IEPDs
- Means to ensure IEPDs are developed using an established, conventional method that results in machine readable, easy‑to‑understand artifacts.
- Place where IEPDs, certified by authoritative sources, can be highlighted and disseminated.
There are a variety of commonly used standards that are currently represented in XML Schema. There must be a method for NIEM to promote and use these external standards where requirements dictate.
There are two fundamental cases:
- Case 1: NIEM IEPDs reference, import, and use components in an external standard schema or namespace that does not conform to NIEM Naming and Design Rules.
- Case 2: External schemas reference, import, and use NIEM components.
Case 1. Presents a methodology for including non-NIEM components in NIEM-conformant schemas. It enables data modeling efforts to build NIEM-conformant components from non-NIEM data objects.
Case 2. The use of NIEM in external standards will likely involve per-standard recommendations. Use of NIEM should maintain compatibility with those standards, by doing things as the external standards intend. For example, Security Assertion Markup Language (SAML) uses attribute assertions, which each have a name and a value. In such a case, NIEM conformant content should be carried as a set of values, with each name indicating a NIEM-conformant component. Specific rules and guidelines will be developed for each standard. Overarching guidelines for using NIEM content in external standards will be developed. Such rules will be overridden by rules for specific standards. General rules will involve (1) focusing on elements as the prime semantic construct in NIEM-conformant data models, and (2) focusing on types as the prime structural entity. These guidelines will help maintain consistency in uses of NIEM content between various architectures.
The term “schema component” is used for any object constructed by XML Schema.
Schema components are specified by the XML Schema specification. They include attribute declarations, type definitions, etc. They include attribute uses (which are distinct from attribute declarations) and use of model groups (distinct from model group definitions). In the National Information Exchange Model (NIEM) the term “NIEM Component” is used for a schema component from a namespace that is NIEM-Conformant.
From XML Schema Part 1: Structures 2d Ed
W3C Recommendation 28 October 2004
[Definition:] Schema component is the generic term for the building blocks that comprise the abstract data model of the schema. [Definition:] An XML Schema is a set of schema components. There are 13 kinds of component in all, falling into three groups. The primary components, which may (type definitions) or must (element and attribute declarations) have names are as follows:
• Simple type definitions
• Complex type definitions
• Attribute declarations
• Element declarations
The secondary components, which must have names, are as follows:
• Attribute group definitions
• Identity-constraint definitions
• Model group definitions
• Notation declarations
Finally, the "helper" components provide small parts of other components; they are not independent of their context:
• Annotations
• Model groups
• Particles
• Wildcards
• Attribute Uses
The term “NIEM Component” is used for a schema component from a namespace that is NIEM-conformant, which follows the rules defined by the NIEM Naming and Design Rules (NDR) for NIEM conformance. The NIEM NDR provides a profile of W3C X ML Schema, along with additional constructs to support creating a data model. In order to be NIEM-conformant, a namespace must claim conformance, and must follow specific rules about structure, XML Schema feature usage, naming, and documentation.
NIEM conformance is determined at the namespace level, based on a reference schema for a particular namespace. To determine if a namespace is NIEM-conformant, the reference schema for the namespace is tested against a set of NIEM conformance rules.
These rules include such things as:
1. The schema must claim to be NIEM conformant.
2. The schema must have a target namespace, over which the schema author has dominion.
3. Schema components must be documented.
4. Component documentation must take specific forms, including being supported with XML annotations from a NIEM-specific namespace, to support data modeling concepts.
The term "External Component" is used for a schema component from a namespace that does not follow the rules for NIEM conformance.
Examples of external, non-NIEM standards include:
· GML: Geography Markup Language. GML is a prime candidate for content that may be included in NIEM structures.
· XHTML: Extensible Hypertext Markup Language. This language would likely be used for exchanging simple structured text.
· SAML: Security Assertion Markup Language. This is a likely language into which NIEM content will be embedded. Some SAML assertions will likely need to contain content defined by NIEM.
There are numerous goals in defining and using adapter components:
- Ensure that content may be carried as defined by external standards, without modification. It would be bad to modify external content standards to make them "fit" NIEM. Instead, we should carry external content exactly as would be expected by external tools.
- Allow modeling efforts to define the granularity of use of external content as needed.
Different groups require different levels of resolution into external standards. For example, one group may exchange a large block representing the geography of a large urban area, while another group may only exchange a single geographic point.
Both may be using the same external standard, but will need to use different parts, with different sizes, and different semantics.
- Ensure specific modeling efforts (e.g. NIEM core, domains, or IEPDs) are independent of a centralized process for use of external components. Developers should be able to immediately utilize standards required for their area of expertise.
- Provide points for harmonization. NIEM-conformant components that use external standards may be integrated into the core of NIEM. By using narrowly defined components with specific semantics, common uses that meet broad requirements may be identified and pulled up into the core of NIEM.
- Reduce coupling between NIEM schemas and external schemas. This method ensures that any given implementation uses external schemas through specific known points of access, without excessive dependence on deeply nested external components.
Use of external schemas within NIEM should not require that each must be harmonized with components in or placed directly into NIEM. XML Schema provides namespaces to maintain semantic independence or uniqueness.
There are potentially two ways to use components from an external standard within the NIEM framework:
Methods of integrating external components
Profile the standard and insert its components into a NIEM namespace (potentially within Common).
Advantages:
- The "standard" components will become part of NIEM.
- The "standard" components will be registered with other NIEM components.
- The "standard" components will have precise semantics (because they ARE NIEM components).
Disadvantages:
- Anytime the standards change, then NIEM must potentially be changed.
- The "standard" components must be factored to conform to the NIEM NDR.
- The "standard" components may need to be harmonized with the NIEM components they potentially duplicate in whole or part (from a semantic perspective).
- The "standard" components may not be used in the same structural representation as the standard intended.
- Interoperability may require translations back to standard structures. (Tools expecting standard geospatial component structures may not recognize or work with those components if they have been re-structured per the NIEM NDR.).
- EACH standard that NIEM incorporates in this manner will result in the preceding disadvantages. Thus, insertion will require a lot of unnecessary extra work.
Provide a mechanism to reference and import the standard schemas/namespaces and use the components they contain within IEPDs constructed from NIEM components.
Advantages:
- Standards components are used within IEPDs in the same structure they were intended without the need to translate -- a potential boost to interoperability.
- Tools designed to recognize (parse) standard components from other namespaces will recognize these components.
- No other refactoring, integration, harmonization, or maintenance of these standards is required (even if the standards change).
- Components in preferred standards can still be registered with and discovered in a repository of NIEM components (requires storage of metadata about the standards).
- Subset schemas of these standards can be maintained and stored locally as required for use within IEPDs, a registry, etc.
Disadvantages:
- A NIEM structure (an adapter or container construct) will be required to encapsulate non-conforming components or schemas within an IEPD schema and to identify and preserve the semantics of those components.
A namespace can be labeled as NIEM-conformant. Any namespace that is not NIEM conformant is referred to as an external namespace. A namespace is NIEM-conformant if its reference schema follows NIEM conformance rules. A schema component must be in a NIEM-conformant namespace to be considered NIEM conformant. For any component of a schema to be conformant, the entire schema must be conformant. A NIEM conformant schema must claim to be conformant. This occurs when the document element, the schema element, has a child annotation with a child appinfo with a child element i:conformant with the character child "true". In other words, the XPath
"/xsd:schema/xsd:annotation/xsd:appinfo/i:conformant" has the value "true".
<xsd:schema ...>
<xsd:annotation>
<xsd:appinfo>
<i:conformant>true</i:conformant>
</xsd:appinfo>
</xsd:annotation>
</xsd:schema>
Non-Schema Namespaces
An external namespace may be defined by a non-schema mechanism, such as DTD. In such a case, a placeholder schema would be created to represent the exact constructs referred to from the NIEM-conformant schema. A placeholder schema would not represent the deeper XML content of such namespaces. Instead, it would define placeholder elements and additional required constructs that are further defined by the non-XML Schema standard.
For example, XHTML 1.0, which has no normative XML Schema definition, may be considered an external namespace. XHTML defines a namespace, and numerous elements within that namespace. Were a NIEM-conformant schema specification to use the element "xhtml:ul" (an unordered list), it would use a reference. In order for schema validation to proceed normally, a schema would have to define that element. However, there is no such schema for Non-XML Schema specifications. The schema that is created to fulfill that role is the placeholder schema. Placeholder schemas should only represent the necessary components directly referred to from NIEM-conformant schemas.
Importing of External Namespaces
When NIEM namespaces are imported, the import statements are documented with a description of how the namespace is relevant to the namespace being defined. External (non-NIEM) namespaces should be documented with additional information, including:
1. An indication that the imported namespace is not NIEM-conformant.
2. The URI for a source of the reference schema for the namespace
3. Version information
4. Information about the body responsible for the standard, including:
a. Contact information
b. URI
Additional metadata will be defined, as the NIEM NDR is further defined. For the time being, the metadata should be included as documentation elements.
A NIEM external adapter type is a complex type that has the following qualities:
1. It is a special form of NIEM-conformant type. It may be used as the type of any NIEM-conformant element.
2. An adapter type should compose a single semantic entity. That is, the subparts of the type should appear together because they form the definition for some concept, not simply as a way of wrapping a block of external content.
3. An adapter type should be documented, as should any NIEM-conformant type.
4. It contains content from an external namespace, including:
a. Attributes from an external namespace
b. Attribute groups from an external namespace
c. A single XSD sequence containing zero or more of:
i. Elements from an external namespace
ii. Model Groups from an external namespace. These are named groups of elements defined schemas.
iii. External container elements, from a NIEM-conformant namespace. These are used when an external type must be used.
5. It must extend the "ComplexObjectType" from the NIEM structures namespace
6. It may not directly reference any other complex or simple types. Such types should be accessed via an external container element.
7. It may not directly reference other NIEM content. Apart from the "ComplexObjectType", all content of an external adapter type should be external.
8. The content it references may be from more than one external namespace.
9. Each referenced external component must be individually documented, describing the meaning of the external component
Additional annotations may be introduced as the NDR is developed.
An example of the simple case shows an adapter type directly referring to an external element:
<complexType name="PointType">
<annotation>
<documentation>
SUMMARY OF TYPE GOES HERE
</documentation>
</annotation>
<complexContent>
<extension base="s:ComplexObjectType">
<sequence>
<element ref="gml:Point">
<annotation>
<documentation>
DESCRIPTION OF EXTERNAL ELEMENT GOES HERE
</documentation>
</annotation>
</element>
</sequence>
</extension>
</complexContent>
</complexType>
An alternate case occurs when types from an external standard need to be used, instead of elements.
The term “External” is used as a suffix to element names in the NIEM conformant namespaces. An element with a name that ends in “External” is referred to as an external container element. Such an element is defined when a NIEM standard needs to reference XML Schema types from an external namespace.
If an external namespace defines elements that are appropriate for use, the elements should be referenced by external adapter types, and external container elements are unnecessary. External container elements are needed to create container elements for types from external namespaces.
An external container element has the following characteristics:
Its name ends in "External".
It is not a NIEM-conformant element.
It may only be referred to by external adapter types. It is an error for any other component to refer to an external container element.
The type of the element is a simple or complex type from an external namespace. The element definition may not reference any other external components.
An external container element may not specify a substitution group.
External container elements may not be referenced by standard conformant components.
They may only be referenced by external adapter types.
Here is an example definition of an external container element:
<element name="PointExternal" type="gml:PointType">
<annotation>
<documentation>
DESCRIPTION OF EXTERNAL TYPE GOES HERE
</documentation>
</annotation>
</element>
Note that the definition is very simple: it provides a container for an external type, and is clearly labeled as non-NIEM content by the suffix "External".
The external container element may be used by an adapter type, as the following example shows:
<complexType name="PointType">
<annotation>
<documentation>
SUMMARY OF TYPE GOES HERE
</documentation>
</annotation>
<complexContent>
<extension base="s:ComplexObjectType">
<sequence>
<element ref="this:PointExternal"/>
</sequence>
</extension>
</complexContent>
</complexType>
External container elements are not NIEM-conformant data model components. Instead, they create container for external types. They are clearly identified external by their names (suffixed with "External"). External elements (that come from non-NIEM namespaces) are clearly identified as external by their namespaces.
The syntax for an instance of an association is simple. Take, for example, the marriage of Adam and Barbara Smith:
<MarriageAssociation>
<SpouseRef s:ref="A"/>
<SpouseRef s:ref="B"/>
<MarriageDate>1937-05-12</MarriageDate>
<DivorceDate>1973-06-02</DivorceDate>
</MarriageAssociation>
Interpreting the above XML fragment is straightforward:
There is an association that we call a marriage. You can tell it is an association, and not a thing, because it is named “something association”.
This marriage association has two spouses, a marriage date, and a divorce date.
One spouse is referenced as the object with the identifier A. The other spouse is identified by the ID B.
These objects are specified elsewhere in the same XML instance: Object A is specified as follows:
<Person s:id="A">
<PersonName>
<PersonFullName>Adam Smith</PersonFullName>
</PersonName>
</Person>
Object B is specified as follows:
<Person s:id="B">
<PersonName>
<PersonFullName>Barbara Smith</PersonFullName>
</PersonName>
</Person>
Other elements in the association specify more information about the association:
<MarriageDate>1937-05-12</MarriageDate>
<DivorceDate>1973-06-02</DivorceDate>
The marriage date and divorce date are specific to the relationship between the two spouses, and so is a natural fit for an element of the association.
The definition of an association is composed of several parts:
1. An element that identifies the specific semantics of the association.
For each semantically distinct association, we define an element. Each element will have annotations indicating the specific meaning of the association. Such documentation is not shown in this document, but follows the guidelines established for GJXDM 3.0. The syntax is standard XML Schema. For example, here is the definition for a parent-child element:
<xs:element
name="ParentChildAssociation"
type="ParentChildAssociationType"/>
We may wish to define a more-specific type of parent-child association. For example, an adoptive parent-child association:
<xs:element
name="AdoptiveParentChildAssociation"
type="ParentChildAssociationType"/>
If we wanted to make the type specific to an adoptive parent-child situation, then we define a new type, instead of reusing the general parent-child type.
2. A type for the association. The type may be have precise semantics, or may be a more generally defined type.
The definition of types for associations is done as needed, depending on the content of the types. We do not, as a rule, define a new type for each use or semantic definition of an association. Instead, we define them as necessary, to accommodate the content required. Here is an example definition for a type for the parent-child association:
<xs:complexType name="ParentChildAssociationType">
<xs:complexContent>
<xs:extension base="u:AssociationType">
<xs:sequence>
<xs:element ref="this:ParentRef" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="this:ChildRef" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
The type definition has several parts:
The name of the type is “something AssociationType”. This makes associations between objects distinct from other types of object definitions.
The type is derived from another association type. This allows definition of type hierarchies for associations, and the definition of characteristics that are shared across multiple association types. The content of the association is a sequence of elements. The content of the association could be entirely related objects. The association could also contain characteristics of the associations, such as dates, names, identifiers, etc.
This technique provides a general method for applying metadata and additional content to data objects in NIEM. It enables users to create a block of Metadata in NIEM metadata and apply it to objects in exchanges. An object states what metadata applies to it using the metadata attribute.
In this example, we have a specific reported date for a person object:
<Person s:metadata="MD">
<PersonName>
<PersonGivenName>Adam</PersonGivenName>
<PersonSurName>Brooks</PersonSurName>
</PersonName>
<PersonBirthDate>1960-10-07</PersonBirthDate>
</Person>
<Metadata s:id="MD">
<ReportedDate>2005-08-01</ReportedDate>
</Metadata>
This example has a few interesting features:
• The person object refers to its metadata
– The reference uses the attribute s:metadata
– The reference is to the object with id MD
• The metadata is a separate element
– The element is called Metadata.
– The metadata object has the id ‘MD.
• The ID is conveyed with the attribute s:id
– The metadata object contains an element ReportedDate
Usage of Roles can be demonstrated via the following example:
<Person s:id="P1">
<PersonName>
<PersonFullName>Fred Smith</PersonFullName>
<PersonName>
</Person>
<EnforcementOfficial>
<RoleOfPersonReference s:ref="P1"/>
<EnforcementOfficialBadgeID>
<ID>101101</ID>
</EnforcementOfficialBadgeID>
</EnforcementOfficial>
From the above example, it is clear that Fred Smith has a "Role", and that role is of an EnforcementOfficial.
"Roles" can be defined in a manner similar to that of defining "Associations", that is, by creating a type of "Role" and then creating an element that identifies that type. See below for an example.
<complexType name="EnforcementOfficialType">
<complexContent>
<extension base="this:SuperType">
<sequence>
<element ref="this:RoleOfePersonReference" minOccurs="0" maxOccurs="unbounded"/>
...
... Additional elements defined for enforcement officials ...
...
</sequence>
</extension>
</complexContent>
</complexType>
<element name="EnforcementOfficial" type="EnforcementOfficialType"/>
In the above example, a "Role" is defined for a Person via the RoleOfPersonReference element that indicates the type of the base object (in this case, a person of type PersonType). The type is not enforced by XML Schema validation. It is indicated, and could be enforced by XSLT scripts, but is not enforced by XML Schema validation.
NIEM is many things. But, for all the ground it covers, there are many things that the NIEM is not. Here are a few comments about the role of NIEM:
NIEM is not a database technology.
NIEM is not a guideline for designing your internal databases. NIEM is only for exchanges between systems. You should not try to make your internal databases mirror the NIEM.
NIEM is not just XML.
NIEM is not just XML. It's a set of reusable objects and their definitions. The definitions are not an afterthought. They are a major feature and benefit of the model.
NIEM is not a programming language.
NIEM is a data model. It's not a programming language. It's represented as XML, which isn't a programming language either.
NIEM is not a silver bullet.
NIEM is a tool for creating exchanges. The model defines pieces and how they fit together. You can use those pieces to build exchanges. But you still need to do the building.
NIEM is not a replacement for exchanges and interagency agreements.
Again, the model is a set of objects. Which objects are used and precisely how they will fit together are questions that will still need to be negotiated and decided between and among exchange partners.
NIEM is not a definition of interoperability.
NIEM helps define the payload of an exchange. Topics like security and messaging layers are beyond the scope of the model.
On September 23, 2014, NIEM hosted a Virtual Town Hall. More than 130 community members joined us to hear presentations from a Best of NIEM 2014 winner and updates from representatives of the Emergency Management Domain, as well as to participate in the question and answer session.
NIEM hosted its second annual NIEM in November event on Tuesday, November 4, 2014. NIEM in November was a half-day event filled with presentations, round tables, and discussions highlighting the community's hard work and success. Hosted at National Defense University and live-streamed on NIEM.gov, the event had attendees and presenters from across the United States and beyond.
Resource Links:
https://www.niem.gov/about-niem/news/niem-november-recap
https://www.niem.gov/about-niem/news/september-virtual-town-hall-recap
https://www.niem.gov/about-niem/news/niem-november-recap
Donna Roy, executive director of the NIEM Program Management Office and director of the Enterprise Data Management Office with the U.S. Department of Homeland Security, recently noted that "DHS has had a variety of successes with NIEM and at the same grand level that NDEx has been for the Department of Justice. Over 35 percent of the major IT Programs in DHS are working on implemented standardized information exchange using NIEM, with an expected increase to 60 percent by the end of 2009. Major drivers for adoption at DHS include requirements of all new IT programs and modifications to existing programs to use NIEM, based on the DHS-wide System Engineering Lifecycle. NIEM is working for DHS, and we will continue to both use NIEM and support the use of NIEM in federal, state, tribal, and local information sharing initiatives."
Please refer to the pdf attached for the full article.
Also, the Information Sharing Environment (ISE) has four success stories available that provide insight into how various elements of the National Information Exchange Model (NIEM), a key aspect of the Common Information Sharing Standards (CISS), can be applied in different user environments:
NIEM and the HHS Meaningful Use “SPRINT”
UCORE and NIEM: Creating Potent New Cross-Boundary Networks
Suspicious Activity Reporting
The DHS Domestic Nuclear Detection Office Goes NIEM
These success stories are available at http://www.ise.gov and are also attached to this article.
Documents
https://bja.ojp.gov/media/document/29911
https://bja.ojp.gov/media/document/29916
https://bja.ojp.gov/media/document/29921
https://bja.ojp.gov/media/document/29926
https://bja.ojp.gov/media/document/29931
The following NIEM Presentation was given in October 5-6, 2009 at a "Workshop on Improving Access to Financial Data on the Web". It was co-organized by W3C and XBRL International, Inc, and hosted by FDIC, Arlington, Virginia USA. For more speakers: http://www.w3.org/2009/03/xbrl/minutes.html.
This presentation on "The National Information Exchange Model (NIEM) Program" was provided by Anthony-Hoang (DHS OCIO) and Justin Stekervetz (Deloitte) on behalf of Donna Roy, Director, Enterprise Data Management Office, and Executive Director, for National Information Exchange Model.
Link to presentation slides: http://www.w3.org/2009/03/xbrl/talks/Anthony-Hoang.pdf
In a progressive and unusual collaboration between the judicial system as represented by the National Center for State Courts and the U.S. Department of Health and Human Services, significant improvements have been made in improving outcomes for abused and neglected children, thanks to the use of the National Information Exchange Model (NIEM).
See attached pdf for full article.
Documents
https://bja.ojp.gov/media/document/29936
The first step in working with an IEPD is to create a batch file that will execute Xsd.exe. Because NIEM IEPDs are comprised of multiple xsd files and Xsd.exe will not automatically find imported schemas, we will need to include every xsd in the Xsd.exe input. The batch file will take the format:
> Xsd.exe "<Path to xsd file 1>" "<Path to xsd file 2>" … "<Path to xsd file n>" /c
An example of this is found at: IJIS Technical Advisory Committee NIEM FAQ Series "NIEM IEPD XML Code Generation in C# with .NET 3.5"; see article ID# 547