Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.9.3: AU Base 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 0]

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.

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

Australian realm Australian Address profile.

This profile builds on Address.

This profile was published on Fri May 05 05:09:53 AEST 2017 as a draft by Health Level Seven Australia (Patient Administration WG).

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

This profile contains the following variations from Address:

  1. zero or more extension sliced
    • at most one noFixedAddress extension
  2. at most one city Name of city, town, suburb, etc.
  3. at most one state Australian state and territory
  4. at most one postalCode
  5. at most one country Australia as a 2 digit ISO 3166 code
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*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 not a fixed address, the type shall be 'physical'
inv-add-2: If not a fixed address, the address text shall begin with 'NO FIXED ADDRESS'
... 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)
... postalCode I0..1stringinv-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..*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 not a fixed address, the type shall be 'physical'
inv-add-2: If not a fixed address, the address text shall begin with 'NO FIXED ADDRESS'
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... no-fixed-address 0..1booleanExtension
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/no-fixed-address"
.... valueBoolean 1..1booleanValue of extension
Fixed Value: true
... 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 Σ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-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}

doco Documentation for this format

This profile contains the following variations from Address:

  1. zero or more extension sliced
    • at most one noFixedAddress extension
  2. at most one city Name of city, town, suburb, etc.
  3. at most one state Australian state and territory
  4. at most one postalCode
  5. at most one country Australia as a 2 digit ISO 3166 code

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*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 not a fixed address, the type shall be 'physical'
inv-add-2: If not a fixed address, the address text shall begin with 'NO FIXED ADDRESS'
... 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)
... postalCode I0..1stringinv-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..*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 not a fixed address, the type shall be 'physical'
inv-add-2: If not a fixed address, the address text shall begin with 'NO FIXED ADDRESS'
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... no-fixed-address 0..1booleanExtension
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/no-fixed-address"
.... valueBoolean 1..1booleanValue of extension
Fixed Value: true
... 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 Σ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-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