type: datatypedatatype: Address

Address

Overview

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This datatype 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.

[%dt Address 11%]

Address.line can include names of departments, 'care-of' instructions, and other types of information that involve the names of entities. Address.line SHOULD NOT include the 'name' of the entity on which the address appears, as this will often result in redundant appearance of the name when printing envelopes. For example, if an address appears on a Patient resource with name "Jane Smith", then "Jane Smith" ought not to appear on an address line. However "XYZ Retirement Home" would be acceptable to appear on the address line, as that is not found in the Patient.name.

The text element Specifies the entire address as it should be displayed e.g., on a postal label, using a newline delimiter for each line (e.g., \n). This may be provided instead of or as well as the specific parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Constraints

[%dt.constraints Address%] [%tx Address%]

Address is used in the following places: [%dtusage Address%]

Elements

Address.use [0..1]: code The purpose of this address
Address.type [0..1]: code Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both
Address.text [0..1]: string Specifies the entire address as it should be displayed e.g. on a postal label, using a newline delimiter for each line (e.g., \n). This may be provided instead of or as well as the specific parts.
Address.line [0..*]: string This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information
Address.city [0..1]: string The name of the city, town, suburb, village or other community or delivery center
Address.district [0..1]: string The name of the administrative area (county)
Address.state [0..1]: string Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes)
Address.postalCode [0..1]: string A postal code designating a region defined by the postal service
Address.country [0..1]: string Country - a nation as commonly understood or generally accepted
Address.period [0..1]: Period Time period when address was/is in use

Aliases

Address.city: Municpality
Address.district: County
Address.state: Province, Territory
Address.postalCode: Zip

Bindings

Address.use: AddressUse | strength: code list | reference: #address-use | The use of an address (home / work / etc.).
Address.type: AddressType | strength: code list | reference: #address-type | The type of an address (physical / postal).

Modifiers

Address.use: Is modifier

Examples

Address.use: home
Address.type: both
Address.text: 137 Nowhere Street, Erewhon 9132
Address.line: 137 Nowhere Street
Address.city: Erewhon
Address.district: Madison
Address.period: { "start" : "2010-03-23", "end" : "2010-07-01" }

Requirements

Address.use: Allows an appropriate address to be chosen from a list of many
Address.text: A renderable, unencoded form
Address.period: Allows addresses to be placed in historical context

Comments

Address.use: Applications can assume that an address is current unless it explicitly says that it is temporary or old
Address.type: The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [[[Location]]] resource). This element is relevant when there is potentially a collection of addresses and a need to differentiate the purpose of each. When this type is used on an element or extension where the 'purpose' of the address is implicit in the extension definition, 'use' will typically be omitted.
Address.text: Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part
Address.district: District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead
Address.country: ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

Order and Missing Meaning

Address.line: Order: The order in which lines should appear in an address label

Mappings

Address.use: RIM Mapping: unique(./use)
Address.use: v2 Mapping: XAD.7
Address.use: ServD Mapping: ./AddressPurpose
Address.type: RIM Mapping: unique(./use)
Address.type: v2 Mapping: XAD.18
Address.type: vCard Mapping: address type parameter
Address.text: RIM Mapping: ./formatted
Address.text: v2 Mapping: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
Address.text: vCard Mapping: address label parameter
Address.line: RIM Mapping: AD.part[parttype = AL]
Address.line: v2 Mapping: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
Address.line: vCard Mapping: street
Address.line: ServD Mapping: ./StreetAddress (newline delimitted)
Address.city: RIM Mapping: AD.part[parttype = CTY]
Address.city: v2 Mapping: XAD.3
Address.city: vCard Mapping: locality
Address.city: ServD Mapping: ./Jurisdiction
Address.district: RIM Mapping: AD.part[parttype = CNT | CPA]
Address.district: v2 Mapping: XAD.9
Address.state: RIM Mapping: AD.part[parttype = STA]
Address.state: v2 Mapping: XAD.4
Address.state: vCard Mapping: region
Address.state: ServD Mapping: ./Region
Address.postalCode: RIM Mapping: AD.part[parttype = ZIP]
Address.postalCode: v2 Mapping: XAD.5
Address.postalCode: vCard Mapping: code
Address.postalCode: ServD Mapping: ./PostalIdentificationCode
Address.country: RIM Mapping: AD.part[parttype = CNT]
Address.country: v2 Mapping: XAD.6
Address.country: vCard Mapping: country
Address.country: ServD Mapping: ./Country
Address.period: RIM Mapping: ./usablePeriod[type="IVL<TS>"]
Address.period: v2 Mapping: XAD.12 / XAD.13 + XAD.14
Address.period: ServD Mapping: ./StartDate and ./EndDate