Australian Base Implementation Guide

This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-address

Australian Address [FMM 2]

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.

Identifiers

These definitions, defined as profiles of Identifier, represent common data held in the Address Identifier extension:

Extensions

Extensions used in this profile:

Potentially useful core extensions:

Usage Notes

Non-Australian addresses can be represented using the core Address data type.

Examples

Postal and work address in Darwin, NT

Level 1, 300 George St, Brisbane, QLD 4000

No fixed address in Melbourne, VIC

Postal address (with DPID and G-NAF Identifier) and work address in Darwin, NT

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-address

This profile defines an address structure that localises core concepts, including identifiers and terminology, for use in an Australian context, to specifically represent an Australian (location) address.

This profile builds on Address.

This profile was published on 2022-03-03 as a active by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressAn 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... address-identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... value[x] 1..1Identifier, DeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... no-fixed-address 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... city 0..1stringName of city, town or suburb
... state 0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode I0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
... country 0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressAn 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..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... address-identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
.... value[x] 1..1Identifier, DeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... no-fixed-address 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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..1stringName of city, town or suburb
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode ΣI0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
Example General: 9132
... country Σ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressAn 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... address-identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... value[x] 1..1Identifier, DeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... no-fixed-address 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... city 0..1stringName of city, town or suburb
... state 0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode I0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
... country 0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressAn 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..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... address-identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
.... value[x] 1..1Identifier, DeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... no-fixed-address 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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..1stringName of city, town or suburb
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode ΣI0..1stringPostal code for area
inv-add-3: Postal code shall be 4 digits
Example General: 9132
... country Σ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-address

none defined

Issues & Feedback