xpil:AddressOnDocument

Address details on the document

Element information

Namespace: urn:oasis:names:tc:ciq:xpil:3

Schema document: external/have/1.0/xPIL.xsd

Type: a:AddressType

Properties: Local, Qualified

Content

Sequence [1..1]
1. a:FreeTextAddress [0..1] Container for free text address elements where address elements are not parsed
2. a:Country [0..1] Country details
3. a:AdministrativeArea [0..1] Details of the top-level area division in the country, such as state, district, province, island, region, etc. Note that some countries do not have this
4. a:Locality [0..1] Details of Locality which is a named densiliy populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Many localities exist in an administrative area or a sub adminisrative area. A locality can also have sub localities. For example, a municipality locality can have many villages associated with it which are sub localities. Example: Tamil Nadu State, Erode District, Bhavani Taluk, Paruvachi Village is a valid address in India. Tamil Nadu is the Administrative Area, Erode is the sub admin area, Bhavani is the locality, and Paruvachi is the sub locality
5. a:Thoroughfare [0..1] Details of the Access route along which buildings/lot/land are located, such as street, road, channel, crescent, avenue, etc. This also includes canals/banks on which houses/boat houses are located where people live
6. a:Premises [0..1] Details of the Premises (could be building(s), site, loaction, property, premise, place) which is a landmark place which has a main address such as large mail user (e.g. Airport, Hospital, University) or could be a building (e.g. apartment, house) or a building or complex of buildings (e.g. an apartment complex or shopping centre) or even a vacant land (e.g. LOT). A premises can have many sub-addresses such as apartments in a building having its own addresses or buildings within an airport having its own addresses including its own thoroughfares
7. a:PostCode [0..1] A container for a single free text or structured postcode. Note that not all countries have post codes
8. a:RuralDelivery [0..1] A container for postal-specific delivery identifier for remote communities. Note that not all countries have RuralDelivery
9. a:PostalDeliveryPoint [0..1] Final mail delivery point where the mail is dropped off for recipients to pick them up directly. E.g. POBox, Private Bag, pigeon hole, free mail numbers, etc.
10. a:PostOffice [0..1] A delivery point/installation where all mails are delivered and the post man/delivery service picks up the mails and delivers it to the recipients through a delivery mode. Examples are a rural post office where post is delivered, a post office containing post office boxes/personal mail boxes. Note that not all countries have PostOffice. Can be used to represent overseas military addresses also along with PostalDeliveryPoint element
11. a:GeoRSS [0..1] GeoRSS GML from Open Geospatial Consortium (OGC – www.opengeospatial.net) is a formal GML Application Profile, and supports a greater range of features than Simple, notably coordinate reference systems other than WGS84 latitude/longitude. It is designed for use with Atom 1.0, RSS 2.0 and RSS 1.0, although it can be used just as easily in non-RSS XML encodings.
12. a:LocationByCoordinates [0..1] Simple Geo-coordinates of the address/location

Attributes

Name	Occ	Type	Description	Notes
a:Type	[0..1]	a:AddressTypeList	Defines the type of address. An address type can be" Primary Address, Secondary Address, Rural Address, Military Address, etc.
a:AddressID	[0..1]	ct:String	A unique address identifier such as postal delivery idetifier assigned to the address by local postal authority, e.g. DPID in Australia.
a:AddressIDType	[0..1]	a:AddressIDTypeList	Type of address ID used. e.g. DPID, etc
a:ID	[0..1]	ct:String	A globally unique identifier assigned to the address
a:Usage	[0..1]	a:AddressUsageList	The purpose the address is used for. E.g. Postal, residential, business, exchange, update, create, delete, etc
a:DeliveryMode	[0..1]	a:DeliveryModeList	Mode of delivery of address. For example: rural route, normal delivery, post office box, etc.
a:Status	[0..1]	ct:StatusList	Status of the entity. e.g. Old, Current, Inactive, Active, etc
ct:DateValidFrom	[0..1]	xsd:dateTime	Could be start date, issue date, validity start date, etc	from group ct:grValidityDate
ct:DateValidTo	[0..1]	xsd:dateTime	Could be end date, expiry date, validity end date, etc	from group ct:grValidityDate
a:AddressKey	[0..1]	ct:String	A primary key to reference Address.
a:AddressKeyRef	[0..1]	ct:String	A foreign key to reference attribute Key of Address.
xlink:type	[0..1]	Unspecified
xlink:label	[0..1]	xsd:string
xlink:href	[0..1]	xsd:anyURI
ct:DataQualityType	[0..1]	ct:DataQualityTypeList	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"	from group ct:grDataQuality
ct:ValidFrom	[0..1]	xsd:dateTime	Date the data quality is valid from	from group ct:grDataQuality
ct:ValidTo	[0..1]	xsd:dateTime	Date the data quality is valid to	from group ct:grDataQuality
ct:LanguageCode	[0..1]	xsd:language	Human Language used. e.g. "en", "en-US", "en-AUS", etc	from group ct:grLanguageCode
Any attribute	[0..*]		Namespace: ##other, Process Contents: lax

Used in

Anonymous type of element xpil:Document

Sample instance

<xpil:AddressOnDocument>
   <a:FreeTextAddress>
      <a:AddressLine>normalizedString</a:AddressLine>
   </a:FreeTextAddress>
   <a:Country>
      <a:NameElement>normalizedString</a:NameElement>
   </a:Country>
   <a:AdministrativeArea>
      <a:NameElement>normalizedString</a:NameElement>
      <a:SubAdministrativeArea>
         <a:NameElement>normalizedString</a:NameElement>
      </a:SubAdministrativeArea>
   </a:AdministrativeArea>
   <a:Locality>
      <a:NameElement>normalizedString</a:NameElement>
      <a:SubLocality>
         <a:NameElement>normalizedString</a:NameElement>
      </a:SubLocality>
   </a:Locality>
   <a:Thoroughfare>
      <a:NameElement>normalizedString</a:NameElement>
      <a:SubThoroughfare>
         <a:NameElement>normalizedString</a:NameElement>
      </a:SubThoroughfare>
   </a:Thoroughfare>
   <a:Premises>
      <a:NameElement>normalizedString</a:NameElement>
      <a:SubPremises>
         <a:NameElement>normalizedString</a:NameElement>
      </a:SubPremises>
   </a:Premises>
   <a:PostCode>
      <a:Identifier>normalizedString</a:Identifier>
   </a:PostCode>
   <a:RuralDelivery>
      <a:Identifier>normalizedString</a:Identifier>
   </a:RuralDelivery>
   <a:PostalDeliveryPoint>
      <a:Identifier>normalizedString</a:Identifier>
   </a:PostalDeliveryPoint>
   <a:PostOffice>
      <a:Identifier>normalizedString</a:Identifier>
   </a:PostOffice>
   <a:GeoRSS>
      <!--any element-->
   </a:GeoRSS>
   <a:LocationByCoordinates>
      <a:Latitude/>
      <a:Longitude/>
   </a:LocationByCoordinates>
</xpil:AddressOnDocument>