Government Enterprise Architecture for New Zealand (GEA-NZ) - Standards

Transcription

1 - From Vision and Direction to Deployment Implementing the Directions and Priorities for Government ICT and Better Public Services Government Enterprise Architecture for New Zealand (GEA-NZ) - Standards New Zealand OASIS CIQ Profile Implementation Guidance Notes Department of Internal Affairs August 2013 Unclassified

2 CROWN COPYRIGHT This work is licensed under the Creative Commons Attribution 3.0 New Zealand licence. In essence, you are free to copy, distribute and adapt the work, as long as you attribute the work to the Crown and abide by the other licence terms. To view a copy of this licence, visit Please note that no departmental or governmental emblem, logo or Coat of Arms may be used in any way which infringes any provision of the Flags, Emblems, and Names Protection Act Attribution to the Crown should be in written form and not by reproduction of any such emblem, logo or Coat of Arms. 2 of 18

3 Document control Document information Project ID/Name Author Title File name DMS reference New Zealand OASIS CIQ Standards Profile GTS Architecture New Zealand OASIS CIQ Profile Implementation Guidance Notes New Zealand OASIS CIQ Profile Implementation Guidance Notes.doc TBC Revision history Version Date Author Description of changes /08/2013 GTS Architecture Final 3 of 18

