HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
| Active as of 2024-08-12 |
XML representation of the NzAddress data type profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="NzAddress"/>
<text>
<status value="additional"/>
<div xmlns="http://www.w3.org/1999/xhtml">NZ Address datatype profile</div>
</text>
<url value="http://hl7.org.nz/fhir/StructureDefinition/NzAddress"/>
<version value="1.0.0"/>
<name value="NzAddress"/>
<title value="Common NZ Address datatype"/>
<status value="active"/>
<date value="2024-08-12T23:49:44+00:00"/>
<publisher value="HL7 New Zealand"/>
<contact>
<name value="HL7 New Zealand"/>
<telecom>
<system value="email"/>
<value value="mailto:admin@hl7.org.nz"/>
</telecom>
</contact>
<description
value="Adds building name, suburb, domicile code and geocode to the Address datatype"/>
<fhirVersion value="4.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="An address expressed using postal conventions (as opposed to GPS or other location definition formats)"/>
<definition
value="An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world."/>
<comment
value="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](location.html#) resource)."/>
<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() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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="Unique id for inter-element referencing"/>
<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>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<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="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. 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
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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Address.extension:nz-geocode">
<path value="Address.extension"/>
<sliceName value="nz-geocode"/>
<short value="A geocode using the NZ specific datum (reference point)"/>
<definition
value="New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode."/>
<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.nz/fhir/StructureDefinition/nz-geocode"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Address.extension:suburb">
<path value="Address.extension"/>
<sliceName value="suburb"/>
<short value="The suburb part of the address"/>
<definition value="Suburb element of a NZ Address."/>
<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.nz/fhir/StructureDefinition/suburb"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Address.extension:building-name">
<path value="Address.extension"/>
<sliceName value="building-name"/>
<short value="The name of the building"/>
<definition value="The name of a building cited in an address."/>
<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.nz/fhir/StructureDefinition/building-name"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Address.extension:domicile-code">
<path value="Address.extension"/>
<sliceName value="domicile-code"/>
<short value="The domicile code associated with this address"/>
<definition
value="NZ Domicile Code. Derived from a patient's primary physical, home address."/>
<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.nz/fhir/StructureDefinition/domicile-code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Address.extension:country-name">
<path value="Address.extension"/>
<sliceName value="country-name"/>
<short
value="The name of the country. The ISO code should be in the country property"/>
<definition value="The display name for a country in an address."/>
<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.nz/fhir/StructureDefinition/country-name"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Address.use">
<path value="Address.use"/>
<short
value="home | work | temp | old | billing - purpose of this address"/>
<definition value="The purpose of this address."/>
<comment
value="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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one"/>
<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."/>
<valueSet value="http://hl7.org/fhir/ValueSet/address-use|4.0.1"/>
</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."/>
<comment
value="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](location.html#) resource)."/>
<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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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)."/>
<valueSet value="http://hl7.org/fhir/ValueSet/address-type|4.0.1"/>
</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="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
value="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 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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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."/>
<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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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, suburb, 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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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="Sub-unit of country (abbreviations ok)"/>
<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 (e.g. 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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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="Should be the ISO 3166 code"/>
<definition
value="Country - a nation as commonly understood or generally accepted."/>
<comment
value="ISO 3166 3 letter codes can be used in place of a human readable 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>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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-23"/>
<end value="2010-07-01"/>
</valuePeriod>
</example>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<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"/>
</element>
<element id="Address.extension:nz-geocode">
<path value="Address.extension"/>
<sliceName value="nz-geocode"/>
<short value="A geocode using the NZ specific datum (reference point)"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org.nz/fhir/StructureDefinition/nz-geocode"/>
</type>
</element>
<element id="Address.extension:suburb">
<path value="Address.extension"/>
<sliceName value="suburb"/>
<short value="The suburb part of the address"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile value="http://hl7.org.nz/fhir/StructureDefinition/suburb"/>
</type>
</element>
<element id="Address.extension:building-name">
<path value="Address.extension"/>
<sliceName value="building-name"/>
<short value="The name of the building"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org.nz/fhir/StructureDefinition/building-name"/>
</type>
</element>
<element id="Address.extension:domicile-code">
<path value="Address.extension"/>
<sliceName value="domicile-code"/>
<short value="The domicile code associated with this address"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org.nz/fhir/StructureDefinition/domicile-code"/>
</type>
</element>
<element id="Address.extension:country-name">
<path value="Address.extension"/>
<sliceName value="country-name"/>
<short
value="The name of the country. The ISO code should be in the country property"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org.nz/fhir/StructureDefinition/country-name"/>
</type>
</element>
<element id="Address.country">
<path value="Address.country"/>
<short value="Should be the ISO 3166 code"/>
</element>
</differential>
</StructureDefinition>