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.

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.

Shortextended composite ID with check digit
Control0..*
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CX.1
ShortID Number
Control1..1
Typehttp://hl7.org/v2/StructureDefinition/ST
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. CX.2
ShortIdentifier Check Digit
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/ST
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CX.3
ShortCheck Digit Scheme
Control0..1
BindingThe codes SHALL be taken from hl7VS-checkDigitScheme
(required to http://terminology.hl7.org/ValueSet/v2-0061)
Typehttp://hl7.org/v2/StructureDefinition/ID
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. CX.4
ShortAssigning Authority
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0363
(required to http://terminology.hl7.org/ValueSet/v2-0363)
Typehttp://hl7.org/v2/StructureDefinition/HD
10. CX.5
ShortIdentifier Type Code
Control1..1
BindingThe codes SHALL be taken from hl7VS-identifierType
(required to http://terminology.hl7.org/ValueSet/v2-0203)
Typehttp://hl7.org/v2/StructureDefinition/ID
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CX.6
ShortAssigning Facility
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/HD
14. CX.7
ShortEffective Date
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/DT
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. CX.8
ShortExpiration Date
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/DT
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. CX.9
ShortAssigning Jurisdiction
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/CWE
20. CX.10
ShortAssigning Agency or Department
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/CWE
22. CX.11
ShortSecurity Check
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/ST
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. CX.12
ShortSecurity Check Scheme
Control0..1
BindingThe codes SHALL be taken from hl7VS-securityCheckScheme
(required to http://terminology.hl7.org/ValueSet/v2-0904)
Typehttp://hl7.org/v2/StructureDefinition/ID
Primitive ValueThis 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.

Shortextended composite ID with check digitBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CX.1
ShortID Number
Control1..1
Typehttp://hl7.org/v2/StructureDefinition/ST
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. CX.2
ShortIdentifier Check Digit
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/ST
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CX.3
ShortCheck Digit Scheme
Control0..1
BindingThe codes SHALL be taken from hl7VS-checkDigitScheme
(required to http://terminology.hl7.org/ValueSet/v2-0061)
Typehttp://hl7.org/v2/StructureDefinition/ID
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. CX.4
ShortAssigning Authority
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0363
(required to http://terminology.hl7.org/ValueSet/v2-0363)
Typehttp://hl7.org/v2/StructureDefinition/HD
10. CX.5
ShortIdentifier Type Code
Control1..1
BindingThe codes SHALL be taken from hl7VS-identifierType
(required to http://terminology.hl7.org/ValueSet/v2-0203)
Typehttp://hl7.org/v2/StructureDefinition/ID
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CX.6
ShortAssigning Facility
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/HD
14. CX.7
ShortEffective Date
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/DT
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. CX.8
ShortExpiration Date
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/DT
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. CX.9
ShortAssigning Jurisdiction
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/CWE
20. CX.10
ShortAssigning Agency or Department
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/CWE
22. CX.11
ShortSecurity Check
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/ST
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. CX.12
ShortSecurity Check Scheme
Control0..1
BindingThe codes SHALL be taken from hl7VS-securityCheckScheme
(required to http://terminology.hl7.org/ValueSet/v2-0904)
Typehttp://hl7.org/v2/StructureDefinition/ID
Primitive ValueThis 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.

Shortextended composite ID with check digit
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CX.1
ShortID Number
Control1..1
Typehttp://hl7.org/v2/StructureDefinition/ST
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. CX.2
ShortIdentifier Check Digit
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/ST
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CX.3
ShortCheck Digit Scheme
Control0..1
BindingThe codes SHALL be taken from hl7VS-checkDigitScheme
(required to http://terminology.hl7.org/ValueSet/v2-0061)
Typehttp://hl7.org/v2/StructureDefinition/ID
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. CX.4
ShortAssigning Authority
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0363
(required to http://terminology.hl7.org/ValueSet/v2-0363)
Typehttp://hl7.org/v2/StructureDefinition/HD
10. CX.5
ShortIdentifier Type Code
Control1..1
BindingThe codes SHALL be taken from hl7VS-identifierType
(required to http://terminology.hl7.org/ValueSet/v2-0203)
Typehttp://hl7.org/v2/StructureDefinition/ID
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CX.6
ShortAssigning Facility
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/HD
14. CX.7
ShortEffective Date
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/DT
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. CX.8
ShortExpiration Date
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/DT
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. CX.9
ShortAssigning Jurisdiction
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/CWE
20. CX.10
ShortAssigning Agency or Department
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/CWE
22. CX.11
ShortSecurity Check
Control0..1
Typehttp://hl7.org/v2/StructureDefinition/ST
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. CX.12
ShortSecurity Check Scheme
Control0..1
BindingThe codes SHALL be taken from hl7VS-securityCheckScheme
(required to http://terminology.hl7.org/ValueSet/v2-0904)
Typehttp://hl7.org/v2/StructureDefinition/ID
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension