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 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
Page standards status: Informative |
<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><p>Mapping from (not specified) to (not specified)</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 colspan="4"><b>Source Concept Details</b></td><td><b>Relationship</b></td><td colspan="2"><b>Target Concept Details</b></td><td><b>Comment</b></td></tr><tr><td colspan="2"><b>Codes</b> from </td><td><b>NarrativeCondition</b></td><td><b>ComputableANTLR</b></td><td/><td colspan="2"><b>Codes</b> from </td><td/></tr><tr><td style="border-right-width: 0px">XPN.1</td><td style="border-left-width: 0px">Family Name</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].family</td><td style="border-left-width: 0px">[1].family</td><td/></tr><tr><td style="border-right-width: 0px">XPN.2</td><td style="border-left-width: 0px">Given Name</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].given[1]</td><td style="border-left-width: 0px">[1].given[1]</td><td>The requirement for XPN.2 being the first iteration of HumanName.given critical when it's an "official" name</td></tr><tr><td style="border-right-width: 0px">XPN.3</td><td style="border-left-width: 0px">Second and Further Given Names or Initials Thereof</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].given[2]</td><td style="border-left-width: 0px">[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 "Mary Anne", is that one name or two?</td></tr><tr><td style="border-right-width: 0px">XPN.4</td><td style="border-left-width: 0px">Suffix (e.g., JR or III)</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].suffix[1]</td><td style="border-left-width: 0px">[1].suffix[1]</td><td/></tr><tr><td style="border-right-width: 0px">XPN.5</td><td style="border-left-width: 0px">Prefix (e.g., DR)</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].prefix</td><td style="border-left-width: 0px">[1].prefix</td><td/></tr><tr><td style="border-right-width: 0px">XPN.6</td><td style="border-left-width: 0px">Degree (e.g., MD)</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].suffix[2]</td><td style="border-left-width: 0px">[1].suffix[2]</td><td/></tr><tr><td style="border-right-width: 0px">XPN.7</td><td style="border-left-width: 0px">Name Type Code</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].use</td><td style="border-left-width: 0px">[1].use</td><td/></tr><tr><td style="border-right-width: 0px">XPN.10</td><td style="border-left-width: 0px">Name Validity Range</td><td/><td>IF XPN.12 NOT VALUED AND XPN.13 NOT VALUED</td><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].period</td><td style="border-left-width: 0px">[1].period</td><td/></tr><tr><td style="border-right-width: 0px">XPN.11</td><td style="border-left-width: 0px">Name Assembly Order</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].extension.url</td><td style="border-left-width: 0px">[1].extension.url</td><td/></tr><tr><td style="border-right-width: 0px">XPN.11</td><td style="border-left-width: 0px">Name Assembly Order</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].extension.valueCode</td><td style="border-left-width: 0px">[1].extension.valueCode</td><td/></tr><tr><td style="border-right-width: 0px">XPN.12</td><td style="border-left-width: 0px">Effective Date</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].period.start</td><td style="border-left-width: 0px">[1].period.start</td><td/></tr><tr><td style="border-right-width: 0px">XPN.13</td><td style="border-left-width: 0px">Expiration Date</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].period.end</td><td style="border-left-width: 0px">[1].period.end</td><td/></tr><tr><td style="border-right-width: 0px">XPN.14</td><td style="border-left-width: 0px">Professional Suffix</td><td/><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[1].suffix[3]</td><td style="border-left-width: 0px">[1].suffix[3]</td><td/></tr><tr><td style="border-right-width: 0px">XPN.15</td><td style="border-left-width: 0px">Called By</td><td>if the resource attribute using the HumanName datatype allows for multiple names</td><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[2].given</td><td style="border-left-width: 0px">[2].given</td><td>One possibility is to put this in HumanName.given where HumanName.use="usual". When XPN.7 does not map to "usual" 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 style="border-right-width: 0px">XPN.15</td><td style="border-left-width: 0px">Called By</td><td>if the resource attribute using the HumanName datatype allows for multiple names</td><td/><td><a href="http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent" title="equivalent">is equivalent to</a></td><td style="border-right-width: 0px">[2].use</td><td style="border-left-width: 0px">[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>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="oo"/>
</extension>
<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://hl7.org/fhir/uv/v2mappings/ImplementationGuide/hl7.fhir.uv.v2mappings"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/uv/v2mappings/ConceptMap/datatype-xpn-to-humanname"/>
<version value="1.0.0"/>
<name value="DatatypeXPNToHumanName"/>
<title value="Datatype XPN to HumanName Map"/>
<status value="active"/>
<experimental value="true"/>
<date value="2025-08-25"/>
<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) 2025, HL7 International, Inc., All Rights Reserved."/>
<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 "official" 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 "Mary Anne", 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 url="mappedVia">
<valueUrl value="ConceptMap/table-hl70200-to-name-use"/>
</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"/>
<dependsOn>
<property value="Computable-ANTLR"/>
<value value="IF XPN.12 NOT VALUED AND XPN.13 NOT VALUED"/>
</dependsOn>
</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 url="assignment">
<valueString
value=""http://hl7.org/fhir/StructureDefinition/humanname-assembly-order""/>
</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 url="mappedVia">
<valueUrl value="ConceptMap/table-hl70444-to-v2-0444"/>
</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="usual". When XPN.7 does not map to "usual" a new occurence of Patient.name should be created
Alternative a new extension could be created for HumanName.family.#ext-called-by#\"/>
<dependsOn>
<property value="Narrative-Condition"/>
<value
value="if the resource attribute using the HumanName datatype allows for multiple names"/>
</dependsOn>
</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 url="assignment">
<valueString value=""nickname""/>
</extension>
</extension>
<code value="[2].use"/>
<display value="[2].use"/>
<equivalence value="equivalent"/>
<dependsOn>
<property value="Narrative-Condition"/>
<value
value="if the resource attribute using the HumanName datatype allows for multiple names"/>
</dependsOn>
</target>
</element>
</group>
</ConceptMap>