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 CX Data Type

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

Note: The check digit and check digit scheme are null if ID is alphanumeric.

Example:

1234567^4^M11^ADT01^MR^University Hospital

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
.. CX 0..* V2ComplexDataType extended composite ID with check digit
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 string ID Number
... 2 0..1 string Identifier Check Digit
... 3 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 5 1..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 6 0..1 HD Assigning Facility
... 7 0..1 date Effective Date
... 8 0..1 date Expiration Date
... 9 0..1 CWE Assigning Jurisdiction
... 10 0..1 CWE Assigning Agency or Department
... 11 0..1 string Security Check
... 12 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CX.3requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
CX.4required​http://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
CX.5requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
CX.12requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904
NameFlagsCard.TypeDescription & Constraintsdoco
.. CX 0..* V2ComplexDataType extended composite ID with check digit
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 string ID Number
... 2 0..1 string Identifier Check Digit
... 3 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 5 1..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 6 0..1 HD Assigning Facility
... 7 0..1 date Effective Date
... 8 0..1 date Expiration Date
... 9 0..1 CWE Assigning Jurisdiction
... 10 0..1 CWE Assigning Agency or Department
... 11 0..1 string Security Check
... 12 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CX.3requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
CX.4required​http://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
CX.5requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
CX.12requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904
NameFlagsCard.TypeDescription & Constraintsdoco
.. CX 0..* V2ComplexDataType extended composite ID with check digit
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 string ID Number
... 2 0..1 string Identifier Check Digit
... 3 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 5 1..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 6 0..1 HD Assigning Facility
... 7 0..1 date Effective Date
... 8 0..1 date Expiration Date
... 9 0..1 CWE Assigning Jurisdiction
... 10 0..1 CWE Assigning Agency or Department
... 11 0..1 string Security Check
... 12 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CX.3requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
CX.4required​http://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
CX.5requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
CX.12requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

This structure is derived from V2ComplexDataType

Summary

Mandatory: 0 element(2 nested mandatory elements)

Differential View

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. CX 0..* V2ComplexDataType extended composite ID with check digit
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 string ID Number
... 2 0..1 string Identifier Check Digit
... 3 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 5 1..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 6 0..1 HD Assigning Facility
... 7 0..1 date Effective Date
... 8 0..1 date Expiration Date
... 9 0..1 CWE Assigning Jurisdiction
... 10 0..1 CWE Assigning Agency or Department
... 11 0..1 string Security Check
... 12 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CX.3requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
CX.4required​http://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
CX.5requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
CX.12requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CX 0..* V2ComplexDataType extended composite ID with check digit
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 string ID Number
... 2 0..1 string Identifier Check Digit
... 3 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 5 1..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 6 0..1 HD Assigning Facility
... 7 0..1 date Effective Date
... 8 0..1 date Expiration Date
... 9 0..1 CWE Assigning Jurisdiction
... 10 0..1 CWE Assigning Agency or Department
... 11 0..1 string Security Check
... 12 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CX.3requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
CX.4required​http://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
CX.5requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
CX.12requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CX 0..* V2ComplexDataType extended composite ID with check digit
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 string ID Number
... 2 0..1 string Identifier Check Digit
... 3 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 5 1..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 6 0..1 HD Assigning Facility
... 7 0..1 date Effective Date
... 8 0..1 date Expiration Date
... 9 0..1 CWE Assigning Jurisdiction
... 10 0..1 CWE Assigning Agency or Department
... 11 0..1 string Security Check
... 12 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CX.3requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
CX.4required​http://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
CX.5requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
CX.12requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

This structure is derived from V2ComplexDataType

Summary

Mandatory: 0 element(2 nested mandatory elements)

 

Other representations of profile: CSV, Excel