HL7 Version 2 to FHIR
1.0.0-ballot - ballot International flag

HL7 Version 2 to FHIR, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2-to-fhir/ and changes regularly. See the Directory of published versions

: Datatype XPN to HumanName Map - XML Representation

Active as of 2024-10-30

Raw xml | Download


<ConceptMap xmlns="http://hl7.org/fhir">
  <id value="datatype-xpn-to-humanname"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: ConceptMap datatype-xpn-to-humanname</b></p><a name="datatype-xpn-to-humanname"> </a><a name="hcdatatype-xpn-to-humanname"> </a><a name="datatype-xpn-to-humanname-en-US"> </a><p>Mapping from XPN to <a href="http://hl7.org/fhir/R4/datatypes.html#HumanName">HumanName</a></p><br/><p><b>Group 1 </b>Mapping from <code>unspecified code system</code> to <code>unspecified code system</code></p><table class="grid"><tr><td><b>Source Code</b></td><td><b>Relationship</b></td><td><b>Target Code</b></td><td><b>Comment</b></td></tr><tr><td>XPN.1 (Family Name)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].family</td><td/></tr><tr><td>XPN.2 (Given Name)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].given[1]</td><td>The requirement for XPN.2 being the first iteration of HumanName.given critical when it's an &quot;official&quot; name</td></tr><tr><td>XPN.3 (Second and Further Given Names or Initials Thereof)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].given[2]</td><td>Consideration must be given if XPN.3 contains multiple names separated by a space. Should these be a single iteration of HumanName.given or is each name an iteration? For example, if XPN.3 is &quot;Mary Anne&quot;, is that one name or two?</td></tr><tr><td>XPN.4 (Suffix (e.g., JR or III))</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].suffix[1]</td><td/></tr><tr><td>XPN.5 (Prefix (e.g., DR))</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].prefix</td><td/></tr><tr><td>XPN.6 (Degree (e.g., MD))</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].suffix[2]</td><td/></tr><tr><td>XPN.7 (Name Type Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].use</td><td/></tr><tr><td>XPN.10 (Name Validity Range)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].period</td><td/></tr><tr><td>XPN.11 (Name Assembly Order)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].extension.url</td><td/></tr><tr><td>XPN.11 (Name Assembly Order)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].extension.valueCode</td><td/></tr><tr><td>XPN.12 (Effective Date)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].period.start</td><td/></tr><tr><td>XPN.13 (Expiration Date)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].period.end</td><td/></tr><tr><td>XPN.14 (Professional Suffix)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[1].suffix[3]</td><td/></tr><tr><td>XPN.15 (Called By)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[2].given</td><td>One possibility is to put this in HumanName.given where HumanName.use=&quot;usual&quot;. When XPN.7 does not map to &quot;usual&quot; a new occurence of Patient.name should be created
Alternative a new extension could be created for HumanName.family.#ext-called-by#\</td></tr><tr><td>XPN.15 (Called By)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>[2].use</td><td/></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/RelatedArtifact">
    <extension url="type">
      <valueCode value="derived-from"/>
    </extension>
    <extension url="label">
      <valueString value="Datatype XPN to HumanName.fsh"/>
    </extension>
    <extension url="url">
      <valueUri
                value="https://docs.google.com/spreadsheets/d/1z8_nsSAHtkBLV0vPQuYJ50lLuh0p3Kv1dAkecl-f7oM/edit#gid=0"/>
    </extension>
  </extension>
  <url value="http://hl7.org/fhir/uv/v2mappings/datatype-xpn-to-humanname"/>
  <version value="1.0.0-ballot"/>
  <name value="DatatypeXPNToHumanName"/>
  <title value="Datatype XPN to HumanName Map"/>
  <status value="active"/>
  <experimental value="true"/>
  <date value="2024-10-30"/>
  <publisher value="HL7 International / Orders and Observations"/>
  <contact>
    <name value="HL7 Orders and Observations Workgroup"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/orders"/>
    </telecom>
  </contact>
  <description
               value="This ConceptMap represents a mapping from the HL7 V2 Datatype XPN to the FHIR HumanName Data Type."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <copyright
             value="Copyright (c) 2020, HL7 International, Inc., All Rights Reserved."/>
  <sourceUri value="XPN"/>
  <targetUri value="HumanName"/>
  <group>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="FN"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.1"/>
      <display value="Family Name"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="string"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="[1].family"/>
        <display value="[1].family"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ST"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.2"/>
      <display value="Given Name"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="string"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="-1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="-1"/>
          </extension>
        </extension>
        <code value="[1].given[1]"/>
        <display value="[1].given[1]"/>
        <equivalence value="equivalent"/>
        <comment
                 value="The requirement for XPN.2 being the first iteration of HumanName.given critical when it's an &quot;official&quot; name"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ST"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.3"/>
      <display value="Second and Further Given Names or Initials Thereof"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="string"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="-1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="-1"/>
          </extension>
        </extension>
        <code value="[1].given[2]"/>
        <display value="[1].given[2]"/>
        <equivalence value="equivalent"/>
        <comment
                 value="Consideration must be given if XPN.3 contains multiple names separated by a space. Should these be a single iteration of HumanName.given or is each name an iteration? For example, if XPN.3 is &quot;Mary Anne&quot;, is that one name or two?"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ST"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.4"/>
      <display value="Suffix (e.g., JR or III)"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="string"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="-1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="-1"/>
          </extension>
        </extension>
        <code value="[1].suffix[1]"/>
        <display value="[1].suffix[1]"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ST"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.5"/>
      <display value="Prefix (e.g., DR)"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="string"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="-1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="-1"/>
          </extension>
        </extension>
        <code value="[1].prefix"/>
        <display value="[1].prefix"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.6"/>
      <display value="Degree (e.g., MD)"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="string"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="-1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="-1"/>
          </extension>
        </extension>
        <code value="[1].suffix[2]"/>
        <display value="[1].suffix[2]"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ID"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.7"/>
      <display value="Name Type Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="code"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="[1].use"/>
        <display value="[1].use"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="DR"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.10"/>
      <display value="Name Validity Range"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="Period"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="[1].period"/>
        <display value="[1].period"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ID"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.11"/>
      <display value="Name Assembly Order"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="uri"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="[1].extension.url"/>
        <display value="[1].extension.url"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ID"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.11"/>
      <display value="Name Assembly Order"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="code"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="[1].extension.valueCode"/>
        <display value="[1].extension.valueCode"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="DTM"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.12"/>
      <display value="Effective Date"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="dateTime"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="[1].period.start"/>
        <display value="[1].period.start"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="DTM"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.13"/>
      <display value="Expiration Date"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="dateTime"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="[1].period.end"/>
        <display value="[1].period.end"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ST"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.14"/>
      <display value="Professional Suffix"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="string"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="-1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="-1"/>
          </extension>
        </extension>
        <code value="[1].suffix[3]"/>
        <display value="[1].suffix[3]"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ST"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.15"/>
      <display value="Called By"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="string"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="-1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="-1"/>
          </extension>
        </extension>
        <code value="[2].given"/>
        <display value="[2].given"/>
        <equivalence value="equivalent"/>
        <comment
                 value="One possibility is to put this in HumanName.given where HumanName.use=&quot;usual&quot;. When XPN.7 does not map to &quot;usual&quot; a new occurence of Patient.name should be created
Alternative a new extension could be created for HumanName.family.#ext-called-by#\"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ST"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="0"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="XPN.15"/>
      <display value="Called By"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="code"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="[2].use"/>
        <display value="[2].use"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
  </group>
</ConceptMap>