Clinical Document Architecture with Australian Schema
1.0.1 - active
Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address | Version: 1.0.1 | |||
| Active as of 2025-10-09 | Maturity Level: 1 | Computable Name: AD | ||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
Australian adaptation of the HL7 International CDA PostalAddress datatype.
This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  AD |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA PostalAddress datatype Elements defined in Ancestors:@nullFlavor Logical Container: ClinicalDocument (CDA Class) | |
  @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
  item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
   (Choice of one) |
1..1 | |||
   delimiter |
C | 0..1 | ADXP | Constraints: text-null |
 (Choice of one) |
1..1 | |||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
 xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
 @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (preferred) Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..* | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AD.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.use | Base | required | CDAPostalAddressUse | 📦1.0.1 | This IG |
| AD.item.delimiter.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.country.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.state | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 | Not Stated | Unknown |
| AD.item.state.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.county.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.city.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.postalCode.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetAddressLine.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.houseNumber.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.houseNumberNumeric.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.direction.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetName.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetNameBase.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetNameType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.additionalLocator.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.unitID.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.unitType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.careOf.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.censusTract.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryAddressLine.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationArea.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationQualifier.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryMode.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryModeIdentifier.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.buildingNumberSuffix.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.postBox.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.precinct.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AD-1 | error | AD.item | Can 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
|
| text-null | error | AD.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.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) |
(xmlText | nullFlavor).count() = 1
|
This structure is derived from ANY
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AD |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA PostalAddress datatype Elements defined in Ancestors:@nullFlavor Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | ||
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
| (Choice of one) |
1..1 | |||
| delimiter |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
0..1 | ADXP | Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (preferred) | |
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
0..* | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AD.use | Base | required | CDAPostalAddressUse | 📦1.0.1 | This IG |
| AD.item.state | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 | Not Stated | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| AD-1 | error | AD.item | Can 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
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AD |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA PostalAddress datatype Elements defined in Ancestors:@nullFlavor Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
| (Choice of one) |
1..1 | |||
| delimiter |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (preferred) Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..* | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AD.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.use | Base | required | CDAPostalAddressUse | 📦1.0.1 | This IG |
| AD.item.delimiter.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.country.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.state | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 | Not Stated | Unknown |
| AD.item.state.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.county.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.city.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.postalCode.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetAddressLine.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.houseNumber.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.houseNumberNumeric.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.direction.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetName.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetNameBase.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetNameType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.additionalLocator.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.unitID.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.unitType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.careOf.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.censusTract.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryAddressLine.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationArea.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationQualifier.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryMode.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryModeIdentifier.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.buildingNumberSuffix.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.postBox.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.precinct.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AD-1 | error | AD.item | Can 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
|
| text-null | error | AD.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.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) |
(xmlText | nullFlavor).count() = 1
|
This structure is derived from ANY
Summary
Fixed: 27 elements
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AD |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA PostalAddress datatype Elements defined in Ancestors:@nullFlavor Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
| (Choice of one) |
1..1 | |||
| delimiter |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (preferred) Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..* | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AD.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.use | Base | required | CDAPostalAddressUse | 📦1.0.1 | This IG |
| AD.item.delimiter.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.country.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.state | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 | Not Stated | Unknown |
| AD.item.state.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.county.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.city.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.postalCode.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetAddressLine.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.houseNumber.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.houseNumberNumeric.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.direction.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetName.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetNameBase.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetNameType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.additionalLocator.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.unitID.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.unitType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.careOf.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.censusTract.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryAddressLine.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationArea.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationQualifier.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryMode.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryModeIdentifier.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.buildingNumberSuffix.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.postBox.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.precinct.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AD-1 | error | AD.item | Can 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
|
| text-null | error | AD.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.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) |
(xmlText | nullFlavor).count() = 1
|
Differential View
This structure is derived from ANY
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AD |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA PostalAddress datatype Elements defined in Ancestors:@nullFlavor Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | ||
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
| (Choice of one) |
1..1 | |||
| delimiter |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
0..1 | ADXP | Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (preferred) | |
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
0..* | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
0..1 | ADXP | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AD.use | Base | required | CDAPostalAddressUse | 📦1.0.1 | This IG |
| AD.item.state | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 | Not Stated | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| AD-1 | error | AD.item | Can 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
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AD |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA PostalAddress datatype Elements defined in Ancestors:@nullFlavor Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
| (Choice of one) |
1..1 | |||
| delimiter |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (preferred) Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..* | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AD.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.use | Base | required | CDAPostalAddressUse | 📦1.0.1 | This IG |
| AD.item.delimiter.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.country.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.state | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 | Not Stated | Unknown |
| AD.item.state.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.county.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.city.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.postalCode.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetAddressLine.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.houseNumber.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.houseNumberNumeric.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.direction.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetName.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetNameBase.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.streetNameType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.additionalLocator.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.unitID.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.unitType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.careOf.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.censusTract.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryAddressLine.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationType.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationArea.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryInstallationQualifier.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryMode.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.deliveryModeIdentifier.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.buildingNumberSuffix.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.postBox.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| AD.item.precinct.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AD-1 | error | AD.item | Can 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
|
| text-null | error | AD.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.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) |
(xmlText | nullFlavor).count() = 1
|
This structure is derived from ANY
Summary
Fixed: 27 elements
Structures
This structure refers to these other structures:
Maturity: 1
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.1 based on FHIR 5.0.0. Generated 2025-10-09
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
