|
|
|
|
|
Record |
|
| This is a generic contianer to combine name
and address. Any cardinality of names and addresses is
permitted. | |
|
@RecordID |
|
| A unique identifier of a
record | |
|
@RecordIDType |
|
|
|
@Status |
|
| Status of the entity. e.g. Old, Current,
Inactive, Active, etc | |
|
@RecordKey |
|
| Primary key for referencing
record | |
|
@RecordKeyRef |
|
| Foreign key to reference
record | |
|
@DateValidFrom |
|
|
if string-length(//Record/@DateValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//Record/@DateValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be start date, issue date, validity
start date, etc | |
|
@DateValidTo |
|
|
if string-length(//Record/@DateValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//Record/@DateValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be end date, expiry date, validity
end date, etc | |
|
@DataQualityType |
|
|
restrictValues('Valid'
|'Invalid') |
|
Valid - The data was
validated and is considered to be true and correct. |
Invalid - Indicates that at least some part of the
content is known to be incorrect. |
| | |
|
| This attribute indicates what level of
trust can be given to the parent element. Omit this attribute if the
data quality is unknown. If the data quality is known, the value is
"Valid, else "InValid" | |
|
@ValidFrom |
|
|
if string-length(//Record/@ValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//Record/@ValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid from
| |
|
@ValidTo |
|
|
if string-length(//Record/@ValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//Record/@ValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid
to | |
|
@LanguageCode |
|
| Human Language used. e.g. "en", "en-US",
"en-AUS", etc | |
|
xnl:PartyName |
|
| Container for defining a name of a Person,
an Organisation or combination of the above as a joint
name. | |
|
@PartyNameID |
|
| A unique identifier of a
party | |
|
@PartyNameIDType |
|
|
|
@ID |
|
| Globally unique
identifier | |
|
@Usage |
|
| Tye of use of this data. e.g. data
exchange, contact, update, create |
|
|
@Status |
|
| Status of the entity. e.g. Old, Current,
Inactive, Active, etc | |
|
@JointNameConnector |
|
| 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.
| |
|
@xlink:type |
|
| Enumeration of values for the type
attribute | |
|
@xlink:label |
|
|
|
@xlink:href |
|
|
|
@DateValidFrom |
|
|
if string-length(//xnl:PartyName/@DateValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:PartyName/@DateValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be start date, issue date, validity
start date, etc | |
|
@DateValidTo |
|
|
if string-length(//xnl:PartyName/@DateValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:PartyName/@DateValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be end date, expiry date, validity
end date, etc | |
|
@NameKey |
|
| A primary key to reference Party
Name. | |
|
@NameKeyRef |
|
| A foreign key to reference attribute Key of
Party Name. | |
|
@DataQualityType |
|
|
restrictValues('Valid'
|'Invalid') |
|
Valid - The data was
validated and is considered to be true and correct. |
Invalid - Indicates that at least some part of the
content is known to be incorrect. |
| | |
|
| This attribute indicates what level of
trust can be given to the parent element. Omit this attribute if the
data quality is unknown. If the data quality is known, the value is
"Valid, else "InValid" | |
|
@ValidFrom |
|
|
if string-length(//xnl:PartyName/@ValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:PartyName/@ValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid from
| |
|
@ValidTo |
|
|
if string-length(//xnl:PartyName/@ValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:PartyName/@ValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid
to | |
|
@LanguageCode |
|
| Human Language used. e.g. "en", "en-US",
"en-AUS", etc | |
|
xnl:NameLine |
|
|
|
|
datatype(normalizedString) |
|
|
|
| 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 |
|
|
@Type |
|
| Enumerated list of type of name. example:
Alias, Nick Name, former name, known as,
etc | |
|
@Abbreviation |
|
|
restrictValues('true'|'false') |
|
| If set to true then indicates that the
value is an abbreviation or initial. If set to false then the value
is definitely not an abbreviation. If omitted then it is not known
if the value is an abbreviation or not.
| |
|
@DataQualityType |
|
|
restrictValues('Valid'
|'Invalid') |
|
Valid - The data was
validated and is considered to be true and correct. |
Invalid - Indicates that at least some part of the
content is known to be incorrect. |
| | |
|
| This attribute indicates what level of
trust can be given to the parent element. Omit this attribute if the
data quality is unknown. If the data quality is known, the value is
"Valid, else "InValid" | |
|
@ValidFrom |
|
|
if string-length(//xnl:NameLine/@ValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:NameLine/@ValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid from
| |
|
@ValidTo |
|
|
if string-length(//xnl:NameLine/@ValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:NameLine/@ValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid
to | |
|
xnl:PersonName |
|
| 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 |
|
|
restrictValues('Alias' |'LegalName'
|'KnownAs' |'MaidenName' |'FormerName' |'CommonUse'
|'NameAtBirth' |'PreferredName' |'OfficialName'
|'UnofficialName' |'NickName' |'PetName') |
|
Alias - Name of an
individual before marriage. | LegalName - Former name of
the person | KnownAs - Name that is commonly used by
others, e.g. a simplified form of the official name. |
MaidenName - A name given to an individual at birth, but
later changed (common in some cultures) | FormerName -
Indicates that the party prefers to be called by this
name | CommonUse - An official name of the person, e.g.
as in the passport. incorporation certificate, etc. |
| | |
|
| Enumerated list of type of name. example:
Alias, Nick Name, former name, known as,
etc | |
|
@PersonID |
|
| A unique identifier of a
person | |
|
@PersonIDType |
|
|
|
@ID |
|
| Globally unique
identifier | |
|
@Usage |
|
| Tye of use of this data. e.g. data
exchange, contact, update, create |
|
|
@Status |
|
| Status of the entity. e.g. Old, Current,
Inactive, Active, etc | |
|
@xlink:type |
|
| Enumeration of values for the type
attribute | |
|
@xlink:label |
|
|
|
@xlink:href |
|
|
|
@DateValidFrom |
|
|
if string-length(//xnl:PersonName/@DateValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:PersonName/@DateValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be start date, issue date, validity
start date, etc | |
|
@DateValidTo |
|
|
if string-length(//xnl:PersonName/@DateValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:PersonName/@DateValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be end date, expiry date, validity
end date, etc | |
|
@NameKey |
|
| A primary key to reference Party
Name. | |
|
@NameKeyRef |
|
| A foreign key to reference attribute Key of
Party Name. | |
|
@DataQualityType |
|
|
restrictValues('Valid'
|'Invalid') |
|
Valid - The data was
validated and is considered to be true and correct. |
Invalid - Indicates that at least some part of the
content is known to be incorrect. |
| | |
|
| This attribute indicates what level of
trust can be given to the parent element. Omit this attribute if the
data quality is unknown. If the data quality is known, the value is
"Valid, else "InValid" | |
|
@ValidFrom |
|
|
if string-length(//xnl:PersonName/@ValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:PersonName/@ValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid from
| |
|
@ValidTo |
|
|
if string-length(//xnl:PersonName/@ValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:PersonName/@ValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid
to | |
|
@LanguageCode |
|
| Human Language used. e.g. "en", "en-US",
"en-AUS", etc | |
|
xnl:NameElement |
|
|
|
|
datatype(normalizedString) |
|
|
|
|
|
@ElementType |
restrictValues('PrecedingTitle'
|'Title' |'FirstName' |'MiddleName' |'LastName' |'OtherName'
|'Alias' |'GenerationIdentifier' |'Degree') |
|
PrecedingTitle - His
Excellency, Honorable, etc. | Title - A title signifies
some sort of status, such as Mr, Miss, Ms (marriage
status), or education such as Professor, PhD, Dr, etc. |
FirstName - The most important name element by which
this particular individual is identified in the group.
E.g. John, Sam, Brian for Anglo-Saxon cultures. |
MiddleName - Name elements related to additional
identification of the individual, such as names are
parents or places. | LastName - Name element that
identifies the group the individual belongs to and is
identified by, such as Last Name, Surname, Family Name,
etc. | OtherName - Any other additional names that are
not directly used to identify or call the individual,
such as names of ancestors, saints, etc. | Alias - A
simple nick name that is commonly used as part of the
name. E.g. a fancy kick-boxer can be commonly known as
Bill "Storm" Bababoons, where "Storm" is obviously an
alias. | GenerationIdentifier - Junior, Senior, The
Second, IV, etc. |
| | |
|
|
|
| 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.
| |
|
@Abbreviation |
|
|
restrictValues('true'|'false') |
|
| If set to true then indicates that the
value is an abbreviation or initial. If set to false then the value
is definitely not an abbreviation. If omitted then it is not known
if the value is an abbreviation or not.
| |
|
xnl:OrganisationName |
|
| A container for organisation name details.
Same organisaion with many types of names can be used by this
container | |
|
@Type |
|
|
restrictValues('LegalName'
|'FormerName' |'CommonUse' |'PublishingName' |'OfficialName'
|'UnofficialName' |'Undefined') |
|
LegalName - Former name of
the organisation | FormerName - unknown |
| | |
|
| Enumerated list of type of name. example:
Alias, Nick Name, former name, known as,
etc | |
|
@OrganisationID |
|
| A unique identifier of an
organisation | |
|
@OrganisationIDType |
|
|
|
@ID |
|
| Globally unique
identifier | |
|
@Usage |
|
| Tye of use of this data. e.g. data
exchange, contact, update, create |
|
|
@Status |
|
| Status of the entity. e.g. Old, Current,
Inactive, Active, etc | |
|
@xlink:type |
|
| Enumeration of values for the type
attribute | |
|
@xlink:label |
|
|
|
@xlink:href |
|
|
|
@DateValidFrom |
|
|
if string-length(//xnl:OrganisationName/@DateValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:OrganisationName/@DateValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be start date, issue date, validity
start date, etc | |
|
@DateValidTo |
|
|
if string-length(//xnl:OrganisationName/@DateValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:OrganisationName/@DateValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be end date, expiry date, validity
end date, etc | |
|
@NameKey |
|
| A primary key to reference Party
Name. | |
|
@NameKeyRef |
|
| A foreign key to reference attribute Key of
Party Name. | |
|
@DataQualityType |
|
|
restrictValues('Valid'
|'Invalid') |
|
Valid - The data was
validated and is considered to be true and correct. |
Invalid - Indicates that at least some part of the
content is known to be incorrect. |
| | |
|
| This attribute indicates what level of
trust can be given to the parent element. Omit this attribute if the
data quality is unknown. If the data quality is known, the value is
"Valid, else "InValid" | |
|
@ValidFrom |
|
|
if string-length(//xnl:OrganisationName/@ValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:OrganisationName/@ValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid from
| |
|
@ValidTo |
|
|
if string-length(//xnl:OrganisationName/@ValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xnl:OrganisationName/@ValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid
to | |
|
@LanguageCode |
|
| Human Language used. e.g. "en", "en-US",
"en-AUS", etc | |
|
xnl:NameElement |
|
|
|
|
datatype(normalizedString) |
|
|
|
|
|
@ElementType |
|
|
restrictValues('NameOnly' |'TypeOnly'
|'FullName') |
|
NameOnly - "Sakthisoft" in
"Sakthisoft Pty. Ltd". "Pty.Ltd" is the legal entity for
the organisation name "Sakthisoft" | TypeOnly - "Pty.
Ltd" in Sakthisoft Pty.Ltd, where "Sakthisoft" is the
name of the organisation. ""Inc" in ABC Inc, where "ABC"
is organisation name | FullName - Full Name of the
organisation. e.g. Sakthisoft Pty. Ltd |
| | |
|
| 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.
| |
|
@Abbreviation |
|
|
restrictValues('true'|'false') |
|
| If set to true then indicates that the
value is an abbreviation or initial. If set to false then the value
is definitely not an abbreviation. If omitted then it is not known
if the value is an abbreviation or not.
| |
|
xnl:SubDivisionName |
|
|
|
|
datatype(normalizedString) |
|
|
|
| Name of a subdivision of an organisation
(e.g. department) | |
|
@Type |
|
|
restrictValues('Department' |'Division'
|'Branch' |'BusinessUnit' |'School'
|'Section') | |
| Enumerated list of type of name. example:
Alias, Nick Name, former name, known as,
etc | |
|
@Abbreviation |
|
|
restrictValues('true'|'false') |
|
| If set to true then indicates that the
value is an abbreviation or initial. If set to false then the value
is definitely not an abbreviation. If omitted then it is not known
if the value is an abbreviation or not.
| |
|
xal:Address |
|
| Top level element for address with geocode
details | |
|
@Type |
|
|
restrictValues('Airport' |'Business'
|'CaravanPark' |'CommercialPark' |'CommunityDevelopment'
|'EducationalInstitution' |'Entertainment' |'Hospital' |'Location'
|'Marina' |'MilitaryBase' |'OverseasMilitary' |'Port' |'Primary'
|'RecreationalPark' |'Resort' |'RetirementVillage' |'Rural'
|'Secondary' |'ShoppingCentre' |'SportingCentre' |'Urban')
| |
| Enumerated list of type of name. example:
Alias, Nick Name, former name, known as,
etc | |
|
@AddressID |
|
| A unique address identifier such as postal
delivery idetifier assigned to the address by local postal
authority, e.g. DPID in Australia. |
|
|
@AddressIDType |
|
| Type of address ID used. e.g. DPID,
etc | |
|
@ID |
|
| Globally unique
identifier | |
|
@Usage |
|
|
restrictValues('Business' |'Billing'
|'Communication' |'Contact' |'Mailing' |'Personal' |'Postal'
|'Residential') |
|
| Tye of use of this data. e.g. data
exchange, contact, update, create |
|
|
@DeliveryMode |
|
| Mode of delivery of address. For example:
rural route, normal delivery, post office box, etc.
| |
|
@Status |
|
| Status of the entity. e.g. Old, Current,
Inactive, Active, etc | |
|
@AddressKey |
|
| A primary key to reference
Address. | |
|
@AddressKeyRef |
|
| A foreign key to reference attribute Key of
Address. | |
|
@xlink:type |
|
| Enumeration of values for the type
attribute | |
|
@xlink:label |
|
|
|
@xlink:href |
|
|
|
@DateValidFrom |
|
|
if string-length(//xal:Address/@DateValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xal:Address/@DateValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be start date, issue date, validity
start date, etc | |
|
@DateValidTo |
|
|
if string-length(//xal:Address/@DateValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xal:Address/@DateValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Could be end date, expiry date, validity
end date, etc | |
|
@DataQualityType |
|
|
restrictValues('Valid'
|'Invalid') |
|
Valid - The data was
validated and is considered to be true and correct. |
Invalid - Indicates that at least some part of the
content is known to be incorrect. |
| | |
|
| This attribute indicates what level of
trust can be given to the parent element. Omit this attribute if the
data quality is unknown. If the data quality is known, the value is
"Valid, else "InValid" | |
|
@ValidFrom |
|
|
if string-length(//xal:Address/@ValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xal:Address/@ValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid from
| |
|
@ValidTo |
|
|
if string-length(//xal:Address/@ValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xal:Address/@ValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid
to | |
|
@LanguageCode |
|
| Human Language used. e.g. "en", "en-US",
"en-AUS", etc | |
|
xal:FreeTextAddress |
|
| Container for free text address elements
where address elements are not parsed
| |
|
@DataQualityType |
|
|
restrictValues('Valid'
|'Invalid') |
|
Valid - The data was
validated and is considered to be true and correct. |
Invalid - Indicates that at least some part of the
content is known to be incorrect. |
| | |
|
| This attribute indicates what level of
trust can be given to the parent element. Omit this attribute if the
data quality is unknown. If the data quality is known, the value is
"Valid, else "InValid" | |
|
@ValidFrom |
|
|
if string-length(//xal:FreeTextAddress/@ValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xal:FreeTextAddress/@ValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid from
| |
|
@ValidTo |
|
|
if string-length(//xal:FreeTextAddress/@ValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xal:FreeTextAddress/@ValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid
to | |
|
xal:AddressLine |
|
|
datatype(normalizedString) |
|
|
|
| Free format address representation. An
address can have more than one line. The order of the AddressLine
elements must be preserved. |
|
|
@Type |
|
| Enumerated list of type of name. example:
Alias, Nick Name, former name, known as,
etc | |
|
@DataQualityType |
|
|
restrictValues('Valid'
|'Invalid') |
|
Valid - The data was
validated and is considered to be true and correct. |
Invalid - Indicates that at least some part of the
content is known to be incorrect. |
| | |
|
| This attribute indicates what level of
trust can be given to the parent element. Omit this attribute if the
data quality is unknown. If the data quality is known, the value is
"Valid, else "InValid" | |
|
@ValidFrom |
|
|
if string-length(//xal:AddressLine/@ValidFrom)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xal:AddressLine/@ValidFrom)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid from
| |
|
@ValidTo |
|
|
if string-length(//xal:AddressLine/@ValidTo)
<26
then
setDateMask(YYYY-MM-DD'T'HH:MI:SSZ)
end if; |
if string-length(//xal:AddressLine/@ValidTo)
>25
then
setDateMask(YYYY-MM-DD'T'HH:MI:SS.SZ)
end
if; | |
| Date the data quality is valid
to | |
|
xal:Country |
|
|
|
xal:NameElement |
|
|
datatype(normalizedString) |
|
|
datatype(normalizedString) |
|
|
|
@NameType |
restrictValues('Name'
|'Type') |
|
Name - Name of the country
e.g. AUSTRALIA | Type - Although a Country, could be
classified as a territory of a country | | | |