HL7 v2 XCN Data Type - Definitions - HL7 v2+ Specification v0.0.0

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: XCN - Detailed Descriptions

Page standards status: Informative

Definitions for the XCN logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. XCN
Short	extended composite ID number and name for persons
Control	0..*
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. XCN.1
Short	Person Identifier
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. XCN.2
Short	Family Name
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/FN
6. XCN.3
Short	Given Name
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. XCN.4
Short	Second and Further Given Names or Initials Thereof
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. XCN.5
Short	Suffix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. XCN.6
Short	Prefix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. XCN.7
Short	Degree
16. XCN.8
Short	Source Table
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0297 (required to `http://terminology.hl7.org/ValueSet/v2-0297`)
Type	http://hl7.org/v2/StructureDefinition/CWE
18. XCN.9
Short	Assigning Authority
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0363 (required to `http://terminology.hl7.org/ValueSet/v2-0363`)
Type	http://hl7.org/v2/StructureDefinition/HD
20. XCN.10
Short	Name Type Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-nameType (required to `http://terminology.hl7.org/ValueSet/v2-0200`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
22. XCN.11
Short	Identifier Check Digit
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. XCN.12
Short	Check Digit Scheme
Control	0..1
Binding	The codes SHALL be taken from hl7VS-checkDigitScheme (required to `http://terminology.hl7.org/ValueSet/v2-0061`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
26. XCN.13
Short	Identifier Type Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-identifierType (required to `http://terminology.hl7.org/ValueSet/v2-0203`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. XCN.14
Short	Assigning Facility
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/HD
30. XCN.15
Short	Name Representation Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-name-addressRepresentation (required to `http://terminology.hl7.org/ValueSet/v2-0465`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
32. XCN.16
Short	Name Context
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0448 (required to `http://terminology.hl7.org/ValueSet/v2-0448`)
Type	http://hl7.org/v2/StructureDefinition/CWE
34. XCN.17
Short	Name Validity Range
36. XCN.18
Short	Name Assembly Order
Control	0..1
Binding	The codes SHALL be taken from hl7VS-nameAssemblyOrder (required to `http://terminology.hl7.org/ValueSet/v2-0444`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
38. XCN.19
Short	Effective Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
40. XCN.20
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
42. XCN.21
Short	Professional Suffix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
44. XCN.22
Short	Assigning Jurisdiction
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
46. XCN.23
Short	Assigning Agency or Department
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
48. XCN.24
Short	Security Check
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
50. XCN.25
Short	Security Check Scheme
Control	0..1
Binding	The codes SHALL be taken from hl7VS-securityCheckScheme (required to `http://terminology.hl7.org/ValueSet/v2-0904`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. XCN
Definition	Base definition for all types defined in FHIR type system.
Short	extended composite ID number and name for personsBase for all types and resources
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. XCN.1
Short	Person Identifier
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. XCN.2
Short	Family Name
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/FN
6. XCN.3
Short	Given Name
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. XCN.4
Short	Second and Further Given Names or Initials Thereof
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. XCN.5
Short	Suffix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. XCN.6
Short	Prefix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. XCN.7
Short	Degree
16. XCN.8
Short	Source Table
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0297 (required to `http://terminology.hl7.org/ValueSet/v2-0297`)
Type	http://hl7.org/v2/StructureDefinition/CWE
18. XCN.9
Short	Assigning Authority
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0363 (required to `http://terminology.hl7.org/ValueSet/v2-0363`)
Type	http://hl7.org/v2/StructureDefinition/HD
20. XCN.10
Short	Name Type Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-nameType (required to `http://terminology.hl7.org/ValueSet/v2-0200`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
22. XCN.11
Short	Identifier Check Digit
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. XCN.12
Short	Check Digit Scheme
Control	0..1
Binding	The codes SHALL be taken from hl7VS-checkDigitScheme (required to `http://terminology.hl7.org/ValueSet/v2-0061`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
26. XCN.13
Short	Identifier Type Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-identifierType (required to `http://terminology.hl7.org/ValueSet/v2-0203`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. XCN.14
Short	Assigning Facility
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/HD
30. XCN.15
Short	Name Representation Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-name-addressRepresentation (required to `http://terminology.hl7.org/ValueSet/v2-0465`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
32. XCN.16
Short	Name Context
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0448 (required to `http://terminology.hl7.org/ValueSet/v2-0448`)
Type	http://hl7.org/v2/StructureDefinition/CWE
34. XCN.17
Short	Name Validity Range
36. XCN.18
Short	Name Assembly Order
Control	0..1
Binding	The codes SHALL be taken from hl7VS-nameAssemblyOrder (required to `http://terminology.hl7.org/ValueSet/v2-0444`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
38. XCN.19
Short	Effective Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
40. XCN.20
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
42. XCN.21
Short	Professional Suffix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
44. XCN.22
Short	Assigning Jurisdiction
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
46. XCN.23
Short	Assigning Agency or Department
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
48. XCN.24
Short	Security Check
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
50. XCN.25
Short	Security Check Scheme
Control	0..1
Binding	The codes SHALL be taken from hl7VS-securityCheckScheme (required to `http://terminology.hl7.org/ValueSet/v2-0904`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. XCN
Definition	Base definition for all types defined in FHIR type system.
Short	extended composite ID number and name for persons
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. XCN.1
Short	Person Identifier
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. XCN.2
Short	Family Name
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/FN
6. XCN.3
Short	Given Name
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. XCN.4
Short	Second and Further Given Names or Initials Thereof
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. XCN.5
Short	Suffix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. XCN.6
Short	Prefix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. XCN.7
Short	Degree
16. XCN.8
Short	Source Table
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0297 (required to `http://terminology.hl7.org/ValueSet/v2-0297`)
Type	http://hl7.org/v2/StructureDefinition/CWE
18. XCN.9
Short	Assigning Authority
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0363 (required to `http://terminology.hl7.org/ValueSet/v2-0363`)
Type	http://hl7.org/v2/StructureDefinition/HD
20. XCN.10
Short	Name Type Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-nameType (required to `http://terminology.hl7.org/ValueSet/v2-0200`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
22. XCN.11
Short	Identifier Check Digit
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. XCN.12
Short	Check Digit Scheme
Control	0..1
Binding	The codes SHALL be taken from hl7VS-checkDigitScheme (required to `http://terminology.hl7.org/ValueSet/v2-0061`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
26. XCN.13
Short	Identifier Type Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-identifierType (required to `http://terminology.hl7.org/ValueSet/v2-0203`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. XCN.14
Short	Assigning Facility
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/HD
30. XCN.15
Short	Name Representation Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-name-addressRepresentation (required to `http://terminology.hl7.org/ValueSet/v2-0465`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
32. XCN.16
Short	Name Context
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0448 (required to `http://terminology.hl7.org/ValueSet/v2-0448`)
Type	http://hl7.org/v2/StructureDefinition/CWE
34. XCN.17
Short	Name Validity Range
36. XCN.18
Short	Name Assembly Order
Control	0..1
Binding	The codes SHALL be taken from hl7VS-nameAssemblyOrder (required to `http://terminology.hl7.org/ValueSet/v2-0444`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
38. XCN.19
Short	Effective Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
40. XCN.20
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
42. XCN.21
Short	Professional Suffix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
44. XCN.22
Short	Assigning Jurisdiction
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
46. XCN.23
Short	Assigning Agency or Department
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
48. XCN.24
Short	Security Check
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
50. XCN.25
Short	Security Check Scheme
Control	0..1
Binding	The codes SHALL be taken from hl7VS-securityCheckScheme (required to `http://terminology.hl7.org/ValueSet/v2-0904`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

IG © HL7 International. Package hl7.v2plus#0.0.0 based on FHIR 5.0.0. Generated 2024-10-31
Links: Table of Contents | QA Report