Australian Base Implementation Guide (AU Base 1.1.1)

This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-address

AU Base Address Profile [FMM Level 2]

This profile is provided for use in an Australian context where some constraint on content is desirable to guarantee the quality of an Australian address whilst still supporting other uses such as unstructured addresses.

Usage Notes

  • Is for use when representing an Australian (location) address so country is fixed to AU.
  • Is not bound to any elements in this implementation guide directly.
  • Overseas addresses can be represented using the core Address data type.
  • May be used as needed in implementation guide by use cases.
  • Is provided as the best practice guidance on Australian address representation.

Standard extensions for address are available from the STU3 specification at http://hl7.org/fhir/STU3/datatypes-extras.html#address

For example can consider the following for address parts support:

  • Unit http://hl7.org/fhir/STU3/extension-iso21090-adxp-unitid.html
  • House Number http://hl7.org/fhir/STU3/extension-iso21090-adxp-housenumber.html
  • Street Name http://hl7.org/fhir/STU3/extension-iso21090-adxp-streetname.html
  • Street Name Type http://hl7.org/fhir/STU3/extension-iso21090-adxp-streetnametype.html
  • Street Name Base http://hl7.org/fhir/STU3/extension-iso21090-adxp-streetnamebase.html

See more info at : http://hl7.org/fhir/STU3/iso-21090.html

Examples

Postal and work address in Darwin, NT

Level 1, 300 George St, Brisbane, QLD 4000

No fixed address in Melbourne, VIC

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 is provided for use in an Australian context where some constraint on content is desirable to guarantee the quality of an Australian address whilst still supporting other uses such as unstructured addresses.

This profile builds on Address.

This profile was published on Tue Sep 25 00:00:00 AEST 2018 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'
inv-add-3: Postal code shall be 4 digits
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... no-fixed-address 0..1booleanNo fixed address flag
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... city 0..1stringName of city, town, suburb, etc.
... state 0..1stringAustralian state and territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... 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'
inv-add-3: Postal code shall be 4 digits
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... no-fixed-address 0..1booleanNo fixed address flag
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
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, suburb, etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringAustralian state and territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode Σ0..1stringPostal code for area
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-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}

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'
inv-add-3: Postal code shall be 4 digits
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... no-fixed-address 0..1booleanNo fixed address flag
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... city 0..1stringName of city, town, suburb, etc.
... state 0..1stringAustralian state and territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... 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'
inv-add-3: Postal code shall be 4 digits
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... no-fixed-address 0..1booleanNo fixed address flag
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
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, suburb, etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringAustralian state and territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
... postalCode Σ0..1stringPostal code for area
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-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}

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