This is the set of resources that conform to either of the profiles US Realm Address (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress) and US Realm Address (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress). E.g. what you have to deal with if you get resources conforming to one of them
| Name | Flags | Card. | Type | Description & Constraints |
|---|
  AD | C | 1..* | | Base for all types and resources
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 | ?? | If addr/@nullFlavor is present, none of the address parts are required.
Binding: ?? (required) |
| isNotOrdered | | 0..1 | ?? | |
| use | | 0..* | ?? | Identifies which address to use for a given purpose.
Binding: ?? (required)
|
  item | C | 0..* | Base | 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 | ?? | Binding: ?? (required) |
 xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
 partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| 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 | ?? | Binding: ?? (required) |
| xmlText | | 0..1 | ?? | Allows for mixed text content |
| representation | | 0..1 | ?? | |
| mediaType | | 0..1 | ?? | |
| language | | 0..1 | ?? | |
| partType | | 0..1 | ?? | |
| xmlText | | 0..1 | ?? | 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 |