HL7 v2 XAD Data Type - Definitions - HL7 v2+ Specification v0.0.0

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

Logical Model: XAD - Detailed Descriptions

Page standards status: Informative

Definitions for the XAD logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. XAD
Definition	Definition: This data type specifies the address of a person, place or organization plus associated information.
Short	extended address
Control	0..*
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. XAD.1
Short	Street Address
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SAD
4. XAD.2
Short	Other Designation
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. XAD.3
Short	City
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. XAD.4
Short	State or Province
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. XAD.5
Short	Zip or Postal Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. XAD.6
Short	Country
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0399 (required to `http://terminology.hl7.org/ValueSet/v2-0399`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. XAD.7
Short	Address Type
Control	0..1
Binding	The codes SHALL be taken from hl7VS-addressType (required to `http://terminology.hl7.org/ValueSet/v2-0190`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. XAD.8
Short	Other Geographic Designation
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. XAD.9
Short	County/Parish Code
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0289 (required to `http://terminology.hl7.org/ValueSet/v2-0289`)
Type	http://hl7.org/v2/StructureDefinition/CWE
20. XAD.10
Short	Census Tract
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0288 (required to `http://terminology.hl7.org/ValueSet/v2-0288`)
Type	http://hl7.org/v2/StructureDefinition/CWE
22. XAD.11
Short	Address Representation Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-name-addressRepresentation (required to `http://terminology.hl7.org/ValueSet/v2-0465`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. XAD.12
Short	Address Validity Range
26. XAD.13
Short	Effective Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. XAD.14
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
30. XAD.15
Short	Expiration Reason
Control	0..1
Binding	The codes SHALL be taken from hl7VS-addressExpirationReason (required to `http://terminology.hl7.org/ValueSet/v2-0616`)
Type	http://hl7.org/v2/StructureDefinition/CWE
32. XAD.16
Short	Temporary Indicator
Control	0..1
Binding	The codes SHALL be taken from hl7VS-yes-no-Indicator (required to `http://terminology.hl7.org/ValueSet/v2-0136`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
34. XAD.17
Short	Bad Address Indicator
Control	0..1
Binding	The codes SHALL be taken from hl7VS-yes-no-Indicator (required to `http://terminology.hl7.org/ValueSet/v2-0136`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
36. XAD.18
Short	Address Usage
Control	0..1
Binding	The codes SHALL be taken from hl7VS-addressUsage (required to `http://terminology.hl7.org/ValueSet/v2-0617`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
38. XAD.19
Short	Addressee
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
40. XAD.20
Short	Comment
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
42. XAD.21
Short	Preference Order
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
44. XAD.22
Short	Protection Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-protectionCode (required to `http://terminology.hl7.org/ValueSet/v2-0618`)
Type	http://hl7.org/v2/StructureDefinition/CWE
46. XAD.23
Short	Address Identifier
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/EI

Guidance on how to interpret the contents of this table can be found here

0. XAD
Definition	Definition: This data type specifies the address of a person, place or organization plus associated information. Base definition for all types defined in FHIR type system.
Short	extended addressBase for all types and resources
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. XAD.1
Short	Street Address
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SAD
4. XAD.2
Short	Other Designation
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. XAD.3
Short	City
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. XAD.4
Short	State or Province
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. XAD.5
Short	Zip or Postal Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. XAD.6
Short	Country
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0399 (required to `http://terminology.hl7.org/ValueSet/v2-0399`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. XAD.7
Short	Address Type
Control	0..1
Binding	The codes SHALL be taken from hl7VS-addressType (required to `http://terminology.hl7.org/ValueSet/v2-0190`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. XAD.8
Short	Other Geographic Designation
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. XAD.9
Short	County/Parish Code
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0289 (required to `http://terminology.hl7.org/ValueSet/v2-0289`)
Type	http://hl7.org/v2/StructureDefinition/CWE
20. XAD.10
Short	Census Tract
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0288 (required to `http://terminology.hl7.org/ValueSet/v2-0288`)
Type	http://hl7.org/v2/StructureDefinition/CWE
22. XAD.11
Short	Address Representation Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-name-addressRepresentation (required to `http://terminology.hl7.org/ValueSet/v2-0465`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. XAD.12
Short	Address Validity Range
26. XAD.13
Short	Effective Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. XAD.14
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
30. XAD.15
Short	Expiration Reason
Control	0..1
Binding	The codes SHALL be taken from hl7VS-addressExpirationReason (required to `http://terminology.hl7.org/ValueSet/v2-0616`)
Type	http://hl7.org/v2/StructureDefinition/CWE
32. XAD.16
Short	Temporary Indicator
Control	0..1
Binding	The codes SHALL be taken from hl7VS-yes-no-Indicator (required to `http://terminology.hl7.org/ValueSet/v2-0136`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
34. XAD.17
Short	Bad Address Indicator
Control	0..1
Binding	The codes SHALL be taken from hl7VS-yes-no-Indicator (required to `http://terminology.hl7.org/ValueSet/v2-0136`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
36. XAD.18
Short	Address Usage
Control	0..1
Binding	The codes SHALL be taken from hl7VS-addressUsage (required to `http://terminology.hl7.org/ValueSet/v2-0617`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
38. XAD.19
Short	Addressee
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
40. XAD.20
Short	Comment
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
42. XAD.21
Short	Preference Order
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
44. XAD.22
Short	Protection Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-protectionCode (required to `http://terminology.hl7.org/ValueSet/v2-0618`)
Type	http://hl7.org/v2/StructureDefinition/CWE
46. XAD.23
Short	Address Identifier
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/EI

Guidance on how to interpret the contents of this table can be found here

0. XAD
Definition	Definition: This data type specifies the address of a person, place or organization plus associated information.
Short	extended address
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. XAD.1
Short	Street Address
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SAD
4. XAD.2
Short	Other Designation
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. XAD.3
Short	City
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. XAD.4
Short	State or Province
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. XAD.5
Short	Zip or Postal Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. XAD.6
Short	Country
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0399 (required to `http://terminology.hl7.org/ValueSet/v2-0399`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. XAD.7
Short	Address Type
Control	0..1
Binding	The codes SHALL be taken from hl7VS-addressType (required to `http://terminology.hl7.org/ValueSet/v2-0190`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. XAD.8
Short	Other Geographic Designation
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. XAD.9
Short	County/Parish Code
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0289 (required to `http://terminology.hl7.org/ValueSet/v2-0289`)
Type	http://hl7.org/v2/StructureDefinition/CWE
20. XAD.10
Short	Census Tract
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0288 (required to `http://terminology.hl7.org/ValueSet/v2-0288`)
Type	http://hl7.org/v2/StructureDefinition/CWE
22. XAD.11
Short	Address Representation Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-name-addressRepresentation (required to `http://terminology.hl7.org/ValueSet/v2-0465`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. XAD.12
Short	Address Validity Range
26. XAD.13
Short	Effective Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. XAD.14
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
30. XAD.15
Short	Expiration Reason
Control	0..1
Binding	The codes SHALL be taken from hl7VS-addressExpirationReason (required to `http://terminology.hl7.org/ValueSet/v2-0616`)
Type	http://hl7.org/v2/StructureDefinition/CWE
32. XAD.16
Short	Temporary Indicator
Control	0..1
Binding	The codes SHALL be taken from hl7VS-yes-no-Indicator (required to `http://terminology.hl7.org/ValueSet/v2-0136`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
34. XAD.17
Short	Bad Address Indicator
Control	0..1
Binding	The codes SHALL be taken from hl7VS-yes-no-Indicator (required to `http://terminology.hl7.org/ValueSet/v2-0136`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
36. XAD.18
Short	Address Usage
Control	0..1
Binding	The codes SHALL be taken from hl7VS-addressUsage (required to `http://terminology.hl7.org/ValueSet/v2-0617`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
38. XAD.19
Short	Addressee
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
40. XAD.20
Short	Comment
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
42. XAD.21
Short	Preference Order
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
44. XAD.22
Short	Protection Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-protectionCode (required to `http://terminology.hl7.org/ValueSet/v2-0618`)
Type	http://hl7.org/v2/StructureDefinition/CWE
46. XAD.23
Short	Address Identifier
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/EI

IG © HL7 International. Package hl7.v2plus#0.0.0 based on FHIR 5.0.0. Generated 2024-10-31
Links: Table of Contents | QA Report