AU Base Implementation Guide
4.1.0 - Trial Use Australia flag

This page is part of the AU Base Implementation Guide 4.1.0. It is based on FHIR R4. For a full list of available versions, see the Directory of published versions

Data Type Profile: Australian Address

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-address Version: 4.1.0
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:

Usage:

Formal Views of Profile Content

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

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... value[x] 1..1Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... noFixedAddress 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... state 0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode C0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
... country 0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Address.staterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
inv-add-0errorAddressThe address shall at least have text or a line
: text.exists() or line.exists()
inv-add-1errorAddressIf 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-2errorAddressIf 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-3errorAddress.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
.... value[x] 1..1Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... noFixedAddress 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... city Σ0..1stringName of city, town or suburb
Example General: Erewhon
... state Σ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode ΣC0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
Example General: 9132
... country Σ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.staterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-add-0errorAddressThe address shall at least have text or a line
: text.exists() or line.exists()
inv-add-1errorAddressIf 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-2errorAddressIf 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-3errorAddress.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn 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..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
.... value[x] 1..1Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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..1stringName of city, town or suburb
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode ΣC0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
Example General: 9132
... country Σ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.staterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-add-3errorAddress.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')

This structure is derived from Address

Summary

Fixed Value: 1 element

Extensions

This structure refers to these extensions:

Maturity: 2

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... value[x] 1..1Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... noFixedAddress 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... state 0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode C0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
... country 0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Address.staterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
inv-add-0errorAddressThe address shall at least have text or a line
: text.exists() or line.exists()
inv-add-1errorAddressIf 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-2errorAddressIf 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-3errorAddress.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
.... value[x] 1..1Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... noFixedAddress 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... city Σ0..1stringName of city, town or suburb
Example General: Erewhon
... state Σ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode ΣC0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
Example General: 9132
... country Σ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.staterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-add-0errorAddressThe address shall at least have text or a line
: text.exists() or line.exists()
inv-add-1errorAddressIf 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-2errorAddressIf 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-3errorAddress.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn 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..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
.... value[x] 1..1Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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..1stringName of city, town or suburb
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode ΣC0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
Example General: 9132
... country Σ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.staterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-add-3errorAddress.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')

This structure is derived from Address

Summary

Fixed Value: 1 element

Extensions

This structure refers to these extensions:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron