Clinical Document Architecture V2.0.1
2.1.0 - CI Build

Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). 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

Definitions for the AD logical model.

1. 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..*
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
3. 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
4. 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
5. 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/fhir/cda/StructureDefinition/ADXP
6. AD.delimiter.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDEL
7. AD.country
Definition

Country

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
8. AD.country.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCNT
9. AD.state
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
10. AD.state.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSTA
11. 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/fhir/cda/StructureDefinition/ADXP
12. AD.county.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCPA
13. AD.city
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
14. AD.city.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCTY
15. AD.postalCode
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
16. AD.postalCode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueZIP
17. AD.streetAddressLine
Definition

Street address line

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
18. AD.streetAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSAL
19. 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/fhir/cda/StructureDefinition/ADXP
20. AD.houseNumber.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueBNR
21. AD.houseNumberNumeric
Definition

The numeric portion of a building number

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
22. AD.houseNumberNumeric.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueBNN
23. AD.direction
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
24. AD.direction.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDIR
25. AD.streetName
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
26. AD.streetName.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSTR
27. AD.streetNameBase
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
28. AD.streetNameBase.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSTB
29. AD.streetNameType
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
30. AD.streetNameType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSTTYP
31. 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/fhir/cda/StructureDefinition/ADXP
32. AD.additionalLocator.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueADL
33. 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/fhir/cda/StructureDefinition/ADXP
34. AD.unitID.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueUNID
35. AD.unitType
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
36. AD.unitType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueUNIT
37. 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/fhir/cda/StructureDefinition/ADXP
38. AD.careOf.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCAR
39. AD.censusTract
Definition

A geographic sub-unit delineated for demographic purposes.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
40. AD.censusTract.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCEN
41. 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/fhir/cda/StructureDefinition/ADXP
42. AD.deliveryAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDAL
43. 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/fhir/cda/StructureDefinition/ADXP
44. AD.deliveryInstallationType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDINST
45. 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/fhir/cda/StructureDefinition/ADXP
46. AD.deliveryInstallationArea.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDINSTA
47. 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/fhir/cda/StructureDefinition/ADXP
48. AD.deliveryInstallationQualifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDINSTQ
49. 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/fhir/cda/StructureDefinition/ADXP
50. AD.deliveryMode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDMOD
51. 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/fhir/cda/StructureDefinition/ADXP
52. AD.deliveryModeIdentifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDMODID
53. 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/fhir/cda/StructureDefinition/ADXP
54. AD.buildingNumberSuffix.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueBNS
55. AD.postBox
Definition

A numbered box located in a post station.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
56. AD.postBox.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValuePOB
57. AD.precinct
Definition

A subsection of a municipality

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
58. AD.precinct.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValuePRE
59. AD.other
Definition

Textual representation of (part of) the address

Control0..1
Typestring
60. AD.useablePeriod[x]
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/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
[x] NoteSee Choice of Data Types for further information about how to use [x]