Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED | Version: 2.1 | |||
Draft as of 2023-09-29 | Computable Name: USRealmAddressADUSFIELDED | |||
Other Identifiers: id: 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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, 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, other, useablePeriod Base for all types and resources 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
use | 0..1 | cs | 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 | C | 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 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). |
city | 1..1 | ADXP | ||
postalCode | C | 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 |
Path | Conformance | ValueSet |
AD.use | required | PostalAddressUse |
AD.country | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.63 |
AD.state | preferred | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.1 |
AD.postalCode | preferred | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.2 |
Id | Grade | Path(s) | 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 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 | 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). : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, 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, other, useablePeriod Base for all types and resources 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
@use | 0..1 | cs | If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: PostalAddressUse (required) | |
country | 0..1 | ADXP | ||
state | C | 0..1 | ADXP | 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). |
city | 1..1 | ADXP | ||
postalCode | C | 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). |
streetAddressLine | 1..4 | ADXP | ||
Documentation for this format |
Path | Conformance | ValueSet |
AD.use | required | PostalAddressUse |
Id | Grade | Path(s) | 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 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 | 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). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, 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, other, useablePeriod Base for all types and resources 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
nullFlavor | C | 0..1 | cs | Primitive Type code Binding: NullFlavor (required) |
@isNotOrdered | 0..1 | bl | ||
@use | 0..1 | cs | If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: PostalAddressUse (required) | |
delimiter | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DEL | |
country | 0..1 | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CNT | |
state | C | 0..1 | ADXP | 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). |
@partType | 0..1 | cs | Fixed Value: STA | |
county | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CPA | |
city | 1..1 | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CTY | |
postalCode | C | 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 | cs | Fixed Value: ZIP | |
streetAddressLine | 1..4 | ADXP | ||
@partType | 0..1 | cs | Fixed Value: SAL | |
houseNumber | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: BNR | |
houseNumberNumeric | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: BNN | |
direction | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DIR | |
streetName | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: STR | |
streetNameBase | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: STB | |
streetNameType | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: STTYP | |
additionalLocator | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: ADL | |
unitID | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: UNID | |
unitType | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: UNIT | |
careOf | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CAR | |
censusTract | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CEN | |
deliveryAddressLine | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DAL | |
deliveryInstallationType | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DINST | |
deliveryInstallationArea | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DINSTA | |
deliveryInstallationQualifier | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DINSTQ | |
deliveryMode | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DMOD | |
deliveryModeIdentifier | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DMODID | |
buildingNumberSuffix | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: BNS | |
postBox | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: POB | |
precinct | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: PRE | |
other | 0..1 | st | ||
useablePeriod | 0..* | |||
useablePeriod | IVL_TS | |||
useablePeriod | EIVL_TS | |||
useablePeriod | PIVL_TS | |||
useablePeriod | SXPR_TS | |||
Documentation for this format |
Path | Conformance | ValueSet |
AD.nullFlavor | required | NullFlavor |
AD.use | required | PostalAddressUse |
Id | Grade | Path(s) | 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 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 | 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). : | |
cs-pattern | error | AD.nullFlavor | cs attributes must not contain any whitespace : matches('^[^\\s]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
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, @nullFlavor, @isNotOrdered, @use, 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, other, useablePeriod Base for all types and resources 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
use | 0..1 | cs | 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 | C | 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 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). |
city | 1..1 | ADXP | ||
postalCode | C | 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 |
Path | Conformance | ValueSet |
AD.use | required | PostalAddressUse |
AD.country | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.63 |
AD.state | preferred | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.1 |
AD.postalCode | preferred | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.2 |
Id | Grade | Path(s) | 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 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 | 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). : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, 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, other, useablePeriod Base for all types and resources 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
@use | 0..1 | cs | If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: PostalAddressUse (required) | |
country | 0..1 | ADXP | ||
state | C | 0..1 | ADXP | 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). |
city | 1..1 | ADXP | ||
postalCode | C | 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). |
streetAddressLine | 1..4 | ADXP | ||
Documentation for this format |
Path | Conformance | ValueSet |
AD.use | required | PostalAddressUse |
Id | Grade | Path(s) | 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 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 | 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). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AD | C | 1..* | AD | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, 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, other, useablePeriod Base for all types and resources 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). |
nullFlavor | C | 0..1 | cs | Primitive Type code Binding: NullFlavor (required) |
@isNotOrdered | 0..1 | bl | ||
@use | 0..1 | cs | If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: PostalAddressUse (required) | |
delimiter | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DEL | |
country | 0..1 | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CNT | |
state | C | 0..1 | ADXP | 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). |
@partType | 0..1 | cs | Fixed Value: STA | |
county | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CPA | |
city | 1..1 | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CTY | |
postalCode | C | 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 | cs | Fixed Value: ZIP | |
streetAddressLine | 1..4 | ADXP | ||
@partType | 0..1 | cs | Fixed Value: SAL | |
houseNumber | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: BNR | |
houseNumberNumeric | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: BNN | |
direction | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DIR | |
streetName | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: STR | |
streetNameBase | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: STB | |
streetNameType | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: STTYP | |
additionalLocator | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: ADL | |
unitID | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: UNID | |
unitType | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: UNIT | |
careOf | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CAR | |
censusTract | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: CEN | |
deliveryAddressLine | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DAL | |
deliveryInstallationType | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DINST | |
deliveryInstallationArea | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DINSTA | |
deliveryInstallationQualifier | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DINSTQ | |
deliveryMode | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DMOD | |
deliveryModeIdentifier | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: DMODID | |
buildingNumberSuffix | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: BNS | |
postBox | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: POB | |
precinct | 0..* | ADXP | ||
@partType | 0..1 | cs | Fixed Value: PRE | |
other | 0..1 | st | ||
useablePeriod | 0..* | |||
useablePeriod | IVL_TS | |||
useablePeriod | EIVL_TS | |||
useablePeriod | PIVL_TS | |||
useablePeriod | SXPR_TS | |||
Documentation for this format |
Path | Conformance | ValueSet |
AD.nullFlavor | required | NullFlavor |
AD.use | required | PostalAddressUse |
Id | Grade | Path(s) | 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 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 | 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). : | |
cs-pattern | error | AD.nullFlavor | cs attributes must not contain any whitespace : matches('^[^\\s]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from AD