HL7 v2 CX 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: CX - Detailed Descriptions

Page standards status: Informative

Definitions for the CX 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. CX
Definition	Definition: This data type is used for specifying an identifier with its associated administrative detail.
Short	extended composite ID with check digit
Control	0..*
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. CX.1
Short	ID Number
Control	1..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. CX.2
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
6. CX.3
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
8. CX.4
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
10. CX.5
Short	Identifier Type Code
Control	1..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
12. CX.6
Short	Assigning Facility
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/HD
14. CX.7
Short	Effective Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DT
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. CX.8
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DT
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. CX.9
Short	Assigning Jurisdiction
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
20. CX.10
Short	Assigning Agency or Department
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
22. CX.11
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
24. CX.12
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. CX
Definition	Definition: This data type is used for specifying an identifier with its associated administrative detail. Base definition for all types defined in FHIR type system.
Short	extended composite ID with check digitBase 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. CX.1
Short	ID Number
Control	1..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. CX.2
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
6. CX.3
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
8. CX.4
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
10. CX.5
Short	Identifier Type Code
Control	1..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
12. CX.6
Short	Assigning Facility
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/HD
14. CX.7
Short	Effective Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DT
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. CX.8
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DT
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. CX.9
Short	Assigning Jurisdiction
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
20. CX.10
Short	Assigning Agency or Department
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
22. CX.11
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
24. CX.12
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. CX
Definition	Definition: This data type is used for specifying an identifier with its associated administrative detail.
Short	extended composite ID with check digit
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. CX.1
Short	ID Number
Control	1..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. CX.2
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
6. CX.3
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
8. CX.4
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
10. CX.5
Short	Identifier Type Code
Control	1..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
12. CX.6
Short	Assigning Facility
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/HD
14. CX.7
Short	Effective Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DT
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. CX.8
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DT
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. CX.9
Short	Assigning Jurisdiction
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
20. CX.10
Short	Assigning Agency or Department
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
22. CX.11
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
24. CX.12
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-11-08
Links: Table of Contents | QA Report