AU Base Implementation Guide
5.0.1-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 5.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Data Type Profile: Australian Address

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-address Version: 5.0.1-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AustralianAddress

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

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.

Usage Notes

Profile specific implementation guidance:

  • An international address can be represented using the core Address data type.

Potentially useful extensions:

Usage:

Changes since version 5.0.0:

  • No changes

    • Formal Views of Profile Content

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

    This structure is derived from Address

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Address C 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
    .... extension:identifier 0..* (Complex) Identifier for the address
    URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
    ..... value[x] 1..1 Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier Address identifier
    .... extension:noFixedAddress C 0..1 boolean No fixed address indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
    ... type C 0..1 code postal | physical | both
    ... text C 0..1 string Text representation of the address
    ... city 0..1 string Name of city, town or suburb
    ... state 0..1 string Australian state or territory
    Binding: Australian States and Territories . (required)
    ... postalCode C 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

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Address.staterequiredAustralianStatesAndTerritories .
    https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

    Constraints

    IdGradePath(s)DetailsRequirements
    inv-add-0errorAddressThe address shall at least have text or a line
    : text.exists() or line.exists()
    inv-add-1errorAddressIf asserting no fixed address, the type shall be 'physical'
    : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
    inv-add-2errorAddressIf asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
    : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
    inv-add-3errorAddress.postalCodePostal code shall be 4 digits
    : matches('^[0-9]{4}$')

     

    Other representations of profile: CSV, Excel, Schematron