AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Data Type Profile: Australian Address

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.

Usages:

• Use this DataType Profile: AU Base Location, AU Base Organization, AU Base Patient, AU Base Practitioner and AU Base RelatedPerson

You can also check for usages in the FHIR IG Statistics

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    Filter: Bindings Constraints Obligations
Address	C	0..*	Address	An address in Australia for use within an Australian healthcare context Constraints: inv-add-0, inv-add-1, inv-add-2
Address.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
Address.Slices for extension.extension:identifier.value[x]		1..1	Identifier , AUDeliveryPointIdentifier , AUGNAFIdentifier	Address identifier
Address.Slices for extension.extension:noFixedAddress	C	0..1	boolean	No fixed address indicator URL: http://hl7.org/fhir/StructureDefinition/no-fixed-address
Address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Address.type	Σ This element is included in summaries. C	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Address.text	Σ This element is included in summaries. C	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Address.line	Σ This element is included in summaries. 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
Address.city	Σ This element is included in summaries.	0..1	string	Name of city, town or suburb Example General: Erewhon
Address.state	Σ This element is included in summaries.	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
Address.postalCode	Σ This element is included in summaries. C	0..1	string	Postal code for area Constraints: inv-add-3 Example General: 9132
Address.country	Σ This element is included in summaries.	0..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Address.state	Base	required	Australian States and Territories	⏿2.0.2	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
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/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/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    Filter: Bindings Constraints Obligations
Address	C	0..*	Address	An address in Australia for use within an Australian healthcare context Constraints: inv-add-0, inv-add-1, inv-add-2
Address.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.value[x]		1..1	Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier	Address identifier
Address.Slices for extension.extension:noFixedAddress	C	0..1	boolean	No fixed address indicator URL: http://hl7.org/fhir/StructureDefinition/no-fixed-address
Address.type	C	0..1	code	postal | physical | both
Address.text	C	0..1	string	Text representation of the address
Address.line	C	0..*	string	Street name, number, direction & P.O. Box etc.
Address.city		0..1	string	Name of city, town or suburb
Address.state		0..1	string	Australian state or territory Binding: Australian States and Territories (required)
Address.postalCode	C	0..1	string	Postal code for area Constraints: inv-add-3
Address.country		0..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU (no extensions allowed)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Address.state	Base	required	Australian States and Territories	⏿2.0.2	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
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/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/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    Filter: Bindings Constraints Obligations
Address	C	0..*	Address	An address in Australia for use within an Australian healthcare context Constraints: inv-add-0, inv-add-1, inv-add-2
Address.id		0..1	string	Unique id for inter-element referencing
Address.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.id		0..1	string	Unique id for inter-element referencing
Address.Slices for extension.extension:identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Address.Slices for extension.extension:identifier.url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
Address.Slices for extension.extension:identifier.value[x]		1..1	Identifier , AUDeliveryPointIdentifier , AUGNAFIdentifier	Address identifier
Address.Slices for extension.extension:noFixedAddress	C	0..1	boolean	No fixed address indicator URL: http://hl7.org/fhir/StructureDefinition/no-fixed-address
Address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Address.type	Σ This element is included in summaries. C	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Address.text	Σ This element is included in summaries. C	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Address.line	Σ This element is included in summaries. 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
Address.city	Σ This element is included in summaries.	0..1	string	Name of city, town or suburb Example General: Erewhon
Address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Address.state	Σ This element is included in summaries.	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
Address.postalCode	Σ This element is included in summaries. C	0..1	string	Postal code for area Constraints: inv-add-3 Example General: 9132
Address.country	Σ This element is included in summaries.	0..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU (no extensions allowed)
Address.period	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Address.state	Base	required	Australian States and Territories	⏿2.0.2	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
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/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/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/fhir/StructureDefinition/no-fixed-address

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Address	C	0..*	Address	An address in Australia for use within an Australian healthcare context Constraints: inv-add-0, inv-add-1, inv-add-2
Address.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
Address.Slices for extension.extension:identifier.value[x]		1..1	Identifier , AUDeliveryPointIdentifier , AUGNAFIdentifier	Address identifier
Address.Slices for extension.extension:noFixedAddress	C	0..1	boolean	No fixed address indicator URL: http://hl7.org/fhir/StructureDefinition/no-fixed-address
Address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Address.type	Σ This element is included in summaries. C	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Address.text	Σ This element is included in summaries. C	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Address.line	Σ This element is included in summaries. 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
Address.city	Σ This element is included in summaries.	0..1	string	Name of city, town or suburb Example General: Erewhon
Address.state	Σ This element is included in summaries.	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
Address.postalCode	Σ This element is included in summaries. C	0..1	string	Postal code for area Constraints: inv-add-3 Example General: 9132
Address.country	Σ This element is included in summaries.	0..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Address.state	Base	required	Australian States and Territories	⏿2.0.2	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
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/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/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    Filter: Bindings Constraints Obligations
Address	C	0..*	Address	An address in Australia for use within an Australian healthcare context Constraints: inv-add-0, inv-add-1, inv-add-2
Address.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.value[x]		1..1	Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier	Address identifier
Address.Slices for extension.extension:noFixedAddress	C	0..1	boolean	No fixed address indicator URL: http://hl7.org/fhir/StructureDefinition/no-fixed-address
Address.type	C	0..1	code	postal | physical | both
Address.text	C	0..1	string	Text representation of the address
Address.line	C	0..*	string	Street name, number, direction & P.O. Box etc.
Address.city		0..1	string	Name of city, town or suburb
Address.state		0..1	string	Australian state or territory Binding: Australian States and Territories (required)
Address.postalCode	C	0..1	string	Postal code for area Constraints: inv-add-3
Address.country		0..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU (no extensions allowed)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Address.state	Base	required	Australian States and Territories	⏿2.0.2	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
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/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/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    Filter: Bindings Constraints Obligations
Address	C	0..*	Address	An address in Australia for use within an Australian healthcare context Constraints: inv-add-0, inv-add-1, inv-add-2
Address.id		0..1	string	Unique id for inter-element referencing
Address.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.id		0..1	string	Unique id for inter-element referencing
Address.Slices for extension.extension:identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Address.Slices for extension.extension:identifier.url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
Address.Slices for extension.extension:identifier.value[x]		1..1	Identifier , AUDeliveryPointIdentifier , AUGNAFIdentifier	Address identifier
Address.Slices for extension.extension:noFixedAddress	C	0..1	boolean	No fixed address indicator URL: http://hl7.org/fhir/StructureDefinition/no-fixed-address
Address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Address.type	Σ This element is included in summaries. C	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Address.text	Σ This element is included in summaries. C	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Address.line	Σ This element is included in summaries. 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
Address.city	Σ This element is included in summaries.	0..1	string	Name of city, town or suburb Example General: Erewhon
Address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Address.state	Σ This element is included in summaries.	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
Address.postalCode	Σ This element is included in summaries. C	0..1	string	Postal code for area Constraints: inv-add-3 Example General: 9132
Address.country	Σ This element is included in summaries.	0..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU (no extensions allowed)
Address.period	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Address.state	Base	required	Australian States and Territories	⏿2.0.2	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
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/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/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/fhir/StructureDefinition/no-fixed-address

Maturity: 2

Other representations of profile: CSV, Excel, Schematron