nhsd-address
type: StructureDefinition
node role: treeRoot
id:
  v: nhsd-address
text:
  status:
    v: extensions
  div: Generated Narrative: StructureDefinition nhsd-address Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Address 0..* AustralianAddress An address in Australia for use within an Australian healthcare context. #xD; id 0..0 #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:noFixedAddress 0..0 #xD; extension:addressLine S 1..1 (Complex) Please use address line extension to populate individual address lines URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line #xD; use 0..0 #xD; type 1..1 code Type of address (only 'physical' is supported) Fixed Value: physical #xD; line 0..* string Street name, number, direction & P.O. Box etc. #xD; city 1..1 string Name of city, town or suburb #xD; district 0..0 #xD; state 1..1 string Australian state or territory Binding: Australian States and Territories (extensible) #xD; postalCode 1..1 string Postcode of city, town or suburb #xD; country 1..1 string Australia as a 2 digit ISO 3166 code #xD; period 0..0 #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
url:
  v: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address
version:
  v: 4.0.1
name:
  v: NHSDAddress
title:
  v: NHSD Address
status:
  v: draft
date:
  v: 2022-07-20T18:18:28+11:00
publisher:
  v: Healthdirect Australia
contact:
  name:
    v: Saravanan Shanmugam
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: This profile applies to NHSD to define an address structure, for use in an Australian context, to specifically represent an Australian (location) address.
copyright:
  v: Copyright © 2022 Healthdirect Australia - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: servd
  uri:
    v: http://www.omg.org/spec/ServD/1.0/
  name:
    v: ServD
mapping:
  identity:
    v: vcard
  uri:
    v: http://w3.org/vcard
  name:
    v: vCard Mapping
kind:
  v: complex-type
abstract:
  v: false
type:
  v: Address
base definition:
  v: http://hl7.org.au/fhir/StructureDefinition/au-address
  link: http://hl7.org.au/fhir/StructureDefinition/au-address
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 4.0.0
  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 to specifically represent a (location) address.
    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
        link: http://hl7.org/fhir/StructureDefinition/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
        link: http://hl7.org.au/fhir/StructureDefinition/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
        link: http://hl7.org.au/fhir/StructureDefinition/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
        link: http://hl7.org.au/fhir/StructureDefinition/au-address
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
    mapping:
      identity:
        v: v2
      map:
        v: XAD
    mapping:
      identity:
        v: rim
      map:
        v: AD
    mapping:
      identity:
        v: servd
      map:
        v: Address
  element:
    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: 0
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      extension:
        value: url
      code:
        v: http://hl7.org/fhirpath/System.String

url
v: string

v: false

v: false

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
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
    link: http://hl7.org/fhir/StructureDefinition/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
    link: http://hl7.org/fhir/StructureDefinition/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
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/address-identifier
    link: http://hl7.org.au/fhir/StructureDefinition/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
    link: http://hl7.org/fhir/StructureDefinition/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
    link: http://hl7.org/fhir/StructureDefinition/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
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/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
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
    link: http://hl7.org/fhir/StructureDefinition/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
    link: http://hl7.org/fhir/StructureDefinition/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
    value: url
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed: uri
  v: http://hl7.org.au/fhir/StructureDefinition/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: An identifier intended for computation
definition:
  v: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
  profile:
    v: http://hl7.org/fhir/StructureDefinition/Identifier
    link: http://hl7.org/fhir/StructureDefinition/Identifier
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-deliverypointidentifier
    link: http://hl7.org.au/fhir/StructureDefinition/au-deliverypointidentifier
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-gnafidentifier
    link: http://hl7.org.au/fhir/StructureDefinition/au-gnafidentifier
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
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CX / EI (occasionally, more often EI maps to a resource id or a URL)
mapping:
  identity:
    v: rim
  map:
    v: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
mapping:
  identity:
    v: servd
  map:
    v: Identifier

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: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
    link: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
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
    link: http://hl7.org/fhir/StructureDefinition/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
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.extension:addressLine
path:
  v: Address.extension
slice name:
  v: addressLine
short:
  v: Please use address line extension to populate individual address lines
definition:
  v: Extensions for address lines.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
    link: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
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
    link: http://hl7.org/fhir/StructureDefinition/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
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: true
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: 0
base:
  path:
    v: Address.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: 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
    link: http://hl7.org/fhir/StructureDefinition/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
    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
    link: 4.0
    link: .1
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: Type of address (only 'physical' is supported)
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: 1
max:
  v: 1
base:
  path:
    v: Address.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
fixed: string
  v: physical
example:
  label:
    v: General
  value: code
    v: both
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
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/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
    link: 4.0
    link: .1
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
example:
  label:
    v: General
  value: string
    v: 137 Nowhere Street, Erewhon 9132
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
    link: http://hl7.org/fhir/StructureDefinition/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
order meaning:
  v: The order in which lines should appear in an address label
example:
  label:
    v: General
  value: string
    v: 137 Nowhere Street
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
    link: http://hl7.org/fhir/StructureDefinition/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: 1
max:
  v: 1
base:
  path:
    v: Address.city
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: 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
    link: http://hl7.org/fhir/StructureDefinition/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: 0
base:
  path:
    v: Address.district
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: 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
    link: http://hl7.org/fhir/StructureDefinition/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: 1
max:
  v: 1
base:
  path:
    v: Address.state
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: 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
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: au-nhsd-states-territories
  strength:
    v: extensible
  value set:
    v: http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories
    link: http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories
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: Postcode of city, town or suburb
definition:
  v: A postal code designating a region defined by the postal service.
alias:
  v: Zip
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Address.postalCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value: string
    v: 9132
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
    link: http://hl7.org/fhir/StructureDefinition/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
    link: http://hl7.org.au/fhir/StructureDefinition/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: 1
max:
  v: 1
base:
  path:
    v: Address.country
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: 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
    link: http://hl7.org/fhir/StructureDefinition/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: 0
base:
  path:
    v: Address.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: 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
    link: http://hl7.org/fhir/StructureDefinition/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 to specifically represent a (location) address.
element:
  id:
    v: Address.id
  path:
    v: Address.id
  max:
    v: 0
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:noFixedAddress
  path:
    v: Address.extension
  slice name:
    v: noFixedAddress
  max:
    v: 0
element:
  id:
    v: Address.extension:addressLine
  path:
    v: Address.extension
  slice name:
    v: addressLine
  short:
    v: Please use address line extension to populate individual address lines
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
      link: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
  must support:
    v: true
element:
  id:
    v: Address.use
  path:
    v: Address.use
  max:
    v: 0
element:
  id:
    v: Address.type
  path:
    v: Address.type
  short:
    v: Type of address (only 'physical' is supported)
  min:
    v: 1
  fixed: string
    v: physical
element:
  id:
    v: Address.line
  path:
    v: Address.line
  min:
    v: 0
element:
  id:
    v: Address.city
  path:
    v: Address.city
  min:
    v: 1
element:
  id:
    v: Address.district
  path:
    v: Address.district
  max:
    v: 0
element:
  id:
    v: Address.state
  path:
    v: Address.state
  min:
    v: 1
  type:
    code:
      v: string
  binding:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      value: string
        v: au-nhsd-states-territories
    strength:
      v: extensible
    value set:
      v: http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories
      link: http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories
element:
  id:
    v: Address.postalCode
  path:
    v: Address.postalCode
  short:
    v: Postcode of city, town or suburb
  min:
    v: 1
element:
  id:
    v: Address.country
  path:
    v: Address.country
  min:
    v: 1
element:
  id:
    v: Address.period
  path:
    v: Address.period
  max:
    v: 0