5. Implementation: Overview

[ Table of Contents ]

5.1 Usage scenarios

This Data Formats for Identity Records Standard SHOULD be used by agencies when they prepare agreements for inter-agency data exchange. Agencies are most likely to use this Standard’s data elements and their formats when undertaking authorised information matching and data-sharing programmes. As shown in 4.2, this Standard will be used by the IVS to store and exchange identity-related data.

This Standard SHOULD be used by agencies as guidance when they redesign hard copy and electronic forms and systems, and prepare request for proposal (RFP) documentation. If agencies use any of the data elements specified in this Standard they MUST be formatted for electronic exchange as specified in this Standard. For example, agencies may continue to capture a person’s name elements as one element (a single string) as long as they exchange it in the atomised format shown in this Standard.

Agencies collecting and exchanging customer information-related elements that can be used to determine entitlement to services other than those specified in this Standard are encouraged to refer to the OASIS CIQ v3.0 Specifications for formatting guidance.

5.2 Relationship to other standards and resources

5.2.1 Customer information

For issues relating to customer information, refer to the relevant section of the New Zealand E-government Interoperability Framework (Business Services Layer).

5.2.2 Data sharing

For issues relating to inter-agency data exchange, refer to the relevant section of the New Zealand E-government Interoperability Framework (Information sharing and matching agreements).

5.2.3 Mapping to/from a database

Where target databases do not use the data elements specified in this Standard, either a mapping tool or the eXtensible Stylesheet Language (XSL) should be used for importing to or exporting from target databases. More information on XML mapping tools is available from: www.w3c.com.

5.2.4 Namespaces

For issues relating to namespaces, refer to the relevant section of the New Zealand E-government Interoperability Framework (Business Services Layer).

5.3 Key concepts in the design of the CIQ v3.0 Specifications

5.3.1 XLink

The CIQ Specifications v3.0 make extensive use of the XML Linking Language (XLink). XLink allows “...elements to be inserted into XML files in order to create and describe links between resources. It uses XML syntax to create structures that can describe the simple unidirectional hyperlinks of...HTML, as well as more sophisticated links” (IDEAlliance 2005). For example, XLink helps programmers to link one person with another (Joe is the brother of Bill) and names with organisations (Samantha is the Director of Doe Limited).

NOTE – Within an XML file, links between resources can also be created and described using the "Key" and "KeyRef" attributes (used as Primary and Foreign Keys) as defined in the CIQ Specifications v3.0. However, this implementation technique is now considered to have transitional conformance.

5.3.2 Enumeration lists

The CIQ Specifications v3.0 make extensive use of enumeration lists. An enumeration list is an XML strategy to define and constrain element attributes. For example, to represent a person’s name in atomic or granular fashion, it is possible to prepare an enumeration list that defines and constrains the attributes of the <NameElement> element from CIQ v3.0.

An example of an enumeration list is given in the following extract from the sample validated exchange file. Values of the enumeration list are defined in quotes.

<NameElement ElementType=LastName />
<NameElement ElementType=FirstName />
<NameElement ElementType=MiddleName />
<NameElement ElementType=MiddleInitial />

The CIQ Specifications v3.0 can also be used to constrain the values of XML element attributes using data from code value lists through the use of XML enumerations. For example, XML enumerations can be used to include agency-specific values in XML transfers to meet specific requirements.

5.3.3 Extensibility

CIQ v3.0 is extensible. This allows agencies to add attributes under the prescribed element set of the schema to capture additional identity-related data elements. Take care in introducing additional elements in the XML-based file used to exchange data (validated exchange file), as the recipient may not be expecting them and this could lead to an inability to interoperate.

While the data elements specified in this Standard are useful in most identity management systems, CIQ v3.0 contains other data elements that agencies may wish to use. CIQ v3.0 is also fully extensible so that other, optional data elements, not included in the CIQ Specifications v3.0, can be added. More information on CIQ v3.0 is available from: www.oasis-open.org/committees/ciq. It is intended that the NZ e-GIF will ultimately adopt the full CIQ Specifications v3.0.

5.3.4 Namespaces

CIQ v3.0 uses namespaces to separate elements that pertain to Name (n), Address (a), and Party (p). The schema specifies the rules of use of the namespaces, and the parser enforces the namespaces in the sense that elements from these three specific namespaces are ‘allowed’ in the resulting XML file. It is also possible to add other elements by defining additional namespaces, using the notation ‘x:’, as this is a valid namespace from the generic XML schema control file.