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 
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.
These definitions, defined as profiles of Identifier, represent common data held in the Address Identifier extension:
Extensions used in this profile:
Potentially useful core extensions:
Non-Australian addresses can be represented using the core Address data type.
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
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.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Address | I | 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 | |
 address-identifier | 0..* | Identifier | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | |
   value[x] | 1..1 | Identifier, DeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation | |
| no-fixed-address | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |
| city | 0..1 | string | Name of city, town or suburb | |
| state | 0..1 | string | Australian state or territory Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required) | |
| postalCode | I | 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | I | 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 | |
| address-identifier | 0..* | Identifier | 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, DeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation | |
| no-fixed-address | 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 | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | Σ | 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: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required) |
| postalCode | ΣI | 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 | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | I | 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 | |
| address-identifier | 0..* | Identifier | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | |
| value[x] | 1..1 | Identifier, DeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation | |
| no-fixed-address | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |
| city | 0..1 | string | Name of city, town or suburb | |
| state | 0..1 | string | Australian state or territory Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required) | |
| postalCode | I | 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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | I | 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 | |
| address-identifier | 0..* | Identifier | 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, DeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation | |
| no-fixed-address | 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 | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | Σ | 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: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required) |
| postalCode | ΣI | 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 | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-address
none defined
© AU Base on FHIR R4
(IG Publisher v4.0.1-a53ec6ee1b) generated on Mon, May 30, 2022 21:52+1000. |
