AU Base Implementation Guide
4.1.1-preview - Preview Australia flag

This page is part of the AU Base Implementation Guide 4.1.1-preview 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.

1. 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.

InvariantsDefined on this element
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
SlicingThis element introduces a set of slices on Address.extension. The slices are and , and can be differentiated using the following discriminators:
  • @
3. Address.extension:identifier
SliceNameidentifier
Control0..?
TypeExtension(AddressIdentifier) (Extension Type: Identifier(Identifier))
4. Address.extension:identifier.value[x]
Control0..?
TypeIdentifier(Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier)
[x] NoteSee Choice of Data Types for further information about how to use [x]
5. Address.extension:noFixedAddress
SliceNamenoFixedAddress
Control0..1 This element is affected by the following invariants: inv-add-1, inv-add-2
TypeExtension(NoFixedAddress) (Extension Type: boolean)
6. Address.type
Control This element is affected by the following invariants: inv-add-1
7. Address.text
Control This element is affected by the following invariants: inv-add-0, inv-add-2
8. Address.line
Control This element is affected by the following invariants: inv-add-0
9. Address.city
10. Address.state
BindingThe codes SHALL be taken from https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2For codes, see (unbound)
11. Address.postalCode
Control This element is affected by the following invariants: inv-add-3
InvariantsDefined on this element
inv-add-3: Postal code shall be 4 digits (: matches('^[0-9]{4}$'))
12. Address.country
Definition

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

Country - a nation as commonly understood or generally accepted.

Fixed ValueAU

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

1. 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.

Control0..* This element is affected by the following invariants: ele-1
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).

InvariantsDefined on this element
ele-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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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:
  • value @ url
3. Address.extension:identifier
SliceNameidentifier
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.

Control0..*
TypeExtension(AddressIdentifier) (Extension Type: Identifier(Identifier))
Summaryfalse
InvariantsDefined on this element
ele-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())
4. Address.extension:identifier.url
Definition

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

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

Fixed Valuehttp://hl7.org.au/fhir/StructureDefinition/address-identifier
5. 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).

Control10..1 This element is affected by the following invariants: ele-1
TypeChoice of: Identifier(Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier), 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]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Address.extension:noFixedAddress
SliceNamenoFixedAddress
Definition

No fixed address indicator.

Control0..1 This element is affected by the following invariants: inv-add-1, inv-add-2
TypeExtension(NoFixedAddress) (Extension Type: boolean)
Summaryfalse
InvariantsDefined on this element
ele-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())
7. Address.use
Definition

The purpose of this address.

Control0..1
BindingThe codes SHALL be taken from AddressUse

The use of an address.

Typecode
Is Modifiertrue
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.

Comments

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

Example
General:home
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. 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.

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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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).

Example
General:both
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. 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.

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

A renderable, unencoded form.

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.

Example
General:137 Nowhere Street, Erewhon 9132
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. 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.

Control0..* This element is affected by the following invariants: inv-add-0
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Address.city
Definition

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

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesMunicpality
Example
General:Erewhon
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. 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).

Control0..1
BindingThe codes SHALL be taken from https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2For codes, see (unbound)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesProvince, Territory
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Address.postalCode
Definition

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

Control0..1 This element is affected by the following invariants: inv-add-3
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesZip
Example
General:9132
InvariantsDefined on this element
ele-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}$'))
14. Address.country
Definition

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

Country - a nation as commonly understood or generally accepted.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

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

Fixed ValueAU
InvariantsDefined on this element
ele-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.

1. Address
Definition

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

Control0..* This element is affected by the following invariants: ele-1
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).

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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
3. Address.extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-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:
  • value @ url
4. Address.extension:identifier
SliceNameidentifier
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.

Control0..*
TypeExtension(AddressIdentifier) (Extension Type: Identifier(Identifier))
Summaryfalse
InvariantsDefined on this element
ele-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())
5. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
6. 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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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:
  • value @ url
7. Address.extension:identifier.url
Definition

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

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

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.

Control1..1 This element is affected by the following invariants: ele-1
TypeIdentifier(Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier)
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Address.extension:noFixedAddress
SliceNamenoFixedAddress
Definition

No fixed address indicator.

Control0..1 This element is affected by the following invariants: inv-add-1, inv-add-2
TypeExtension(NoFixedAddress) (Extension Type: boolean)
Summaryfalse
InvariantsDefined on this element
ele-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())
10. Address.use
Definition

The purpose of this address.

Control0..1
BindingThe codes SHALL be taken from AddressUse The use of an address
Typecode
Is Modifiertrue
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.

Comments

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

Example
General:home
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. 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.

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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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).

Example
General:both
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. 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.

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

A renderable, unencoded form.

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.

Example
General:137 Nowhere Street, Erewhon 9132
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. 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.

Control0..* This element is affected by the following invariants: inv-add-0
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Address.city
Definition

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

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesMunicpality
Example
General:Erewhon
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Address.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesCounty
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.

Example
General:Madison
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. 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).

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

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

Control0..1 This element is affected by the following invariants: inv-add-3
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesZip
Example
General:9132
InvariantsDefined on this element
ele-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}$'))
18. Address.country
Definition

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

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

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

Fixed ValueAU
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Address.period
Definition

Time period when address was/is in use.

Control0..1
TypePeriod
Summarytrue
Requirements

Allows addresses to be placed in historical context.

Example
General:<valuePeriod xmlns="http://hl7.org/fhir">
  <start value="2010-03-23"/>
  <end value="2010-07-01"/>
</valuePeriod>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))