Australian Base Profiles Implementation Guide
This page is part of the Australian Base IG (v0.5.0: AU Base 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 
Raw xml
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="au-address"/> <meta> <lastUpdated value="2018-02-20T11:36:39.236+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p>AU Address</p> </div> </text> <url value="http://hl7.org.au/fhir/StructureDefinition/au-address"/> <name value="AUBaseAddress"/> <title value="AU Base Address"/> <status value="draft"/> <date value="2017-05-05T05:09:53+10:00"/> <publisher value="HL7 Australia"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org.au/fhir"/> </telecom> </contact> <description value="Australian Address"/> <fhirVersion value="3.0.1"/> <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="Australian Use Address"/> <definition value="An address profile where validation of elements is desired for an Australian address."/> <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() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="au-address-01"/> <severity value="error"/> <human value="Provision of text or address line is required"/> <expression value="text.exists() or line.exists()"/> </constraint> <constraint> <key value="au-address-02"/> <severity value="error"/> <human value="If country is AU then state shall be in Australian States and Territories valueset"/> <expression value="(country='AU' and state.exists()) implies state in 'http://hl7.org.au/fhir/ValueSet/valueset-au-address-states'"/> </constraint> <constraint> <key value="au-address-03"/> <severity value="error"/> <human value="Postal code for Australian address must be 4 digits"/> <expression value="(country='AU' and postalCode.exists()) implies postalCode.matches('^\\d{4}$')"/> </constraint> <constraint> <key value="au-address-05"/> <severity value="error"/> <human value="When noFixedAddress is present and 'true' then the Address.type must be equal to 'physical'"/> <expression value="extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress' and value=true).exists() implies type='physical'"/> </constraint> <constraint> <key value="au-address-06"/> <severity value="error"/> <human value="When noFixedAddress is present and 'true' then the Address.text must start with 'NO FIXED ADDRESS'"/> <expression value="extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress').exists() implies text.startsWith('NO FIXED ADDRESS')"/> </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> <type> <code value="Extension"/> <profile value="http://hl7.org.au/fhir/StructureDefinition/no-fixed-address"/> </type> <isModifier value="false"/> </element> <element id="Address.extension:nofixedaddress.id"> <path value="Address.extension.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:nofixedaddress.extension"> <path value="Address.extension.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="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Address.extension:nofixedaddress.url"> <path value="Address.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comment value="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 value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org.au/fhir/StructureDefinition/no-fixed-address"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Address.extension:nofixedaddress.valueBoolean"> <path value="Address.extension.valueBoolean"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <fixedBoolean value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </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 "Is Modifier" 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 & 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 etc."/> <definition value="The name of the city, town, village 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 'county' 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 when country is AU"/> <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"/> <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="Prefer 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> <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="IVL<TS>"]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> </snapshot> <differential> <element id="Address"> <path value="Address"/> <short value="Australian Use Address"/> <definition value="An address profile where validation of elements is desired for an Australian address."/> <constraint> <key value="au-address-01"/> <severity value="error"/> <human value="Provision of text or address line is required"/> <expression value="text.exists() or line.exists()"/> </constraint> <constraint> <key value="au-address-02"/> <severity value="error"/> <human value="If country is AU then state shall be in Australian States and Territories valueset"/> <expression value="(country='AU' and state.exists()) implies state in 'http://hl7.org.au/fhir/ValueSet/valueset-au-address-states'"/> </constraint> <constraint> <key value="au-address-03"/> <severity value="error"/> <human value="Postal code for Australian address must be 4 digits"/> <expression value="(country='AU' and postalCode.exists()) implies postalCode.matches('^\\d{4}$')"/> </constraint> <constraint> <key value="au-address-05"/> <severity value="error"/> <human value="When noFixedAddress is present and 'true' then the Address.type must be equal to 'physical'"/> <expression value="extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress' and value=true).exists() implies type='physical'"/> </constraint> <constraint> <key value="au-address-06"/> <severity value="error"/> <human value="When noFixedAddress is present and 'true' then the Address.text must start with 'NO FIXED ADDRESS'"/> <expression value="extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress').exists() implies text.startsWith('NO FIXED ADDRESS')"/> </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"/> <short value="No Fixed Address Flag"/> <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> <type> <code value="Extension"/> <profile value="http://hl7.org.au/fhir/StructureDefinition/no-fixed-address"/> </type> <isModifier value="false"/> </element> <element id="Address.state"> <path value="Address.state"/> <short value="Australian State and Territory when country is AU"/> </element> <element id="Address.country"> <path value="Address.country"/> <short value="Prefer 2 digit ISO 3166 code"/> <definition value="fixed value if present otherwise assumed to be Australia in this context"/> </element> </differential> </StructureDefinition>
AU Base © FHIR STU3 (IG Publisher v3.0.1-11917) generated on Mon, Mar 12, 2018 22:39+1100. |
