au-address
type: StructureDefinition
node role: treeRoot
id:
  v: au-address
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition au-address Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Address <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( inv-add-0, inv-add-1, inv-add-2 )">C 0..* Address An address in Australia for use within an Australian healthcare context Constraints: inv-add-0, inv-add-1, inv-add-2 #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:identifier 0..* (Complex) Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier #xD; value[x] 1..1 Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier Address identifier #xD; extension:noFixedAddress <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( inv-add-1, inv-add-2 )">C 0..1 boolean No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address #xD; type C 0..1 code postal | physical | both #xD; text <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element …
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    l: structuredefinition-fmm
  value: Integer
    v: 2
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: trial-use
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Canonical
        v: http://hl7.org.au/fhir/ImplementationGuide/hl7.fhir.au.base
        l: hl7.fhir.au.base
url:
  v: http://hl7.org.au/fhir/StructureDefinition/au-address
  l: au-address
version:
  v: 6.0.0-ci-build
name:
  v: AustralianAddress
title:
  v: Australian Address
status:
  v: active
date:
  v: 2025-12-16T23:57:12+00:00
publisher:
  v: HL7 Australia
contact:
  name:
    v: HL7 Australia FHIR Working Group
  telecom:
    system:
      v: url
    value:
      v: https://confluence.hl7.org/display/HAFWG
    use:
      v: work
description:
  v: 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.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: AU
copyright:
  v: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
    l: v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: servd
  uri:
    v: http://www.omg.org/spec/ServD/1.0/
    l: http://www.omg.org/spec/ServD/1.0/
  name:
    v: ServD
mapping:
  identity:
    v: vcard
  uri:
    v: http://w3.org/vcard
    l: vcard
  name:
    v: vCard Mapping
kind:
  v: complex-type
abstract:
  v: false
type:
  v: Address
  l: Address
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Address
  l: Address
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: Address
    path:
      v: Address
    short:
      v: An address in Australia for use within an Australian healthcare context
    definition:
      v: An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).
    comment:
      v: Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Address
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        l: Element
    constraint:
      key:
        v: inv-add-0
      severity:
        v: error
      human:
        v: The address shall at least have text or a line
      expression:
        v: text.exists() or line.exists()
      source:
        v: http://hl7.org.au/fhir/StructureDefinition/au-address
        l: au-address
    constraint:
      key:
        v: inv-add-1
      severity:
        v: error
      human:
        v: If asserting no fixed address, the type shall be 'physical'
      expression:
        v: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
      source:
        v: http://hl7.org.au/fhir/StructureDefinition/au-address
        l: au-address
    constraint:
      key:
        v: inv-add-2
      severity:
        v: error
      human:
        v: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
      expression:
        v: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
      source:
        v: http://hl7.org.au/fhir/StructureDefinition/au-address
        l: au-address
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
    mapping:
      identity:
        v: v2
      map:
        v: XAD

identity:
  v: rim
map:
  v: AD

identity:
  v: servd
map:
  v: Address

id:
  v: Address.id
path:
  v: Address.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.extension
path:
  v: Address.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.extension:identifier
path:
  v: Address.extension
slice name:
  v: identifier
short:
  v: Identifier for the address
definition:
  v: A unique identifier associated with a location address and may be used to look up an address, validate an address, or link to other data relating to an address.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/address-identifier
    l: address-identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.extension:identifier.id
path:
  v: Address.extension.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.extension:identifier.extension
path:
  v: Address.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.extension:identifier.url
path:
  v: Address.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: uri
      l: uri
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
fixed: Uri
  v: http://hl7.org.au/fhir/StructureDefinition/address-identifier
  l: address-identifier
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.extension:identifier.value[x]
path:
  v: Address.extension.value[x]
short:
  v: Address identifier
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier
  profile:
    v: http://hl7.org/fhir/StructureDefinition/Identifier
    l: Identifier
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-deliverypointidentifier
    l: au-deliverypointidentifier
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-gnafidentifier
    l: au-gnafidentifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.extension:noFixedAddress
path:
  v: Address.extension
slice name:
  v: noFixedAddress
short:
  v: No fixed address indicator
definition:
  v: No fixed address indicator.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
    l: no-fixed-address
