HL7 v2 EI Data Type - XML Representation - HL7 v2+ Specification v0.0.0

HL7 v2+ Specification, published by HL7 International. This guide is not an authorized publication; it is the continuous build for version 0.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2ig/ and changes regularly. See the Directory of published versions
Logical Model: EI - XML Profile

Page standards status: Informative
XML representation of the EI logical model.
Raw xml | Download

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="EI"/>
  <meta>
    <profile
             value="http://hl7.org/v2/StructureDefinition/ComplexDataType-Profile"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition EI</b></p><a name="EI"> </a><a name="hcEI"> </a><a name="EI-en-US"> </a><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="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" 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="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" 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="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" 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="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" 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-EI-definitions.html#EI" title="*Definition:* The entity identifier defines a given entity within a specified series of identifiers.">EI</a><a name="EI"> </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">0..*</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="StructureDefinition-v2-complex-data-type.html">V2ComplexDataType</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">entity identifier<br/><span style="font-weight:bold">Instances of this logical model are not marked to be the target of a Reference</span><br/></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_primitive.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-EI-definitions.html#EI.1">1</a><a name="EI.1"> </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">0..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="StructureDefinition-ST.html">string</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Entity Identifier</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="." style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-EI-definitions.html#EI.2">2</a><a name="EI.2"> </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">0..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="StructureDefinition-IS.html">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">Namespace ID<br/><span style="font-weight:bold">Binding: </span><a href="http://terminology.hl7.org/ValueSet/v2-0363">http://terminology.hl7.org/ValueSet/v2-0363</a> (<a href="http://hl7.org/fhir/R5/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_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_primitive.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-EI-definitions.html#EI.3">3</a><a name="EI.3"> </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">0..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="StructureDefinition-ST.html">string</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Universal ID</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_primitive.png" alt="." style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-EI-definitions.html#EI.4">4</a><a name="EI.4"> </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">0..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="StructureDefinition-ID.html">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">Universal ID Type<br/><span style="font-weight:bold">Binding: </span><a href="http://terminology.hl7.org/6.0.2/ValueSet-v2-0301.html" title="http://terminology.hl7.org/ValueSet/v2-0301">hl7VS-universalIdType</a> (<a href="http://hl7.org/fhir/R5/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="informative">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://somewhere.org/fhir/uv/v2plus/ImplementationGuide/hl7.other.uv.v2plus"/>
      </extension>
    </valueCode>
  </extension>
  <url value="http://hl7.org/v2/StructureDefinition/EI"/>
  <version value="0.0.0"/>
  <name value="EI"/>
  <title value="HL7 v2 EI Data Type"/>
  <status value="active"/>
  <date value="2024-10-31T15:11:23+00:00"/>
  <publisher value="HL7 International"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/Special/committees/v2mgmt"/>
    </telecom>
  </contact>
  <description
               value="The EI is appropriate for, but not limited to, machine or software generated identifiers. The generated identifier goes in the first component. The remaining components, 2 through 4, are known as the assigning authority; they identify the machine/system responsible for generating the identifier in component 1.

