Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: US Realm Address - AD.US.FIELDED

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2 Version: 2.1.0-draft1
Active as of 2023-01-16 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..*ADBase for all types and resources
81-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 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 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 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..*ADBase for all types and resources
81-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..1ADXP
... state C0..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).
... 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 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..*ADBase for all types and resources
81-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
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DEL
... country 0..1ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: CNT
... state C0..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).
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: STA
... county 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: CPA
... city 1..1ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed 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).
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: ZIP
... streetAddressLine 1..4ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: SAL
... houseNumber 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: BNR
... houseNumberNumeric 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: BNN
... direction 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DIR
... streetName 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: STR
... streetNameBase 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: STB
... streetNameType 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: STTYP
... additionalLocator 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: ADL
... unitID 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: UNID
... unitType 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: UNIT
... careOf 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: CAR
... censusTract 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: CEN
... deliveryAddressLine 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DAL
... deliveryInstallationType 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DINST
... deliveryInstallationArea 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DINSTA
... deliveryInstallationQualifier 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DINSTQ
... deliveryMode 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DMOD
... deliveryModeIdentifier 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DMODID
... buildingNumberSuffix 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: BNS
... postBox 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: POB
... precinct 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... 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

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
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).
:
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..*ADBase for all types and resources
81-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 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 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 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..*ADBase for all types and resources
81-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..1ADXP
... state C0..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).
... 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 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..*ADBase for all types and resources
81-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
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DEL
... country 0..1ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: CNT
... state C0..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).
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: STA
... county 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: CPA
... city 1..1ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed 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).
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: ZIP
... streetAddressLine 1..4ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: SAL
... houseNumber 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: BNR
... houseNumberNumeric 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: BNN
... direction 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DIR
... streetName 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: STR
... streetNameBase 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: STB
... streetNameType 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: STTYP
... additionalLocator 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: ADL
... unitID 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: UNID
... unitType 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: UNIT
... careOf 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: CAR
... censusTract 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: CEN
... deliveryAddressLine 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DAL
... deliveryInstallationType 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DINST
... deliveryInstallationArea 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DINSTA
... deliveryInstallationQualifier 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DINSTQ
... deliveryMode 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DMOD
... deliveryModeIdentifier 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: DMODID
... buildingNumberSuffix 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: BNS
... postBox 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... partType 0..1codeFixed Value: POB
... precinct 0..*ADXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1code
.... 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

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
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).
:
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, Schematron