Documentation for: NameTypes

CIQ-xNL-v4.cam (output generator 1.06)

Owner OASIS CIQ TC
Version 4.0 draft
Description Generated for AllRootLevelTypeDefinitions by XSD 2 CAM generator v1.77
Date 2011-02-06T18:26:30

Assembly Structures

Structure

ID: NameTypes

Taxonomy: XML

XPath locator (and depth)
Rule(s)
Annotation
1  AllRootLevelTypeDefinitions
required item
  
  
  2  PartyNameType
required item
  
  
    @id
optional
  
Definition
Globally unique identifier
  
    @usage
optional
  
Definition
Tye of use of this data. e.g. data exchange, contact, update, create
  
    @status
optional
  
Definition
Status of the entity. e.g. Old, Current, Inactive, Active, etc
  
    @JointNameConnector
optional
  
Definition
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.
  
    @NameKeyRef
optional
  
Definition
A foreign key to reference attribute Key of Party Name.
  
    @LanguageCode
optional
  
  
    3  NameLine
repeatable item
optional
  
Definition
Define name as a free format text as a single text string. This name format 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. Use this when the type of the entity (person or organisation) is unknown.
  
      @Type
optional
  
Definition
Enumerated list of type of name. example: Alias, Nick Name, former name, known as, etc
  
    3  PersonName
repeatable item
optional
  
Definition
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.
  
      @Type
optional
Only allowed values are: 'Alias' | 'LegalName' | 'KnownAs' | 'MaidenName' | 'FormerName' | 'CommonUse' | 'NameAtBirth' | 'PreferredName' | 'OfficialName' | 'UnofficialName' | 'NickName' | 'PetName'
  
Definition
Enumerated list of type of name. example: Alias, Nick Name, former name, known as, etc
  
      @id
optional
  
Definition
Globally unique identifier
  
      @usage
optional
  
Definition
Tye of use of this data. e.g. data exchange, contact, update, create
  
      @status
optional
  
Definition
Status of the entity. e.g. Old, Current, Inactive, Active, etc
  
      @NameKeyRef
optional
  
Definition
A foreign key to reference attribute Key of Party Name.
  
      @LanguageCode
optional
  
  
      4  NameElement
repeatable item
optional
  
Definition
Name or part of a name.
  
        @ElementType
Only allowed values are: 'PrecedingTitle' | 'Title' | 'FirstName' | 'MiddleName' | 'LastName' | 'OtherName' | 'Alias' | 'GenerationIdentifier' | 'Degree'
optional
  
Definition
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.
  
    3  OrganisationName
repeatable item
optional
  
Definition
A container for organisation name details. Same organisation with many types of names can be used by this container.
  
      @Type
optional
Only allowed values are: 'LegalName' | 'FormerName' | 'CommonUse' | 'PublishingName' | 'OfficialName' | 'UnofficialName' | 'Undefined'
  
Definition
Enumerated list of type of name. example: Alias, Nick Name, former name, known as, etc
  
      @id
optional
  
Definition
Globally unique identifier
  
      @usage
optional
  
Definition
Tye of use of this data. e.g. data exchange, contact, update, create
  
      @status
optional
  
Definition
Status of the entity. e.g. Old, Current, Inactive, Active, etc
  
      @NameKeyRef
optional
  
Definition
A foreign key to reference attribute Key of Party Name.
  
      @LanguageCode
optional
  
  
      4  NameElement
repeatable item
optional
  
Definition
Name or part of a name.
  
        @ElementType
Only allowed values are: 'NameOnly' | 'TypeOnly' | 'FullName'
optional
  
Definition
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.
  
      4  SubDivisionName
repeatable item
optional
  
Definition
Name of a subdivision of an organisation (e.g. department)
  
        @Type
Only allowed values are: 'Department' | 'Division' | 'Branch' | 'BusinessUnit' | 'School' | 'Section'
optional
  
Definition
Enumerated list of type of name. example: Alias, Nick Name, former name, known as, etc
  
  2  PersonNameType
required item
  
  
    @Type
optional
Only allowed values are: 'Alias' | 'LegalName' | 'KnownAs' | 'MaidenName' | 'FormerName' | 'CommonUse' | 'NameAtBirth' | 'PreferredName' | 'OfficialName' | 'UnofficialName' | 'NickName' | 'PetName'
  
Definition
Enumerated list of type of name. example: Alias, Nick Name, former name, known as, etc
  
    @id
optional
  
Definition
Globally unique identifier
  
    @usage
optional
  
Definition
Tye of use of this data. e.g. data exchange, contact, update, create
  
    @status
optional
  
Definition
Status of the entity. e.g. Old, Current, Inactive, Active, etc
  
    @NameKeyRef
optional
  
Definition
A foreign key to reference attribute Key of Party Name.
  
    @LanguageCode
optional
  
  
    3  NameElement
repeatable item
optional
  
Definition
Name or part of a name.
  
      @ElementType
Only allowed values are: 'PrecedingTitle' | 'Title' | 'FirstName' | 'MiddleName' | 'LastName' | 'OtherName' | 'Alias' | 'GenerationIdentifier' | 'Degree'
optional
  
Definition
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.
  
    3  PersonFullName
optional
  
Type
PersonFullNameDefinition
Definition
Person name in unformat single string line.
  
    3  PersonPreviousName
repeatable item
optional
  
Type
PersonPreviousNameDefinition
Definition
Previous name used by person; could be prior name before marriage, adoption or a legal name change.
  
    3  PersonNameDetail
optional
  
Definition
Structured name of a person with components for each aspect of the name.
  
      4  NamePrefixText
optional
  
Type
NamePrefixTextDefinition
  
      4  GivenName
optional
  
Type
GivenNameDefinition
  
      4  MiddleName
repeatable item
optional
  
Type
MiddleNameDefinition
  
      4  FamilyName
optional
  
Type
FamilyNameDefinition
  
      4  NameSuffixText
optional
  
Type
NameSuffixTextDefinition
  
  2  OrganisationNameType
required item
  
  
    @Type
optional
Only allowed values are: 'LegalName' | 'FormerName' | 'CommonUse' | 'PublishingName' | 'OfficialName' | 'UnofficialName' | 'Undefined'
  
Definition
Enumerated list of type of name. example: Alias, Nick Name, former name, known as, etc
  
    @id
optional
  
Definition
Globally unique identifier
  
    @usage
optional
  
Definition
Tye of use of this data. e.g. data exchange, contact, update, create
  
    @status
optional
  
Definition
Status of the entity. e.g. Old, Current, Inactive, Active, etc
  
    @NameKeyRef
optional
  
Definition
A foreign key to reference attribute Key of Party Name.
  
    @LanguageCode
optional
  
  
    3  NameElement
repeatable item
optional
  
Definition
Name or part of a name.
  
      @ElementType
optional
Only allowed values are: 'NameOnly' | 'TypeOnly' | 'FullName'
  
Definition
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.
  
    3  SubDivisionName
repeatable item
optional
  
Definition
Name of a subdivision of an organisation (e.g. department)
  
      @Type
optional
Only allowed values are: 'Department' | 'Division' | 'Branch' | 'BusinessUnit' | 'School' | 'Section'
  
Definition
Enumerated list of type of name. example: Alias, Nick Name, former name, known as, etc