HL7 v2+ Specification
0.0.0 - draft
HL7 v2+ Specification
0.0.0 - draft
HL7 v2+ Specification, published by HL7 International. This guide is not an authorized publication; it is the continuous build for version 0.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/v2/StructureDefinition/XAD | Version: 0.0.0 | |||
| Standards status: Informative | Computable Name: XAD | |||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from V2ComplexDataType
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  XAD |
0..* | V2ComplexDataType | extended address Instances of this logical model are not marked to be the target of a Reference | |
  1 |
0..1 | SAD | Street Address | |
 2 |
0..1 | string | Other Designation | |
| 3 |
0..1 | string | City | |
| 4 |
0..1 | string | State or Province | |
| 5 |
0..1 | string | Zip or Postal Code | |
| 6 |
0..1 | code | Country Binding: http://terminology.hl7.org/ValueSet/v2-0399 (required) | |
| 7 |
0..1 | code | Address Type Binding: hl7VS-addressType (required) | |
| 8 |
0..1 | string | Other Geographic Designation | |
| 9 |
0..1 | CWE | County/Parish Code Binding: http://terminology.hl7.org/ValueSet/v2-0289 (required) | |
| 10 |
0..1 | CWE | Census Tract Binding: http://terminology.hl7.org/ValueSet/v2-0288 (required) | |
| 11 |
0..1 | code | Address Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 12 |
Address Validity Range | |||
| 13 |
0..1 | dateTime | Effective Date | |
| 14 |
0..1 | dateTime | Expiration Date | |
| 15 |
0..1 | CWE | Expiration Reason Binding: hl7VS-addressExpirationReason (required) | |
| 16 |
0..1 | code | Temporary Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 17 |
0..1 | code | Bad Address Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 18 |
0..1 | code | Address Usage Binding: hl7VS-addressUsage (required) | |
| 19 |
0..1 | string | Addressee | |
| 20 |
0..1 | string | Comment | |
| 21 |
0..1 | decimal | Preference Order | |
| 22 |
0..1 | CWE | Protection Code Binding: hl7VS-protectionCode (required) | |
 23 |
