description: 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.
package_name: hl7.fhir.au.base
derivation: constraint
name: AustralianAddress
type: Address
elements:
  extension:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        identifier:
          match: {url: null}
          schema:
            type: Extension
            url: http://hl7.org.au/fhir/StructureDefinition/address-identifier
            index: 1
            elements:
              value:
                choices: [valueIdentifier]
                index: 3
              valueIdentifier: {type: Identifier, choiceOf: value, index: 4}
        noFixedAddress:
          match: {url: null}
          schema: {type: Extension, url: 'http://hl7.org.au/fhir/StructureDefinition/no-fixed-address', index: 5}
          max: 1
  type: {index: 6}
  text: {index: 7}
  line: {index: 8}
  city: {short: 'Name of city, town or suburb', index: 9}
  state:
    short: Australian state or territory
    binding: {strength: required, valueSet: 'https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2'}
    index: 10
  postalCode:
    constraint:
      inv-add-3: {human: Postal code shall be 4 digits, source: 'http://hl7.org.au/fhir/StructureDefinition/au-address', severity: error, expression: 'matches(''^[0-9]{4}$'')'}
    index: 11
  country:
    short: Australia as a 2 digit ISO 3166 code
    pattern: {type: String, value: AU}
    index: 12
package_version: 4.2.1-preview
extensions:
  identifier:
    url: http://hl7.org.au/fhir/StructureDefinition/address-identifier
    type: Extension
    index: 1
    elements:
      value:
        choices: [valueIdentifier]
        index: 3
      valueIdentifier: {type: Identifier, choiceOf: value, index: 4}
  noFixedAddress: {url: 'http://hl7.org.au/fhir/StructureDefinition/no-fixed-address', max: 1, type: Extension, index: 5}
class: complex-type
kind: complex-type
url: http://hl7.org.au/fhir/StructureDefinition/au-address
base: http://hl7.org/fhir/StructureDefinition/Address
version: 4.2.1-preview