HL7 Version 2 to FHIR
1.0.0-ballot - ballot
HL7 Version 2 to FHIR
1.0.0-ballot - ballot
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
| Active as of 2024-12-20 |
{
"resourceType" : "ConceptMap",
"id" : "datatype-xpn-to-humanname",
"text" : {
"status" : "generated",
"div" : "<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 "official" 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 "Mary Anne", 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="usual". When XPN.7 does not map to "usual" a new occurence of Patient.name should be created\nAlternative 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>"
},
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "derived-from"
},
{
"url" : "label",
"valueString" : "Datatype XPN to HumanName.fsh"
},
{
"url" : "url",
"valueUri" : "https://docs.google.com/spreadsheets/d/1z8_nsSAHtkBLV0vPQuYJ50lLuh0p3Kv1dAkecl-f7oM/edit#gid=0"
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/RelatedArtifact"
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/datatype-xpn-to-humanname",
"version" : "1.0.0-ballot",
"name" : "DatatypeXPNToHumanName",
"title" : "Datatype XPN to HumanName Map",
"status" : "active",
"experimental" : true,
"date" : "2024-12-20",
"publisher" : "HL7 International / Orders and Observations",
"contact" : [
{
"name" : "HL7 Orders and Observations Workgroup",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders"
}
]
}
],
"description" : "This ConceptMap represents a mapping from the HL7 V2 Datatype XPN to the FHIR HumanName Data Type.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"copyright" : "Copyright (c) 2020, HL7 International, Inc., All Rights Reserved.",
"sourceUri" : "XPN",
"targetUri" : "HumanName",
"group" : [
{
"element" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "FN"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.1",
"display" : "Family Name",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "string"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].family",
"display" : "[1].family",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ST"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.2",
"display" : "Given Name",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "string"
},
{
"url" : "cardinalityMin",
"valueInteger" : -1
},
{
"url" : "cardinalityMax",
"valueInteger" : -1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].given[1]",
"display" : "[1].given[1]",
"equivalence" : "equivalent",
"comment" : "The requirement for XPN.2 being the first iteration of HumanName.given critical when it's an \"official\" name"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ST"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.3",
"display" : "Second and Further Given Names or Initials Thereof",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "string"
},
{
"url" : "cardinalityMin",
"valueInteger" : -1
},
{
"url" : "cardinalityMax",
"valueInteger" : -1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].given[2]",
"display" : "[1].given[2]",
"equivalence" : "equivalent",
"comment" : "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?"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ST"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.4",
"display" : "Suffix (e.g., JR or III)",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "string"
},
{
"url" : "cardinalityMin",
"valueInteger" : -1
},
{
"url" : "cardinalityMax",
"valueInteger" : -1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].suffix[1]",
"display" : "[1].suffix[1]",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ST"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.5",
"display" : "Prefix (e.g., DR)",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "string"
},
{
"url" : "cardinalityMin",
"valueInteger" : -1
},
{
"url" : "cardinalityMax",
"valueInteger" : -1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].prefix",
"display" : "[1].prefix",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.6",
"display" : "Degree (e.g., MD)",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "string"
},
{
"url" : "cardinalityMin",
"valueInteger" : -1
},
{
"url" : "cardinalityMax",
"valueInteger" : -1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].suffix[2]",
"display" : "[1].suffix[2]",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ID"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.7",
"display" : "Name Type Code",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "code"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].use",
"display" : "[1].use",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "DR"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.10",
"display" : "Name Validity Range",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "Period"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].period",
"display" : "[1].period",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ID"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.11",
"display" : "Name Assembly Order",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "uri"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].extension.url",
"display" : "[1].extension.url",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ID"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.11",
"display" : "Name Assembly Order",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "code"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].extension.valueCode",
"display" : "[1].extension.valueCode",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "DTM"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.12",
"display" : "Effective Date",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "dateTime"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].period.start",
"display" : "[1].period.start",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "DTM"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.13",
"display" : "Expiration Date",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "dateTime"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].period.end",
"display" : "[1].period.end",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ST"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.14",
"display" : "Professional Suffix",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "string"
},
{
"url" : "cardinalityMin",
"valueInteger" : -1
},
{
"url" : "cardinalityMax",
"valueInteger" : -1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[1].suffix[3]",
"display" : "[1].suffix[3]",
"equivalence" : "equivalent"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ST"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.15",
"display" : "Called By",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "string"
},
{
"url" : "cardinalityMin",
"valueInteger" : -1
},
{
"url" : "cardinalityMax",
"valueInteger" : -1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[2].given",
"display" : "[2].given",
"equivalence" : "equivalent",
"comment" : "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\nAlternative a new extension could be created for HumanName.family.#ext-called-by#\\"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "ST"
},
{
"url" : "cardinalityMin",
"valueInteger" : 0
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "XPN.15",
"display" : "Called By",
"target" : [
{
"extension" : [
{
"extension" : [
{
"url" : "type",
"valueCode" : "code"
},
{
"url" : "cardinalityMin",
"valueInteger" : 1
},
{
"url" : "cardinalityMax",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
}
],
"code" : "[2].use",
"display" : "[2].use",
"equivalence" : "equivalent"
}
]
}
]
}
]
}
IG © 2020+ HL7 International / Orders and Observations. Package hl7.fhir.uv.v2mappings#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-12-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change