Australian Base Profiles Implementation Guide

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

Address Profile for Australian Use

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

When the country element is set to the ISO 3166 two digit code AU this explicity asserts an Australian address profile is in use and contraints will be applied to postalCode and state elements.

Examples

  1. Address with minimum required elements.
  2. Address with maximum required elements.
  3. Address with Structured Australian Address.
  4. Address with Structured International Address.
  5. Address with Unstructured Australian Address.
  6. Address with Unstructured International Address.
  7. Address with Australian No Fixed Address.
  8. Address with International No Fixed Address.

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Australian Address

This profile builds on Address.

This profile was published on Fri May 05 05:09:53 AEST 2017 as a draft by HL7 Australia.

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

Address Profile for Australian Use

  1. Base: Address (as Address)
  2. Optional: Address Type (must be ‘physical’ if no fixed address extension is true)
  3. Optional: Address Text (either text or lines required)
  4. Optional: Address Lines (either text or lines required)
  5. Optional: Australian Postcode (require 4 digit numeric code if country is AU)
  6. Optional: Australian State (bound to Australian States and Territories if country is AU)
  7. Optional: Country (2 digit ISO 3166 AU to select Australian address)
  8. Optional: No Fixed Address Extension (explicit no fixed address)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*Australian Use Address
au-address-01: Provision of text or address line is required
au-address-02: If country is AU then state shall be in Australian States and Territories valueset
au-address-03: Postal code for Australian address must be 4 digits
au-address-05: When noFixedAddress is present and 'true' then the Address.type must be equal to 'physical'
au-address-06: When noFixedAddress is present and 'true' then the Address.text must start with 'NO FIXED ADDRESS'
... no-fixed-address 0..1booleanNo Fixed Address Flag
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... state 0..1stringAustralian State and Territory when country is AU
... country 0..1stringPrefer 2 digit ISO 3166 code

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*Australian Use Address
au-address-01: Provision of text or address line is required
au-address-02: If country is AU then state shall be in Australian States and Territories valueset
au-address-03: Postal code for Australian address must be 4 digits
au-address-05: When noFixedAddress is present and 'true' then the Address.type must be equal to 'physical'
au-address-06: When noFixedAddress is present and 'true' then the Address.text must start with 'NO FIXED ADDRESS'
... id 0..1stringxml:id (or equivalent in JSON)
... no-fixed-address 0..1booleanNo Fixed Address Flag
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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 etc.
Example General': Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General': Madison
... state Σ0..1stringAustralian State and Territory when country is AU
... postalCode Σ0..1stringPostal code for area
Example General': 9132
... country Σ0..1stringPrefer 2 digit ISO 3166 code
... 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

Address Profile for Australian Use

  1. Base: Address (as Address)
  2. Optional: Address Type (must be ‘physical’ if no fixed address extension is true)
  3. Optional: Address Text (either text or lines required)
  4. Optional: Address Lines (either text or lines required)
  5. Optional: Australian Postcode (require 4 digit numeric code if country is AU)
  6. Optional: Australian State (bound to Australian States and Territories if country is AU)
  7. Optional: Country (2 digit ISO 3166 AU to select Australian address)
  8. Optional: No Fixed Address Extension (explicit no fixed address)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*Australian Use Address
au-address-01: Provision of text or address line is required
au-address-02: If country is AU then state shall be in Australian States and Territories valueset
au-address-03: Postal code for Australian address must be 4 digits
au-address-05: When noFixedAddress is present and 'true' then the Address.type must be equal to 'physical'
au-address-06: When noFixedAddress is present and 'true' then the Address.text must start with 'NO FIXED ADDRESS'
... no-fixed-address 0..1booleanNo Fixed Address Flag
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
... state 0..1stringAustralian State and Territory when country is AU
... country 0..1stringPrefer 2 digit ISO 3166 code

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*Australian Use Address
au-address-01: Provision of text or address line is required
au-address-02: If country is AU then state shall be in Australian States and Territories valueset
au-address-03: Postal code for Australian address must be 4 digits
au-address-05: When noFixedAddress is present and 'true' then the Address.type must be equal to 'physical'
au-address-06: When noFixedAddress is present and 'true' then the Address.text must start with 'NO FIXED ADDRESS'
... id 0..1stringxml:id (or equivalent in JSON)
... no-fixed-address 0..1booleanNo Fixed Address Flag
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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 etc.
Example General': Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General': Madison
... state Σ0..1stringAustralian State and Territory when country is AU
... postalCode Σ0..1stringPostal code for area
Example General': 9132
... country Σ0..1stringPrefer 2 digit ISO 3166 code
... 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