Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: AD - Detailed Descriptions

Active as of 2023-10-03

Definitions for the AD logical model.

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

0. AD
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

Control1..*
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.The children of this property can appear in any order in the XML.
2. AD.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. AD.isNotOrdered
Definition

A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIs Not Ordered
6. AD.use
Definition

A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.

Control0..*
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelUse Code
8. AD.delimiter
Definition

Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
10. AD.delimiter.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDEL
12. AD.country
Definition

Country

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
14. AD.country.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCNT
16. AD.state
Definition

A sub-unit of a country with limited sovereignty in a federally organized country.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
18. AD.state.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTA
20. AD.county
Definition

A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
22. AD.county.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCPA
24. AD.city
Definition

The name of the city, town, village, or other community or delivery center

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
26. AD.city.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCTY
28. AD.postalCode
Definition

A postal code designating a region defined by the postal service.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
30. AD.postalCode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueZIP
32. AD.streetAddressLine
Definition

Street address line

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
34. AD.streetAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSAL
36. AD.houseNumber
Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
38. AD.houseNumber.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueBNR
40. AD.houseNumberNumeric
Definition

The numeric portion of a building number

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
42. AD.houseNumberNumeric.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueBNN
44. AD.direction
Definition

Direction (e.g., N, S, W, E)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
46. AD.direction.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDIR
48. AD.streetName
Definition

Name of a roadway or artery recognized by a municipality (including street type and direction)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
50. AD.streetName.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTR
52. AD.streetNameBase
Definition

The base name of a roadway or artery recognized by a municipality (excluding street type and direction)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
54. AD.streetNameBase.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTB
56. AD.streetNameType
Definition

The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
58. AD.streetNameType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTTYP
60. AD.additionalLocator
Definition

This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
62. AD.additionalLocator.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueADL
64. AD.unitID
Definition

The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
66. AD.unitID.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueUNID
68. AD.unitType
Definition

Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
70. AD.unitType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueUNIT
72. AD.careOf
Definition

The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
74. AD.careOf.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCAR
76. AD.censusTract
Definition

A geographic sub-unit delineated for demographic purposes.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
78. AD.censusTract.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCEN
80. AD.deliveryAddressLine
Definition

A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
82. AD.deliveryAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDAL
84. AD.deliveryInstallationType
Definition

Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
86. AD.deliveryInstallationType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDINST
88. AD.deliveryInstallationArea
Definition

The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
90. AD.deliveryInstallationArea.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDINSTA
92. AD.deliveryInstallationQualifier
Definition

A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
94. AD.deliveryInstallationQualifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDINSTQ
96. AD.deliveryMode
Definition

Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
98. AD.deliveryMode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDMOD
100. AD.deliveryModeIdentifier
Definition

Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
102. AD.deliveryModeIdentifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDMODID
104. AD.buildingNumberSuffix
Definition

Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
106. AD.buildingNumberSuffix.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueBNS
108. AD.postBox
Definition

A numbered box located in a post station.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
110. AD.postBox.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePOB
112. AD.precinct
Definition

A subsection of a municipality

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
114. AD.precinct.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePRE
116. AD.xmlText
ShortAllows for mixed text content
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
118. AD.useablePeriod
Definition

A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period

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

0. AD
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.The children of this property can appear in any order in the XML.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. AD.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

ShortPrimitive Type code
Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
LabelExceptional Value Detail
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
cs-pattern: cs attributes must not contain any whitespace (matches('^[^\\s]+$'))
4. AD.isNotOrdered
Definition

A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIs Not Ordered
6. AD.use
Definition

A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.

Control0..*
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelUse Code
8. AD.delimiter
Definition

Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
10. AD.delimiter.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDEL
12. AD.country
Definition

Country

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
14. AD.country.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCNT
16. AD.state
Definition

A sub-unit of a country with limited sovereignty in a federally organized country.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
18. AD.state.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTA
20. AD.county
Definition

A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
22. AD.county.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCPA
24. AD.city
Definition

The name of the city, town, village, or other community or delivery center

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
26. AD.city.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCTY
28. AD.postalCode
Definition

A postal code designating a region defined by the postal service.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
30. AD.postalCode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueZIP
32. AD.streetAddressLine
Definition

Street address line

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
34. AD.streetAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSAL
36. AD.houseNumber
Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
38. AD.houseNumber.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueBNR
40. AD.houseNumberNumeric
Definition

The numeric portion of a building number

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
42. AD.houseNumberNumeric.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueBNN
44. AD.direction
Definition

Direction (e.g., N, S, W, E)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
46. AD.direction.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDIR
48. AD.streetName
Definition

Name of a roadway or artery recognized by a municipality (including street type and direction)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
50. AD.streetName.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTR
52. AD.streetNameBase
Definition

The base name of a roadway or artery recognized by a municipality (excluding street type and direction)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
54. AD.streetNameBase.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTB
56. AD.streetNameType
Definition