4 New Zealand OASIS CIQ Profile Implementation Guidance Notes. The following note provides useful implementation guidance for those making use of the New Zealand OASIS CIQ Profiles. The guidance is intended to help those implementing OASIS CIQ ( and does not state a standard. Readers are expected to be familiar with both the OASIS CIQ specifications ( as well as the NZ OASIS CIQ Profiles ( for the following information to be meaningful. This document provides guidance based on initial practical application of the NZ OASIS CIQ Profiles, it is anticipated that as broader use is made of CIQ further experience based knowledge can be added to help the user community. The NZ OASIS CIQ working group comprising of government agency and private sector experts met periodically for two years to develop the three New Zealand CIQ profiles. Prior to this the DIA was a leading participant in the OASIS CIQ Technical Committee international collaboration work that created and published the OASIS CIQ standard itself. The OASIS CIQ standard is an established international standard and New Zealand OASIS CIQ Profiles are used by a number of New Zealand government agencies and businesses. OASIS CIQ (Customer Information Quality) Standard OASIS CIQ is an XML data exchange standard. It provides an XML based format and implementation schemas for exchanging primary customer information. The scope includes a Party object and a number of Party associated information objects including Party Names, Party Addresses and Party Roles and Relationships. A Party may be person or a non-personal entity. The Party object itself carries a broad range of party attribute types. Together the full scope of CIQ objects provides for the exchange of a broad range of core customer datasets and supports mixed personal and organisational data exchanges. OASIS CIQ is not a database or data store design standard, it is a data exchange standard. As a data exchange standard is sets down a format for exchanging data between applications. NZ OASIS CIQ requires government agencies that are implementing data exchanges of names, addresses and roles and relationships to use the OASIS CIQ data exchange format. It is important to recognise that OASIS CIQ provides important application data design requirements for applications that will be exchanging data. However it does not provide an out of the box database design. It may be possible to generate a database design implementation straight from the CIQ schemas however this would include redundant data structures provided in OASIS CIQ to accommodate for differing levels of granularity and different jurisdictional data demands and conventions. Applications that are intended to exchange data via OASIS CIQ should be designed to efficiently meet the OASIS CIQ exchange data formats. Transformation tools such XSLT may be needed to transform the format used in a database to the format used in CIQ. The OASIS CIQ Standard including documentation and schemas is located at ( 4 of 18

5 Using the OASIS CIQ (Customer Information Quality) Standard All inter-agency information exchanges that include customer information are required by the NZ e-gif to use OASIS CIQ standard. Internal customer information data exchanges within an agency may use OASIS CIQ as a means of reducing the proliferation of bespoke data exchange designs and improving data exchange quality. The key consideration for implementing a CIQ based information exchange are the alignment of the source system data structures and formats against the CIQ standard for information within the scope of CIQ (Party, Name, Address, and Role and Relationship). Typical scenarios for CIQ use are the development of new information systems that include customer information exchanges and the enhancement of existing systems to provide new customer information exchanges. New systems that include customer information data exchanges should implement the full scope of the applicable OASIS CIQ standard i.e. fully apply CIQ Names if names are to be exchanged and fully apply CIQ Addresses if addresses are to be exchanged. The highest quality customer information data exchanges are only achievable by implementing the OASIS CIQ standard without compromise. For example, maximum exchange quality is achieved when all the elements of name and address are stored in separate fields, allowing the recipient to choose how to process the exchange. New systems that include any data exchange capabilities should therefore include OASIS CIQ as a key data design requirement for customer information (Party, Name, Address, and Roles and Relationships). If data stores and interfaces are designed ignoring OASIS CIQ data exchange requirements then the later addition of data exchanges will be problematic. Data store and interface design is the key design point at which data exchange quality can be irretrievably compromised. For the scope of data being exchanged a new system design should consider the following. Is there a one to one mapping between the planned system data elements and the CIQ data exchange data elements? Are system data elements defined at the required level of granularity to deliver a fully defined CIQ data exchange? A one to one mapping of data from the source system to CIQ will allow a data exchange to be implemented simply and efficiently. If the source data is less granular than required by the CIQ data exchange then mapping becomes problematic or may be impossible. For example, using an undefined string to hold a name that may or may not include title, or an address as a series of undefined address lines in the source system will make mapping to CIQ difficult or impossible. Exchange of composite field data is possible with CIQ, but not recommended, as it imposes processing restrictions (such as matching) and creates processing complexity for the data exchange recipient. Are codes and abbreviations using a New Zealand accepted standard? (Modern systems do not require abbreviated data values just to save space, and the use of non-standard codes reduces data quality and inhibits interoperability). New CIQ based data exchange capabilities can be added simply to existing systems if a system data design is verified as compatible. Adding a new data exchange capability to an existing system where the existing data design is shown to be incompatible, or there are data quality issues with existing data held in the system, is more problematic. It is expected that existing systems will have limitations both in terms of structure and content quality. Most commonly existing systems suffer from poor quality database design, such as ambiguous data structures, and the use of composite or non-standard fields. For example, personal names could be in the format First Name and Last Name (non-standard composite fields), and addresses could be in the format address line 1, address line 2, address line 3 (ambiguous data structures with uncertain content). Because of these issues the existing system 5 of 18

6 cannot deliver the data required to construct a complete CIQ customer information exchange. Ideally action would be taken to address data quality issues with the data source to allow for full CIQ implementation however it is recognised that in many cases this will not be feasible. For example, where an established historical, and potentially authoritative, data store exists which cannot be changed. CIQ should still be used for the data exchange and can still be used to carry less than optimum information exchanges. New Zealand OASIS CIQ Profile set The New Zealand OASIS CIQ Profiles (name, address and role and relationships) provide guidance on applying the corresponding OASIS CIQ standards. The profiles describe how New Zealand Government names, addresses and roles and relationships should be exchanged using the OASIS CIQ standard. The profiles restrict the OASIS standard to reduce the ambiguity inherent in the standard that caters for international variants and the full possible range of data quality levels. The profiles set a minimum data content and quality to provide efficient New Zealand government data exchange of names, address and roles and relationships. Key data quality aspects applied by all NZ OASIS CIQ Profile data exchanges. Data exchange must use the maximum semantic quality available. i.e. If a fully qualified and defined data set format is available it should be used rather than a lower quality format even if the lower quality data format appears to be adequate for current requirements. Data exchange must not aggregate data from its atomic source form. e.g. If separate address elements are available they should be exchanged rather than a composite address line. Data exchange must not in itself degrade the data quality. Data exchange must not alter data. e.g. Sentence case must be preserved within a data string such as a name element containing McCall must not be altered to MCCALL or Mccall. All data must be encoded in a form that preserves macrons and diacritics. All data quality indicators included in a CIQ data exchanges have a meaning that applies to each specific exchange context only. Although CIQ is capable of imparting authoritative data quality, if the exchanging parties agree, CIQ data quality indicators should not be assumed to be providing any level of authoritative data. Particular care should be taken to ensure CIQ data exchanges that do include a data quality indicator are not misinterpreted outside the context they were originally intended for. 6 of 18

7 New Zealand OASIS CIQ Profile Schema usage Implementation of a CIQ based data exchange will require assembling conformant XML data records. The data structure, format and content are defined using XML schemas. The schemas can be used to validate data exchanges and to support the reading and writing of xml via schema enabled xml parsers. The schemas are provided as zipped package. The entire package must be used without modification as they include the required NZ Profile amendments and have been tested as a consistent unit. The NZ OASIS CIQ Profile schemas are provided on the ict.govt.nz web site. NZ OASIS CIQ Name Profile schema (xnlnzprofile.xsd and xnlnzprofile-types.xsd) The NZ OASIS Name Profile includes a small number of minor extensions to CIQ which are defined in a separate New Zealand specific Name Profile extension schema (xnlnzprofile.xsd). This includes four additional attributes (Deceased Estate, Anonymous, PresentationOrder, and CompositeName). Use of these Name extension attributes is optional, for example the RealMe Name exchange does not use them. Supporting these additional New Zealand specific attributes is a New Zealand Name extension data type schema (xnlnzprofile-types.xsd) that defines the valid values for the extension attributes. If you wish to use any of these Name extension attributes in your data exchange you must include both the xnlnzprofile.xsd and xnlnzprofile-types.xsd schema files in the schema set used. When assembling xml that includes any of the New Zealand Name Profile extension attributes the attribute names must be qualified by the New Zealand Name profile xml namespace as defined in the schema. The use of the New Zealand Name Profiles schemas is optional and does not impact on the validation of OASIS CIQ Name xml using the base OASIS schemas. The additional NZ profile attributes reside in a separate New Zealand specific namespace and are ignored by the OASIS CIQ Name schema. An example of the xml encoding of the extension attributes is included in the NZ Profile xml schema zip file. NZ OASIS CIQ Address Profile schema (modified xaltypes.xsd) The NZ OASIS Address Profile does not utilise any additional attributes or elements, however it uses the OASIS CIQ recommended practice of extending valid value lists with local values. Additional local valid values are applied to selected address attributes. As recommended by OASIS CIQ these NZ profile valid values have been added directly into the OASIS xaltypes.xsd file. The reason for doing the change this way is to ensure other CIQ schemas in the set include the modified address schema (Party xpil and Name and address xnal) without requiring further modification. All valid values are inserted as additions and therefore will not effect the behaviour of base OASIS CIQ Name schema. You must use the modified schema for New Zealand address exchanges. An example of the xml encoding including the NZ Profile valid values is included in the NZ Profile xml schema zip file. NZ OASIS CIQ Roles and Relationships (Party Relationship) Profile schema (xprl.xsd) The NZ OASIS Roles and Relationships Profile does not utilise any additional schema attributes or elements or valid values 7 of 18

8 NZ OASIS CIQ Schema structure schematic xpilnzprofile.xsd (Party incl Name and Address) Use of xpilnzprofile.xsd or xnalnzprofile.xsd is only required if using NZCIQ extended Name Attributes. xnalnzprofile.xsd Name and Address) OASIS CIQ NZ CIQ Base Schema set xpil.xsd (Party Incl Name and Address) xnal.xsd (Name and Address) xal.xsd (Address) xnl.xsd (Name) xnlnzprofile.xsd (NZCIQ Name attributes) xpil-types.xsd (Party) (includes NZCIQ code values BirthInfo) xal-types.xsd (Address) (includes NZCIQ code values Address types) xnl-types.xsd (Name) xnlnzprofiletypes.xsd (NZCIQ Name attribute values) 8 of 18

9 New Zealand OASIS CIQ Names Profile The NZ CIQ OASIS Name Profile defines how New Zealand personal and non-personal names should be encoded using the OASIS CIQ xnl or xnal schema. The key aspects of the Name Profile are. All personal Names must include a Family Name. Given Name or Other Given Name may be composite but not both. If a composite name element is exchanged this must identified as such by setting the CompositeName flag to allow the recipient to processes it correctly i.e. An Other Given Name element that carries a composite name should be marked as such only if it contains more than one name and not marked as composite if doesn t. Without this detail the recipient doesn t know whether a composite element containing Te Huia contains two given names or just one. Accommodates name requirements in line with DIA Good practice guidance for the recording and use of Personal Names New Zealand OASIS CIQ Address Profile The NZ CIQ OASIS Address Profile defines how New Zealand addresses (NZ Street, NZ Rural, NZ Postal Delivery Points, Overseas and spatial location addresses) should be encoded for exchange using the OASIS CIQ xal or xnal schema. The key aspects of the Address Profile are. All addresses must be given a New Zealand Profile Address Type which tells the recipient what content and semantics are applied. If a composite address element is exchanged this must identified as such by setting the Name Type to the appropriate composite content type. This allows the recipient to processes composite address content correctly. Accommodates address requirements in line with the New Zealand Post Address Standards New Zealand OASIS Roles and Relationship Profile The NZ CIQ Roles and Relationships Profile define how New Zealand roles and relationships should be encoded for exchange using the OASIS CIQ xprl and xpil schema. New Zealand roles and relationships exchange data scope includes both relationships and roles with supporting role and relationship credentials and role and relationship authorising parties. Relationship exchange scope includes a relationship on its own, a relationship with a relationship credential, a relationship with authorising party, and a relationship with a relationship credential and a credential authorising party. Role exchange scope includes a party role outside a relationship, a party role within a relationship, a party role with a role credential, and a party role with a role credential and a credential authorising party. The key aspects of the Role and Relationship Profile are. Parties for which roles and relationships are defined may be a person or a non-personal entity. All credential and authorisation data is expressed as business data only. Other technical standards may be used with CIQ to exchange electronic assertions of identity authentication or authorisation. Accommodates information requirements in line with the New Zealand AoG CIQ Roles and Relationships Data Model of 18

10 Introduction to the CIQ data coverage The following section provides a high level introduction to the main OASIS Customer Information Quality (CIQ) Standard data objects. This is intended to provide a useful introduction to the data content of each of the principle objects for those directly designing CIQ based data exchanges or those designing new information systems that will be required to support interfaces that use CIQ data exchanges. It is important that designers gain a quick understanding of the scope of each CIQ object and the location of the most commonly used customer data exchange elements in them. Party (xpil) Extensible Party Information Language (xpil) defines an XML specification to represent party centric data. Note that, unlike CIQ Name (xnl), Address (xal), and Party Relationships and Roles (xprl) the Party (xpil) CIQ object has not been profiled for New Zealand. Those deploying Party (xpil) data exchanges should refer directly to the OASIS CIQ Standard. A Party can be viewed as a container object that may include one or more of the following structured elements Names, structured detail defined through extensible Name Language (xnl) Addresses, structured detail defined through extensible Address Language (xal) Relationships to other Parties structured detail defined through extensible Party Relationship Language (xprl) Party Roles, structured detail defined through extensible Party Relationship Language (xprl) Each Party may also carry, within itself, one or more instances of the following xpil structured elements, each of which may contain a number of detailed attributes. Electronic address identifiers (including and other electronic communications identifiers) Contact numbers (Mobile, Pages, Fax, Landline, etc) Communication language details Nationality details Identification details (e.g. passport, license number, identification card, etc) Person characteristics (e.g. marital status, physical status) Birth details Physical details (biometrics) Visa details Qualification details Account details (e.g. bank account, club account, etc) Membership details Reference Contacts Revenues Key event details Preferences Organisation characteristics (e.g. Registration details, business nature) Vehicle details Hobbies 10 of 18

11 Name (xnl) Extensible Name Language (xnl) defines an XML format to represent party name information. The NZ CIQ Name profile further qualifies party name as either personal or non-personal name. Nonpersonal names can describe institutions or organisations or physical objects such as ships, planes, animals etc. xnl is designed to handle international name data that are culture- and geography- specific. xnl is designed to support party names in over 36 formats internationally For example, the concept of given name and family names do not exist in some countries such as India (some regions), so the traditional FirstName/LastName or GivenName/FamilyName approach is not always applicable. The NZ CIQ Name Profile defines the use of CIQ for New Zealand names and includes the following details. Given Names Family Name Title Suffix Presentation order Name in a foreign national character set Address (xal) Extensible Address Language (xal) defines an XML format to represent address data. xal has been carefully designed (based on use cases and address structures around the world) to handle them. xal is designed to support addresses of 240+ countries of the world and in over 130 formats. The NZ CIQ Address Profile defines the following structured address types that xal can be used to exchange: New Zealand Street Addresses New Zealand Rural Delivery Addresses New Zealand Postal Delivery Point Addresses Overseas Addresses Geo-location Addresses Address in a foreign national character set Party Relationships and Roles (xprl) Extensible Party Relationship Language (xprl). xprl defines XML specifications to represent implicit and explicit party relationships. Party relationships could be: Person to Person relationships Person to Organisation relationships, and Organisation to Organisation relationships The NZ CIQ Roles and Relationships Profile defines the following xprl relationship exchange structures; Relationships between parties 11 of 18

12 Relationship credential (e.g. a marriage certificate number as a relationship credential) Relationships from a relationship credential to a credential authorising party (e.g. a licencing authority that issues Relationship credentials). Relationship from a relationship to a relationship authorising party (e.g. tax agency relationship authorised by IRD). The NZ CIQ Roles and Relationships Profile extends the use of the relationship model to carry Party Roles for both parties inside and parties outside a relationship. The NZ CIQ Roles and Relationships Profile defines the following xprl Party Role exchange structures; Roles for a party. Roles for a party inside the context of a relationship (the role a party has in a specific relationship). Role credentials (e.g. a professional membership certificate id) Relationships from a Role credential to a Role credential authorising party (e.g. a professional body that issues Role credential). Relationships from a Role to a role authorising party (e.g. tax agency role is authorised by IRD). 12 of 18

13 OASIS CIQ New Zealand OASIS CIQ Profiles cover Name, Address and Roles and Relationships. Party is not profiled and is primarily a container for names and addresses, and is the object to which roles are assigned and relationships are formed. OASIS CIQ V3 Customer Information Quality Standard Name and Address Name Address Party Relationship Party Relationship Party Name Address Name Address 13 of 18

14 CIQ Name cd Name «type» PartyNameType + Names connector: 0..* 0..* 0..* Free Text Name Line Person Name - FirstName: - LastName: - MiddleName: - GivenName1: - GivenName2: - Title: Organisation Name - Name: - Type: SubDiv ision - Name: «hierarchy» 14 of 18

15 CIQ Address cd Address «hierarchy» Country Administrativ earea FreeTextAddress - Name: - Code: - Name: - Type: Locality - Name: - Type: «hierarchy» Thoroughfare Location Coordinates - Identifiers: RuralDeliv ery - Identifier: «type» Address - Type: - Usage: - Date Valid From: - Date Valid To: - Postal ID: - Name: - Number: - Type: Premises - Name: - Number: - Type: «hierarchy» PostalDeliv erypoint Postcode - Identifier: - Identifier: PostOffice - Identifier: 15 of 18

16 CIQ Party 16 of 18

17 CIQ Relationship 17 of 18

18 18 of 18