Australian Base Implementation Guide
This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions 
Raw xml
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="au-ihi"/>
<text>
<status value="extensions"/>
<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/R4/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/R4/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/R4/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/R4/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/R4/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/R4/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/R4/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-ihi-definitions.html#Identifier" title="Individual Healthcare Identifier (IHI) assigned under the HI Service to a patient.">Identifier</a><a name="Identifier"> </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-ihi-value-0, inv-ihi-value-1, inv-ihi-value-2)">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.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</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/R4/datatypes.html#Identifier">Identifier</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Individual Healthcare Identifier (IHI)<br/><span style="font-weight:bold">inv-ihi-value-0: </span>IHI shall be an exactly 16 digit number<br/><span style="font-weight:bold">inv-ihi-value-1: </span>IHI prefix is 800360<br/><span style="font-weight:bold">inv-ihi-value-2: </span>IHI shall pass the Luhn algorithm check</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-ihi-definitions.html#Identifier.extension">Slices for extension</a><a name="Identifier.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.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</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.5" href="http://hl7.org/fhir/R4/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="opacity: 0.5">Extension</span><br/><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-ihi-definitions.html#Identifier.extension:ihiStatus" title="Extension URL = http://hl7.org.au/fhir/StructureDefinition/ihi-status">ihi-status</a><a name="Identifier.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.5">0</span>..1</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/R4/datatypes.html#Coding">Coding</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="opacity: 0.5">IHI status</span><br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/R4/StructureDefinition-ihi-status.html">http://hl7.org.au/fhir/StructureDefinition/ihi-status</a><br/><span style="font-weight:bold">Binding: </span><a href="https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1">https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1</a> (<a href="http://hl7.org/fhir/R4/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_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: #F7F7F7; background-color: inherit" title="Slice Item" class="hierarchy"/> <a href="StructureDefinition-au-ihi-definitions.html#Identifier.extension:ihiRecordStatus" title="Extension URL = http://hl7.org.au/fhir/StructureDefinition/ihi-record-status">ihi-record-status</a><a name="Identifier.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.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/datatypes.html#Coding">Coding</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="opacity: 0.5">IHI record status</span><br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/R4/StructureDefinition-ihi-record-status.html">http://hl7.org.au/fhir/StructureDefinition/ihi-record-status</a><br/><span style="font-weight:bold">Binding: </span><a href="https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1">https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1</a> (<a href="http://hl7.org/fhir/R4/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: 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-ihi-definitions.html#Identifier.extension:ihiVerifiedDate" title="Extension URL = http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date">ihi-verified-date</a><a name="Identifier.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.5">0</span>..1</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/R4/datatypes.html#dateTime">dateTime</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="opacity: 0.5">IHI Verification Date</span><br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/R4/StructureDefinition-ihi-verified-date.html">http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date</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_bck11.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-ihi-definitions.html#Identifier.type">type</a><a name="Identifier.type"> </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">1..<span style="opacity: 0.5">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.5" href="http://hl7.org/fhir/R4/datatypes.html#CodeableConcept">CodeableConcept</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="opacity: 0.5">Description of identifier</span><br/><span style="font-weight:bold">Required Pattern: </span><span style="color: darkgreen">At least the following</span></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_bck101.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_fixed.gif" alt="." style="background-color: white; background-color: inherit" title="Fixed Value" class="hierarchy"/> <a href="http://hl7.org/fhir/R4/datatypes-definitions.html#CodeableConcept.coding">coding</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">1..*</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/R4/datatypes.html#Coding">Coding</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Code defined by a terminology system<br/><span style="font-weight: bold">Fixed Value: </span><span style="color: darkgreen">(complex)</span></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_bck1010.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_fixed.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Fixed Value" class="hierarchy"/> <a href="http://hl7.org/fhir/R4/datatypes-definitions.html#Coding.system">system</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">1..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Identity of the terminology system<br/><span style="font-weight: bold">Fixed Value: </span><a style="color: darkgreen" href="http://terminology.hl7.org/3.1.0/CodeSystem-v2-0203.html">http://terminology.hl7.org/CodeSystem/v2-0203</a></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_bck1000.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_fixed.gif" alt="." style="background-color: white; background-color: inherit" title="Fixed Value" class="hierarchy"/> <a href="http://hl7.org/fhir/R4/datatypes-definitions.html#Coding.code">code</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">1..1</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/R4/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Symbol in syntax defined by the system<br/><span style="font-weight: bold">Fixed Value: </span><span style="color: darkgreen">NI</span></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-ihi-definitions.html#Identifier.system">system</a><a name="Identifier.system"> </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">1..<span style="opacity: 0.5">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.5" href="http://hl7.org/fhir/R4/datatypes.html#uri">uri</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="opacity: 0.5">The namespace for the identifier value</span><br/><span style="font-weight:bold">Fixed Value: </span><span style="color: darkgreen">http://ns.electronichealth.net.au/id/hi/ihi/1.0</span></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_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: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-au-ihi-definitions.html#Identifier.value">value</a><a name="Identifier.value"> </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">1..<span style="opacity: 0.5">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.5" href="http://hl7.org/fhir/R4/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">IHI<br/><span style="font-weight:bold">Example IHI: </span><span style="color: darkgreen">8003608833357361</span><br/><span style="font-weight:bold">Max Length: </span><span style="color: darkgreen">16</span></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/R4/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/R4/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-ihi"/>
<version value="4.0.0"/>
<name value="AUIHI"/>
<title value="AU IHI"/>
<status value="active"/>
<date value="2022-04-03"/>
<publisher value="Health Level Seven Australia (Patient Administration WG)"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://hl7.com.au"/>
<use value="work"/>
</telecom>
</contact>
<description
value="This identifier profile defines an Individual Healthcare Identifier (IHI) in an Australian context."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="AU"/>
<display value="Australia"/>
</coding>
</jurisdiction>
<copyright
value="HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved."/>
<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>
<kind value="complex-type"/>
<abstract value="false"/>
<type value="Identifier"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Identifier"/>
<derivation value="constraint"/>
<snapshot>
<element id="Identifier">
<path value="Identifier"/>
<short value="Individual Healthcare Identifier (IHI)"/>
<definition
value="Individual Healthcare Identifier (IHI) assigned under the HI Service to a patient."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Identifier"/>
<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>
<constraint>
<key value="inv-ihi-value-0"/>
<severity value="error"/>
<human value="IHI shall be an exactly 16 digit number"/>
<expression value="value.matches('^([0-9]{16})$')"/>
<source value="http://hl7.org.au/fhir/StructureDefinition/au-ihi"/>
</constraint>
<constraint>
<key value="inv-ihi-value-1"/>
<severity value="error"/>
<human value="IHI prefix is 800360"/>
<expression value="value.startsWith('800360')"/>
<source value="http://hl7.org.au/fhir/StructureDefinition/au-ihi"/>
</constraint>
<constraint>
<key value="inv-ihi-value-2"/>
<severity value="error"/>
<human value="IHI shall pass the Luhn algorithm check"/>
<expression
value="(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)"/>
<source value="http://hl7.org.au/fhir/StructureDefinition/au-ihi"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
<mapping>
<identity value="v2"/>
<map
value="CX / EI (occasionally, more often EI maps to a resource id or a URL)"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="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>
<mapping>
<identity value="servd"/>
<map value="Identifier"/>
</mapping>
</element>
<element id="Identifier.id">
<path value="Identifier.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="Identifier.extension">
<path value="Identifier.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>
<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="Identifier.extension:ihiStatus">
<path value="Identifier.extension"/>
<sliceName value="ihiStatus"/>
<short value="IHI status"/>
<definition value="IHI number status associated with an IHI identifier."/>
<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/ihi-status"/>
</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="Identifier.extension:ihiRecordStatus">
<path value="Identifier.extension"/>
<sliceName value="ihiRecordStatus"/>
<short value="IHI record status"/>
<definition
value="Known IHI record status associated with an IHI identifier."/>
<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/ihi-record-status"/>
</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="Identifier.extension:ihiVerifiedDate">
<path value="Identifier.extension"/>
<sliceName value="ihiVerifiedDate"/>
<short value="IHI Verification Date"/>
<definition
value="The date, and optionally time, that the IHI was verified with HI Services."/>
<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/ihi-verified-date"/>
</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="Identifier.use">
<path value="Identifier.use"/>
<short value="usual | official | temp | secondary | old (If known)"/>
<definition value="The purpose of this identifier."/>
<comment
value="Applications can assume that an identifier is permanent unless it explicitly says that it is temporary."/>
<requirements
value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.use"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="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>
<isModifier value="true"/>
<isModifierReason
value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one."/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierUse"/>
</extension>
<strength value="required"/>
<description
value="Identifies the purpose for this identifier, if known ."/>
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="N/A"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Role.code or implied by context"/>
</mapping>
</element>
<element id="Identifier.type">
<path value="Identifier.type"/>
<short value="Description of identifier"/>
<definition
value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose."/>
<comment
value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type."/>
<requirements
value="Allows users to make use of identifiers when the identifier system is not known."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Identifier.type"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<patternCodeableConcept>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="NI"/>
</coding>
</patternCodeableConcept>
<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="IdentifierType"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true"/>
</extension>
<strength value="extensible"/>
<description
value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."/>
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-type"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="CX.5"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Role.code or implied by context"/>
</mapping>
</element>
<element id="Identifier.system">
<path value="Identifier.system"/>
<short value="The namespace for the identifier value"/>
<definition
value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique."/>
<comment value="Identifier.system is always case sensitive."/>
<requirements
value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Identifier.system"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<fixedUri value="http://ns.electronichealth.net.au/id/hi/ihi/1.0"/>
<example>
<label value="General"/>
<valueUri value="http://www.acme.com/identifiers/patient"/>
</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="CX.4 / EI-2-4"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="II.root or Role.id.root"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./IdentifierType"/>
</mapping>
</element>
<element id="Identifier.value">
<path value="Identifier.value"/>
<short value="IHI"/>
<definition
value="The portion of the identifier typically relevant to the user and which is unique within the context of the system."/>
<comment
value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Identifier.value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<example>
<label value="General"/>
<valueString value="123456"/>
</example>
<example>
<label value="IHI"/>
<valueString value="8003608833357361"/>
</example>
<maxLength value="16"/>
<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="CX.1 / EI.1"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./Value"/>
</mapping>
</element>
<element id="Identifier.period">
<path value="Identifier.period"/>
<short value="Time period when id is/was valid for use"/>
<definition
value="Time period during which identifier is/was valid for use."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.period"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Period"/>
</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="CX.7 + CX.8"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Role.effectiveTime or implied by context"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./StartDate and ./EndDate"/>
</mapping>
</element>
<element id="Identifier.assigner">
<path value="Identifier.assigner"/>
<short value="Organization that issued id (may be just text)"/>
<definition value="Organization that issued/manages the identifier."/>
<comment
value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.assigner"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Organization"/>
</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="CX.4 / (CX.4,CX.9,CX.10)"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./IdentifierIssuingAuthority"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="Identifier">
<path value="Identifier"/>
<short value="Individual Healthcare Identifier (IHI)"/>
<definition
value="Individual Healthcare Identifier (IHI) assigned under the HI Service to a patient."/>
<constraint>
<key value="inv-ihi-value-0"/>
<severity value="error"/>
<human value="IHI shall be an exactly 16 digit number"/>
<expression value="value.matches('^([0-9]{16})$')"/>
<source value="http://hl7.org.au/fhir/StructureDefinition/au-ihi"/>
</constraint>
<constraint>
<key value="inv-ihi-value-1"/>
<severity value="error"/>
<human value="IHI prefix is 800360"/>
<expression value="value.startsWith('800360')"/>
<source value="http://hl7.org.au/fhir/StructureDefinition/au-ihi"/>
</constraint>
<constraint>
<key value="inv-ihi-value-2"/>
<severity value="error"/>
<human value="IHI shall pass the Luhn algorithm check"/>
<expression
value="(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)"/>
<source value="http://hl7.org.au/fhir/StructureDefinition/au-ihi"/>
</constraint>
</element>
<element id="Identifier.extension">
<path value="Identifier.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<rules value="open"/>
</slicing>
</element>
<element id="Identifier.extension:ihiStatus">
<path value="Identifier.extension"/>
<sliceName value="ihiStatus"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile value="http://hl7.org.au/fhir/StructureDefinition/ihi-status"/>
</type>
</element>
<element id="Identifier.extension:ihiRecordStatus">
<path value="Identifier.extension"/>
<sliceName value="ihiRecordStatus"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org.au/fhir/StructureDefinition/ihi-record-status"/>
</type>
</element>
<element id="Identifier.extension:ihiVerifiedDate">
<path value="Identifier.extension"/>
<sliceName value="ihiVerifiedDate"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date"/>
</type>
</element>
<element id="Identifier.type">
<path value="Identifier.type"/>
<min value="1"/>
<patternCodeableConcept>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="NI"/>
</coding>
</patternCodeableConcept>
</element>
<element id="Identifier.system">
<path value="Identifier.system"/>
<min value="1"/>
<fixedUri value="http://ns.electronichealth.net.au/id/hi/ihi/1.0"/>
</element>
<element id="Identifier.value">
<path value="Identifier.value"/>
<short value="IHI"/>
<min value="1"/>
<example>
<label value="IHI"/>
<valueString value="8003608833357361"/>
</example>
<maxLength value="16"/>
</element>
</differential>
</StructureDefinition>
© AU Base on FHIR R4
(IG Publisher v4.0.1-a53ec6ee1b) generated on Mon, May 30, 2022 21:52+1000. |
