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
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: USRealmAddressADUSFIELDED | |||
Other Identifiers: : urn:oid:2.16.840.1.113883.10.20.22.5.2 |
Reusable address template, for use in US Realm CDA Header.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AD
This structure is derived from AD
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | I | 1..* | AD | 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
use | 0..1 | code | If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: PostalAddressUse (required) | |
country | 0..1 | ADXP | Binding: VSAC 2.16.840.1.113883.3.88.12.80.63 (required) | |
state | I | 0..1 | ADXP | Binding: VSAC 2.16.840.1.113883.3.88.12.80.1 (preferred) 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). |
city | 1..1 | ADXP | ||
postalCode | I | 0..1 | ADXP | Binding: VSAC 2.16.840.1.113883.3.88.12.80.2 (preferred) 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). |
streetAddressLine | 1..4 | ADXP | ||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | I | 1..* | AD | 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
isNotOrdered | 0..1 | boolean | ||
use | 0..1 | code | If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: PostalAddressUse (required) | |
delimiter | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DEL | |
country | 0..1 | ADXP | ||
partType | 0..1 | code | Fixed Value: CNT | |
state | I | 0..1 | ADXP | 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). |
partType | 0..1 | code | Fixed Value: STA | |
county | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: CPA | |
city | 1..1 | ADXP | ||
partType | 0..1 | code | Fixed Value: CTY | |
postalCode | I | 0..1 | ADXP | 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). |
partType | 0..1 | code | Fixed Value: ZIP | |
streetAddressLine | 1..4 | ADXP | ||
partType | 0..1 | code | Fixed Value: SAL | |
houseNumber | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: BNR | |
houseNumberNumeric | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: BNN | |
direction | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DIR | |
streetName | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: STR | |
streetNameBase | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: STB | |
streetNameType | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: STTYP | |
additionalLocator | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: ADL | |
unitID | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: UNID | |
unitType | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: UNIT | |
careOf | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: CAR | |
censusTract | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: CEN | |
deliveryAddressLine | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DAL | |
deliveryInstallationType | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DINST | |
deliveryInstallationArea | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DINSTA | |
deliveryInstallationQualifier | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DINSTQ | |
deliveryMode | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DMOD | |
deliveryModeIdentifier | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DMODID | |
buildingNumberSuffix | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: BNS | |
postBox | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: POB | |
precinct | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: PRE | |
other | 0..1 | string | ||
useablePeriod[x] | 0..* | |||
useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS | IVL_TS | |||
useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/EIVL-TS | EIVL_TS | |||
useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/PIVL-TS | PIVL_TS | |||
useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS | SXPR_TS | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | I | 1..* | AD | 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
Documentation for this format |
This structure is derived from AD
Differential View
This structure is derived from AD
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | I | 1..* | AD | 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
use | 0..1 | code | If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: PostalAddressUse (required) | |
country | 0..1 | ADXP | Binding: VSAC 2.16.840.1.113883.3.88.12.80.63 (required) | |
state | I | 0..1 | ADXP | Binding: VSAC 2.16.840.1.113883.3.88.12.80.1 (preferred) 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). |
city | 1..1 | ADXP | ||
postalCode | I | 0..1 | ADXP | Binding: VSAC 2.16.840.1.113883.3.88.12.80.2 (preferred) 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). |
streetAddressLine | 1..4 | ADXP | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | I | 1..* | AD | 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
isNotOrdered | 0..1 | boolean | ||
use | 0..1 | code | If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: PostalAddressUse (required) | |
delimiter | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DEL | |
country | 0..1 | ADXP | ||
partType | 0..1 | code | Fixed Value: CNT | |
state | I | 0..1 | ADXP | 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). |
partType | 0..1 | code | Fixed Value: STA | |
county | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: CPA | |
city | 1..1 | ADXP | ||
partType | 0..1 | code | Fixed Value: CTY | |
postalCode | I | 0..1 | ADXP | 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). |
partType | 0..1 | code | Fixed Value: ZIP | |
streetAddressLine | 1..4 | ADXP | ||
partType | 0..1 | code | Fixed Value: SAL | |
houseNumber | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: BNR | |
houseNumberNumeric | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: BNN | |
direction | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DIR | |
streetName | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: STR | |
streetNameBase | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: STB | |
streetNameType | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: STTYP | |
additionalLocator | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: ADL | |
unitID | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: UNID | |
unitType | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: UNIT | |
careOf | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: CAR | |
censusTract | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: CEN | |
deliveryAddressLine | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DAL | |
deliveryInstallationType | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DINST | |
deliveryInstallationArea | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DINSTA | |
deliveryInstallationQualifier | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DINSTQ | |
deliveryMode | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DMOD | |
deliveryModeIdentifier | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: DMODID | |
buildingNumberSuffix | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: BNS | |
postBox | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: POB | |
precinct | 0..* | ADXP | ||
partType | 0..1 | code | Fixed Value: PRE | |
other | 0..1 | string | ||
useablePeriod[x] | 0..* | |||
useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS | IVL_TS | |||
useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/EIVL-TS | EIVL_TS | |||
useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/PIVL-TS | PIVL_TS | |||
useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS | SXPR_TS | |||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
AD.nullFlavor | required | NullFlavor |
AD.use | required | PostalAddressUse |
Id | Grade | Path | Details | Requirements |
81-7296 | error | AD | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
81-10024 | error | AD.state | 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). : | |
81-10025 | error | AD.postalCode | 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). : |