Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Active as of 2022-05-13 |
Definitions for the 2.16.840.1.113883.10.20.22.5.2 resource profile.
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. |
Control | 1..* |
Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) |
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 |
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. |
Control | 0..1 |
Type | boolean |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from PostalAddressUse |
Type | code |
Requirements | SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290). |
5. 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/fhir/cda/StructureDefinition/ADXP |
6. AD.delimiter.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | DEL |
7. AD.country | |
Definition | Country |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
Requirements | SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295). |
8. AD.country.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | CNT |
9. AD.state | |
Definition | A sub-unit of a country with limited sovereignty in a federally organized country. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
Requirements | SHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293). |
Invariants | Defined on this element 81-10024: If the country is US, the state element is required but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (: ) |
10. AD.state.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | STA |
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".) |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
12. AD.county.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | CPA |
13. AD.city | |
Definition | The name of the city, town, village, or other community or delivery center |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
Requirements | SHALL contain exactly one [1..1] city (CONF:81-7292). |
14. AD.city.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | CTY |
15. AD.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
Requirements | SHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). |
Invariants | Defined on this element 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (: ) |
16. AD.postalCode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | ZIP |
17. AD.streetAddressLine | |
Definition | Street address line |
Control | 1..4 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
Requirements | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). |
18. AD.streetAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | SAL |
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. |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
20. AD.houseNumber.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | BNR |
21. AD.houseNumberNumeric | |
Definition | The numeric portion of a building number |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
22. AD.houseNumberNumeric.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | BNN |
23. AD.direction | |
Definition | Direction (e.g., N, S, W, E) |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
24. AD.direction.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | DIR |
25. AD.streetName | |
Definition | Name of a roadway or artery recognized by a municipality (including street type and direction) |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
26. AD.streetName.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | STR |
27. 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/fhir/cda/StructureDefinition/ADXP |
28. AD.streetNameBase.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | STB |
29. AD.streetNameType | |
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.) |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
30. AD.streetNameType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | STTYP |
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). |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
32. AD.additionalLocator.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | ADL |
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. |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
34. AD.unitID.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | UNID |
35. 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/fhir/cda/StructureDefinition/ADXP |
36. AD.unitType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | UNIT |
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 |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
38. AD.careOf.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | CAR |
39. AD.censusTract | |
Definition | A geographic sub-unit delineated for demographic purposes. |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
40. AD.censusTract.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | CEN |
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. |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
42. AD.deliveryAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | DAL |
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. |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
44. AD.deliveryInstallationType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | DINST |
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. |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
46. AD.deliveryInstallationArea.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | DINSTA |
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'. |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
48. AD.deliveryInstallationQualifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | DINSTQ |
49. 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/fhir/cda/StructureDefinition/ADXP |
50. AD.deliveryMode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | DMOD |
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). |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
52. AD.deliveryModeIdentifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | DMODID |
53. 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/fhir/cda/StructureDefinition/ADXP |
54. AD.buildingNumberSuffix.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | BNS |
55. AD.postBox | |
Definition | A numbered box located in a post station. |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
56. AD.postBox.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | POB |
57. AD.precinct | |
Definition | A subsection of a municipality |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
58. AD.precinct.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code |
Fixed Value | PRE |
59. AD.other | |
Definition | Textual representation of (part of) the address |
Control | 0..1 |
Type | string |
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. |
Control | 0..* |
Type | Choice 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] Note | See Choice of Data Types for further information about how to use [x] |