condition:
  v: inv-add-1
condition:
  v: inv-add-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.use
path:
  v: Address.use
short:
  v: home | work | temp | old | billing - purpose of this address
definition:
  v: The purpose of this address.
comment:
  v: Applications can assume that an address is current unless it explicitly says that it is temporary or old.
requirements:
  v: Allows an appropriate address to be chosen from a list of many.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
example:
  label:
    v: General
  value: Code
    v: home
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: AddressUse
  strength:
    v: required
  description:
    v: The use of an address.
  value set:
    v: http://hl7.org/fhir/ValueSet/address-use|4.0.1
    l: http://hl7.org/fhir/ValueSet/address-use
mapping:
  identity:
    v: v2
  map:
    v: XAD.7
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./AddressPurpose

id:
  v: Address.type
path:
  v: Address.type
short:
  v: postal | physical | both
definition:
  v: Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
comment:
  v: The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
example:
  label:
    v: General
  value: Code
    v: both
condition:
  v: inv-add-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: AddressType
  strength:
    v: required
  description:
    v: The type of an address (physical / postal).
  value set:
    v: http://hl7.org/fhir/ValueSet/address-type|4.0.1
    l: http://hl7.org/fhir/ValueSet/address-type
mapping:
  identity:
    v: v2
  map:
    v: XAD.18
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: vcard
  map:
    v: address type parameter

id:
  v: Address.text
path:
  v: Address.text
short:
  v: Text representation of the address
definition:
  v: Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
comment:
  v: Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
requirements:
  v: A renderable, unencoded form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: 137 Nowhere Street, Erewhon 9132
condition:
  v: inv-add-0
condition:
  v: inv-add-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
mapping:
  identity:
    v: rim
  map:
    v: ./formatted
mapping:
  identity:
    v: vcard
  map:
    v: address label parameter

id:
  v: Address.line
path:
  v: Address.line
short:
  v: Street name, number, direction & P.O. Box etc.
definition:
  v: This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Address.line
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
    l: string
order meaning:
  v: The order in which lines should appear in an address label
example:
  label:
    v: General
  value: String
    v: 137 Nowhere Street
condition:
  v: inv-add-0
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = AL]
mapping:
  identity:
    v: vcard
  map:
    v: street
mapping:
  identity:
    v: servd
  map:
    v: ./StreetAddress (newline delimitted)

id:
  v: Address.city
path:
  v: Address.city
short:
  v: Name of city, town or suburb
definition:
  v: The name of the city, town, suburb, village or other community or delivery center.
alias:
  v: Municpality
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.city
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: Erewhon
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.3
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CTY]
mapping:
  identity:
    v: vcard
  map:
    v: locality
mapping:
  identity:
    v: servd
  map:
    v: ./Jurisdiction

id:
  v: Address.district
path:
  v: Address.district
short:
  v: District name (aka county)
definition:
  v: The name of the administrative area (county).
comment:
  v: District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
alias:
  v: County
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.district
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: Madison
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.9
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CNT | CPA]

id:
  v: Address.state
path:
  v: Address.state
short:
  v: Australian state or territory
definition:
  v: Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
alias:
  v: Province
alias:
  v: Territory
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.state
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
    l: australian-states-territories-2
mapping:
  identity:
    v: v2
  map:
    v: XAD.4
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = STA]
mapping:
  identity:
    v: vcard
  map:
    v: region
mapping:
  identity:
    v: servd
  map:
    v: ./Region

id:
  v: Address.postalCode
path:
  v: Address.postalCode
short:
  v: Postal code for area
definition:
  v: A postal code designating a region defined by the postal service.
alias:
  v: Zip
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.postalCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: 9132
condition:
  v: inv-add-3
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: inv-add-3
  severity:
    v: error
  human:
    v: Postal code shall be 4 digits
  expression:
    v: matches('^[0-9]{4}$')
  source:
    v: http://hl7.org.au/fhir/StructureDefinition/au-address
    l: au-address
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.5
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = ZIP]
mapping:
  identity:
    v: vcard
  map:
    v: code
mapping:
  identity:
    v: servd
  map:
    v: ./PostalIdentificationCode

id:
  v: Address.country
path:
  v: Address.country
