Skip to main content

Address

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. If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

type Address implements Element {
  use: String
  type: String
  text: String
  line: [String]
  city: String
  district: String
  state: String
  postalCode: String
  country: String
  period: Period
  extension: [Extension]
  id: String
}

Fields​

Address.use ● String scalar​

The purpose of this address.

Address.type ● String scalar​

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 ● String scalar​

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.

Address.line ● [String] list scalar​

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

Address.city ● String scalar​

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

Address.district ● String scalar​

The name of the administrative area (county).

Address.state ● String scalar​

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 ● String scalar​

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

Address.country ● String scalar​

Country - a nation as commonly understood or generally accepted.

Address.period ● Period object​

Time period when address was/is in use.

Address.extension ● [Extension] list object​

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.

Address.id ● String scalar​

Interfaces​

Element interface​

Base definition for all elements in a resource. If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Member Of​

CitationEntry object ● ClaimAccident object ● ClaimItem object ● ClaimResponseAddItem object ● ElementDefinition object ● ElementDefinitionExample object ● ExplanationOfBenefitAccident object ● ExplanationOfBenefitAddItem object ● ExplanationOfBenefitItem object ● Extension object ● InsurancePlanContact object ● Location object ● Organization object ● OrganizationContact object ● Patient object ● PatientContact object ● Person object ● Practitioner object ● RelatedPerson object ● StructureMapSource object ● TaskInput object ● TaskOutput object