The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
58. AD.streetNameType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTTYP
60. AD.additionalLocator
Definition

This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
62. AD.additionalLocator.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueADL
64. AD.unitID
Definition

The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
66. AD.unitID.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueUNID
68. AD.unitType
Definition

Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
70. AD.unitType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueUNIT
72. AD.careOf
Definition

The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
74. AD.careOf.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCAR
76. AD.censusTract
Definition

A geographic sub-unit delineated for demographic purposes.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
78. AD.censusTract.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCEN
80. AD.deliveryAddressLine
Definition

A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
82. AD.deliveryAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDAL
84. AD.deliveryInstallationType
Definition

Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
86. AD.deliveryInstallationType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDINST
88. AD.deliveryInstallationArea
Definition

The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
90. AD.deliveryInstallationArea.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDINSTA
92. AD.deliveryInstallationQualifier
Definition

A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
94. AD.deliveryInstallationQualifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDINSTQ
96. AD.deliveryMode
Definition

Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
98. AD.deliveryMode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDMOD
100. AD.deliveryModeIdentifier
Definition

Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
102. AD.deliveryModeIdentifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDMODID
104. AD.buildingNumberSuffix
Definition

Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
106. AD.buildingNumberSuffix.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueBNS
108. AD.postBox
Definition

A numbered box located in a post station.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
110. AD.postBox.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePOB
112. AD.precinct
Definition

A subsection of a municipality

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
114. AD.precinct.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePRE
116. AD.xmlText
ShortAllows for mixed text content
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
118. AD.useablePeriod
Definition

A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period

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

0. AD
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Control1..*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.The children of this property can appear in any order in the XML.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. AD.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

ShortPrimitive Type code
Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
LabelExceptional Value Detail
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
cs-pattern: cs attributes must not contain any whitespace (matches('^[^\\s]+$'))
4. AD.isNotOrdered
Definition

A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIs Not Ordered
6. AD.use
Definition

A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.

Control0..*
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelUse Code
8. AD.delimiter
Definition

Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
10. AD.delimiter.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDEL
12. AD.country
Definition

Country

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
14. AD.country.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCNT
16. AD.state
Definition

A sub-unit of a country with limited sovereignty in a federally organized country.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
18. AD.state.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTA
20. AD.county
Definition

A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
22. AD.county.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCPA
24. AD.city
Definition

The name of the city, town, village, or other community or delivery center

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
26. AD.city.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCTY
28. AD.postalCode
Definition

A postal code designating a region defined by the postal service.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
30. AD.postalCode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueZIP
32. AD.streetAddressLine
Definition

Street address line

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
34. AD.streetAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSAL
36. AD.houseNumber
Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
38. AD.houseNumber.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueBNR
40. AD.houseNumberNumeric
Definition

The numeric portion of a building number

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
42. AD.houseNumberNumeric.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueBNN
44. AD.direction
Definition

Direction (e.g., N, S, W, E)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
46. AD.direction.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDIR
48. AD.streetName
Definition

Name of a roadway or artery recognized by a municipality (including street type and direction)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
50. AD.streetName.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTR
52. AD.streetNameBase
Definition

The base name of a roadway or artery recognized by a municipality (excluding street type and direction)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
54. AD.streetNameBase.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTB
56. AD.streetNameType
Definition

The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
58. AD.streetNameType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSTTYP
60. AD.additionalLocator
Definition

This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
62. AD.additionalLocator.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueADL
64. AD.unitID
Definition

The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
66. AD.unitID.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueUNID
68. AD.unitType
Definition

Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
70. AD.unitType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueUNIT
72. AD.careOf
Definition

The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
74. AD.careOf.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCAR
76. AD.censusTract
Definition

A geographic sub-unit delineated for demographic purposes.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
78. AD.censusTract.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCEN
80. AD.deliveryAddressLine
Definition

A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
82. AD.deliveryAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDAL
84. AD.deliveryInstallationType
Definition

Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
86. AD.deliveryInstallationType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDINST
88. AD.deliveryInstallationArea
Definition

The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
90. AD.deliveryInstallationArea.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDINSTA
92. AD.deliveryInstallationQualifier
Definition

A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
94. AD.deliveryInstallationQualifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDINSTQ
96. AD.deliveryMode
Definition

Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
98. AD.deliveryMode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDMOD
100. AD.deliveryModeIdentifier
Definition

Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
102. AD.deliveryModeIdentifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDMODID
104. AD.buildingNumberSuffix
Definition

Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
106. AD.buildingNumberSuffix.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueBNS
108. AD.postBox
Definition

A numbered box located in a post station.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
110. AD.postBox.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePOB
112. AD.precinct
Definition

A subsection of a municipality

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
114. AD.precinct.partType
Definition

Specifies the type of the address part

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePRE
116. AD.xmlText
ShortAllows for mixed text content
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
118. AD.useablePeriod
Definition

A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period