HL7 v2+ Specification
0.0.0 - draft

HL7 v2+ Specification, published by HL7 International. This guide is not an authorized publication; it is the continuous build for version 0.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2ig/ and changes regularly. See the Directory of published versions

Logical Model: HL7 v2 XCN Data Type

Official URL: http://hl7.org/v2/StructureDefinition/XCN Version: 0.0.0
Standards status: Informative Computable Name: XCN

Note: Replaces CN data type as of v 2.3.

This data type is used extensively appearing in the PV1, ORC, RXO, RXE, OBR and SCH segments, as well as others, where there is a need to specify the ID number and name of a person.

Example without assigning authority and assigning facility:

1234567^Everyman^Adam^A^III^DR^^ADT01^^L^4^M11^MR

Examples with assigning authority and assigning facility:

Dr. Harold Hippocrates’ provider ID was assigned by the Provider Master and was first issued at Good Health Hospital within the Community Health and Hospitals System. Since IS table values (first component of the HD) were not used for assigning authority and assigning facility, components 2 and 3 of the HD data type are populated and demoted to sub-components as follows:

12188^Hippocrates^Harold^H^IV^Dr^^^&Provider Master.Community Health and Hospitals&L^L^9^M10^DN^&Good Health Hospital.Community Health and Hospitals&L^A

Ludwig van Beethoven's medical record number was assigned by the Master Patient Index and was first issued at Fairview Hospital within the University Hospitals System.

10535^van Beethoven&van^Ludwig^A^III^Dr^^^&MPI.Community Health and Hospitals&L^L^3^M10^MR^& Good Health Hospital.Community Health and Hospitals&L^A

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. XCN 0..* V2ComplexDataType extended composite ID number and name for persons
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 0..1 CWE Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 16 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 17 Name Validity Range
... 18 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 19 0..1 dateTime Effective Date
... 20 0..1 dateTime Expiration Date
... 21 0..1 string Professional Suffix
... 22 0..1 CWE Assigning Jurisdiction
... 23 0..1 CWE Assigning Agency or Department
... 24 0..1 string Security Check
... 25 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
XCN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
XCN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
XCN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XCN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
XCN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
XCN.15requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XCN.16requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XCN.18requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
XCN.25requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904
NameFlagsCard.TypeDescription & Constraintsdoco
.. XCN 0..* V2ComplexDataType extended composite ID number and name for persons
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 0..1 CWE Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 16 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 17 Name Validity Range
... 18 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 19 0..1 dateTime Effective Date
... 20 0..1 dateTime Expiration Date
... 21 0..1 string Professional Suffix
... 22 0..1 CWE Assigning Jurisdiction
... 23 0..1 CWE Assigning Agency or Department
... 24 0..1 string Security Check
... 25 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XCN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
XCN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
XCN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XCN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
XCN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
XCN.15requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XCN.16requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XCN.18requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
XCN.25requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904
NameFlagsCard.TypeDescription & Constraintsdoco
.. XCN 0..* V2ComplexDataType extended composite ID number and name for persons
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 0..1 CWE Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 16 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 17 Name Validity Range
... 18 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 19 0..1 dateTime Effective Date
... 20 0..1 dateTime Expiration Date
... 21 0..1 string Professional Suffix
... 22 0..1 CWE Assigning Jurisdiction
... 23 0..1 CWE Assigning Agency or Department
... 24 0..1 string Security Check
... 25 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XCN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
XCN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
XCN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XCN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
XCN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
XCN.15requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XCN.16requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XCN.18requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
XCN.25requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

This structure is derived from V2ComplexDataType

Summary

Differential View

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. XCN 0..* V2ComplexDataType extended composite ID number and name for persons
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 0..1 CWE Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 16 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 17 Name Validity Range
... 18 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 19 0..1 dateTime Effective Date
... 20 0..1 dateTime Expiration Date
... 21 0..1 string Professional Suffix
... 22 0..1 CWE Assigning Jurisdiction
... 23 0..1 CWE Assigning Agency or Department
... 24 0..1 string Security Check
... 25 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
XCN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
XCN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
XCN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XCN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
XCN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
XCN.15requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XCN.16requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XCN.18requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
XCN.25requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. XCN 0..* V2ComplexDataType extended composite ID number and name for persons
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 0..1 CWE Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 16 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 17 Name Validity Range
... 18 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 19 0..1 dateTime Effective Date
... 20 0..1 dateTime Expiration Date
... 21 0..1 string Professional Suffix
... 22 0..1 CWE Assigning Jurisdiction
... 23 0..1 CWE Assigning Agency or Department
... 24 0..1 string Security Check
... 25 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XCN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
XCN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
XCN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XCN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
XCN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
XCN.15requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XCN.16requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XCN.18requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
XCN.25requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. XCN 0..* V2ComplexDataType extended composite ID number and name for persons
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 0..1 CWE Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 16 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 17 Name Validity Range
... 18 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 19 0..1 dateTime Effective Date
... 20 0..1 dateTime Expiration Date
... 21 0..1 string Professional Suffix
... 22 0..1 CWE Assigning Jurisdiction
... 23 0..1 CWE Assigning Agency or Department
... 24 0..1 string Security Check
... 25 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XCN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
XCN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
XCN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XCN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
XCN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
XCN.15requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XCN.16requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XCN.18requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
XCN.25requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

This structure is derived from V2ComplexDataType

Summary

 

Other representations of profile: CSV, Excel