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
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. |
Control | 1..* |
XML Format | In 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional 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. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Is 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. |
Control | 0..* |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use 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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
10. AD.delimiter.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEL |
12. AD.country | |
Definition | Country |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
14. AD.country.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CNT |
16. AD.state | |
Definition | A sub-unit of a country with limited sovereignty in a federally organized country. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
18. AD.state.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STA |
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".) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
22. AD.county.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CPA |
24. AD.city | |
Definition | The name of the city, town, village, or other community or delivery center |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
26. AD.city.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CTY |
28. AD.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
30. AD.postalCode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ZIP |
32. AD.streetAddressLine | |
Definition | Street address line |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
34. AD.streetAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SAL |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
38. AD.houseNumber.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNR |
40. AD.houseNumberNumeric | |
Definition | The numeric portion of a building number |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
42. AD.houseNumberNumeric.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNN |
44. AD.direction | |
Definition | Direction (e.g., N, S, W, E) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
46. AD.direction.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DIR |
48. AD.streetName | |
Definition | Name of a roadway or artery recognized by a municipality (including street type and direction) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
50. AD.streetName.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STR |
52. AD.streetNameBase | |
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
54. AD.streetNameBase.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STB |
56. AD.streetNameType | |
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
58. AD.streetNameType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STTYP |
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). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
62. AD.additionalLocator.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ADL |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
66. AD.unitID.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNID |
68. AD.unitType | |
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
70. AD.unitType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNIT |
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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
74. AD.careOf.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CAR |
76. AD.censusTract | |
Definition | A geographic sub-unit delineated for demographic purposes. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
78. AD.censusTract.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CEN |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
82. AD.deliveryAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DAL |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
86. AD.deliveryInstallationType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINST |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
90. AD.deliveryInstallationArea.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTA |
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'. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
94. AD.deliveryInstallationQualifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTQ |
96. AD.deliveryMode | |
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
98. AD.deliveryMode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMOD |
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). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
102. AD.deliveryModeIdentifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMODID |
104. AD.buildingNumberSuffix | |
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
106. AD.buildingNumberSuffix.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNS |
108. AD.postBox | |
Definition | A numbered box located in a post station. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
110. AD.postBox.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | POB |
112. AD.precinct | |
Definition | A subsection of a municipality |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
114. AD.precinct.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | PRE |
116. AD.xmlText | |
Short | Allows 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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In 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. |
Control | 0..* |
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable 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. |
Short | Base for all types and resources |
Control | 10..* |
Is Modifier | false |
XML Format | In 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. |
Invariants | ele-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. |
Short | Primitive Type code |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code(cs: Coded Simple Value) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Label | Exceptional Value Detail |
Invariants | ele-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. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Is 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. |
Control | 0..* |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use 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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
10. AD.delimiter.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEL |
12. AD.country | |
Definition | Country |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
14. AD.country.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CNT |
16. AD.state | |
Definition | A sub-unit of a country with limited sovereignty in a federally organized country. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
18. AD.state.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STA |
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".) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
22. AD.county.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CPA |
24. AD.city | |
Definition | The name of the city, town, village, or other community or delivery center |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
26. AD.city.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CTY |
28. AD.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
30. AD.postalCode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ZIP |
32. AD.streetAddressLine | |
Definition | Street address line |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
34. AD.streetAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SAL |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
38. AD.houseNumber.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNR |
40. AD.houseNumberNumeric | |
Definition | The numeric portion of a building number |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
42. AD.houseNumberNumeric.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNN |
44. AD.direction | |
Definition | Direction (e.g., N, S, W, E) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
46. AD.direction.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DIR |
48. AD.streetName | |
Definition | Name of a roadway or artery recognized by a municipality (including street type and direction) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
50. AD.streetName.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STR |
52. AD.streetNameBase | |
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
54. AD.streetNameBase.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STB |
56. AD.streetNameType | |
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
58. AD.streetNameType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STTYP |
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). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
62. AD.additionalLocator.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ADL |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
66. AD.unitID.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNID |
68. AD.unitType | |
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
70. AD.unitType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNIT |
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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
74. AD.careOf.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CAR |
76. AD.censusTract | |
Definition | A geographic sub-unit delineated for demographic purposes. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
78. AD.censusTract.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CEN |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
82. AD.deliveryAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DAL |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
86. AD.deliveryInstallationType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINST |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
90. AD.deliveryInstallationArea.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTA |
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'. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
94. AD.deliveryInstallationQualifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTQ |
96. AD.deliveryMode | |
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
98. AD.deliveryMode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMOD |
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). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
102. AD.deliveryModeIdentifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMODID |
104. AD.buildingNumberSuffix | |
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
106. AD.buildingNumberSuffix.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNS |
108. AD.postBox | |
Definition | A numbered box located in a post station. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
110. AD.postBox.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | POB |
112. AD.precinct | |
Definition | A subsection of a municipality |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
114. AD.precinct.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | PRE |
116. AD.xmlText | |
Short | Allows 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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In 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. |
Control | 0..* |
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable 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. |
Short | Base for all types and resources |
Control | 1..* |
Is Modifier | false |
XML Format | In 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. |
Invariants | ele-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. |
Short | Primitive Type code |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code(cs: Coded Simple Value) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Label | Exceptional Value Detail |
Invariants | ele-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. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Is 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. |
Control | 0..* |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use 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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
10. AD.delimiter.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEL |
12. AD.country | |
Definition | Country |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
14. AD.country.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CNT |
16. AD.state | |
Definition | A sub-unit of a country with limited sovereignty in a federally organized country. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
18. AD.state.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STA |
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".) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
22. AD.county.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CPA |
24. AD.city | |
Definition | The name of the city, town, village, or other community or delivery center |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
26. AD.city.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CTY |
28. AD.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
30. AD.postalCode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ZIP |
32. AD.streetAddressLine | |
Definition | Street address line |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
34. AD.streetAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SAL |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
38. AD.houseNumber.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNR |
40. AD.houseNumberNumeric | |
Definition | The numeric portion of a building number |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
42. AD.houseNumberNumeric.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNN |
44. AD.direction | |
Definition | Direction (e.g., N, S, W, E) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
46. AD.direction.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DIR |
48. AD.streetName | |
Definition | Name of a roadway or artery recognized by a municipality (including street type and direction) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
50. AD.streetName.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STR |
52. AD.streetNameBase | |
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
54. AD.streetNameBase.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STB |
56. AD.streetNameType | |
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.) |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
58. AD.streetNameType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STTYP |
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). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
62. AD.additionalLocator.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ADL |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
66. AD.unitID.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNID |
68. AD.unitType | |
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
70. AD.unitType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNIT |
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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
74. AD.careOf.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CAR |
76. AD.censusTract | |
Definition | A geographic sub-unit delineated for demographic purposes. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
78. AD.censusTract.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CEN |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
82. AD.deliveryAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DAL |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
86. AD.deliveryInstallationType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINST |
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. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
90. AD.deliveryInstallationArea.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTA |
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'. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
94. AD.deliveryInstallationQualifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTQ |
96. AD.deliveryMode | |
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
98. AD.deliveryMode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMOD |
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). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
102. AD.deliveryModeIdentifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMODID |
104. AD.buildingNumberSuffix | |
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
106. AD.buildingNumberSuffix.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNS |
108. AD.postBox | |
Definition | A numbered box located in a post station. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
110. AD.postBox.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | POB |
112. AD.precinct | |
Definition | A subsection of a municipality |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
114. AD.precinct.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | PRE |
116. AD.xmlText | |
Short | Allows 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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In 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. |
Control | 0..* |
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable Period |