Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA)
3.0.0 - STU3
This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress | Version: 3.0.0 | |||
| Draft as of 2024-05-18 | Computable Name: USRealmAddress | |||
| Other Identifiers: urn:oid:2.16.840.1.113883.10.20.22.5.2 | ||||
Reusable address template, for use in US Realm documents.
Certifying systems SHALL and non-certifying systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for Street Address Line and City for new and updated records.
For certifying systems, this requirement does not apply to historical records/documents that are exposed through C-CDA documents.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from AD
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  AD |
C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @isNotOrdered, @use, item, useablePeriod Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country | ||||||
 @nullFlavor |
0..1 | cs | If addr/@nullFlavor is present, none of the address parts are required. | |||||||
| @use |
0..* | cs | Identifies which address to use for a given purpose. | |||||||
 item |
||||||||||
 country |
0..1 | ADXP | Binding: Country2 (required) | |||||||
| state |
0..1 | ADXP | Binding: (unbound) (example): If country is something other than US, the state MAY be present but MAY be bound to different vocabularies
| |||||||
| city |
0..1 | ADXP | city is required if nullFlavor is absent | |||||||
| postalCode |
0..1 | ADXP | If country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####) | |||||||
 streetAddressLine |
0..1 | ADXP | Min: 1, Max: 4 streetAddressLine required if nullFlavor is absent | |||||||
| useablePeriod |
0..* | IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | (USCDI) Previous Address - Current or prior place where a person may have been located or could have been contacted. | |||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| AD.item.country | required | Country2http://terminology.hl7.org/ValueSet/v3-Country2 | |
| AD.item.state | example | |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | AD | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | AD | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | AD | 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| shall-city | error | AD | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | AD | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | AD | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-country | warning | AD | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-use | warning | AD | SHOULD contain @use : nullFlavor.exists() or use.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AD |
C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @isNotOrdered, @use, item, useablePeriod Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
 @nullFlavor |
0..1 | cs | If addr/@nullFlavor is present, none of the address parts are required. Binding: CDANullFlavor (required) | |
| @use |
0..* | cs | Identifies which address to use for a given purpose. Binding: CDAPostalAddressUse (required) | |
  useablePeriod |
0..* | (USCDI) Previous Address - Current or prior place where a person may have been located or could have been contacted. | ||
  useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AD.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.use | required | CDAPostalAddressUsehttp://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | AD | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | AD | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | AD | 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| shall-city | error | AD | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | AD | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | AD | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-country | warning | AD | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-use | warning | AD | SHOULD contain @use : nullFlavor.exists() or use.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AD |
C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @isNotOrdered, @use, item, useablePeriod Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| @nullFlavor |
0..1 | cs | If addr/@nullFlavor is present, none of the address parts are required. Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Identifies which address to use for a given purpose. Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance AD-1: Can only have only one of the possible item elements in each choice |
| (Choice of one) |
1..1 | |||
  delimiter |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
 (Choice of one) |
1..1 | |||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
 xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | city is required if nullFlavor is absent text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | If country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####) text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..1 | ADXP | Min: 1, Max: 4 streetAddressLine required if nullFlavor is absent text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | (USCDI) Previous Address - Current or prior place where a person may have been located or could have been contacted. | ||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AD.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.use | required | CDAPostalAddressUsehttp://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse | |
