visit the hl7 website The Demo site for our new HL7 Version 2+ (plus) Standard

18.3.8 XAD - extended address (2A.3.87)

HL7 Component Table - XAD - Extended Address

Core Framework Base Standard Profile
Seq# Description Interpretation Flags Cardinality Length C.LEN Vocabulary Data Type Implement Cardinality Vocabulary
XAD
1 Street Address [0..1]     SAD      
2 Other Designation [0..1]     ST      
3 City [0..1]     ST      
4 State or Province [0..1]     ST      
5 Zip or Postal Code [0..1]     ST      
6 Country [0..1]   iso3166-1 (CD VS) ID     (CS)
7
Address Type
C

Condition defined for this element


[1..1]
[0..0]
  addressType (CD VS) ID MAY   (CS)
8 Other Geographic Designation [0..1]     ST      
9 County/Parish Code [0..1]   noObject (CD VS) CWE     (CS)
10 Census Tract [0..1]   noObject (CD VS) CWE     (CS)
11 Address Representation Code [0..1]   name-addressRepresentation (CD VS) ID     (CS)
12 Address Validity Range W [0..0]     - SHALL NOT    
13 Effective Date [0..1]     DTM      
14 Expiration Date [0..1]     DTM      
15 Expiration Reason [0..1]   addressExpirationReason (CD VS) CWE     (CS)
16 Temporary Indicator [0..1]   expandedYes-NoIndicator (CD VS) ID     (CS)
17 Bad Address Indicator [0..1]   expandedYes-NoIndicator (CD VS) ID     (CS)
18 Address Usage [0..1]   addressUsage (CD VS) ID     (CS)
19 Addressee [0..1]     ST      
20 Comment [0..1]     ST      
21 Preference Order [0..1]     NM      
22 Protection Code [0..1]   protection (CD VS) CWE     (CS)
23 Address Identifier [0..1]     EI      

Definition: This data type specifies the address of a person, place or organization plus associated information.

Note: Replaces the AD data type as of v2.3.

Example of usage for US:

|1000 Hospital Lane^Ste. 123^Ann Arbor ^MI^99999^USA^B^^WA^|

This would be formatted for postal purposes as

1000 Hospital Lane

Ste. 123

Ann Arbor MI 99999

Example of usage for Australia:

|14th Floor^1000 Hospital Lane^Sidney^QLD^9999|

This would be formatted for postal purposes using the same rules as for the American example as

14th Floor

1000 Hospital Lane

Sidney QLD 9999

International note: Countries typically have a standard method of formatting addresses. This data type does not specify the formatting usages, only the components of a postal address.

18.3.8.1 Street Address (SAD) (2A.3.87.0)

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

18.3.8.2 Other Designation (ST) (2A.3.87.1)

Definition: This component contains the second line of address. In US usage, it qualifies address. Examples: Suite 555 or Fourth Floor. When referencing an institution, this component specifies the street address.

18.3.8.3 City (ST) (2A.3.87.2)

Definition: This component specifies the city, or district or place where the addressee is located depending upon the national convention for formatting addresses for postal usage.

18.3.8.4 State or Province (ST) (2A.3.87.3)

Definition: This component specifies the state or province where the addressee is located. State or province should be represented by the official postal service codes for that country.

18.3.8.5 Zip or Postal Code (ST) (2A.3.87.4)

Definition: This component specifies the zip or postal code where the addressee is located. Zip or postal codes should be represented by the official codes for that country. In the US, the zip code takes the form 99999[-9999], while the Canadian postal code takes the form A9A9A9, and the Australian Postcode takes the form 9999.

18.3.8.6 Country (ID) (2A.3.87.5)

Definition: This component specifies the country where the addressee is located. HL7 specifies that the 3-character (alphabetic) form of ISO 3166 be used for the country code. Refer to HL7 Table 0399 - Country Code for valid values.

18.3.8.7 Address Type (ID) (2A.3.87.6)

Definition: This component specifies the kind or type of address. Refer to HL7 Table 0190 - Address Type for valid values.

XAD.7 is required if there are multiple occurrences of XAD in a field.

18.3.8.8 Other Geographic Designation (ST) (2A.3.87.7)

Definition: This component specifies any other geographic designation. It includes county, bioregion, SMSA, etc.

18.3.8.9 County/Parish Code (CWE) (2A.3.87.8)

Definition: A code that represents the county in which the specified address resides. User-defined Table 0289 - County/parish is used as the HL7 identifier for the user-defined table of values for this component. When this component is used to represent the county (or parish), component 8 should not duplicate it (i.e., the use of to represent the county is allowed only for the purpose of backward compatibility, and should be discouraged in this and future versions of HL7).

Allowable values: codes defined by government.

18.3.8.10 Census Tract (CWE) (2A.3.87.9)

Definition: A code that represents the census tract in which the specified address resides. User-defined Table 0288 - Census Tract is used as the HL7 identifier for the user-defined table of values for this component.

Allowable Values: codes defined by government.