Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: US Realm Address

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress Version: 4.0.0
Draft as of 2025-06-20 Computable Name: USRealmAddress
Other Identifiers: 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.

Usages:

Changes since version 3.0.0:

  • No changes

    • Formal Views of Template Content

    Description of Template, Differentials, Snapshots and how the different presentations work.

    This structure is derived from AD

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: shall-city, shall-streetAddressLine, should-use, should-country, 81-7296, 81-10024, 81-10025, shall-max-ad-parts
    ... @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 Description: (example): If country is something other than US, the state MAY be present but MAY be bound to different vocabularies
    Additional BindingsPurposeDocumentation
    USPS Two Letter Alphabetic Codes Required
    For US Addresses
    .... 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

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    AD.item.countryrequiredCountry2
    http://terminology.hl7.org/ValueSet/v3-Country2
    AD.item.stateexample

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296)
    : item.xmlText.empty()
    81-10024errorADIf 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://terminology.hl7.org/ValueSet/USPS-State'))
    81-10025errorADIf 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-cityerrorADSHALL contain exactly one [1..1] city (CONF:81-7292).
    : nullFlavor.exists() or item.city.count() = 1
    shall-max-ad-partserrorADSHALL 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-streetAddressLineerrorADSHALL 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-countrywarningADSHOULD contain country
    : nullFlavor.exists() or item.country.exists()
    should-usewarningADSHOULD contain @use
    : nullFlavor.exists() or use.exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: shall-city, shall-streetAddressLine, should-use, should-country, 81-7296, 81-10024, 81-10025, shall-max-ad-parts
    ... @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)
    .... (Choice of one) 1..1
    ..... delimiter C 0..1 ADXP Constraints: text-null
    ...... (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 Binding: Country2 (required)
    Constraints: text-null
    ...... (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 Binding Description: (example): If country is something other than US, the state MAY be present but MAY be bound to different vocabularies
    Additional BindingsPurposeDocumentation
    USPS Two Letter Alphabetic Codes Required
    For US Addresses

    Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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
    Constraints: text-null
    ...... (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 #####-####)
    Constraints: text-null
    ...... (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
    Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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..* 𝗨𝗦𝗖𝗗𝗜: 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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    AD.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.userequiredCDAPostalAddressUse
    http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse
    AD.item.delimiter.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.countryrequiredCountry2
    http://terminology.hl7.org/ValueSet/v3-Country2
    AD.item.country.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.stateexample
    AD.item.state.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.county.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.city.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.postalCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetAddressLine.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.houseNumber.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.houseNumberNumeric.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.direction.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetName.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetNameBase.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetNameType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.additionalLocator.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.unitID.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.unitType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.careOf.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.censusTract.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryAddressLine.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationArea.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationQualifier.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryMode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryModeIdentifier.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.buildingNumberSuffix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.postBox.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.precinct.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296)
    : item.xmlText.empty()
    81-10024errorADIf 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://terminology.hl7.org/ValueSet/USPS-State'))
    81-10025errorADIf 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-1errorAD.itemCan 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-cityerrorADSHALL contain exactly one [1..1] city (CONF:81-7292).
    : nullFlavor.exists() or item.city.count() = 1
    shall-max-ad-partserrorADSHALL 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-streetAddressLineerrorADSHALL 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-countrywarningADSHOULD contain country
    : nullFlavor.exists() or item.country.exists()
    should-usewarningADSHOULD contain @use
    : nullFlavor.exists() or use.exists()
    text-nullerrorAD.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.precinctxmlText and nullFlavor are mutually exclusive (one must be present)
    : (xmlText | nullFlavor).count() = 1
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: shall-city, shall-streetAddressLine, should-use, should-country, 81-7296, 81-10024, 81-10025, shall-max-ad-parts
    ... @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)
    .... (Choice of one) 1..1
    ..... delimiter C 0..1 ADXP Constraints: text-null
    ...... (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 Binding: Country2 (required)
    Constraints: text-null
    ...... (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 Binding Description: (example): If country is something other than US, the state MAY be present but MAY be bound to different vocabularies
    Additional BindingsPurposeDocumentation
    USPS Two Letter Alphabetic Codes Required
    For US Addresses

    Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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
    Constraints: text-null
    ...... (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 #####-####)
    Constraints: text-null
    ...... (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
    Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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..* 𝗨𝗦𝗖𝗗𝗜: 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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    AD.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.userequiredCDAPostalAddressUse
    http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse
    AD.item.delimiter.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.countryrequiredCountry2
    http://terminology.hl7.org/ValueSet/v3-Country2
    AD.item.country.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.stateexample
    AD.item.state.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.county.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.city.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.postalCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetAddressLine.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.houseNumber.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.houseNumberNumeric.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.direction.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetName.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetNameBase.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetNameType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.additionalLocator.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.unitID.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.unitType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.careOf.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.censusTract.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryAddressLine.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationArea.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationQualifier.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryMode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryModeIdentifier.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.buildingNumberSuffix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.postBox.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.precinct.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296)
    : item.xmlText.empty()
    81-10024errorADIf 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://terminology.hl7.org/ValueSet/USPS-State'))
    81-10025errorADIf 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-1errorAD.itemCan 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-cityerrorADSHALL contain exactly one [1..1] city (CONF:81-7292).
    : nullFlavor.exists() or item.city.count() = 1
    shall-max-ad-partserrorADSHALL 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-streetAddressLineerrorADSHALL 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-countrywarningADSHOULD contain country
    : nullFlavor.exists() or item.country.exists()
    should-usewarningADSHOULD contain @use
    : nullFlavor.exists() or use.exists()
    text-nullerrorAD.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.precinctxmlText and nullFlavor are mutually exclusive (one must be present)
    : (xmlText | nullFlavor).count() = 1

    This structure is derived from AD

    Summary

    Differential View

    This structure is derived from AD

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: shall-city, shall-streetAddressLine, should-use, should-country, 81-7296, 81-10024, 81-10025, shall-max-ad-parts
    ... @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 Description: (example): If country is something other than US, the state MAY be present but MAY be bound to different vocabularies
    Additional BindingsPurposeDocumentation
    USPS Two Letter Alphabetic Codes Required
    For US Addresses
    .... 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

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    AD.item.countryrequiredCountry2
    http://terminology.hl7.org/ValueSet/v3-Country2
    AD.item.stateexample

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296)
    : item.xmlText.empty()
    81-10024errorADIf 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://terminology.hl7.org/ValueSet/USPS-State'))
    81-10025errorADIf 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-cityerrorADSHALL contain exactly one [1..1] city (CONF:81-7292).
    : nullFlavor.exists() or item.city.count() = 1
    shall-max-ad-partserrorADSHALL 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-streetAddressLineerrorADSHALL 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-countrywarningADSHOULD contain country
    : nullFlavor.exists() or item.country.exists()
    should-usewarningADSHOULD contain @use
    : nullFlavor.exists() or use.exists()

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: shall-city, shall-streetAddressLine, should-use, should-country, 81-7296, 81-10024, 81-10025, shall-max-ad-parts
    ... @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)
    .... (Choice of one) 1..1
    ..... delimiter C 0..1 ADXP Constraints: text-null
    ...... (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 Binding: Country2 (required)
    Constraints: text-null
    ...... (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 Binding Description: (example): If country is something other than US, the state MAY be present but MAY be bound to different vocabularies
    Additional BindingsPurposeDocumentation
    USPS Two Letter Alphabetic Codes Required
    For US Addresses

    Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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
    Constraints: text-null
    ...... (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 #####-####)
    Constraints: text-null
    ...... (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
    Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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..* 𝗨𝗦𝗖𝗗𝗜: 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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    AD.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.userequiredCDAPostalAddressUse
    http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse
    AD.item.delimiter.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.countryrequiredCountry2
    http://terminology.hl7.org/ValueSet/v3-Country2
    AD.item.country.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.stateexample
    AD.item.state.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.county.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.city.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.postalCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetAddressLine.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.houseNumber.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.houseNumberNumeric.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.direction.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetName.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetNameBase.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetNameType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.additionalLocator.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.unitID.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.unitType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.careOf.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.censusTract.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryAddressLine.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationArea.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationQualifier.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryMode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryModeIdentifier.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.buildingNumberSuffix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.postBox.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.precinct.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296)
    : item.xmlText.empty()
    81-10024errorADIf 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://terminology.hl7.org/ValueSet/USPS-State'))
    81-10025errorADIf 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-1errorAD.itemCan 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-cityerrorADSHALL contain exactly one [1..1] city (CONF:81-7292).
    : nullFlavor.exists() or item.city.count() = 1
    shall-max-ad-partserrorADSHALL 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-streetAddressLineerrorADSHALL 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-countrywarningADSHOULD contain country
    : nullFlavor.exists() or item.country.exists()
    should-usewarningADSHOULD contain @use
    : nullFlavor.exists() or use.exists()
    text-nullerrorAD.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.precinctxmlText and nullFlavor are mutually exclusive (one must be present)
    : (xmlText | nullFlavor).count() = 1

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: shall-city, shall-streetAddressLine, should-use, should-country, 81-7296, 81-10024, 81-10025, shall-max-ad-parts
    ... @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)
    .... (Choice of one) 1..1
    ..... delimiter C 0..1 ADXP Constraints: text-null
    ...... (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 Binding: Country2 (required)
    Constraints: text-null
    ...... (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 Binding Description: (example): If country is something other than US, the state MAY be present but MAY be bound to different vocabularies
    Additional BindingsPurposeDocumentation
    USPS Two Letter Alphabetic Codes Required
    For US Addresses

    Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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
    Constraints: text-null
    ...... (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 #####-####)
    Constraints: text-null
    ...... (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
    Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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 Constraints: text-null
    ...... (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..* 𝗨𝗦𝗖𝗗𝗜: 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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    AD.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.userequiredCDAPostalAddressUse
    http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse
    AD.item.delimiter.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.countryrequiredCountry2
    http://terminology.hl7.org/ValueSet/v3-Country2
    AD.item.country.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.stateexample
    AD.item.state.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.county.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.city.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.postalCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetAddressLine.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.houseNumber.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.houseNumberNumeric.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.direction.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetName.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetNameBase.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.streetNameType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.additionalLocator.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.unitID.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.unitType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.careOf.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.censusTract.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryAddressLine.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationType.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationArea.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryInstallationQualifier.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryMode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.deliveryModeIdentifier.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.buildingNumberSuffix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.postBox.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    AD.item.precinct.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296)
    : item.xmlText.empty()
    81-10024errorADIf 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://terminology.hl7.org/ValueSet/USPS-State'))
    81-10025errorADIf 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-1errorAD.itemCan 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-cityerrorADSHALL contain exactly one [1..1] city (CONF:81-7292).
    : nullFlavor.exists() or item.city.count() = 1
    shall-max-ad-partserrorADSHALL 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-streetAddressLineerrorADSHALL 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-countrywarningADSHOULD contain country
    : nullFlavor.exists() or item.country.exists()
    should-usewarningADSHOULD contain @use
    : nullFlavor.exists() or use.exists()
    text-nullerrorAD.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.precinctxmlText and nullFlavor are mutually exclusive (one must be present)
    : (xmlText | nullFlavor).count() = 1

    This structure is derived from AD

    Summary

     

    Other representations of profile: CSV, Excel