Datatypes
Class Address

A label for the place or location at which a person or organization may be reached. This class is used primarily for mailing addresses, but includes an optional County property which is often needed for statistical reporting or pricing purposes. Note that it doesn’t include a State code, as this code is added in a US-specific subtype. This is done because states or provinces for other countries will be identified in using different value-sets, if at all. The state code in the US Mailing Address sub-type is bound to a particular value set, the province code in the Canadian Mailing Address sub-type is bound to a different value set, while the Other Country Mailing Address simply contain as string for the jurisdiction.
"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." - HL7 FHIR, Address.

Attributes
String city city

"The name of the city, town, village, or other community or delivery center." - HL7 V3
"The name of the city, town, village or other community or delivery center." - HL7 FHIR, Address.city
"Freeform text for city name." - ASAP Standard for PDMP, PAT14: City Address

«CS» Code country country

The state or nation having jurisdiction over the location specified in the address. This information is needed to properly route correspondence across national boundaries.
"Country - a nation as commonly understood or generally accepted." - HL7 FHIR, Address.postalCode
"Used when the patient’s address is a foreign country" - ASAP Standard for PDMP, PAT22: Country of Non-U.S. Resident

«CS» Code county county

A region created by territorial division for the purpose of local government. In the United States, a county (or parish in Louisiana) is the largest administrative district within a state. This optional property is used primarily for statistical and pricing information (i.e., the same service may be more expensive in an affluent section of the country than in a less-affluent portion).
"The name of the administrative area (county)." HL7 FHIR, Address.district

«IVL_TS» Period effectiveDateRange effectiveDateRange

The time period during which the address is a valid location for the person or organization. The data type is a TimeInterval, which includes both a start date and end date, either of which may be empty.
"Time period when address was/is in use." - HL7 FHIR, Address.period

String line1 line1

The first line of the street address. While this street address could be broken into several constituent parts (as was done in HL7 V3), for the purpose of this logical model, the whole line is treated as a single concept. Note that this property is optional because in some cases (such as birth address) it may not be known or collected.
"This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information." - HL7 FHIR, Address.line.
"Freeform text for address information" - ASAP Standard for PDMP, PAT12: Address Information – 1

String line2 line2

The second line of the street address. While this street address could be broken into several constituent parts (as was done in HL7 V3), for the purpose of this logical model, the whole line is treated as a single concept.
"This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information." - HL7 FHIR, Address.line.
"Freeform text for additional address information" - ASAP Standard for PDMP, PAT13: Address Information – 2

String line3 line3

The third line of the street address. While this street address could be broken into several constituent parts (as was done in HL7 V3), for the purpose of this logical model, the whole line is treated as a single concept.
"This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information." - HL7 FHIR, Address.line.

String postalCode postalCode

A string of digits (and in some countries, letters) used as part of a postal address to aid the sorting of mail. This code is defined by the postal system of the country in which location is contained.
"A postal code designating a region defined by the postal service." - HL7 FHIR, Address.postalCode
"U.S. Postal Service ZIP code." - ASAP Standard for PDMP, PAT15: ZIP Code Address

String text text

"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." - HL7 FHIR, Address.text

«CS» Code type type

"Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both." - HL7 FHIR, Address.type

«CS» Code use use

Indicates the kind of address that is contained within this class. Examples include primary home, work, etc. This facilitates the selection of a particular address from a list of addresses that may apply to the person or organization.
"The purpose of this address." - HL7 FHIR, Address.use.


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsAD
NameAddress
Name Expression
NamespaceDatatypes
Owned Template Signature
OwnerDatatypes
Owning Template Parameter
PackageDatatypes
Qualified NameFHIM::Datatypes::Address
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 city
Public String city

"The name of the city, town, village, or other community or delivery center." - HL7 V3
"The name of the city, town, village or other community or delivery center." - HL7 FHIR, Address.city
"Freeform text for city name." - ASAP Standard for PDMP, PAT14: City Address

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namecity
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::city
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 country
Public «CS» Code country

The state or nation having jurisdiction over the location specified in the address. This information is needed to properly route correspondence across national boundaries.
"Country - a nation as commonly understood or generally accepted." - HL7 FHIR, Address.postalCode
"Used when the patient’s address is a foreign country" - ASAP Standard for PDMP, PAT22: Country of Non-U.S. Resident

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namecountry
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::country
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 county
Public «CS» Code county

A region created by territorial division for the purpose of local government. In the United States, a county (or parish in Louisiana) is the largest administrative district within a state. This optional property is used primarily for statistical and pricing information (i.e., the same service may be more expensive in an affluent section of the country than in a less-affluent portion).
"The name of the administrative area (county)." HL7 FHIR, Address.district

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namecounty
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::county
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 effectiveDateRange
Public «IVL_TS» Period effectiveDateRange

The time period during which the address is a valid location for the person or organization. The data type is a TimeInterval, which includes both a start date and end date, either of which may be empty.
"Time period when address was/is in use." - HL7 FHIR, Address.period

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameeffectiveDateRange
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::effectiveDateRange
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 line1
Public String line1

The first line of the street address. While this street address could be broken into several constituent parts (as was done in HL7 V3), for the purpose of this logical model, the whole line is treated as a single concept. Note that this property is optional because in some cases (such as birth address) it may not be known or collected.
"This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information." - HL7 FHIR, Address.line.
"Freeform text for address information" - ASAP Standard for PDMP, PAT12: Address Information – 1

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameline1
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::line1
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 line2
Public String line2

The second line of the street address. While this street address could be broken into several constituent parts (as was done in HL7 V3), for the purpose of this logical model, the whole line is treated as a single concept.
"This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information." - HL7 FHIR, Address.line.
"Freeform text for additional address information" - ASAP Standard for PDMP, PAT13: Address Information – 2

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameline2
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::line2
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 line3
Public String line3

The third line of the street address. While this street address could be broken into several constituent parts (as was done in HL7 V3), for the purpose of this logical model, the whole line is treated as a single concept.
"This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information." - HL7 FHIR, Address.line.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameline3
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::line3
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 postalCode
Public String postalCode

A string of digits (and in some countries, letters) used as part of a postal address to aid the sorting of mail. This code is defined by the postal system of the country in which location is contained.
"A postal code designating a region defined by the postal service." - HL7 FHIR, Address.postalCode
"U.S. Postal Service ZIP code." - ASAP Standard for PDMP, PAT15: ZIP Code Address

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamepostalCode
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::postalCode
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 text
Public String text

"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." - HL7 FHIR, Address.text

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nametext
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::text
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 type
Public «CS» Code type

"Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both." - HL7 FHIR, Address.type

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nametype
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::type
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 use
Public «CS» Code use

Indicates the kind of address that is contained within this class. Examples include primary home, work, etc. This facilitates the selection of a particular address from a list of addresses that may apply to the person or organization.
"The purpose of this address." - HL7 FHIR, Address.use.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«AD» Address
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameuse
Name Expression
Namespace«AD» Address
Opposite
Owner«AD» Address
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Address::use
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic