Address

An address expressed using postal conventions (as opposed to GPS or other location definition formats).

Definition

This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

Type

address

Attributes

Key	Type	Cardinality	Description
use	code	0..1	Purpose of this address. Proposed values are: - home: A home address. - work: An office address. First choice for business-related address. - temp: A temporary address. The period can provide more detailed information. - old: This address is no longer in use (or was never correct but retained for records). - billing: An address to send bills, invoices, receipts etc.
type	code	0..1	Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Proposed values are: - postal: Mailing addresses, PO Boxes and care-of addresses. - physical: A physical address that can be visited. - both: An address that is both physical and postal.
text	symbol	0..1	Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts
line	symbol	0..*	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label.
city	symbol	0..1	The name of the city.
district	symbol	0..1	Features that are smaller than top-level administrative features but typically larger than cities, in countries that use such an additional layer in postal addressing (for example, prefectures in China).
state	symbol	0..1	Sub-unit of country (abbreviations ok).
postalCode	symbol	0..1	A postal code designating a region defined by the postal service.
country	symbol	0..1	Country - a nation as commonly understood or generally accepted.
period	period	0..1	Time period when the address was/is in use.

JSON

{
  "use" : "<code>", 
  "type" : "<code>",
  "text" : "<string>",
  "line" : ["<string>"],
  "city" : "<string>",
  "district" : "<string>",
  "state" : "<string>",
  "postalCode" : "<string>",
  "country" : "<string>",
  "period" : { Period }
}