0..1 | EI | Address Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XAD.6 | required | http://terminology.hl7.org/ValueSet/v2-0399http://terminology.hl7.org/ValueSet/v2-0399 | |
| XAD.7 | required | Hl7VSAddressTypehttp://terminology.hl7.org/ValueSet/v2-0190 | |
| XAD.9 | required | http://terminology.hl7.org/ValueSet/v2-0289http://terminology.hl7.org/ValueSet/v2-0289 | |
| XAD.10 | required | http://terminology.hl7.org/ValueSet/v2-0288http://terminology.hl7.org/ValueSet/v2-0288 | |
| XAD.11 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 | |
| XAD.15 | required | Hl7VSAddressExpirationReasonhttp://terminology.hl7.org/ValueSet/v2-0616 | |
| XAD.16 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.17 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.18 | required | Hl7VSAddressUsagehttp://terminology.hl7.org/ValueSet/v2-0617 | |
| XAD.22 | required | Hl7VSProtectionCodehttp://terminology.hl7.org/ValueSet/v2-0618 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XAD |
0..* | V2ComplexDataType | extended address Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | SAD | Street Address | |
| 2 |
0..1 | string | Other Designation | |
| 3 |
0..1 | string | City | |
| 4 |
0..1 | string | State or Province | |
| 5 |
0..1 | string | Zip or Postal Code | |
| 6 |
0..1 | code | Country Binding: http://terminology.hl7.org/ValueSet/v2-0399 (required) | |
| 7 |
0..1 | code | Address Type Binding: hl7VS-addressType (required) | |
| 8 |
0..1 | string | Other Geographic Designation | |
| 9 |
0..1 | CWE | County/Parish Code Binding: http://terminology.hl7.org/ValueSet/v2-0289 (required) | |
| 10 |
0..1 | CWE | Census Tract Binding: http://terminology.hl7.org/ValueSet/v2-0288 (required) | |
| 11 |
0..1 | code | Address Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 12 |
Address Validity Range | |||
| 13 |
0..1 | dateTime | Effective Date | |
| 14 |
0..1 | dateTime | Expiration Date | |
| 15 |
0..1 | CWE | Expiration Reason Binding: hl7VS-addressExpirationReason (required) | |
| 16 |
0..1 | code | Temporary Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 17 |
0..1 | code | Bad Address Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 18 |
0..1 | code | Address Usage Binding: hl7VS-addressUsage (required) | |
| 19 |
0..1 | string | Addressee | |
| 20 |
0..1 | string | Comment | |
| 21 |
0..1 | decimal | Preference Order | |
| 22 |
0..1 | CWE | Protection Code Binding: hl7VS-protectionCode (required) | |
| 23 |
0..1 | EI | Address Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XAD.6 | required | http://terminology.hl7.org/ValueSet/v2-0399http://terminology.hl7.org/ValueSet/v2-0399 | |
| XAD.7 | required | Hl7VSAddressTypehttp://terminology.hl7.org/ValueSet/v2-0190 | |
| XAD.9 | required | http://terminology.hl7.org/ValueSet/v2-0289http://terminology.hl7.org/ValueSet/v2-0289 | |
| XAD.10 | required | http://terminology.hl7.org/ValueSet/v2-0288http://terminology.hl7.org/ValueSet/v2-0288 | |
| XAD.11 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 | |
| XAD.15 | required | Hl7VSAddressExpirationReasonhttp://terminology.hl7.org/ValueSet/v2-0616 | |
| XAD.16 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.17 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.18 | required | Hl7VSAddressUsagehttp://terminology.hl7.org/ValueSet/v2-0617 | |
| XAD.22 | required | Hl7VSProtectionCodehttp://terminology.hl7.org/ValueSet/v2-0618 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XAD |
0..* | V2ComplexDataType | extended address Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | SAD | Street Address | |
| 2 |
0..1 | string | Other Designation | |
| 3 |
0..1 | string | City | |
| 4 |
0..1 | string | State or Province | |
| 5 |
0..1 | string | Zip or Postal Code | |
| 6 |
0..1 | code | Country Binding: http://terminology.hl7.org/ValueSet/v2-0399 (required) | |
| 7 |
0..1 | code | Address Type Binding: hl7VS-addressType (required) | |
| 8 |
0..1 | string | Other Geographic Designation | |
| 9 |
0..1 | CWE | County/Parish Code Binding: http://terminology.hl7.org/ValueSet/v2-0289 (required) | |
| 10 |
0..1 | CWE | Census Tract Binding: http://terminology.hl7.org/ValueSet/v2-0288 (required) | |
| 11 |
0..1 | code | Address Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 12 |
Address Validity Range | |||
| 13 |
0..1 | dateTime | Effective Date | |
| 14 |
0..1 | dateTime | Expiration Date | |
| 15 |
0..1 | CWE | Expiration Reason Binding: hl7VS-addressExpirationReason (required) | |
| 16 |
0..1 | code | Temporary Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 17 |
0..1 | code | Bad Address Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 18 |
0..1 | code | Address Usage Binding: hl7VS-addressUsage (required) | |
| 19 |
0..1 | string | Addressee | |
| 20 |
0..1 | string | Comment | |
| 21 |
0..1 | decimal | Preference Order | |
| 22 |
0..1 | CWE | Protection Code Binding: hl7VS-protectionCode (required) | |
| 23 |
0..1 | EI | Address Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XAD.6 | required | http://terminology.hl7.org/ValueSet/v2-0399http://terminology.hl7.org/ValueSet/v2-0399 | |
| XAD.7 | required | Hl7VSAddressTypehttp://terminology.hl7.org/ValueSet/v2-0190 | |
| XAD.9 | required | http://terminology.hl7.org/ValueSet/v2-0289http://terminology.hl7.org/ValueSet/v2-0289 | |
| XAD.10 | required | http://terminology.hl7.org/ValueSet/v2-0288http://terminology.hl7.org/ValueSet/v2-0288 | |
| XAD.11 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 | |
| XAD.15 | required | Hl7VSAddressExpirationReasonhttp://terminology.hl7.org/ValueSet/v2-0616 | |
| XAD.16 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.17 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.18 | required | Hl7VSAddressUsagehttp://terminology.hl7.org/ValueSet/v2-0617 | |
| XAD.22 | required | Hl7VSProtectionCodehttp://terminology.hl7.org/ValueSet/v2-0618 |
This structure is derived from V2ComplexDataType
Differential View
This structure is derived from V2ComplexDataType
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XAD |
0..* | V2ComplexDataType | extended address Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | SAD | Street Address | |
| 2 |
0..1 | string | Other Designation | |
| 3 |
0..1 | string | City | |
| 4 |
0..1 | string | State or Province | |
| 5 |
0..1 | string | Zip or Postal Code | |
| 6 |
0..1 | code | Country Binding: http://terminology.hl7.org/ValueSet/v2-0399 (required) | |
| 7 |
0..1 | code | Address Type Binding: hl7VS-addressType (required) | |
| 8 |
0..1 | string | Other Geographic Designation | |
| 9 |
0..1 | CWE | County/Parish Code Binding: http://terminology.hl7.org/ValueSet/v2-0289 (required) | |
| 10 |
0..1 | CWE | Census Tract Binding: http://terminology.hl7.org/ValueSet/v2-0288 (required) | |
| 11 |
0..1 | code | Address Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 12 |
Address Validity Range | |||
| 13 |
0..1 | dateTime | Effective Date | |
| 14 |
0..1 | dateTime | Expiration Date | |
| 15 |
0..1 | CWE | Expiration Reason Binding: hl7VS-addressExpirationReason (required) | |
| 16 |
0..1 | code | Temporary Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 17 |
0..1 | code | Bad Address Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 18 |
0..1 | code | Address Usage Binding: hl7VS-addressUsage (required) | |
| 19 |
0..1 | string | Addressee | |
| 20 |
0..1 | string | Comment | |
| 21 |
0..1 | decimal | Preference Order | |
| 22 |
0..1 | CWE | Protection Code Binding: hl7VS-protectionCode (required) | |
| 23 |
0..1 | EI | Address Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XAD.6 | required | http://terminology.hl7.org/ValueSet/v2-0399http://terminology.hl7.org/ValueSet/v2-0399 | |
| XAD.7 | required | Hl7VSAddressTypehttp://terminology.hl7.org/ValueSet/v2-0190 | |
| XAD.9 | required | http://terminology.hl7.org/ValueSet/v2-0289http://terminology.hl7.org/ValueSet/v2-0289 | |
| XAD.10 | required | http://terminology.hl7.org/ValueSet/v2-0288http://terminology.hl7.org/ValueSet/v2-0288 | |
| XAD.11 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 | |
| XAD.15 | required | Hl7VSAddressExpirationReasonhttp://terminology.hl7.org/ValueSet/v2-0616 | |
| XAD.16 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.17 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.18 | required | Hl7VSAddressUsagehttp://terminology.hl7.org/ValueSet/v2-0617 | |
| XAD.22 | required | Hl7VSProtectionCodehttp://terminology.hl7.org/ValueSet/v2-0618 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XAD |
0..* | V2ComplexDataType | extended address Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | SAD | Street Address | |
| 2 |
0..1 | string | Other Designation | |
| 3 |
0..1 | string | City | |
| 4 |
0..1 | string | State or Province | |
| 5 |
0..1 | string | Zip or Postal Code | |
| 6 |
0..1 | code | Country Binding: http://terminology.hl7.org/ValueSet/v2-0399 (required) | |
| 7 |
0..1 | code | Address Type Binding: hl7VS-addressType (required) | |
| 8 |
0..1 | string | Other Geographic Designation | |
| 9 |
0..1 | CWE | County/Parish Code Binding: http://terminology.hl7.org/ValueSet/v2-0289 (required) | |
| 10 |
0..1 | CWE | Census Tract Binding: http://terminology.hl7.org/ValueSet/v2-0288 (required) | |
| 11 |
0..1 | code | Address Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 12 |
Address Validity Range | |||
| 13 |
0..1 | dateTime | Effective Date | |
| 14 |
0..1 | dateTime | Expiration Date | |
| 15 |
0..1 | CWE | Expiration Reason Binding: hl7VS-addressExpirationReason (required) | |
| 16 |
0..1 | code | Temporary Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 17 |
0..1 | code | Bad Address Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 18 |
0..1 | code | Address Usage Binding: hl7VS-addressUsage (required) | |
| 19 |
0..1 | string | Addressee | |
| 20 |
0..1 | string | Comment | |
| 21 |
0..1 | decimal | Preference Order | |
| 22 |
0..1 | CWE | Protection Code Binding: hl7VS-protectionCode (required) | |
| 23 |
0..1 | EI | Address Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XAD.6 | required | http://terminology.hl7.org/ValueSet/v2-0399http://terminology.hl7.org/ValueSet/v2-0399 | |
| XAD.7 | required | Hl7VSAddressTypehttp://terminology.hl7.org/ValueSet/v2-0190 | |
| XAD.9 | required | http://terminology.hl7.org/ValueSet/v2-0289http://terminology.hl7.org/ValueSet/v2-0289 | |
| XAD.10 | required | http://terminology.hl7.org/ValueSet/v2-0288http://terminology.hl7.org/ValueSet/v2-0288 | |
| XAD.11 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 | |
| XAD.15 | required | Hl7VSAddressExpirationReasonhttp://terminology.hl7.org/ValueSet/v2-0616 | |
| XAD.16 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.17 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.18 | required | Hl7VSAddressUsagehttp://terminology.hl7.org/ValueSet/v2-0617 | |
| XAD.22 | required | Hl7VSProtectionCodehttp://terminology.hl7.org/ValueSet/v2-0618 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XAD |
0..* | V2ComplexDataType | extended address Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | SAD | Street Address | |
| 2 |
0..1 | string | Other Designation | |
| 3 |
0..1 | string | City | |
| 4 |
0..1 | string | State or Province | |
| 5 |
0..1 | string | Zip or Postal Code | |
| 6 |
0..1 | code | Country Binding: http://terminology.hl7.org/ValueSet/v2-0399 (required) | |
| 7 |
0..1 | code | Address Type Binding: hl7VS-addressType (required) | |
| 8 |
0..1 | string | Other Geographic Designation | |
| 9 |
0..1 | CWE | County/Parish Code Binding: http://terminology.hl7.org/ValueSet/v2-0289 (required) | |
| 10 |
0..1 | CWE | Census Tract Binding: http://terminology.hl7.org/ValueSet/v2-0288 (required) | |
| 11 |
0..1 | code | Address Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 12 |
Address Validity Range | |||
| 13 |
0..1 | dateTime | Effective Date | |
| 14 |
0..1 | dateTime | Expiration Date | |
| 15 |
0..1 | CWE | Expiration Reason Binding: hl7VS-addressExpirationReason (required) | |
| 16 |
0..1 | code | Temporary Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 17 |
0..1 | code | Bad Address Indicator Binding: hl7VS-yes-no-Indicator (required) | |
| 18 |
0..1 | code | Address Usage Binding: hl7VS-addressUsage (required) | |
| 19 |
0..1 | string | Addressee | |
| 20 |
0..1 | string | Comment | |
| 21 |
0..1 | decimal | Preference Order | |
| 22 |
0..1 | CWE | Protection Code Binding: hl7VS-protectionCode (required) | |
| 23 |
0..1 | EI | Address Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XAD.6 | required | http://terminology.hl7.org/ValueSet/v2-0399http://terminology.hl7.org/ValueSet/v2-0399 | |
| XAD.7 | required | Hl7VSAddressTypehttp://terminology.hl7.org/ValueSet/v2-0190 | |
| XAD.9 | required | http://terminology.hl7.org/ValueSet/v2-0289http://terminology.hl7.org/ValueSet/v2-0289 | |
| XAD.10 | required | http://terminology.hl7.org/ValueSet/v2-0288http://terminology.hl7.org/ValueSet/v2-0288 | |
| XAD.11 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 | |
| XAD.15 | required | Hl7VSAddressExpirationReasonhttp://terminology.hl7.org/ValueSet/v2-0616 | |
| XAD.16 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.17 | required | Hl7VSYesNoIndicatorhttp://terminology.hl7.org/ValueSet/v2-0136 | |
| XAD.18 | required | Hl7VSAddressUsagehttp://terminology.hl7.org/ValueSet/v2-0617 | |
| XAD.22 | required | Hl7VSProtectionCodehttp://terminology.hl7.org/ValueSet/v2-0618 |
This structure is derived from V2ComplexDataType