Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

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

Resource Profile: US Realm Address (AD.US.FIELDED)

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2 Version: 2.2
Active as of 2022-05-13 Computable Name: USRealmAddressADUSFIELDED
Other Identifiers: : urn:oid:2.16.840.1.113883.10.20.22.5.2

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

Usage:

Formal Views of Profile Content

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

This structure is derived from AD

Summary

Mandatory: 2 elements

This structure is derived from AD

NameFlagsCard.TypeDescription & Constraintsdoco
.. AD I1..*AD81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... use 0..1codeIf 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 I0..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 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 I0..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
NameFlagsCard.TypeDescription & Constraintsdoco
.. AD I1..*AD81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... nullFlavor 0..1codeBinding: NullFlavor (required)
... isNotOrdered 0..1boolean
... use 0..1codeIf addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: PostalAddressUse (required)
... delimiter 0..*ADXP
.... partType 0..1codeFixed Value: DEL
... country 0..1ADXP
.... partType 0..1codeFixed Value: CNT
... state I0..1ADXP81-10024: If the country is US, the state element is required but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
.... partType 0..1codeFixed Value: STA
... county 0..*ADXP
.... partType 0..1codeFixed Value: CPA
... city 1..1ADXP
.... partType 0..1codeFixed Value: CTY
... postalCode I0..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..1codeFixed Value: ZIP
... streetAddressLine 1..4ADXP
.... partType 0..1codeFixed Value: SAL
... houseNumber 0..*ADXP
.... partType 0..1codeFixed Value: BNR
... houseNumberNumeric 0..*ADXP
.... partType 0..1codeFixed Value: BNN
... direction 0..*ADXP
.... partType 0..1codeFixed Value: DIR
... streetName 0..*ADXP
.... partType 0..1codeFixed Value: STR
... streetNameBase 0..*ADXP
.... partType 0..1codeFixed Value: STB
... streetNameType 0..*ADXP
.... partType 0..1codeFixed Value: STTYP
... additionalLocator 0..*ADXP
.... partType 0..1codeFixed Value: ADL
... unitID 0..*ADXP
.... partType 0..1codeFixed Value: UNID
... unitType 0..*ADXP
.... partType 0..1codeFixed Value: UNIT
... careOf 0..*ADXP
.... partType 0..1codeFixed Value: CAR
... censusTract 0..*ADXP
.... partType 0..1codeFixed Value: CEN
... deliveryAddressLine 0..*ADXP
.... partType 0..1codeFixed Value: DAL
... deliveryInstallationType 0..*ADXP
.... partType 0..1codeFixed Value: DINST
... deliveryInstallationArea 0..*ADXP
.... partType 0..1codeFixed Value: DINSTA
... deliveryInstallationQualifier 0..*ADXP
.... partType 0..1codeFixed Value: DINSTQ
... deliveryMode 0..*ADXP
.... partType 0..1codeFixed Value: DMOD
... deliveryModeIdentifier 0..*ADXP
.... partType 0..1codeFixed Value: DMODID
... buildingNumberSuffix 0..*ADXP
.... partType 0..1codeFixed Value: BNS
... postBox 0..*ADXP
.... partType 0..1codeFixed Value: POB
... precinct 0..*ADXP
.... partType 0..1codeFixed Value: PRE
... other 0..1string
... useablePeriod[x] 0..*
.... useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/IVL-TSIVL_TS
.... useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/EIVL-TSEIVL_TS
.... useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/PIVL-TSPIVL_TS
.... useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TSSXPR_TS

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. AD I1..*AD81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).

doco Documentation for this format

This structure is derived from AD

Summary

Mandatory: 2 elements

Differential View

This structure is derived from AD

NameFlagsCard.TypeDescription & Constraintsdoco
.. AD I1..*AD81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... use 0..1codeIf 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 I0..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 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 I0..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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AD I1..*AD81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296).
... nullFlavor 0..1codeBinding: NullFlavor (required)
... isNotOrdered 0..1boolean
... use 0..1codeIf addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: PostalAddressUse (required)
... delimiter 0..*ADXP
.... partType 0..1codeFixed Value: DEL
... country 0..1ADXP
.... partType 0..1codeFixed Value: CNT
... state I0..1ADXP81-10024: If the country is US, the state element is required but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
.... partType 0..1codeFixed Value: STA
... county 0..*ADXP
.... partType 0..1codeFixed Value: CPA
... city 1..1ADXP
.... partType 0..1codeFixed Value: CTY
... postalCode I0..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..1codeFixed Value: ZIP
... streetAddressLine 1..4ADXP
.... partType 0..1codeFixed Value: SAL
... houseNumber 0..*ADXP
.... partType 0..1codeFixed Value: BNR
... houseNumberNumeric 0..*ADXP
.... partType 0..1codeFixed Value: BNN
... direction 0..*ADXP
.... partType 0..1codeFixed Value: DIR
... streetName 0..*ADXP
.... partType 0..1codeFixed Value: STR
... streetNameBase 0..*ADXP
.... partType 0..1codeFixed Value: STB
... streetNameType 0..*ADXP
.... partType 0..1codeFixed Value: STTYP
... additionalLocator 0..*ADXP
.... partType 0..1codeFixed Value: ADL
... unitID 0..*ADXP
.... partType 0..1codeFixed Value: UNID
... unitType 0..*ADXP
.... partType 0..1codeFixed Value: UNIT
... careOf 0..*ADXP
.... partType 0..1codeFixed Value: CAR
... censusTract 0..*ADXP
.... partType 0..1codeFixed Value: CEN
... deliveryAddressLine 0..*ADXP
.... partType 0..1codeFixed Value: DAL
... deliveryInstallationType 0..*ADXP
.... partType 0..1codeFixed Value: DINST
... deliveryInstallationArea 0..*ADXP
.... partType 0..1codeFixed Value: DINSTA
... deliveryInstallationQualifier 0..*ADXP
.... partType 0..1codeFixed Value: DINSTQ
... deliveryMode 0..*ADXP
.... partType 0..1codeFixed Value: DMOD
... deliveryModeIdentifier 0..*ADXP
.... partType 0..1codeFixed Value: DMODID
... buildingNumberSuffix 0..*ADXP
.... partType 0..1codeFixed Value: BNS
... postBox 0..*ADXP
.... partType 0..1codeFixed Value: POB
... precinct 0..*ADXP
.... partType 0..1codeFixed Value: PRE
... other 0..1string
... useablePeriod[x] 0..*
.... useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/IVL-TSIVL_TS
.... useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/EIVL-TSEIVL_TS
.... useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/PIVL-TSPIVL_TS
.... useablePeriodHttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TSSXPR_TS

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
AD.nullFlavorrequiredNullFlavor
AD.userequiredPostalAddressUse

Constraints

IdGradePathDetailsRequirements
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 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).
: