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-xcn-to-patient | Version: 1.0.0-ballot | |||
Active as of 2024-10-14 | Computable Name: DatatypeXCNToPatient | |||
Copyright/Legal: Copyright (c) 2020, HL7 International, Inc., All Rights Reserved. |
This ConceptMap represents a mapping from the HL7 V2 Datatype XCN to the FHIR Patient Resource.
This ConceptMap represents the mapping from the HL7 V2 XCN Data Type to the FHIR Patient Resource. 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 Mapping (IS, ID, CE, CEN, CWE) | Assignment | |
1 | XCN.1 | Person Identifier | ST | 0 | 1 | Patient.identifier.value | Patient.string | 0 | 1 | ||||||||
2 | XCN.2 | Family Name | FN | 0 | 1 | Patient.name | Patient.HumanName | 0 | -1 | FN[HumanName] | |||||||
3 | XCN.3 | Given Name | ST | 0 | 1 | Patient.name.given | Patient.string | 0 | -1 | ||||||||
4 | XCN.4 | Second and Further Given Names or Initials Thereof | ST | 0 | 1 | Patient.name.given | Patient.string | 0 | -1 | ||||||||
5 | XCN.5 | Suffix (e.g., JR or III) | ST | 0 | 1 | Patient.name.suffix | Patient.string | 0 | -1 | ||||||||
6 | XCN.6 | Prefix (e.g., DR) | ST | 0 | 1 | Patient.name.prefix | Patient.string | 0 | -1 | ||||||||
7 | XCN.7 | Degree (e.g., MD) | 0 | 1 | Patient.name.suffix[2} | Patient.string | 0 | -1 | |||||||||
8 | XCN.8 | Source Table | CWE | 0 | 1 | ||||||||||||
9 | XCN.9 | Assigning Authority | HD | 0 | 1 | If organization | Patient.identifier.assigner(Patient.Organization) | Reference(Patient.Organization) | 0 | 1 | HD[Organization] | ||||||
9 | XCN.9 | Assigning Authority | HD | 0 | 1 | If system | Patient.identifier.system | Patient.uri | 0 | 1 | HD[uri] | Typically the assigning authority reflects an organization, but if it is an actual system (EHR 1 vs. EHR 2, both supporting the same organization where one cannot get more specific), then XCN.9 should be mapped to .system | |||||
10 | XCN.10 | Name Type Code | ID | 0 | 1 | Patient.name.use | Patient.code | 0 | 1 | NameType | |||||||
11 | XCN.11 | Identifier Check Digit | ST | 0 | 1 | Patient.identifier.extension.url | Patient.uri | 0 | 1 | "http://hl7.org/fhir/StructureDefinition/identifier-checkDigit" | |||||||
11 | XCN.11 | Identifier Check Digit | ST | 0 | 1 | Patient.identifier.extension.valueString | Patient.string | 1 | 1 | ||||||||
12 | XCN.12 | Check Digit Scheme | ID | 0 | 1 | Patient.identifier.extension.url | Patient.uri | 0 | 1 | "http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit" | |||||||
12 | XCN.12 | Check Digit Scheme | ID | 0 | 1 | Patient.identifier.extension.valueString | Patient.string | 1 | 1 | ||||||||
13 | XCN.13 | Identifier Type Code | ID | 0 | 1 | Patient.identifier.type.coding.code | Patient.code | 0 | 1 | IDType | |||||||
14 | XCN.14 | Assigning Facility | HD | 0 | 1 | identifier.#ext-assigningFacility# | Reference(Patient.Location) | 0 | 1 | HD[Location] | |||||||
15 | XCN.15 | Name Representation Code | ID | 0 | 1 | ||||||||||||
16 | XCN.16 | Name Context | CWE | 0 | 1 | ||||||||||||
17 | XCN.17 | Name Validity Range | 0 | 1 | IF XCN.19 DOES NOT EXIST AND IF XCN.20 DOES NOT EXIST | Patient.name.period | Patient.Period | 0 | 1 | DR[Period] | |||||||
18 | XCN.18 | Name Assembly Order | ID | 0 | 1 | Patient.name.family.extension.url | Patient.uri | 0 | 1 | "http://hl7.org/fhir/R4/extension-humanname-assembly-order.html" | |||||||
18 | XCN.18 | Name Assembly Order | ID | 0 | 1 | Patient.name.family.extension.valueCode | Patient.code | 0 | 1 | NameAssemblyOrder | |||||||
19 | XCN.19 | Effective Date | DTM | 0 | 1 | Patient.name.period.start | Patient.dateTime | 0 | 1 | ||||||||
20 | XCN.20 | Expiration Date | DTM | 0 | 1 | Patient.name.period.end | Patient.dateTime | 0 | 1 | ||||||||
21 | XCN.21 | Professional Suffix | ST | 0 | 1 | Patient.name.suffix | Patient.string | 0 | -1 | ||||||||
22 | XCN.22 | Assigning Jurisdiction | CWE | 0 | 1 | ||||||||||||
23 | XCN.23 | Assigning Agency or Department | CWE | 0 | 1 | ||||||||||||
24 | XCN.24 | Security Check | ST | 0 | 1 | ||||||||||||
25 | XCN.25 | Security Check Scheme | ID | 0 | 1 |
Generated Narrative: ConceptMap datatype-xcn-to-patient
Mapping from XCN to Patient
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 | narrative | antlr | ||||||||
XCN.1 | Person Identifier | is equivalent to | identifier[1].value | identifier[1].value | ||||||||||
XCN.2 | Family Name | FN[HumanName] | is equivalent to | name | name | |||||||||
XCN.3 | Given Name | is equivalent to | name.given[1] | name.given[1] | ||||||||||
XCN.4 | Second and Further Given Names or Initials Thereof | is equivalent to | name.given[2] | name.given[2] | ||||||||||
XCN.5 | Suffix (e.g., JR or III) | is equivalent to | name.suffix[1] | name.suffix[1] | ||||||||||
XCN.6 | Prefix (e.g., DR) | is equivalent to | name.prefix | name.prefix | ||||||||||
XCN.7 | Degree (e.g., MD) | is equivalent to | name.suffix[2} | name.suffix[2} | ||||||||||
XCN.9 | Assigning Authority | HD[Organization] | is equivalent to | identifier[1].assigner(Organization) | identifier[1].assigner(Organization) | If organization | ||||||||
XCN.9 | Assigning Authority | HD[uri] | is equivalent to | identifier[1].system | identifier[1].system | If system | Typically the assigning authority reflects an organization, but if it is an actual system (EHR 1 vs. EHR 2, both supporting the same organization where one cannot get more specific), then XCN.9 should be mapped to .system | |||||||
XCN.10 | Name Type Code | NameType | is equivalent to | name.use | name.use | |||||||||
XCN.11 | Identifier Check Digit | "http://hl7.org/fhir/StructureDefinition/identifier-checkDigit" | is equivalent to | identifier[1].extension[1].url | identifier[1].extension[1].url | |||||||||
XCN.11 | Identifier Check Digit | is equivalent to | identifier[1].extension[1].valueString | identifier[1].extension[1].valueString | ||||||||||
XCN.12 | Check Digit Scheme | "http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit" | is equivalent to | identifier[1].extension[2].url | identifier[1].extension[2].url | |||||||||
XCN.12 | Check Digit Scheme | is equivalent to | identifier[1].extension[2].valueString | identifier[1].extension[2].valueString | ||||||||||
XCN.13 | Identifier Type Code | IDType | is equivalent to | identifier[1].type.coding.code | identifier[1].type.coding.code | |||||||||
XCN.17 | Name Validity Range | DR[Period] | is equivalent to | name.period | name.period | IF XCN.19 DOES NOT EXIST AND IF XCN.20 DOES NOT EXIST | ||||||||
XCN.18 | Name Assembly Order | "http://hl7.org/fhir/R4/extension-humanname-assembly-order.html" | is equivalent to | name.family.extension.url | name.family.extension.url | |||||||||
XCN.18 | Name Assembly Order | NameAssemblyOrder | is equivalent to | name.family.extension.valueCode | name.family.extension.valueCode | |||||||||
XCN.19 | Effective Date | is equivalent to | name.period.start | name.period.start | ||||||||||
XCN.20 | Expiration Date | is equivalent to | name.period.end | name.period.end | ||||||||||
XCN.21 | Professional Suffix | is equivalent to | name.suffix | name.suffix |