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

Draft Website - For Review Purposes Only

XAD - extended address

HL7 Component Table - XAD - extended address
Seq# Description Implement Flags Cardinality Length C.LEN Vocabulary Data Type
XAD
1 Street Address [0..1]     SAD
2 Other Designation # [0..1] 120 ST
3 City # [0..1]  50 ST
4 State or Province # [0..1]  50 ST
5 Zip or Postal Code = [0..1]  12 ST
6 Country SHALL [0..1] [3..3]     0399 ID
7

Address Type MAY
True:
False:
C
[1..1]
[0..1]
[1..3]     0190 ID
8 Other Geographic Designation # [0..1]  50 ST
9 County/Parish Code [0..1]     0289 CWE
10 Census Tract [0..1]     0288 CWE
11 Address Representation Code SHALL [0..1] [1..1]     0465 ID
12 Address Validity Range [0..1]    
13 Effective Date = [0..1]   8 DTM
14 Expiration Date = [0..1]   8 DTM
15 Expiration Reason [0..1]     0616 CWE
16 Temporary Indicator SHALL [0..1] [1..1]     0136 ID
17 Bad Address Indicator SHALL [0..1] [1..1]     0136 ID
18 Address Usage SHALL [0..1] [1..1]     0617 ID
19 Addressee # [0..1] 199 ST
20 Comment # [0..1] 199 ST
21 Preference Order = [0..1]   2 NM
22 Protection Code [0..1]     0618 CWE
23 Address Identifier [0..1]     EI

Components: <Street Address (SAD)> & <Other Designation (ST)> & <City (ST)> & <State or Province (ST)> & <Zip or Postal Code (ST)> & <Country (ID)> & <Address Type (ID)> & <Other Geographic Designation (ST)> & <County/Parish Code (CWE)> & <Census Tract (CWE)> & <Address Representation Code (ID)> & <WITHDRAWN Address Validity Range> & <Effective Date (DTM)> & <Expiration Date (DTM)> & <Expiration Reason (CWE)> & <Temporary Indicator (ID)> & <Bad Address Indicator (ID)> & <Address Usage (ID)> & <Addressee (ST)> & <Comment (ST)> & <Preference Order (NM)> & <Protection Code (CWE)> & <Address Identifier (EI)>

Subcomponents for Street Address (SAD): <Street or Mailing Address (ST)> ^ <Street Name (ST)> ^ <Dwelling Number (ST)>

Subcomponents for County/Parish Code (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>

Subcomponents for Census Tract (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>

Subcomponents for Expiration Reason (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>

Subcomponents for Protection Code (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>

Subcomponents for Address Identifier (EI): <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>

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.


XAD-1: Street Address (SAD)

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

XAD-2: Other Designation (ST)

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.

XAD-3: City (ST)

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.

XAD-4: State or Province (ST)

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.

XAD-5: Zip or Postal Code (ST)

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.

XAD-6: Country (ID)

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.

XAD-7: Address Type (ID)

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.

XAD-8: Other Geographic Designation (ST)

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

XAD-9: County/Parish Code (CWE)

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 <other geographic designation> should not duplicate it (i.e., the use of <other geographic designation> 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.

XAD-10: Census Tract (CWE)

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.

XAD-11: Address Representation Code (ID)

Definition: Different <name/address types> and representations of the same name/address should be described by repeating of this field, with different values of the <name/address type> and/or <name/address representation> component.

Note: Also note that this new component remains in "alphabetic" representation with each repetition of the fields using these data types. I.e. even though the address may be represented in an ideographic character set, this component will remain represented in an alphabetic character set.


Refer to HL7 Table 0465 – Name/address Representation for valid values.

In general this component provides an indication of the representation provided by the data item. It does not necessarily specify the character sets used. Thus, even though the representation might provide an indication of what to expect, the sender is still free to encode the contents using whatever character set is desired. This component provides only hints for the receiver, so it can make choices regarding what it has been sent and what it is capable of displaying.

XAD-12: Address Validity Range (XAD)

Attention: The XAD.12 component was retained for backward compatibility as of v2.5 and the detail was withdrawn and removed from the standard as of v2.7. Refer to2.A.86.13, "Effective Date (DTM)" and 2.A.86.14, "Expiration Date (DTM)" components.

XAD-13: Effective Date (DTM)

Definition: The first date, if known, on which the address is valid and active for the ‘owning’ entity.

XAD-14: Expiration Date (DTM)

Definition: The last date, if known, on which the address is valid and active for the ‘owning’ entity.

XAD-15: Expiration Reason (CWE)

Definition: This identifies why this address was marked as "ended". Refer to User-defined Table 0616 – Address Expiration Reason for valid values.

XAD-16: Temporary Indicator (ID)

Definition: If "Y" this indicates that the address is considered temporary. Refer to HL7 Table 0136 – Yes/No Indicator.

XAD-17: Bad Address Indicator (ID)

Definition: If "Y", this indicates that it is not possible to contact the "owning" entity at this address. Refer to HL7 Table 0136 – Yes/No Indicator.

XAD-18: Address Usage (ID)

Definition: This indicates how the address is intended to be used. Refer to User-defined Table 0617 – Address Usage for valid values.

XAD-19: Addressee (ST)

Definition: Identifies the name of the person or organization that should appear as part of the address. This is also known as the "Care of" or "C/O" line.

XAD-20: Comment (ST)

Definition: Descriptive information about the use of the address.

Example: "Do not ring bell."

XAD-21: Preference Order (NM)

Definition: For an entity having multiple addresses, indicates which is the 'most preferred' (lowest number) to 'least preferred' (highest number).

If the preference order is unique across all usages for a given type, then it indicates the preference across all usages, (e.g., first try my home address, then my business address). Otherwise, the preference order is assumed to only apply within a specific usage.

Preference order numbers need not be sequential (i.e., four addresses with the priority orders of 10, 1, 5 and 15 are legitimate). The preference order numbers must be non-negative.

XAD-22: Protection Code (CWE)

Definition: Identifies that an address needs to be treated with special care or sensitivity.

The specific set of codes and appropriate handling of such addresses will vary by jurisdiction and is subject to site-specific negotiation. For example, a provider address marked as 'unlisted' might not be printed in an internal address listing. Refer to User-defined Table 0618 – Protection Code for valid values.

XAD-23: Address Identifier (EI)

Definition: A unique identifier for the address.

This component allows an address to be uniquely identified, and enables the linking of a single address to multiple people and contexts. For example, each member of a family living at the same location would share the same address, having the same identifier. A correction to the address of one family member could be automatically propagated to other members of the family.