Package | hl7.fhir.uv.v2mappings |
Type | ConceptMap |
Id | datatype-xpn-to-humanname |
FHIR Version | R4 |
Source | http://hl7.org/fhir/uv/v2mappings/https://build.fhir.org/ig/HL7/v2-to-fhir/ConceptMap-datatype-xpn-to-humanname.html |
URL | http://hl7.org/fhir/uv/v2mappings/ConceptMap/datatype-xpn-to-humanname |
Version | 1.0.0 |
Status | active |
Date | 2025-07-22 |
Name | DatatypeXPNToHumanName |
Title | Datatype XPN to HumanName Map |
Realm | uv |
Authority | hl7 |
Description | This ConceptMap represents a mapping from the HL7 V2 Datatype XPN to the FHIR HumanName Data Type. |
Copyright | Copyright (c) 2025, HL7 International, Inc., All Rights Reserved. |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ConceptMap datatype-xpn-to-humanname
Mapping from (not specified) to (not specified)
Group 1 Mapping from unspecified code system
to unspecified code system
Source Concept Details | Relationship | Target Concept Details | Comment | ||||
Codes from | NarrativeCondition | ComputableANTLR | Codes from | ||||
XPN.1 | Family Name | is equivalent to | [1].family | [1].family | |||
XPN.2 | Given Name | is equivalent to | [1].given[1] | [1].given[1] | The requirement for XPN.2 being the first iteration of HumanName.given critical when it's an "official" name | ||
XPN.3 | Second and Further Given Names or Initials Thereof | is equivalent to | [1].given[2] | [1].given[2] | 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? | ||
XPN.4 | Suffix (e.g., JR or III) | is equivalent to | [1].suffix[1] | [1].suffix[1] | |||
XPN.5 | Prefix (e.g., DR) | is equivalent to | [1].prefix | [1].prefix | |||
XPN.6 | Degree (e.g., MD) | is equivalent to | [1].suffix[2] | [1].suffix[2] | |||
XPN.7 | Name Type Code | is equivalent to | [1].use | [1].use | |||
XPN.10 | Name Validity Range | IF XPN.12 NOT VALUED AND XPN.13 NOT VALUED | is equivalent to | [1].period | [1].period | ||
XPN.11 | Name Assembly Order | is equivalent to | [1].extension.url | [1].extension.url | |||
XPN.11 | Name Assembly Order | is equivalent to | [1].extension.valueCode | [1].extension.valueCode | |||
XPN.12 | Effective Date | is equivalent to | [1].period.start | [1].period.start | |||
XPN.13 | Expiration Date | is equivalent to | [1].period.end | [1].period.end | |||
XPN.14 | Professional Suffix | is equivalent to | [1].suffix[3] | [1].suffix[3] | |||
XPN.15 | Called By | if the resource attribute using the HumanName datatype allows for multiple names | is equivalent to | [2].given | [2].given | 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#\ | |
XPN.15 | Called By | if the resource attribute using the HumanName datatype allows for multiple names | is equivalent to | [2].use | [2].use |
{ "resourceType": "ConceptMap", "id": "datatype-xpn-to-humanname", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "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/StructureDefinition/structuredefinition-wg", "valueCode": "oo" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "informative", "_valueCode": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/uv/v2mappings/ImplementationGuide/hl7.fhir.uv.v2mappings" } ] } } ], "url": "http://hl7.org/fhir/uv/v2mappings/ConceptMap/datatype-xpn-to-humanname", "version": "1.0.0", "name": "DatatypeXPNToHumanName", "title": "Datatype XPN to HumanName Map", "status": "active", "experimental": true, "date": "2025-07-22", "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) 2025, HL7 International, Inc., All Rights Reserved.", "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": "mappedVia", "valueUrl": "ConceptMap/table-hl70200-to-name-use" } ], "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", "dependsOn": [ { "property": "Computable-ANTLR", "value": "IF XPN.12 NOT VALUED AND XPN.13 NOT VALUED" } ] } ] }, { "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": "assignment", "valueString": "\"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order\"" } ], "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": "mappedVia", "valueUrl": "ConceptMap/table-hl70444-to-v2-0444" } ], "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#\\", "dependsOn": [ { "property": "Narrative-Condition", "value": "if the resource attribute using the HumanName datatype allows for multiple names" } ] } ] }, { "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": "assignment", "valueString": "\"nickname\"" } ], "url": "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo" } ], "code": "[2].use", "display": "[2].use", "equivalence": "equivalent", "dependsOn": [ { "property": "Narrative-Condition", "value": "if the resource attribute using the HumanName datatype allows for multiple names" } ] } ] } ] } ] }