short:
  v: Australia as a 2 digit ISO 3166 code
definition:
  v: Fixed value if present otherwise assumed to be Australia in this context.
comment:
  v: ISO 3166 3 letter codes can be used in place of a human readable country name.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.country
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
fixed: String
  v: AU
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.6
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CNT]
mapping:
  identity:
    v: vcard
  map:
    v: country
mapping:
  identity:
    v: servd
  map:
    v: ./Country

id:
  v: Address.period
path:
  v: Address.period
short:
  v: Time period when address was/is in use
definition:
  v: Time period when address was/is in use.
requirements:
  v: Allows addresses to be placed in historical context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
example:
  label:
    v: General
  value: Period
    start:
      v: 2010-03-23
    end:
      v: 2010-07-01
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.12 / XAD.13 + XAD.14
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

element:
  id:
    v: Address
  path:
    v: Address
  short:
    v: An address in Australia for use within an Australian healthcare context
  definition:
    v: An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).
  constraint:
    key:
      v: inv-add-0
    severity:
      v: error
    human:
      v: The address shall at least have text or a line
    expression:
      v: text.exists() or line.exists()
    source:
      v: http://hl7.org.au/fhir/StructureDefinition/au-address
      l: au-address
  constraint:
    key:
      v: inv-add-1
    severity:
      v: error
    human:
      v: If asserting no fixed address, the type shall be 'physical'
    expression:
      v: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
    source:
      v: http://hl7.org.au/fhir/StructureDefinition/au-address
      l: au-address
  constraint:
    key:
      v: inv-add-2
    severity:
      v: error
    human:
      v: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
    expression:
      v: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
    source:
      v: http://hl7.org.au/fhir/StructureDefinition/au-address
      l: au-address
element:
  id:
    v: Address.extension
  path:
    v: Address.extension
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: url
    rules:
      v: open
element:
  id:
    v: Address.extension:identifier
  path:
    v: Address.extension
  slice name:
    v: identifier
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org.au/fhir/StructureDefinition/address-identifier
      l: address-identifier
element:
  id:
    v: Address.extension:identifier.value[x]
  path:
    v: Address.extension.value[x]
  type:
    code:
      v: Identifier
      l: Identifier
    profile:
      v: http://hl7.org/fhir/StructureDefinition/Identifier
      l: Identifier
    profile:
      v: http://hl7.org.au/fhir/StructureDefinition/au-deliverypointidentifier
      l: au-deliverypointidentifier
    profile:
      v: http://hl7.org.au/fhir/StructureDefinition/au-gnafidentifier
      l: au-gnafidentifier
element:
  id:
    v: Address.extension:noFixedAddress
  path:
    v: Address.extension
  slice name:
    v: noFixedAddress
  max:
    v: 1
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
      l: no-fixed-address
  condition:
    v: inv-add-1
  condition:
    v: inv-add-2
element:
  id:
    v: Address.type
  path:
    v: Address.type
  condition:
    v: inv-add-1
element:
  id:
    v: Address.text
  path:
    v: Address.text
  condition:
    v: inv-add-0
  condition:
    v: inv-add-2
element:
  id:
    v: Address.line
  path:
    v: Address.line
  condition:
    v: inv-add-0
element:
  id:
    v: Address.city
  path:
    v: Address.city
  short:
    v: Name of city, town or suburb
element:
  id:
    v: Address.state
  path:
    v: Address.state
  short:
    v: Australian state or territory
  binding:
    strength:
      v: required
    value set:
      v: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
      l: australian-states-territories-2
element:
  id:
    v: Address.postalCode
  path:
    v: Address.postalCode
  condition:
    v: inv-add-3
  constraint:
    key:
      v: inv-add-3
    severity:
      v: error
    human:
      v: Postal code shall be 4 digits
    expression:
      v: matches('^[0-9]{4}$')
    source:
      v: http://hl7.org.au/fhir/StructureDefinition/au-address
      l: au-address
element:
  id:
    v: Address.country
  path:
    v: Address.country
  short:
    v: Australia as a 2 digit ISO 3166 code
  definition:
    v: Fixed value if present otherwise assumed to be Australia in this context.
  fixed: String
    v: AU