AU Base Implementation Guide
5.1.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Data Type Profile: Australian Address

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-address | Version: 5.1.0-preview
Standards status: Trial-use | Maturity Level: 2 | Computable Name: AustralianAddress
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines an address structure that localises core concepts, including identifiers and terminology, for use in an Australian context, to specifically represent an Australian (location) address. The purpose of this profile is to provide best practice guidance on Australian address representation, where some constraint on content is desirable to guarantee the quality of an Australian address.

### Usage Notes

Profile specific implementation guidance:

- An international address can be represented using the core Address data type.

Potentially useful extensions:

- Address.line: Unit
- Address.line: House Number
- Address.line: Street Name
- Address.line: Street Name Type
- Address.line: Street Name Base

Usage:

- Use this DataType Constraint: AU Base Location, AU Base Organisation, AU Base Patient, AU Base Practitioner and AU Base Related Person

Changes since version 5.0.0:

- No changes

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Address | C | 0..* | Address | An address in Australia for use within an Australian healthcare context ele-1: All FHIR elements must have a @value or children inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier ele-1: All FHIR elements must have a @value or children
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
type | Σ C | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). ele-1: All FHIR elements must have a @value or children Example General: both
text | Σ C | 0..1 | string | Text representation of the address ele-1: All FHIR elements must have a @value or children Example General: 137 Nowhere Street, Erewhon 9132
line | Σ C | 0..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town or suburb ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state | Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required) ele-1: All FHIR elements must have a @value or children
postalCode | Σ C | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children inv-add-3: Postal code shall be 4 digits Example General: 9132
country | Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code ele-1: All FHIR elements must have a @value or children Fixed Value: AU
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Address.state | required | AustralianStatesAndTerritories `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-add-0 | error | Address | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-add-3 | error | Address.postalCode | Postal code shall be 4 digits : matches('^[0-9]{4}$') |

This structure is derived from Address

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Address | C | 0..* | Address | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
type | C | 0..1 | code | postal | physical | both
text | C | 0..1 | string | Text representation of the address
line | C | 0..* | string | Street name, number, direction & P.O. Box etc.
city |  | 0..1 | string | Name of city, town or suburb
state |  | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
postalCode | C | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits
country |  | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Address.state | required | AustralianStatesAndTerritories `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-add-0 | error | Address | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-add-3 | error | Address.postalCode | Postal code shall be 4 digits : matches('^[0-9]{4}$') |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Address | C | 0..* | Address | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ C | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ C | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town or suburb Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
postalCode | Σ C | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits Example General: 9132
country | Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Address.state | required | AustralianStatesAndTerritories `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-add-0 | error | Address | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-add-3 | error | Address.postalCode | Postal code shall be 4 digits : matches('^[0-9]{4}$') |

This structure is derived from Address

Summary

Fixed: 1 element

Extensions

This structure refers to these extensions:

- http://hl7.org.au/fhir/StructureDefinition/address-identifier
- http://hl7.org.au/fhir/StructureDefinition/no-fixed-address

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Address | C | 0..* | Address | An address in Australia for use within an Australian healthcare context ele-1: All FHIR elements must have a @value or children inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier ele-1: All FHIR elements must have a @value or children
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
type | Σ C | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). ele-1: All FHIR elements must have a @value or children Example General: both
text | Σ C | 0..1 | string | Text representation of the address ele-1: All FHIR elements must have a @value or children Example General: 137 Nowhere Street, Erewhon 9132
line | Σ C | 0..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town or suburb ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state | Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required) ele-1: All FHIR elements must have a @value or children
postalCode | Σ C | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children inv-add-3: Postal code shall be 4 digits Example General: 9132
country | Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code ele-1: All FHIR elements must have a @value or children Fixed Value: AU
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Address.state | required | AustralianStatesAndTerritories `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-add-0 | error | Address | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-add-3 | error | Address.postalCode | Postal code shall be 4 digits : matches('^[0-9]{4}$') |

Differential View

This structure is derived from Address

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Address | C | 0..* | Address | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
type | C | 0..1 | code | postal | physical | both
text | C | 0..1 | string | Text representation of the address
line | C | 0..* | string | Street name, number, direction & P.O. Box etc.
city |  | 0..1 | string | Name of city, town or suburb
state |  | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
postalCode | C | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits
country |  | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Address.state | required | AustralianStatesAndTerritories `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-add-0 | error | Address | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-add-3 | error | Address.postalCode | Postal code shall be 4 digits : matches('^[0-9]{4}$') |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Address | C | 0..* | Address | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ C | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ C | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town or suburb Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
postalCode | Σ C | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits Example General: 9132
country | Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Address.state | required | AustralianStatesAndTerritories `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-add-0 | error | Address | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-add-3 | error | Address.postalCode | Postal code shall be 4 digits : matches('^[0-9]{4}$') |

This structure is derived from Address

Summary

Fixed: 1 element

Extensions

This structure refers to these extensions:

- http://hl7.org.au/fhir/StructureDefinition/address-identifier
- http://hl7.org.au/fhir/StructureDefinition/no-fixed-address

Maturity: 2

Other representations of profile: CSV, Excel, Schematron