| AD.item.delimiter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.country.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.state.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.county.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.city.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.postalCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.streetAddressLine.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.houseNumber.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.houseNumberNumeric.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.direction.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.streetName.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.streetNameBase.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.streetNameType.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.additionalLocator.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.unitID.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.unitType.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.careOf.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.censusTract.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryAddressLine.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryInstallationType.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryInstallationArea.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryInstallationQualifier.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryMode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryModeIdentifier.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.buildingNumberSuffix.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.postBox.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.precinct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | AD | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | AD | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | AD | 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| AD-1 | error | AD.item | Can only have only one of the possible item elements in each choice : (delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1 | |
| shall-city | error | AD | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | AD | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | AD | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-country | warning | AD | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-use | warning | AD | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
| text-null | error | AD.item.delimiter, AD.item.country, AD.item.state, AD.item.county, AD.item.city, AD.item.postalCode, AD.item.streetAddressLine, AD.item.houseNumber, AD.item.houseNumberNumeric, AD.item.direction, AD.item.streetName, AD.item.streetNameBase, AD.item.streetNameType, AD.item.additionalLocator, AD.item.unitID, AD.item.unitType, AD.item.careOf, AD.item.censusTract, AD.item.deliveryAddressLine, AD.item.deliveryInstallationType, AD.item.deliveryInstallationArea, AD.item.deliveryInstallationQualifier, AD.item.deliveryMode, AD.item.deliveryModeIdentifier, AD.item.buildingNumberSuffix, AD.item.postBox, AD.item.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText | nullFlavor).count() = 1 |
This structure is derived from AD
Differential View
This structure is derived from AD
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| AD |
C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @isNotOrdered, @use, item, useablePeriod Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country | ||||||
| @nullFlavor |
0..1 | cs | If addr/@nullFlavor is present, none of the address parts are required. | |||||||
| @use |
0..* | cs | Identifies which address to use for a given purpose. | |||||||
| item |
||||||||||
| country |
0..1 | ADXP | Binding: Country2 (required) | |||||||
| state |
0..1 | ADXP | Binding: (unbound) (example): If country is something other than US, the state MAY be present but MAY be bound to different vocabularies
| |||||||
| city |
0..1 | ADXP | city is required if nullFlavor is absent | |||||||
| postalCode |
0..1 | ADXP | If country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####) | |||||||
| streetAddressLine |
0..1 | ADXP | Min: 1, Max: 4 streetAddressLine required if nullFlavor is absent | |||||||
| useablePeriod |
0..* | IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | (USCDI) Previous Address - Current or prior place where a person may have been located or could have been contacted. | |||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| AD.item.country | required | Country2http://terminology.hl7.org/ValueSet/v3-Country2 | |
| AD.item.state | example | |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | AD | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | AD | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | AD | 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| shall-city | error | AD | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | AD | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | AD | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-country | warning | AD | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-use | warning | AD | SHOULD contain @use : nullFlavor.exists() or use.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AD |
C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @isNotOrdered, @use, item, useablePeriod Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| @nullFlavor |
0..1 | cs | If addr/@nullFlavor is present, none of the address parts are required. Binding: CDANullFlavor (required) | |
| @use |
0..* | cs | Identifies which address to use for a given purpose. Binding: CDAPostalAddressUse (required) | |
| useablePeriod |
0..* | (USCDI) Previous Address - Current or prior place where a person may have been located or could have been contacted. | ||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AD.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.use | required | CDAPostalAddressUsehttp://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | AD | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | AD | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | AD | 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| shall-city | error | AD | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | AD | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | AD | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-country | warning | AD | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-use | warning | AD | SHOULD contain @use : nullFlavor.exists() or use.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AD |
C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @isNotOrdered, @use, item, useablePeriod Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| @nullFlavor |
0..1 | cs | If addr/@nullFlavor is present, none of the address parts are required. Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Identifies which address to use for a given purpose. Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance AD-1: Can only have only one of the possible item elements in each choice |
| (Choice of one) |
1..1 | |||
| delimiter |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | city is required if nullFlavor is absent text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | If country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####) text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..1 | ADXP | Min: 1, Max: 4 streetAddressLine required if nullFlavor is absent text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | (USCDI) Previous Address - Current or prior place where a person may have been located or could have been contacted. | ||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AD.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.use | required | CDAPostalAddressUsehttp://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse | |
| AD.item.delimiter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.country.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.state.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.county.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.city.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.postalCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.streetAddressLine.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.houseNumber.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.houseNumberNumeric.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.direction.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.streetName.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.streetNameBase.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.streetNameType.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.additionalLocator.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.unitID.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.unitType.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.careOf.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.censusTract.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryAddressLine.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryInstallationType.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryInstallationArea.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryInstallationQualifier.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryMode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.deliveryModeIdentifier.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.buildingNumberSuffix.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.postBox.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| AD.item.precinct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | AD | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | AD | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | AD | 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). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| AD-1 | error | AD.item | Can only have only one of the possible item elements in each choice : (delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1 | |
| shall-city | error | AD | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | AD | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | AD | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-country | warning | AD | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-use | warning | AD | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
| text-null | error | AD.item.delimiter, AD.item.country, AD.item.state, AD.item.county, AD.item.city, AD.item.postalCode, AD.item.streetAddressLine, AD.item.houseNumber, AD.item.houseNumberNumeric, AD.item.direction, AD.item.streetName, AD.item.streetNameBase, AD.item.streetNameType, AD.item.additionalLocator, AD.item.unitID, AD.item.unitType, AD.item.careOf, AD.item.censusTract, AD.item.deliveryAddressLine, AD.item.deliveryInstallationType, AD.item.deliveryInstallationArea, AD.item.deliveryInstallationQualifier, AD.item.deliveryMode, AD.item.deliveryModeIdentifier, AD.item.buildingNumberSuffix, AD.item.postBox, AD.item.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText | nullFlavor).count() = 1 |
This structure is derived from AD
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0 based on FHIR 5.0.0. Generated 2024-05-18
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change