sfx2/classification/xNL.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <xs:schema xmlns="urn:oasis:names:tc:ciq:xnl:3" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ct="urn:oasis:names:tc:ciq:ct:3" targetNamespace="urn:oasis:names:tc:ciq:xnl:3" elementFormDefault="qualified" attributeFormDefault="qualified">
   3         <xs:annotation>
   4                 <xs:documentation>
   5                 Specification Name: OASIS CIQ TC - extensible Name Language (xNL)
   6                 Description: Defines the W3C schema for representing party names (Person or Organisation)
   7                 (Using XML Schema based standard code list/enumeration mechanism - OPTION 1 AND DEFAULT)
   8                 Produced by: OASIS Customer Information Quality Technical Committee
   9                 URL: http://www.oasis-open.org/committees/ciq
  10                 Version: 3.0
  11                 Status: Committee Specification
  12                 Copyright: 2006-07, OASIS, http://www.oasis-open.org
  13                 Last Modified: 18 September 2007
  14                 Last Modified by: Ram Kumar, Chair, OASIS CIQ TC
  15
  16                 NOTE: Do not modify this schema as it will break specifications compatibility
  17                 </xs:documentation>
  18         </xs:annotation>
  19         <xs:include schemaLocation="xNL-types.xsd"/>
  20         <xs:import namespace="urn:oasis:names:tc:ciq:ct:3" schemaLocation="CommonTypes.xsd"/>
  21         <xs:import namespace="http://www.w3.org/1999/xlink" schemaLocation="xlink-2003-12-31.xsd"/>
  22         <xs:attributeGroup name="grNameKey">
  23                 <xs:annotation>
  24                         <xs:documentation>Reference to another Person Name or Organisation Name with primary and foreign key reinforcement. </xs:documentation>
  25                 </xs:annotation>
  26                 <xs:attribute name="NameKey" type="ct:String">
  27                         <xs:annotation>
  28                                 <xs:documentation>A primary key to reference Party Name.</xs:documentation>
  29                         </xs:annotation>
  30                 </xs:attribute>
  31                 <xs:attribute name="NameKeyRef" type="ct:String">
  32                         <xs:annotation>
  33                                 <xs:documentation>A foreign key to reference attribute Key of Party Name.</xs:documentation>
  34                         </xs:annotation>
  35                 </xs:attribute>
  36         </xs:attributeGroup>
  37         <xs:complexType name="PartyNameType">
  38                 <xs:annotation>
  39                         <xs:documentation>Reusable complex type for a party. A party is a person or an organisation</xs:documentation>
  40                 </xs:annotation>
  41                 <xs:sequence>
  42                         <xs:element ref="NameLine" minOccurs="0" maxOccurs="unbounded"/>
  43                         <xs:element name="PersonName" minOccurs="0" maxOccurs="unbounded">
  44                                 <xs:annotation>
  45                                         <xs:documentation>Container for person name details. Same person with many types (e.g. alias, pet name, nick name)  of names can be used by this container.  </xs:documentation>
  46                                 </xs:annotation>
  47                                 <xs:complexType>
  48                                         <xs:complexContent>
  49                                                 <xs:extension base="PersonNameType"/>
  50                                         </xs:complexContent>
  51                                 </xs:complexType>
  52                         </xs:element>
  53                         <xs:element name="OrganisationName" minOccurs="0" maxOccurs="unbounded">
  54                                 <xs:annotation>
  55                                         <xs:documentation>A container for organisation name details. Same organisaion with many types of names can be used by this container</xs:documentation>
  56                                 </xs:annotation>
  57                                 <xs:complexType>
  58                                         <xs:complexContent>
  59                                                 <xs:extension base="OrganisationNameType"/>
  60                                         </xs:complexContent>
  61                                 </xs:complexType>
  62                         </xs:element>
  63                 </xs:sequence>
  64                 <xs:attribute name="PartyNameID" type="ct:String">
  65                         <xs:annotation>
  66                                 <xs:documentation>A unique identifier of a party</xs:documentation>
  67                         </xs:annotation>
  68                 </xs:attribute>
  69                 <xs:attribute name="PartyNameIDType" type="PartyNameIDTypeList">
  70                         <xs:annotation>
  71                                 <xs:documentation>Type of Party Name ID</xs:documentation>
  72                         </xs:annotation>
  73                 </xs:attribute>
  74                 <xs:attribute name="ID" type="ct:String">
  75                         <xs:annotation>
  76                                 <xs:documentation>Globally unique identifier</xs:documentation>
  77                         </xs:annotation>
  78                 </xs:attribute>
  79                 <xs:attribute name="Usage" type="PartyNameUsageList">
  80                         <xs:annotation>
  81                                 <xs:documentation>Tye of use of this data. e.g. data exchange, contact, update, create</xs:documentation>
  82                         </xs:annotation>
  83                 </xs:attribute>
  84                 <xs:attribute name="Status" type="ct:StatusList">
  85                         <xs:annotation>
  86                                 <xs:documentation>Status of the entity. e.g. Old, Current, Inactive, Active, etc</xs:documentation>
  87                         </xs:annotation>
  88                 </xs:attribute>
  89                 <xs:attribute name="JointNameConnector" type="JointNameConnectorList">
  90                         <xs:annotation>
  91                                 <xs:documentation>The connector used to join more than one person name. Example: Mr Hunt AND Mrs Clark, where AND is the JointNameConnector. The flow is from the preceding to the following. If there is more than 2 names then all names are connected using this connector in the natural order.</xs:documentation>
  92                         </xs:annotation>
  93                 </xs:attribute>
  94                 <xs:attributeGroup ref="ct:grValidityDate"/>
  95                 <xs:attributeGroup ref="grNameKey"/>
  96                 <xs:attribute ref="xlink:type"/>
  97                 <xs:attribute ref="xlink:label"/>
  98                 <xs:attribute ref="xlink:href"/>
  99                 <xs:attributeGroup ref="ct:grDataQuality"/>
 100                 <xs:attributeGroup ref="ct:grLanguageCode"/>
 101                 <xs:anyAttribute namespace="##other" processContents="lax"/>
 102         </xs:complexType>
 103         <xs:complexType name="PersonNameType">
 104                 <xs:annotation>
 105                         <xs:documentation>Reusable complex type</xs:documentation>
 106                 </xs:annotation>
 107                 <xs:sequence>
 108                         <xs:element name="NameElement" minOccurs="0" maxOccurs="unbounded">
 109                                 <xs:annotation>
 110                                         <xs:documentation>Name or part of a name. </xs:documentation>
 111                                 </xs:annotation>
 112                                 <xs:complexType>
 113                                         <xs:simpleContent>
 114                                                 <xs:extension base="ct:String">
 115                                                         <xs:attribute name="ElementType" type="PersonNameElementList">
 116                                                                 <xs:annotation>
 117                                                                         <xs:documentation>Clarifies the meaning of the element.Could be first name, middle name, etc. that is defined in the List list. Omit this attribute if the type of the name element is not known.</xs:documentation>
 118                                                                 </xs:annotation>
 119                                                         </xs:attribute>
 120                                                         <xs:attributeGroup ref="ct:grAbbreviation"/>
 121                                                         <xs:anyAttribute namespace="##other" processContents="lax"/>
 122                                                 </xs:extension>
 123                                         </xs:simpleContent>
 124                                 </xs:complexType>
 125                         </xs:element>
 126                 </xs:sequence>
 127                 <xs:attribute name="Type" type="PersonNameTypeList">
 128                         <xs:annotation>
 129                                 <xs:documentation>Enumerated list of type of name.  example: Alias, Nick Name, former name, known as, etc</xs:documentation>
 130                         </xs:annotation>
 131                 </xs:attribute>
 132                 <xs:attribute name="PersonID" type="ct:String">
 133                         <xs:annotation>
 134                                 <xs:documentation>A unique identifier of a person</xs:documentation>
 135                         </xs:annotation>
 136                 </xs:attribute>
 137                 <xs:attribute name="PersonIDType" type="PersonIDTypeList">
 138                         <xs:annotation>
 139                                 <xs:documentation>Type of identifier</xs:documentation>
 140                         </xs:annotation>
 141                 </xs:attribute>
 142                 <xs:attribute name="ID" type="ct:String">
 143                         <xs:annotation>
 144                                 <xs:documentation>Globally unique identifier</xs:documentation>
 145                         </xs:annotation>
 146                 </xs:attribute>
 147                 <xs:attribute name="Usage" type="PersonNameUsageList">
 148                         <xs:annotation>
 149                                 <xs:documentation>Usage of a person name. How is it used and for what purpose. Allows user which name in a set of names to select for a given purpose.
 150 e.g. used for legal purposes</xs:documentation>
 151                         </xs:annotation>
 152                 </xs:attribute>
 153                 <xs:attribute name="Status" type="ct:StatusList">
 154                         <xs:annotation>
 155                                 <xs:documentation>Status of the entity. e.g. Old, Current, Inactive, Active, etc</xs:documentation>
 156                         </xs:annotation>
 157                 </xs:attribute>
 158                 <xs:attributeGroup ref="ct:grValidityDate"/>
 159                 <xs:attributeGroup ref="grNameKey"/>
 160                 <xs:attribute ref="xlink:type"/>
 161                 <xs:attribute ref="xlink:label"/>
 162                 <xs:attribute ref="xlink:href"/>
 163                 <xs:attributeGroup ref="ct:grDataQuality"/>
 164                 <xs:attributeGroup ref="ct:grLanguageCode"/>
 165                 <xs:anyAttribute namespace="##other" processContents="lax"/>
 166         </xs:complexType>
 167         <xs:complexType name="OrganisationNameType">
 168                 <xs:annotation>
 169                         <xs:documentation>Reusable complex type</xs:documentation>
 170                 </xs:annotation>
 171                 <xs:sequence>
 172                         <xs:element name="NameElement" minOccurs="0" maxOccurs="unbounded">
 173                                 <xs:annotation>
 174                                         <xs:documentation>Name of the organisation. E.g. ACME Inc.</xs:documentation>
 175                                 </xs:annotation>
 176                                 <xs:complexType>
 177                                         <xs:simpleContent>
 178                                                 <xs:extension base="ct:String">
 179                                                         <xs:attribute name="ElementType" type="OrganisationNameElementList">
 180                                                                 <xs:annotation>
 181                                                                         <xs:documentation>Clarifies the meaning of the element. Example: name, type . Omit this attribute if the type of the name element is not known.</xs:documentation>
 182                                                                 </xs:annotation>
 183                                                         </xs:attribute>
 184                                                         <xs:attributeGroup ref="ct:grAbbreviation"/>
 185                                                         <xs:anyAttribute namespace="##other" processContents="lax"/>
 186                                                 </xs:extension>
 187                                         </xs:simpleContent>
 188                                 </xs:complexType>
 189                         </xs:element>
 190                         <xs:element name="SubDivisionName" minOccurs="0" maxOccurs="unbounded">
 191                                 <xs:annotation>
 192                                         <xs:documentation>Name of a subdivision of an organisation (e.g. department) </xs:documentation>
 193                                 </xs:annotation>
 194                                 <xs:complexType>
 195                                         <xs:simpleContent>
 196                                                 <xs:extension base="ct:String">
 197                                                         <xs:attribute name="Type" type="SubDivisionTypeList">
 198                                                                 <xs:annotation>
 199                                                                         <xs:documentation>Type of sub division. e.g. department, warehouse, branch</xs:documentation>
 200                                                                 </xs:annotation>
 201                                                         </xs:attribute>
 202                                                         <xs:attributeGroup ref="ct:grAbbreviation"/>
 203                                                         <xs:anyAttribute namespace="##other" processContents="lax"/>
 204                                                 </xs:extension>
 205                                         </xs:simpleContent>
 206                                 </xs:complexType>
 207                         </xs:element>
 208                 </xs:sequence>
 209                 <xs:attribute name="Type" type="OrganisationNameTypeList">
 210                         <xs:annotation>
 211                                 <xs:documentation>Enumerated list of common types of aliases or name types.</xs:documentation>
 212                         </xs:annotation>
 213                 </xs:attribute>
 214                 <xs:attribute name="OrganisationID" type="ct:String">
 215                         <xs:annotation>
 216                                 <xs:documentation>A unique identifier of an organisation</xs:documentation>
 217                         </xs:annotation>
 218                 </xs:attribute>
 219                 <xs:attribute name="OrganisationIDType" type="OrganisationIDTypeList">
 220                         <xs:annotation>
 221                                 <xs:documentation>Type of identifier</xs:documentation>
 222                         </xs:annotation>
 223                 </xs:attribute>
 224                 <xs:attribute name="ID" type="ct:String">
 225                         <xs:annotation>
 226                                 <xs:documentation>Globally unique identifer</xs:documentation>
 227                         </xs:annotation>
 228                 </xs:attribute>
 229                 <xs:attribute name="Usage" type="OrganisationNameUsageList">
 230                         <xs:annotation>
 231                                 <xs:documentation>Usage of organisation name. How is it used and for what purpose. Allows user which name in a set of names to select for a given purpose.
 232 e.g. used for legal purposes</xs:documentation>
 233                         </xs:annotation>
 234                 </xs:attribute>
 235                 <xs:attribute name="Status" type="ct:StatusList">
 236                         <xs:annotation>
 237                                 <xs:documentation>Status of the entity. e.g. Old, Current, Inactive, Active, etc</xs:documentation>
 238                         </xs:annotation>
 239                 </xs:attribute>
 240                 <xs:attributeGroup ref="ct:grValidityDate"/>
 241                 <xs:attributeGroup ref="grNameKey"/>
 242                 <xs:attribute ref="xlink:type"/>
 243                 <xs:attribute ref="xlink:label"/>
 244                 <xs:attribute ref="xlink:href"/>
 245                 <xs:attributeGroup ref="ct:grDataQuality"/>
 246                 <xs:attributeGroup ref="ct:grLanguageCode"/>
 247                 <xs:anyAttribute namespace="##other" processContents="lax"/>
 248         </xs:complexType>
 249         <xs:element name="NameLine">
 250                 <xs:annotation>
 251                         <xs:documentation>Define name as a free format text. Use this when the type of the entity (person or organisation) is unknown, or is not broken down into individual elements (e.g. unstructured, unparsed) or is beyond the provided types. The name represented may be formatted in the right order or may not be as it is not parsed/broken into atomic fields</xs:documentation>
 252                 </xs:annotation>
 253                 <xs:complexType>
 254                         <xs:simpleContent>
 255                                 <xs:extension base="ct:String">
 256                                         <xs:attribute name="Type" type="NameLineTypeList">
 257                                                 <xs:annotation>
 258                                                         <xs:documentation>Type define what this free format name line could mean. For example, the Type could be "Unknown" </xs:documentation>
 259                                                 </xs:annotation>
 260                                         </xs:attribute>
 261                                         <xs:attributeGroup ref="ct:grAbbreviation"/>
 262                                         <xs:attributeGroup ref="ct:grDataQuality"/>
 263                                         <xs:anyAttribute namespace="##other" processContents="lax"/>
 264                                 </xs:extension>
 265                         </xs:simpleContent>
 266                 </xs:complexType>
 267         </xs:element>
 268         <xs:element name="PartyName" type="PartyNameType">
 269                 <xs:annotation>
 270                         <xs:documentation>Container for defining a name of a Person, an Organisation or combination of the above as a joint name.</xs:documentation>
 271                 </xs:annotation>
 272         </xs:element>
 273         <xs:element name="PersonName" type="PersonNameType">
 274                 <xs:annotation>
 275                         <xs:documentation>Person Name</xs:documentation>
 276                 </xs:annotation>
 277         </xs:element>
 278         <xs:element name="OrganisationName" type="OrganisationNameType">
 279                 <xs:annotation>
 280                         <xs:documentation>Organisation Name</xs:documentation>
 281                 </xs:annotation>
 282         </xs:element>
 283 </xs:schema>