Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . 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: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: USRealmAddress
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.5.2

Reusable address template, for use in US Realm documents

Usage:

Formal Views of Profile Content

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

This structure is derived from AD

NameFlagsCard.TypeDescription & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @isNotOrdered, @use, item, useablePeriod
Base for all types and resources
Logical Container: ClinicalDocument (CDA Class)
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
... @nullFlavor 0..1csIf addr/@nullFlavor is present, none of the address parts are required.
... @use 0..*csIdentifies which address to use for a given purpose.
... item
.... country 0..1ADXPBinding: Country2 (required)
.... state 0..1ADXPBinding: (unbound) (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 CodesRequired Binding
For US Addresses
.... city 0..1ADXPcity is required if nullFlavor is absent
.... postalCode 0..1ADXPIf country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####)
.... streetAddressLine 0..1ADXPMin: 1, Max: 4 streetAddressLine required if nullFlavor is absent

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
AD.item.countryrequiredCountry2
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://hl7.org/fhir/us/core/ValueSet/us-core-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 & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @isNotOrdered, @use, item, useablePeriod
Base for all types and resources
Logical Container: ClinicalDocument (CDA Class)
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
... @nullFlavor 0..1csIf addr/@nullFlavor is present, none of the address parts are required.
Binding: CDANullFlavor (required)
... @use 0..*csIdentifies which address to use for a given purpose.
Binding: CDAPostalAddressUse (required)
... useablePeriod 0..*(USCDI) Care Team Member Role - Previous Address - Current or prior place where a person may have been located or could have been contacted.
.... useablePeriodIVL_TS
.... useablePeriodEIVL_TS
.... useablePeriodPIVL_TS
.... useablePeriodSXPR_TS

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AD.nullFlavorrequiredCDANullFlavor
AD.userequiredCDAPostalAddressUse

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://hl7.org/fhir/us/core/ValueSet/us-core-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 & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @isNotOrdered, @use, item, useablePeriod
Base for all types and resources
Logical Container: ClinicalDocument (CDA Class)
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
... @nullFlavor 0..1csIf addr/@nullFlavor is present, none of the address parts are required.
Binding: CDANullFlavor (required)
... @isNotOrdered 0..1bl
... @use 0..*csIdentifies which address to use for a given purpose.
Binding: CDAPostalAddressUse (required)
.... (Choice of one) 1..1
..... delimiter C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DEL
..... country C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CNT
..... state C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: STA
..... county C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CPA
..... city C0..1ADXPcity is required if nullFlavor is absent
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CTY
..... postalCode C0..1ADXPIf country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####)
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: ZIP
..... streetAddressLine C0..1ADXPMin: 1, Max: 4 streetAddressLine required if nullFlavor is absent
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: SAL
..... houseNumber C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: BNR
..... houseNumberNumeric C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: BNN
..... direction C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DIR
..... streetName C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: STR
..... streetNameBase C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: STB
..... streetNameType C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: STTYP
..... additionalLocator C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: ADL
..... unitID C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: UNID
..... unitType C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: UNIT
..... careOf C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CAR
..... censusTract C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CEN
..... deliveryAddressLine C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DAL
..... deliveryInstallationType C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DINST
..... deliveryInstallationArea C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DINSTA
..... deliveryInstallationQualifier C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DINSTQ
..... deliveryMode C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DMOD
..... deliveryModeIdentifier C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DMODID
..... buildingNumberSuffix C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: BNS
..... postBox C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: POB
..... precinct C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: PRE
..... xmlText 0..1stAllows for mixed text content
... useablePeriod 0..*(USCDI) Care Team Member Role - Previous Address - Current or prior place where a person may have been located or could have been contacted.
.... useablePeriodIVL_TS
.... useablePeriodEIVL_TS
.... useablePeriodPIVL_TS
.... useablePeriodSXPR_TS

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AD.nullFlavorrequiredCDANullFlavor
AD.userequiredCDAPostalAddressUse
AD.item.delimiter.nullFlavorrequiredCDANullFlavor
AD.item.country.nullFlavorrequiredCDANullFlavor
AD.item.state.nullFlavorrequiredCDANullFlavor
AD.item.county.nullFlavorrequiredCDANullFlavor
AD.item.city.nullFlavorrequiredCDANullFlavor
AD.item.postalCode.nullFlavorrequiredCDANullFlavor
AD.item.streetAddressLine.nullFlavorrequiredCDANullFlavor
AD.item.houseNumber.nullFlavorrequiredCDANullFlavor
AD.item.houseNumberNumeric.nullFlavorrequiredCDANullFlavor
AD.item.direction.nullFlavorrequiredCDANullFlavor
AD.item.streetName.nullFlavorrequiredCDANullFlavor
AD.item.streetNameBase.nullFlavorrequiredCDANullFlavor
AD.item.streetNameType.nullFlavorrequiredCDANullFlavor
AD.item.additionalLocator.nullFlavorrequiredCDANullFlavor
AD.item.unitID.nullFlavorrequiredCDANullFlavor
AD.item.unitType.nullFlavorrequiredCDANullFlavor
AD.item.careOf.nullFlavorrequiredCDANullFlavor
AD.item.censusTract.nullFlavorrequiredCDANullFlavor
AD.item.deliveryAddressLine.nullFlavorrequiredCDANullFlavor
AD.item.deliveryInstallationType.nullFlavorrequiredCDANullFlavor
AD.item.deliveryInstallationArea.nullFlavorrequiredCDANullFlavor
AD.item.deliveryInstallationQualifier.nullFlavorrequiredCDANullFlavor
AD.item.deliveryMode.nullFlavorrequiredCDANullFlavor
AD.item.deliveryModeIdentifier.nullFlavorrequiredCDANullFlavor
AD.item.buildingNumberSuffix.nullFlavorrequiredCDANullFlavor
AD.item.postBox.nullFlavorrequiredCDANullFlavor
AD.item.precinct.nullFlavorrequiredCDANullFlavor

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://hl7.org/fhir/us/core/ValueSet/us-core-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 & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @isNotOrdered, @use, item, useablePeriod
Base for all types and resources
Logical Container: ClinicalDocument (CDA Class)
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
... @nullFlavor 0..1csIf addr/@nullFlavor is present, none of the address parts are required.
... @use 0..*csIdentifies which address to use for a given purpose.
... item
.... country 0..1ADXPBinding: Country2 (required)
.... state 0..1ADXPBinding: (unbound) (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 CodesRequired Binding
For US Addresses
.... city 0..1ADXPcity is required if nullFlavor is absent
.... postalCode 0..1ADXPIf country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####)
.... streetAddressLine 0..1ADXPMin: 1, Max: 4 streetAddressLine required if nullFlavor is absent

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
AD.item.countryrequiredCountry2
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://hl7.org/fhir/us/core/ValueSet/us-core-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 & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @isNotOrdered, @use, item, useablePeriod
Base for all types and resources
Logical Container: ClinicalDocument (CDA Class)
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
... @nullFlavor 0..1csIf addr/@nullFlavor is present, none of the address parts are required.
Binding: CDANullFlavor (required)
... @use 0..*csIdentifies which address to use for a given purpose.
Binding: CDAPostalAddressUse (required)
... useablePeriod 0..*(USCDI) Care Team Member Role - Previous Address - Current or prior place where a person may have been located or could have been contacted.
.... useablePeriodIVL_TS
.... useablePeriodEIVL_TS
.... useablePeriodPIVL_TS
.... useablePeriodSXPR_TS

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AD.nullFlavorrequiredCDANullFlavor
AD.userequiredCDAPostalAddressUse

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://hl7.org/fhir/us/core/ValueSet/us-core-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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @isNotOrdered, @use, item, useablePeriod
Base for all types and resources
Logical Container: ClinicalDocument (CDA Class)
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
... @nullFlavor 0..1csIf addr/@nullFlavor is present, none of the address parts are required.
Binding: CDANullFlavor (required)
... @isNotOrdered 0..1bl
... @use 0..*csIdentifies which address to use for a given purpose.
Binding: CDAPostalAddressUse (required)
.... (Choice of one) 1..1
..... delimiter C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DEL
..... country C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CNT
..... state C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: STA
..... county C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CPA
..... city C0..1ADXPcity is required if nullFlavor is absent
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CTY
..... postalCode C0..1ADXPIf country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####)
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: ZIP
..... streetAddressLine C0..1ADXPMin: 1, Max: 4 streetAddressLine required if nullFlavor is absent
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: SAL
..... houseNumber C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: BNR
..... houseNumberNumeric C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: BNN
..... direction C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DIR
..... streetName C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: STR
..... streetNameBase C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: STB
..... streetNameType C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: STTYP
..... additionalLocator C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: ADL
..... unitID C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: UNID
..... unitType C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: UNIT
..... careOf C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CAR
..... censusTract C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: CEN
..... deliveryAddressLine C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DAL
..... deliveryInstallationType C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DINST
..... deliveryInstallationArea C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DINSTA
..... deliveryInstallationQualifier C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DINSTQ
..... deliveryMode C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DMOD
..... deliveryModeIdentifier C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: DMODID
..... buildingNumberSuffix C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: BNS
..... postBox C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: POB
..... precinct C0..1ADXP
...... (Choice of one) 1..1
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... xmlText 0..1stAllows for mixed text content
...... @representation 0..1csFixed Value: TXT
...... @mediaType 0..1csFixed Value: text/plain
...... @language 0..1cs
...... @partType 0..1csFixed Value: PRE
..... xmlText 0..1stAllows for mixed text content
... useablePeriod 0..*(USCDI) Care Team Member Role - Previous Address - Current or prior place where a person may have been located or could have been contacted.
.... useablePeriodIVL_TS
.... useablePeriodEIVL_TS
.... useablePeriodPIVL_TS
.... useablePeriodSXPR_TS

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AD.nullFlavorrequiredCDANullFlavor
AD.userequiredCDAPostalAddressUse
AD.item.delimiter.nullFlavorrequiredCDANullFlavor
AD.item.country.nullFlavorrequiredCDANullFlavor
AD.item.state.nullFlavorrequiredCDANullFlavor
AD.item.county.nullFlavorrequiredCDANullFlavor
AD.item.city.nullFlavorrequiredCDANullFlavor
AD.item.postalCode.nullFlavorrequiredCDANullFlavor
AD.item.streetAddressLine.nullFlavorrequiredCDANullFlavor
AD.item.houseNumber.nullFlavorrequiredCDANullFlavor
AD.item.houseNumberNumeric.nullFlavorrequiredCDANullFlavor
AD.item.direction.nullFlavorrequiredCDANullFlavor
AD.item.streetName.nullFlavorrequiredCDANullFlavor
AD.item.streetNameBase.nullFlavorrequiredCDANullFlavor
AD.item.streetNameType.nullFlavorrequiredCDANullFlavor
AD.item.additionalLocator.nullFlavorrequiredCDANullFlavor
AD.item.unitID.nullFlavorrequiredCDANullFlavor
AD.item.unitType.nullFlavorrequiredCDANullFlavor
AD.item.careOf.nullFlavorrequiredCDANullFlavor
AD.item.censusTract.nullFlavorrequiredCDANullFlavor
AD.item.deliveryAddressLine.nullFlavorrequiredCDANullFlavor
AD.item.deliveryInstallationType.nullFlavorrequiredCDANullFlavor
AD.item.deliveryInstallationArea.nullFlavorrequiredCDANullFlavor
AD.item.deliveryInstallationQualifier.nullFlavorrequiredCDANullFlavor
AD.item.deliveryMode.nullFlavorrequiredCDANullFlavor
AD.item.deliveryModeIdentifier.nullFlavorrequiredCDANullFlavor
AD.item.buildingNumberSuffix.nullFlavorrequiredCDANullFlavor
AD.item.postBox.nullFlavorrequiredCDANullFlavor
AD.item.precinct.nullFlavorrequiredCDANullFlavor

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://hl7.org/fhir/us/core/ValueSet/us-core-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