Australian Base Implementation Guide (AU Base 1.1.1)

This page is part of the Australian Base IG (v1.1.1: AU Base 1.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

StructureDefinition-au-address

Formats: XML, JSON, Turtle

Raw xml


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="au-address"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Additional information about the element">Description &amp; Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-au-address-definitions.html#Address" title="An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).">Address</a><a name="Address"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: black; null" title="This element has or is affected by some invariants (inv-add-0, inv-add-1, inv-add-2, inv-add-3)">I</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/datatypes.html#Address">Address</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">An address in Australia for use within an Australian healthcare context<br/><span style="font-weight:bold">inv-add-0: </span>The address shall at least have text or a line<br/><span style="font-weight:bold">inv-add-1: </span>If asserting no fixed address, the type shall be 'physical'<br/><span style="font-weight:bold">inv-add-2: </span>If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'<br/><span style="font-weight:bold">inv-add-3: </span>Postal code shall be 4 digits</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck12.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_extension_simple.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Simple Extension" class="hierarchy"/> <a href="StructureDefinition-au-address-definitions.html#Address.extension">extension</a><a name="Address.extension"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/extensibility.html#Extension">Extension</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Slice: </span>Unordered, Open by value:url</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck14.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_slice_item.png" alt="." style="background-color: white; background-color: inherit" title="Slice Item" class="hierarchy"/> <a href="StructureDefinition-au-address-definitions.html#Address.extension:noFixedAddress" title="Extension URL = http://hl7.org.au/fhir/StructureDefinition/no-fixed-address">no-fixed-address</a><a name="Address.extension"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span>..<span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/datatypes.html#boolean">boolean</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">No fixed address flag<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/STU3/StructureDefinition-no-fixed-address.html">http://hl7.org.au/fhir/StructureDefinition/no-fixed-address</a></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-au-address-definitions.html#Address.city" title="The name of the city, town, village, suburb, or other community or delivery center.">city</a><a name="Address.city"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Name of city, town, suburb, etc.</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-au-address-definitions.html#Address.state">state</a><a name="Address.state"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Australian state and territory<br/><span style="font-weight:bold">Binding: </span><a href="https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2">https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-au-address-definitions.html#Address.country" title="Fixed value if present otherwise assumed to be Australia in this context.">country</a><a name="Address.country"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Australia as a 2 digit ISO 3166 code<br/><span style="font-weight:bold">Fixed Value: </span><span style="color: darkgreen">AU</span></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
  </text>
  <url value="http://hl7.org.au/fhir/StructureDefinition/au-address"/>
  <version value="1.1.1"/>
  <name value="AUBaseAddress"/>
  <title value="AU Base Address"/>
  <status value="active"/>
  <date value="2018-09-25T00:00:00+10:00"/>
  <publisher value="Health Level Seven Australia (Patient Administration WG)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org.au/fhir"/>
      <use value="work"/>
    </telecom>
  </contact>
  <description
               value="This profile is provided for use in an Australian context where some constraint on content is desirable to guarantee the quality of an Australian address whilst still supporting     other uses such as unstructured addresses."/>
  <fhirVersion value="3.0.2"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2 Mapping"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <mapping>
    <identity value="servd"/>
    <uri value="http://www.omg.org/spec/ServD/1.0/"/>
    <name value="ServD"/>
  </mapping>
  <mapping>
    <identity value="vcard"/>
    <uri value="http://w3.org/vcard"/>
    <name value="vCard Mapping"/>
  </mapping>
  <kind value="complex-type"/>
  <abstract value="false"/>
  <type value="Address"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Address"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Address">
      <path value="Address"/>
      <short
             value="An address in Australia for use within an Australian healthcare context"/>
      <definition
                  value="An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats)."/>
      <comment
               value="Note: address is for postal addresses, not physical locations."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Address"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <condition value="ele-1"/>
      <constraint>
        <key value="ele-1"/>
        <severity value="error"/>
        <human value="All FHIR elements must have a @value or children"/>
        <expression value="hasValue() | (children().count() &gt; id.count())"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="Element"/>
      </constraint>
      <constraint>
        <key value="inv-add-0"/>
        <severity value="error"/>
        <human value="The address shall at least have text or a line"/>
        <expression value="text.exists() or line.exists()"/>
      </constraint>
      <constraint>
        <key value="inv-add-1"/>
        <severity value="error"/>
        <human
               value="If asserting no fixed address, the type shall be &#39;physical&#39;"/>
        <expression
                    value="extension.where(url=&#39;http://hl7.org.au/fhir/StructureDefinition/no-fixed-address&#39; and value=true).exists() implies type=&#39;physical&#39;"/>
      </constraint>
      <constraint>
        <key value="inv-add-2"/>
        <severity value="error"/>
        <human
               value="If asserting no fixed address, the address text shall begin with &#39;NO FIXED ADDRESS&#39;"/>
        <expression
                    value="extension.where(url=&#39;http://hl7.org.au/fhir/StructureDefinition/no-fixed-address&#39;).exists() implies text.startsWith(&#39;NO FIXED ADDRESS&#39;)"/>
      </constraint>
      <constraint>
        <key value="inv-add-3"/>
        <severity value="error"/>
        <human value="Postal code shall be 4 digits"/>
        <expression
                    value="postalCode.exists() implies postalCode.matches(&#39;^[0-9]{4}$&#39;)"/>
      </constraint>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <map value="XAD"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="AD"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="Address"/>
      </mapping>
    </element>
    <element id="Address.id">
      <path value="Address.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition
                  value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Element.id"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Address.extension">
      <path value="Address.extension"/>
      <slicing>
        <discriminator>
          <type value="value"/>
          <path value="url"/>
        </discriminator>
        <description value="Extensions are always sliced by (at least) url"/>
        <rules value="open"/>
      </slicing>
      <short value="Extension"/>
      <definition value="An Extension"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Element.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
    </element>
    <element id="Address.extension:noFixedAddress">
      <path value="Address.extension"/>
      <sliceName value="noFixedAddress"/>
      <short value="No fixed address flag"/>
      <definition value="No fixed address indicator."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Element.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
        <profile
                 value="http://hl7.org.au/fhir/StructureDefinition/no-fixed-address"/>
      </type>
    </element>
    <element id="Address.use">
      <path value="Address.use"/>
      <short value="home | work | temp | old - purpose of this address"/>
      <definition value="The purpose of this address."/>
      <comment
               value="This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old."/>
      <requirements
                    value="Allows an appropriate address to be chosen from a list of many."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Address.use"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <example>
        <label value="General"/>
        <valueCode value="home"/>
      </example>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AddressUse"/>
        </extension>
        <strength value="required"/>
        <description value="The use of an address"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/address-use"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="XAD.7"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="unique(./use)"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./AddressPurpose"/>
      </mapping>
    </element>
    <element id="Address.type">
      <path value="Address.type"/>
      <short value="postal | physical | both"/>
      <definition
                  value="Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Address.type"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <example>
        <label value="General"/>
        <valueCode value="both"/>
      </example>
      <isSummary value="true"/>
      <binding>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AddressType"/>
        </extension>
        <strength value="required"/>
        <description value="The type of an address (physical / postal)"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/address-type"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="XAD.18"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="unique(./use)"/>
      </mapping>
      <mapping>
        <identity value="vcard"/>
        <map value="address type parameter"/>
      </mapping>
    </element>
    <element id="Address.text">
      <path value="Address.text"/>
      <short value="Text representation of the address"/>
      <definition value="A full text representation of the address."/>
      <comment value="Can provide both a text representation and parts."/>
      <requirements value="A renderable, unencoded form."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Address.text"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <example>
        <label value="General"/>
        <valueString value="137 Nowhere Street, Erewhon 9132"/>
      </example>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./formatted"/>
      </mapping>
      <mapping>
        <identity value="vcard"/>
        <map value="address label parameter"/>
      </mapping>
    </element>
    <element id="Address.line">
      <path value="Address.line"/>
      <short value="Street name, number, direction &amp; P.O. Box etc."/>
      <definition
                  value="This component contains the house number, apartment number, street name, street direction,  P.O. Box number, delivery hints, and similar address information."/>
      <requirements value="home | work | temp | old - purpose of this address."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Address.line"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <orderMeaning
                    value="The order in which lines should appear in an address label"/>
      <example>
        <label value="General"/>
        <valueString value="137 Nowhere Street"/>
      </example>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map
             value="XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="AD.part[parttype = AL]"/>
      </mapping>
      <mapping>
        <identity value="vcard"/>
        <map value="street"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./StreetAddress (newline delimitted)"/>
      </mapping>
    </element>
    <element id="Address.city">
      <path value="Address.city"/>
      <short value="Name of city, town, suburb, etc."/>
      <definition
                  value="The name of the city, town, village, suburb, or other community or delivery center."/>
      <alias value="Municpality"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Address.city"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <example>
        <label value="General"/>
        <valueString value="Erewhon"/>
      </example>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XAD.3"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="AD.part[parttype = CTY]"/>
      </mapping>
      <mapping>
        <identity value="vcard"/>
        <map value="locality"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./Jurisdiction"/>
      </mapping>
    </element>
    <element id="Address.district">
      <path value="Address.district"/>
      <short value="District name (aka county)"/>
      <definition value="The name of the administrative area (county)."/>
      <comment
               value="District is sometimes known as county, but in some regions &#39;county&#39; is used in place of city (municipality), so county name should be conveyed in city instead."/>
      <alias value="County"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Address.district"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <example>
        <label value="General"/>
        <valueString value="Madison"/>
      </example>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XAD.9"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="AD.part[parttype = CNT | CPA]"/>
      </mapping>
    </element>
    <element id="Address.state">
      <path value="Address.state"/>
      <short value="Australian state and territory"/>
      <definition
                  value="Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes)."/>
      <alias value="Province"/>
      <alias value="Territory"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Address.state"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference
                     value="https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="XAD.4"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="AD.part[parttype = STA]"/>
      </mapping>
      <mapping>
        <identity value="vcard"/>
        <map value="region"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./Region"/>
      </mapping>
    </element>
    <element id="Address.postalCode">
      <path value="Address.postalCode"/>
      <short value="Postal code for area"/>
      <definition
                  value="A postal code designating a region defined by the postal service."/>
      <alias value="Zip"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Address.postalCode"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <example>
        <label value="General"/>
        <valueString value="9132"/>
      </example>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XAD.5"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="AD.part[parttype = ZIP]"/>
      </mapping>
      <mapping>
        <identity value="vcard"/>
        <map value="code"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./PostalIdentificationCode"/>
      </mapping>
    </element>
    <element id="Address.country">
      <path value="Address.country"/>
      <short value="Australia as a 2 digit ISO 3166 code"/>
      <definition
                  value="Fixed value if present otherwise assumed to be Australia in this context."/>
      <comment
               value="ISO 3166 3 letter codes can be used in place of a full country name."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Address.country"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <fixedString value="AU"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XAD.6"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="AD.part[parttype = CNT]"/>
      </mapping>
      <mapping>
        <identity value="vcard"/>
        <map value="country"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./Country"/>
      </mapping>
    </element>
    <element id="Address.period">
      <path value="Address.period"/>
      <short value="Time period when address was/is in use"/>
      <definition value="Time period when address was/is in use."/>
      <requirements value="Allows addresses to be placed in historical context."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Address.period"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Period"/>
      </type>
      <example>
        <label value="General"/>
        <valuePeriod>
          <start value="2010-03-23T00:00:00+11:00"/>
          <end value="2010-07-01T00:00:00+10:00"/>
        </valuePeriod>
      </example>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XAD.12 / XAD.13 + XAD.14"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./usablePeriod[type=&quot;IVL&lt;TS&gt;&quot;]"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./StartDate and ./EndDate"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Address">
      <path value="Address"/>
      <short
             value="An address in Australia for use within an Australian healthcare context"/>
      <definition
                  value="An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats)."/>
      <constraint>
        <key value="inv-add-0"/>
        <severity value="error"/>
        <human value="The address shall at least have text or a line"/>
        <expression value="text.exists() or line.exists()"/>
      </constraint>
      <constraint>
        <key value="inv-add-1"/>
        <severity value="error"/>
        <human
               value="If asserting no fixed address, the type shall be &#39;physical&#39;"/>
        <expression
                    value="extension.where(url=&#39;http://hl7.org.au/fhir/StructureDefinition/no-fixed-address&#39; and value=true).exists() implies type=&#39;physical&#39;"/>
      </constraint>
      <constraint>
        <key value="inv-add-2"/>
        <severity value="error"/>
        <human
               value="If asserting no fixed address, the address text shall begin with &#39;NO FIXED ADDRESS&#39;"/>
        <expression
                    value="extension.where(url=&#39;http://hl7.org.au/fhir/StructureDefinition/no-fixed-address&#39;).exists() implies text.startsWith(&#39;NO FIXED ADDRESS&#39;)"/>
      </constraint>
      <constraint>
        <key value="inv-add-3"/>
        <severity value="error"/>
        <human value="Postal code shall be 4 digits"/>
        <expression
                    value="postalCode.exists() implies postalCode.matches(&#39;^[0-9]{4}$&#39;)"/>
      </constraint>
    </element>
    <element id="Address.extension">
      <path value="Address.extension"/>
      <slicing>
        <discriminator>
          <type value="value"/>
          <path value="url"/>
        </discriminator>
        <rules value="open"/>
      </slicing>
    </element>
    <element id="Address.extension:noFixedAddress">
      <path value="Address.extension"/>
      <sliceName value="noFixedAddress"/>
      <definition value="No fixed address indicator."/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
        <profile
                 value="http://hl7.org.au/fhir/StructureDefinition/no-fixed-address"/>
      </type>
    </element>
    <element id="Address.city">
      <path value="Address.city"/>
      <short value="Name of city, town, suburb, etc."/>
      <definition
                  value="The name of the city, town, village, suburb, or other community or delivery center."/>
    </element>
    <element id="Address.state">
      <path value="Address.state"/>
      <short value="Australian state and territory"/>
      <binding>
        <strength value="required"/>
        <valueSetUri
                     value="https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2"/>
      </binding>
    </element>
    <element id="Address.country">
      <path value="Address.country"/>
      <short value="Australia as a 2 digit ISO 3166 code"/>
      <definition
                  value="Fixed value if present otherwise assumed to be Australia in this context."/>
      <fixedString value="AU"/>
    </element>
  </differential>
</StructureDefinition>