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
Official URL: http://hl7.org/fhir/uv/v2mappings/datatype-xpn-to-humanname | Version: 1.0.0-ballot | |||
Active as of 2024-07-28 | Computable Name: DatatypeXPNToHumanName | |||
Copyright/Legal: Copyright (c) 2020, HL7 International, Inc., All Rights Reserved. |
This ConceptMap represents a mapping from the HL7 V2 Datatype XPN to the FHIR HumanName Data Type.
This ConceptMap represents the mapping from the HL7 V2 XPN Data Type to the FHIR HumanName Data Type. See also the FHIR Shorthand or the CSV Source.
HL7 v2 | Condition (IF True, args) | HL7 FHIR | Comments | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sort Order | Identifier | Name | Data Type | Cardinality - Min | Cardinality - Max | Computable ANTLR | Computable FHIRPath | Narrative | FHIR Attribute | Proposed Extension | Data Type | Cardinality - Min | Cardinality - Max | Data Type Mapping | Vocabulary | Assignment | |
1 | XPN.1 | Family Name | FN | 0 | 1 | HumanName..family | HumanName.string | 0 | 1 | FN[HumanName] | |||||||
2 | XPN.2 | Given Name | ST | 0 | 1 | HumanName..given | HumanName.string | 0 | -1 | The requirement for XPN.2 being the first iteration of HumanName.given critical when it's an "official" name | |||||||
3 | XPN.3 | Second and Further Given Names or Initials Thereof | ST | 0 | 1 | HumanName..given | HumanName.string | 0 | -1 | 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? | |||||||
4 | XPN.4 | Suffix (e.g., JR or III) | ST | 0 | 1 | HumanName..suffix | HumanName.string | 0 | -1 | ||||||||
5 | XPN.5 | Prefix (e.g., DR) | ST | 0 | 1 | HumanName..prefix | HumanName.string | 0 | -1 | ||||||||
6 | XPN.6 | Degree (e.g., MD) | 0 | 1 | HumanName..suffix | HumanName.string | 0 | -1 | |||||||||
7 | XPN.7 | Name Type Code | ID | 0 | 1 | HumanName..use | HumanName.code | 0 | 1 | NameType | |||||||
8 | XPN.8 | Name Representation Code | ID | 0 | 1 | ||||||||||||
9 | XPN.9 | Name Context | CWE | 0 | 1 | ||||||||||||
10 | XPN.10 | Name Validity Range | DR | 0 | 1 | IF XPN.12 NOT VALUED AND XPN.13 NOT VALUED | HumanName..period | HumanName.Period | 0 | 1 | DR[Period] | ||||||
11 | XPN.11 | Name Assembly Order | ID | 0 | 1 | HumanName..extension.url | HumanName.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |||||||
11 | XPN.11 | Name Assembly Order | ID | 0 | 1 | HumanName..extension.valueCode | HumanName.code | 1 | 1 | NameAssemblyOrder | |||||||
12 | XPN.12 | Effective Date | DTM | 0 | 1 | HumanName..period.start | HumanName.dateTime | 0 | 1 | ||||||||
13 | XPN.13 | Expiration Date | DTM | 0 | 1 | HumanName..period.end | HumanName.dateTime | 0 | 1 | ||||||||
14 | XPN.14 | Professional Suffix | ST | 0 | 1 | HumanName..suffix | HumanName.string | 0 | -1 | ||||||||
15 | XPN.15 | Called By | ST | 0 | 1 | if the resource attribute using the HumanName datatype allows for multiple names | HumanName..given | HumanName.string | 0 | -1 | 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# | ||||||
15 | XPN.15 | Called By | ST | 0 | 1 | if the resource attribute using the HumanName datatype allows for multiple names | HumanName..use | HumanName.code | 0 | 1 | "nickname" |
Generated Narrative: ConceptMap datatype-xpn-to-humanname
Mapping from XPN to HumanName
Group 1 Mapping from unspecified code system
to unspecified code system
Source Concept Details | Relationship | Target Concept Details | Comment | Properties | ||||||||||
Codes from | vocabularymap | datatypemap | value | Codes from | antlr | narrative | ||||||||
XPN.1 | Family Name | FN[HumanName] | 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 | NameType | is equivalent to | [1].use | [1].use | |||||||||
XPN.10 | Name Validity Range | DR[Period] | is equivalent to | [1].period | [1].period | IF XPN.12 NOT VALUED AND XPN.13 NOT VALUED | ||||||||
XPN.11 | Name Assembly Order | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | is equivalent to | [1].extension.url | [1].extension.url | |||||||||
XPN.11 | Name Assembly Order | NameAssemblyOrder | 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 | is equivalent to | [2].given | [2].given | if the resource attribute using the HumanName datatype allows for multiple names | 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 | "nickname" | is equivalent to | [2].use | [2].use | if the resource attribute using the HumanName datatype allows for multiple names |