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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: HL7 v2 EI Data Type

The EI is appropriate for, but not limited to, machine or software generated identifiers. The generated identifier goes in the first component. The remaining components, 2 through 4, are known as the assigning authority; they identify the machine/system responsible for generating the identifier in component 1.

The specified series, the assigning authority, is defined by components 2 through 4. The assigning authority is of the hierarchic designator (HD) data type, but it is defined as three separate components in the EI data type, rather than as a single component as would normally be the case. This is in order to maintain backward compatibility with the EI’s use as a component in several existing data fields. Otherwise, the components 2 through 4 are as defined in Section 2A.2.33, "HD - hierarchic designator". Hierarchic designators (HD) are unique across a given HL7 implementation.

Usage:

• Use this Logical Model Profile: HL7 v2 EIP Data Type, HL7 v2 PIP Data Type, HL7 v2 PL Data Type, HL7 v2 XAD Data Type and HL7 v2 XTN Data Type

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from V2ComplexDataType

Name	Flags	Card.	Type	Description & Constraints
EI		0..*	V2ComplexDataType	entity identifier Instances of this logical model are not marked to be the target of a Reference
1		0..1	string	Entity Identifier
2		0..1	code	​Namespace ID Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
3		0..1	string	Universal ID
4		0..1	code	Universal ID Type Binding: hl7VS-universalIdType (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
EI.2	required	​http://terminology.hl7.org/ValueSet/v2-0363 http://terminology.hl7.org/ValueSet/v2-0363
EI.4	required	Hl7VSUniversalIdType http://terminology.hl7.org/ValueSet/v2-0301

Name	Flags	Card.	Type	Description & Constraints
EI		0..*	V2ComplexDataType	entity identifier Instances of this logical model are not marked to be the target of a Reference
1		0..1	string	Entity Identifier
2		0..1	code	​Namespace ID Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
3		0..1	string	Universal ID
4		0..1	code	Universal ID Type Binding: hl7VS-universalIdType (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EI.2	required	​http://terminology.hl7.org/ValueSet/v2-0363 http://terminology.hl7.org/ValueSet/v2-0363
EI.4	required	Hl7VSUniversalIdType http://terminology.hl7.org/ValueSet/v2-0301

Name	Flags	Card.	Type	Description & Constraints
EI		0..*	V2ComplexDataType	entity identifier Instances of this logical model are not marked to be the target of a Reference
1		0..1	string	Entity Identifier
2		0..1	code	​Namespace ID Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
3		0..1	string	Universal ID
4		0..1	code	Universal ID Type Binding: hl7VS-universalIdType (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EI.2	required	​http://terminology.hl7.org/ValueSet/v2-0363 http://terminology.hl7.org/ValueSet/v2-0363
EI.4	required	Hl7VSUniversalIdType http://terminology.hl7.org/ValueSet/v2-0301

This structure is derived from V2ComplexDataType

Summary

Differential View

This structure is derived from V2ComplexDataType

Name	Flags	Card.	Type	Description & Constraints
EI		0..*	V2ComplexDataType	entity identifier Instances of this logical model are not marked to be the target of a Reference
1		0..1	string	Entity Identifier
2		0..1	code	​Namespace ID Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
3		0..1	string	Universal ID
4		0..1	code	Universal ID Type Binding: hl7VS-universalIdType (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
EI.2	required	​http://terminology.hl7.org/ValueSet/v2-0363 http://terminology.hl7.org/ValueSet/v2-0363
EI.4	required	Hl7VSUniversalIdType http://terminology.hl7.org/ValueSet/v2-0301

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
EI		0..*	V2ComplexDataType	entity identifier Instances of this logical model are not marked to be the target of a Reference
1		0..1	string	Entity Identifier
2		0..1	code	​Namespace ID Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
3		0..1	string	Universal ID
4		0..1	code	Universal ID Type Binding: hl7VS-universalIdType (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EI.2	required	​http://terminology.hl7.org/ValueSet/v2-0363 http://terminology.hl7.org/ValueSet/v2-0363
EI.4	required	Hl7VSUniversalIdType http://terminology.hl7.org/ValueSet/v2-0301

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
EI		0..*	V2ComplexDataType	entity identifier Instances of this logical model are not marked to be the target of a Reference
1		0..1	string	Entity Identifier
2		0..1	code	​Namespace ID Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
3		0..1	string	Universal ID
4		0..1	code	Universal ID Type Binding: hl7VS-universalIdType (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EI.2	required	​http://terminology.hl7.org/ValueSet/v2-0363 http://terminology.hl7.org/ValueSet/v2-0363
EI.4	required	Hl7VSUniversalIdType http://terminology.hl7.org/ValueSet/v2-0301

This structure is derived from V2ComplexDataType

Summary

Other representations of profile: CSV, Excel