Australian Address - AU Base Implementation Guide v4.2.2-ci-build

AU Base Implementation Guide
4.2.2-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 4.2.2-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

Data Type Profile: Australian Address

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

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

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
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
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'
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x]		1..1	Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier	Address identifier
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
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
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}$')

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
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
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:

Maturity: 2

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
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
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}$')

Key Elements 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'
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x]		1..1	Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier	Address identifier
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
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
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}$')

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
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
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:

Maturity: 2

Other representations of profile: CSV, Excel, Schematron

IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.2.2-ci-build based on FHIR 4.0.1. Generated 2024-11-15
Links: Table of Contents | QA Report | Version History | | Propose a change