Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: US Realm Address (AD.US.FIELDED)

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED Version: 2.1
Draft as of 2023-09-29 Computable Name: USRealmAddressADUSFIELDED
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.5.2

Reusable address template, for use in US Realm CDA Header.

Usage:

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, @nullFlavor, @isNotOrdered, @use, delimiter, country, state, county, city, postalCode, streetAddressLine, houseNumber, houseNumberNumeric, direction, streetName, streetNameBase, streetNameType, additionalLocator, unitID, unitType, careOf, censusTract, deliveryAddressLine, deliveryInstallationType, deliveryInstallationArea, deliveryInstallationQualifier, deliveryMode, deliveryModeIdentifier, buildingNumberSuffix, postBox, precinct, other, useablePeriod
Base for all types and resources
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... use 0..1csIf addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: PostalAddressUse (required)
... country 0..1ADXPBinding: VSAC 2.16.840.1.113883.3.88.12.80.63 (required)
... state C0..1ADXPBinding: VSAC 2.16.840.1.113883.3.88.12.80.1 (preferred)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
... postalCode C0..1ADXPBinding: VSAC 2.16.840.1.113883.3.88.12.80.2 (preferred)
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
... streetAddressLine 1..4ADXP

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
AD.userequiredPostalAddressUse
AD.countryrequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.63
AD.statepreferredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.1
AD.postalCodepreferredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.2

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-10024errorAD.stateIf 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-10025errorAD.postalCodeIf 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).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, delimiter, country, state, county, city, postalCode, streetAddressLine, houseNumber, houseNumberNumeric, direction, streetName, streetNameBase, streetNameType, additionalLocator, unitID, unitType, careOf, censusTract, deliveryAddressLine, deliveryInstallationType, deliveryInstallationArea, deliveryInstallationQualifier, deliveryMode, deliveryModeIdentifier, buildingNumberSuffix, postBox, precinct, other, useablePeriod
Base for all types and resources
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... @use 0..1csIf addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: PostalAddressUse (required)
... country 0..1ADXP
... state C0..1ADXP81-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).
... postalCode C0..1ADXP81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
... streetAddressLine 1..4ADXP

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AD.userequiredPostalAddressUse

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-10024errorAD.stateIf 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-10025errorAD.postalCodeIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, delimiter, country, state, county, city, postalCode, streetAddressLine, houseNumber, houseNumberNumeric, direction, streetName, streetNameBase, streetNameType, additionalLocator, unitID, unitType, careOf, censusTract, deliveryAddressLine, deliveryInstallationType, deliveryInstallationArea, deliveryInstallationQualifier, deliveryMode, deliveryModeIdentifier, buildingNumberSuffix, postBox, precinct, other, useablePeriod
Base for all types and resources
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... nullFlavor C0..1csPrimitive Type code
Binding: NullFlavor (required)
... @isNotOrdered 0..1bl
... @use 0..1csIf addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: PostalAddressUse (required)
... delimiter 0..*ADXP
.... @partType 0..1csFixed Value: DEL
... country 0..1ADXP
.... @partType 0..1csFixed Value: CNT
... state C0..1ADXP81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
.... @partType 0..1csFixed Value: STA
... county 0..*ADXP
.... @partType 0..1csFixed Value: CPA
... city 1..1ADXP
.... @partType 0..1csFixed Value: CTY
... postalCode C0..1ADXP81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
.... @partType 0..1csFixed Value: ZIP
... streetAddressLine 1..4ADXP
.... @partType 0..1csFixed Value: SAL
... houseNumber 0..*ADXP
.... @partType 0..1csFixed Value: BNR
... houseNumberNumeric 0..*ADXP
.... @partType 0..1csFixed Value: BNN
... direction 0..*ADXP
.... @partType 0..1csFixed Value: DIR
... streetName 0..*ADXP
.... @partType 0..1csFixed Value: STR
... streetNameBase 0..*ADXP
.... @partType 0..1csFixed Value: STB
... streetNameType 0..*ADXP
.... @partType 0..1csFixed Value: STTYP
... additionalLocator 0..*ADXP
.... @partType 0..1csFixed Value: ADL
... unitID 0..*ADXP
.... @partType 0..1csFixed Value: UNID
... unitType 0..*ADXP
.... @partType 0..1csFixed Value: UNIT
... careOf 0..*ADXP
.... @partType 0..1csFixed Value: CAR
... censusTract 0..*ADXP
.... @partType 0..1csFixed Value: CEN
... deliveryAddressLine 0..*ADXP
.... @partType 0..1csFixed Value: DAL
... deliveryInstallationType 0..*ADXP
.... @partType 0..1csFixed Value: DINST
... deliveryInstallationArea 0..*ADXP
.... @partType 0..1csFixed Value: DINSTA
... deliveryInstallationQualifier 0..*ADXP
.... @partType 0..1csFixed Value: DINSTQ
... deliveryMode 0..*ADXP
.... @partType 0..1csFixed Value: DMOD
... deliveryModeIdentifier 0..*ADXP
.... @partType 0..1csFixed Value: DMODID
... buildingNumberSuffix 0..*ADXP
.... @partType 0..1csFixed Value: BNS
... postBox 0..*ADXP
.... @partType 0..1csFixed Value: POB
... precinct 0..*ADXP
.... @partType 0..1csFixed Value: PRE
... other 0..1st
... useablePeriod 0..*
.... useablePeriodIVL_TS
.... useablePeriodEIVL_TS
.... useablePeriodPIVL_TS
.... useablePeriodSXPR_TS

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AD.nullFlavorrequiredNullFlavor
AD.userequiredPostalAddressUse

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-10024errorAD.stateIf 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-10025errorAD.postalCodeIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
:
cs-patternerrorAD.nullFlavorcs attributes must not contain any whitespace
: matches('^[^\\s]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from AD

Summary

Mandatory: 2 elements

Differential View

This structure is derived from AD

NameFlagsCard.TypeDescription & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, delimiter, country, state, county, city, postalCode, streetAddressLine, houseNumber, houseNumberNumeric, direction, streetName, streetNameBase, streetNameType, additionalLocator, unitID, unitType, careOf, censusTract, deliveryAddressLine, deliveryInstallationType, deliveryInstallationArea, deliveryInstallationQualifier, deliveryMode, deliveryModeIdentifier, buildingNumberSuffix, postBox, precinct, other, useablePeriod
Base for all types and resources
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... use 0..1csIf addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: PostalAddressUse (required)
... country 0..1ADXPBinding: VSAC 2.16.840.1.113883.3.88.12.80.63 (required)
... state C0..1ADXPBinding: VSAC 2.16.840.1.113883.3.88.12.80.1 (preferred)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
... postalCode C0..1ADXPBinding: VSAC 2.16.840.1.113883.3.88.12.80.2 (preferred)
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
... streetAddressLine 1..4ADXP

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
AD.userequiredPostalAddressUse
AD.countryrequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.63
AD.statepreferredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.1
AD.postalCodepreferredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.2

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-10024errorAD.stateIf 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-10025errorAD.postalCodeIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, delimiter, country, state, county, city, postalCode, streetAddressLine, houseNumber, houseNumberNumeric, direction, streetName, streetNameBase, streetNameType, additionalLocator, unitID, unitType, careOf, censusTract, deliveryAddressLine, deliveryInstallationType, deliveryInstallationArea, deliveryInstallationQualifier, deliveryMode, deliveryModeIdentifier, buildingNumberSuffix, postBox, precinct, other, useablePeriod
Base for all types and resources
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... @use 0..1csIf addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: PostalAddressUse (required)
... country 0..1ADXP
... state C0..1ADXP81-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).
... postalCode C0..1ADXP81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
... streetAddressLine 1..4ADXP

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AD.userequiredPostalAddressUse

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-10024errorAD.stateIf 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-10025errorAD.postalCodeIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AD C1..*ADXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @nullFlavor, @isNotOrdered, @use, delimiter, country, state, county, city, postalCode, streetAddressLine, houseNumber, houseNumberNumeric, direction, streetName, streetNameBase, streetNameType, additionalLocator, unitID, unitType, careOf, censusTract, deliveryAddressLine, deliveryInstallationType, deliveryInstallationArea, deliveryInstallationQualifier, deliveryMode, deliveryModeIdentifier, buildingNumberSuffix, postBox, precinct, other, useablePeriod
Base for all types and resources
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... nullFlavor C0..1csPrimitive Type code
Binding: NullFlavor (required)
... @isNotOrdered 0..1bl
... @use 0..1csIf addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: PostalAddressUse (required)
... delimiter 0..*ADXP
.... @partType 0..1csFixed Value: DEL
... country 0..1ADXP
.... @partType 0..1csFixed Value: CNT
... state C0..1ADXP81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
.... @partType 0..1csFixed Value: STA
... county 0..*ADXP
.... @partType 0..1csFixed Value: CPA
... city 1..1ADXP
.... @partType 0..1csFixed Value: CTY
... postalCode C0..1ADXP81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
.... @partType 0..1csFixed Value: ZIP
... streetAddressLine 1..4ADXP
.... @partType 0..1csFixed Value: SAL
... houseNumber 0..*ADXP
.... @partType 0..1csFixed Value: BNR
... houseNumberNumeric 0..*ADXP
.... @partType 0..1csFixed Value: BNN
... direction 0..*ADXP
.... @partType 0..1csFixed Value: DIR
... streetName 0..*ADXP
.... @partType 0..1csFixed Value: STR
... streetNameBase 0..*ADXP
.... @partType 0..1csFixed Value: STB
... streetNameType 0..*ADXP
.... @partType 0..1csFixed Value: STTYP
... additionalLocator 0..*ADXP
.... @partType 0..1csFixed Value: ADL
... unitID 0..*ADXP
.... @partType 0..1csFixed Value: UNID
... unitType 0..*ADXP
.... @partType 0..1csFixed Value: UNIT
... careOf 0..*ADXP
.... @partType 0..1csFixed Value: CAR
... censusTract 0..*ADXP
.... @partType 0..1csFixed Value: CEN
... deliveryAddressLine 0..*ADXP
.... @partType 0..1csFixed Value: DAL
... deliveryInstallationType 0..*ADXP
.... @partType 0..1csFixed Value: DINST
... deliveryInstallationArea 0..*ADXP
.... @partType 0..1csFixed Value: DINSTA
... deliveryInstallationQualifier 0..*ADXP
.... @partType 0..1csFixed Value: DINSTQ
... deliveryMode 0..*ADXP
.... @partType 0..1csFixed Value: DMOD
... deliveryModeIdentifier 0..*ADXP
.... @partType 0..1csFixed Value: DMODID
... buildingNumberSuffix 0..*ADXP
.... @partType 0..1csFixed Value: BNS
... postBox 0..*ADXP
.... @partType 0..1csFixed Value: POB
... precinct 0..*ADXP
.... @partType 0..1csFixed Value: PRE
... other 0..1st
... useablePeriod 0..*
.... useablePeriodIVL_TS
.... useablePeriodEIVL_TS
.... useablePeriodPIVL_TS
.... useablePeriodSXPR_TS

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AD.nullFlavorrequiredNullFlavor
AD.userequiredPostalAddressUse

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAD**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-10024errorAD.stateIf 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-10025errorAD.postalCodeIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
:
cs-patternerrorAD.nullFlavorcs attributes must not contain any whitespace
: matches('^[^\\s]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from AD

Summary

Mandatory: 2 elements

 

Other representations of profile: CSV, Excel