AU Base Implementation Guide
6.0.0-draft - Draft

Publication Build: This will be filled in by the publication tooling

## Data Type Profile: AustralianAddress - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 2

Definitions for the au-address data type profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

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

0. Address
Definition | An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).
Short | An address in Australia for use within an Australian healthcare context
Invariants | 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
Slicing | This element introduces a set of slices on `Address.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Address.extension:identifier
Slice Name | identifier
Type | Extension(Address Identifier) (Extension Type: Identifier(Identifier))
6. Address.extension:identifier.value[x]
Type | Identifier(Identifier, AU Delivery Point Identifier, AU G-NAF Identifier)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
8. Address.extension:noFixedAddress
Slice Name | noFixedAddress
Control | 0..1 This element is affected by the following invariants: inv-add-1, inv-add-2
Type | Extension(No Fixed Address) (Extension Type: boolean)
10. Address.type
12. Address.text
14. Address.line
16. Address.city
Short | Name of city, town or suburb
18. Address.state
Short | Australian state or territory
Binding | The codes SHALL be taken from Australian States and Territories (required to `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` )
20. Address.postalCode
Invariants | inv-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.
Short | Australia as a 2 digit ISO 3166 code
Fixed Value | `AU`

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

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.
Short | An 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). 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).
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | 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.
Short | ExtensionAdditional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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())
Slicing | This element introduces a set of slices on `Address.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Address.extension:identifier
Slice Name | identifier
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.
Short | Identifier for the address
Control | 0..*
Type | Extension(Address Identifier) (Extension Type: Identifier(Identifier))
Is Modifier | false
Summary | false
Invariants | 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())
6. Address.extension:identifier.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org.au/fhir/StructureDefinition/address-identifier`
8. Address.extension:identifier.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Address identifierValue of extension
Control | 10..1
Type | Identifier(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] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Address.extension:noFixedAddress
Slice Name | noFixedAddress
Definition | No fixed address indicator.
Short | No fixed address indicator
Control | 0..1 This element is affected by the following invariants: inv-add-1, inv-add-2
Type | Extension(No Fixed Address) (Extension Type: boolean)
Is Modifier | false
Summary | false
Invariants | 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())
12. Address.use
Definition | The purpose of this address.
Short | home | 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.
Control | 0..1
Binding | The codes SHALL be taken from AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/address-use|4.0.1` ) The use of an address.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Example | <br/><b>General</b>:home
Invariants | ele-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.
Short | postal | 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). 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).
Control | 0..1 This element is affected by the following invariants: inv-add-1
Binding | The codes SHALL be taken from AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/address-type|4.0.1` ) The type of an address (physical / postal).
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | <br/><b>General</b>:both
Invariants | ele-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.
Short | Text 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.
Control | 0..1 This element is affected by the following invariants: inv-add-0, inv-add-2
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | A renderable, unencoded form.
Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132
Invariants | ele-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.
Short | Street name, number, direction & P.O. Box etc.
Control | 0..* This element is affected by the following invariants: inv-add-0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | <br/><b>General</b>:137 Nowhere Street
Invariants | ele-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.
Short | Name of city, town or suburbName of city, town etc.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Municpality
Example | <br/><b>General</b>:Erewhon
Invariants | ele-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).
Short | Australian state or territorySub-unit of country (abbreviations ok)
Control | 0..1
Binding | The codes SHALL be taken from For codes, see Australian States and Territories (required to `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` )
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Province, Territory
Invariants | ele-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.
Short | Postal code for area
Control | 0..1 This element is affected by the following invariants: inv-add-3
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Zip
Example | <br/><b>General</b>:9132
Invariants | 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}$')`)
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.
Short | Australia 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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Fixed Value | `AU`
Invariants | 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 foundhere

0. Address
Definition | An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).
Short | An 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).
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | 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.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
4. Address.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | 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()`)
Slicing | This element introduces a set of slices on `Address.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Address.extension:identifier
Slice Name | identifier
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.
Short | Identifier for the address
Control | 0..*
Type | Extension(Address Identifier) (Extension Type: Identifier(Identifier))
Is Modifier | false
Summary | false
Invariants | 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()`)
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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
Slicing | This element introduces a set of slices on `Address.extension.extension`. The slices areUnordered and Open, 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.
Short | identifies 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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org.au/fhir/StructureDefinition/address-identifier`
14. Address.extension:identifier.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Address identifier
Control | 1..1
Type | Identifier(Identifier, AU Delivery Point Identifier, AU G-NAF Identifier)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Address.extension:noFixedAddress
Slice Name | noFixedAddress
Definition | No fixed address indicator.
Short | No fixed address indicator
Control | 0..1 This element is affected by the following invariants: inv-add-1, inv-add-2
Type | Extension(No Fixed Address) (Extension Type: boolean)
Is Modifier | false
Summary | false
Invariants | 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()`)
18. Address.use
Definition | The purpose of this address.
Short | home | 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.
Control | 0..1
Binding | The codes SHALL be taken from AddressUse (required to `http://hl7.org/fhir/ValueSet/address-use|4.0.1` ) The use of an address.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Example | <br/><b>General</b>:home
Invariants | ele-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.
Short | postal | 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).
Control | 0..1 This element is affected by the following invariants: inv-add-1
Binding | The codes SHALL be taken from AddressType (required to `http://hl7.org/fhir/ValueSet/address-type|4.0.1` ) The type of an address (physical / postal).
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | <br/><b>General</b>:both
Invariants | ele-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.
Short | Text 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.
Control | 0..1 This element is affected by the following invariants: inv-add-0, inv-add-2
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | A renderable, unencoded form.
Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132
Invariants | ele-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.
Short | Street name, number, direction & P.O. Box etc.
Control | 0..* This element is affected by the following invariants: inv-add-0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | <br/><b>General</b>:137 Nowhere Street
Invariants | ele-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.
Short | Name of city, town or suburb
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Municpality
Example | <br/><b>General</b>:Erewhon
Invariants | ele-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).
Short | District 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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | County
Example | <br/><b>General</b>:Madison
Invariants | ele-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).
Short | Australian state or territory
Control | 0..1
Binding | The codes SHALL be taken from Australian States and Territories (required to `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` )
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Province, Territory
Invariants | ele-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.
Short | Postal code for area
Control | 0..1 This element is affected by the following invariants: inv-add-3
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Zip
Example | <br/><b>General</b>:9132
Invariants | 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}$')`)
34. Address.country
Definition | Fixed value if present otherwise assumed to be Australia in this context.
Short | Australia as a 2 digit ISO 3166 code
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Fixed Value | `AU`
Invariants | ele-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.
Short | Time period when address was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Allows addresses to be placed in historical context.
Example | <br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)