The specified series, the assigning authority, is defined by components 2 through 4. The assigning authority is of the hierarchic designator (HD) data type, but it is defined as three separate components in the EI data type, rather than as a single component as would normally be the case. This is in order to maintain backward compatibility with the EI’s use as a component in several existing data fields. Otherwise, the components 2 through 4 are as defined in Section _2A.2.33_, &quot;_HD - hierarchic designator_&quot;. Hierarchic designators (HD) are unique across a given HL7 implementation."/>
  <fhirVersion value="5.0.0"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="http://hl7.org/v2/StructureDefinition/EI"/>
  <baseDefinition
                  value="http://hl7.org/v2/StructureDefinition/v2-complex-data-type"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="EI">
      <path value="EI"/>
      <short value="entity identifier"/>
      <definition
                  value="*Definition:* The entity identifier defines a given entity within a specified series of identifiers."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="EI.1">
      <extension url="http://hl7.org/v2/StructureDefinition/v2-optionality">
        <valueCode value="O"/>
      </extension>
      <extension
                 url="http://hl7.org/v2/StructureDefinition/v2-conformance-length">
        <extension url="length">
          <valueInteger value="199"/>
        </extension>
        <extension url="noTruncate">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <path value="EI.1"/>
      <short value="Entity Identifier"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="EI.1"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/v2/StructureDefinition/ST"/>
      </type>
    </element>
    <element id="EI.2">
      <extension url="http://hl7.org/v2/StructureDefinition/v2-optionality">
        <valueCode value="O"/>
      </extension>
      <extension
                 url="http://hl7.org/v2/StructureDefinition/v2-conformance-length">
        <extension url="length">
          <valueInteger value="20"/>
        </extension>
        <extension url="noTruncate">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <path value="EI.2"/>
      <short value="Namespace ID"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="EI.2"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/v2/StructureDefinition/IS"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v2-0363"/>
      </binding>
    </element>
    <element id="EI.3">
      <extension url="http://hl7.org/v2/StructureDefinition/v2-optionality">
        <valueCode value="C"/>
      </extension>
      <extension
                 url="http://hl7.org/v2/StructureDefinition/v2-conformance-length">
        <extension url="length">
          <valueInteger value="199"/>
        </extension>
        <extension url="noTruncate">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <path value="EI.3"/>
      <short value="Universal ID"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="EI.3"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/v2/StructureDefinition/ST"/>
      </type>
    </element>
    <element id="EI.4">
      <extension url="http://hl7.org/v2/StructureDefinition/v2-optionality">
        <valueCode value="C"/>
      </extension>
      <extension url="http://hl7.org/v2/StructureDefinition/v2-length">
        <extension url="min">
          <valueInteger value="1"/>
        </extension>
        <extension url="max">
          <valueInteger value="6"/>
        </extension>
      </extension>
      <path value="EI.4"/>
      <short value="Universal ID Type"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="EI.4"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/v2/StructureDefinition/ID"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v2-0301"/>
      </binding>
    </element>
  </snapshot>
  <differential>
    <element id="EI">
      <path value="EI"/>
      <short value="entity identifier"/>
      <definition
                  value="*Definition:* The entity identifier defines a given entity within a specified series of identifiers."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element id="EI.1">
      <extension url="http://hl7.org/v2/StructureDefinition/v2-optionality">
        <valueCode value="O"/>
      </extension>
      <extension
                 url="http://hl7.org/v2/StructureDefinition/v2-conformance-length">
        <extension url="length">
          <valueInteger value="199"/>
        </extension>
        <extension url="noTruncate">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <path value="EI.1"/>
      <short value="Entity Identifier"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/v2/StructureDefinition/ST"/>
      </type>
    </element>
    <element id="EI.2">
      <extension url="http://hl7.org/v2/StructureDefinition/v2-optionality">
        <valueCode value="O"/>
      </extension>
      <extension
                 url="http://hl7.org/v2/StructureDefinition/v2-conformance-length">
        <extension url="length">
          <valueInteger value="20"/>
        </extension>
        <extension url="noTruncate">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <path value="EI.2"/>
      <short value="Namespace ID"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/v2/StructureDefinition/IS"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v2-0363"/>
      </binding>
    </element>
    <element id="EI.3">
      <extension url="http://hl7.org/v2/StructureDefinition/v2-optionality">
        <valueCode value="C"/>
      </extension>
      <extension
                 url="http://hl7.org/v2/StructureDefinition/v2-conformance-length">
        <extension url="length">
          <valueInteger value="199"/>
        </extension>
        <extension url="noTruncate">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <path value="EI.3"/>
      <short value="Universal ID"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/v2/StructureDefinition/ST"/>
      </type>
    </element>
    <element id="EI.4">
      <extension url="http://hl7.org/v2/StructureDefinition/v2-optionality">
        <valueCode value="C"/>
      </extension>
      <extension url="http://hl7.org/v2/StructureDefinition/v2-length">
        <extension url="min">
          <valueInteger value="1"/>
        </extension>
        <extension url="max">
          <valueInteger value="6"/>
        </extension>
      </extension>
      <path value="EI.4"/>
      <short value="Universal ID Type"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/v2/StructureDefinition/ID"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v2-0301"/>
      </binding>
    </element>
  </differential>
</StructureDefinition>