Skip to main content

Address

Base StructureDefinition for Address Type: An address expressed using postal conventions (as opposed to GPS or other location definition formats). 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.

Properties

NameRequiredTypeDescription
idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

usecode

home | work | temp | old | billing - purpose of this address

Details

The purpose of this address.

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

typecode

postal | physical | both

Details

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

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](location.html#) resource).

textstring

Text representation of the address

Details

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.

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.

linestring[]

Street name, number, direction & P.O. Box etc.

Details

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

citystring

Name of city, town etc.

Details

The name of the city, town, suburb, village or other community or delivery center.

districtstring

District name (aka county)

Details

The name of the administrative area (county).

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.

statestring

Sub-unit of country (abbreviations ok)

Details

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).

postalCodestring

Postal code for area

Details

A postal code designating a region defined by the postal service.

countrystring

Country (e.g. can be ISO 3166 2 or 3 letter code)

Details

Country - a nation as commonly understood or generally accepted.

ISO 3166 3 letter codes can be used in place of a human readable country name.

periodPeriod

Time period when address was/is in use

Details

Time period when address was/is in use.