AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

This page is part of the Australian Base IG (v4.1.2-preview: AU Base) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Data Type Profile: AustralianAddress - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the au-address data type profile.

Guidance on how to interpret the contents of this table can be found here

0. Address
Definition

An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).

ShortAn address in Australia for use within an Australian healthcare context
Invariantsinv-add-0: The address shall at least have text or a line (text.exists() or line.exists())
inv-add-1: 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: 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'))
2. Address.extension
SlicingThis element introduces a set of slices on Address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
4. Address.extension:identifier
Slice Nameidentifier
TypeExtension(Address Identifier) (Extension Type: Identifier(Identifier))
6. Address.extension:identifier.value[x]
TypeIdentifier(Identifier, AU Delivery Point Identifier, AU G-NAF Identifier)
[x] NoteSee Choice of Data Types for further information about how to use [x]
8. Address.extension:noFixedAddress
Slice NamenoFixedAddress
Control0..1
This element is affected by the following invariants: inv-add-1, inv-add-2
TypeExtension(No Fixed Address) (Extension Type: boolean)
10. Address.type
12. Address.text
14. Address.line
16. Address.city
ShortName of city, town or suburb
18. Address.state
ShortAustralian state or territory
BindingThe codes SHALL be taken from https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
20. Address.postalCode
Invariantsinv-add-3: Postal code shall be 4 digits (matches('^[0-9]{4}$'))
22. Address.country
Definition

Fixed value if present otherwise assumed to be Australia in this context.

ShortAustralia as a 2 digit ISO 3166 code
Fixed ValueAU

Guidance on how to interpret the contents of this table can be found here

0. Address
Definition

An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).


An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

ShortAn address in Australia for use within an Australian healthcare contextAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Comments

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-add-0: The address shall at least have text or a line (text.exists() or line.exists())
inv-add-1: 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: 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'))
2. Address.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
4. Address.extension:identifier
Slice Nameidentifier
Definition

A unique identifier associated with a location address and may be used to look up an address, validate an address, or link to other data relating to an address.

ShortIdentifier for the address
Control0..*
TypeExtension(Address Identifier) (Extension Type: Identifier(Identifier))
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Address.extension:identifier.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://hl7.org.au/fhir/StructureDefinition/address-identifier
8. Address.extension:identifier.value[x]
Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortAn identifier intended for computationValue of extension
Control10..1
This element is affected by the following invariants: ele-1
TypeIdentifier(Identifier, AU Delivery Point Identifier, AU G-NAF Identifier), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Address.extension:noFixedAddress
Slice NamenoFixedAddress
Definition

No fixed address indicator.

ShortNo fixed address indicator
Control0..1
This element is affected by the following invariants: inv-add-1, inv-add-2
TypeExtension(No Fixed Address) (Extension Type: boolean)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Address.use
Definition

The purpose of this address.

Shorthome | work | temp | old | billing - purpose of this address
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1

The use of an address.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Example<br/><b>General</b>:home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Address.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Shortpostal | physical | both
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..1
This element is affected by the following invariants: inv-add-1
BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1

The type of an address (physical / postal).

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Address.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

ShortText representation of the address
Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
This element is affected by the following invariants: inv-add-0, inv-add-2
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

A renderable, unencoded form.

Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Address.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

ShortStreet name, number, direction & P.O. Box etc.
Control0..*
This element is affected by the following invariants: inv-add-0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Address.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

ShortName of city, town or suburbName of city, town etc.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesMunicpality
Example<br/><b>General</b>:Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Address.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

ShortAustralian state or territorySub-unit of country (abbreviations ok)
Control0..1
BindingThe codes SHALL be taken from For codes, see https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesProvince, Territory
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Address.postalCode
Definition

A postal code designating a region defined by the postal service.

ShortPostal code for area
Control0..1
This element is affected by the following invariants: inv-add-3
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesZip
Example<br/><b>General</b>:9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-add-3: Postal code shall be 4 digits (matches('^[0-9]{4}$'))
26. Address.country
Definition

Fixed value if present otherwise assumed to be Australia in this context.


Country - a nation as commonly understood or generally accepted.

ShortAustralia as a 2 digit ISO 3166 codeCountry (e.g. can be ISO 3166 2 or 3 letter code)
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed ValueAU
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Address
Definition

An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).

ShortAn address in Australia for use within an Australian healthcare context
Comments

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-add-0: The address shall at least have text or a line (text.exists() or line.exists())
inv-add-1: 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: 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'))
2. Address.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Address.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
6. Address.extension:identifier
Slice Nameidentifier
Definition

A unique identifier associated with a location address and may be used to look up an address, validate an address, or link to other data relating to an address.

ShortIdentifier for the address
Control0..*
TypeExtension(Address Identifier) (Extension Type: Identifier(Identifier))
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Address.extension:identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
10. Address.extension:identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Address.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
12. Address.extension:identifier.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://hl7.org.au/fhir/StructureDefinition/address-identifier
14. Address.extension:identifier.value[x]
Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

ShortAn identifier intended for computation
Control1..1
This element is affected by the following invariants: ele-1
TypeIdentifier(Identifier, AU Delivery Point Identifier, AU G-NAF Identifier)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Address.extension:noFixedAddress
Slice NamenoFixedAddress
Definition

No fixed address indicator.

ShortNo fixed address indicator
Control0..1
This element is affected by the following invariants: inv-add-1, inv-add-2
TypeExtension(No Fixed Address) (Extension Type: boolean)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Address.use
Definition

The purpose of this address.

Shorthome | work | temp | old | billing - purpose of this address
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUse: The use of an address.
Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Example<br/><b>General</b>:home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Address.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Shortpostal | physical | both
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..1
This element is affected by the following invariants: inv-add-1
BindingThe codes SHALL be taken from AddressType: The type of an address (physical / postal).
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Address.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

ShortText representation of the address
Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
This element is affected by the following invariants: inv-add-0, inv-add-2
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

A renderable, unencoded form.

Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Address.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

ShortStreet name, number, direction & P.O. Box etc.
Control0..*
This element is affected by the following invariants: inv-add-0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Address.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

ShortName of city, town or suburb
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesMunicpality
Example<br/><b>General</b>:Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Address.district
Definition

The name of the administrative area (county).

ShortDistrict name (aka county)
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesCounty
Example<br/><b>General</b>:Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Address.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

ShortAustralian state or territory
Control0..1
BindingThe codes SHALL be taken from https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesProvince, Territory
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Address.postalCode
Definition

A postal code designating a region defined by the postal service.

ShortPostal code for area
Control0..1
This element is affected by the following invariants: inv-add-3
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesZip
Example<br/><b>General</b>:9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-add-3: Postal code shall be 4 digits (matches('^[0-9]{4}$'))
34. Address.country
Definition

Fixed value if present otherwise assumed to be Australia in this context.

ShortAustralia as a 2 digit ISO 3166 code
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed ValueAU
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Address.period
Definition

Time period when address was/is in use.

ShortTime period when address was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Requirements

Allows addresses to be placed in historical context.

Example<br/><b>General</b>:&lt;valuePeriod&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;start&nbsp;value=&quot;2010-03-23&quot;/&gt;<br/>&nbsp;&nbsp;&lt;end&nbsp;value=&quot;2010-07-01&quot;/&gt;<br/>&lt;/valuePeriod&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))