Package ca.uhn.hl7v2.model.v251.datatype

Class EI

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v251.datatype.EI

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class EI
extends AbstractComposite

Represents an HL7 EI (Entity Identifier) data type. This type consists of the following components:

• Entity Identifier (ST)
• Namespace ID (IS)
• Universal ID (ST)
• Universal ID Type (ID)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EI(Message message)	Creates a new EI type

Method Summary

Modifier and Type	Method	Description
Type	getComponent(int number)	Returns an individual data component.
Type[]	getComponents()	Returns an array containing the data elements.
ST	getEi1_EntityIdentifier()	Returns Entity Identifier (component 1).
IS	getEi2_NamespaceID()	Returns Namespace ID (component 2).
ST	getEi3_UniversalID()	Returns Universal ID (component 3).
ID	getEi4_UniversalIDType()	Returns Universal ID Type (component 4).
ST	getEntityIdentifier()	Returns Entity Identifier (component 1).
IS	getNamespaceID()	Returns Namespace ID (component 2).
ST	getUniversalID()	Returns Universal ID (component 3).
ID	getUniversalIDType()	Returns Universal ID Type (component 4).

Methods inherited from class ca.uhn.hl7v2.model.AbstractComposite

accept, clear, getTyped, isEmpty, provideLocation

Methods inherited from class ca.uhn.hl7v2.model.AbstractType

encode, getExtraComponents, getMessage, getName, parse, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Type

encode, getExtraComponents, getMessage, getName, parse

Constructor Details

EI

public EI(Message message)

Creates a new EI type

Method Details

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Parameters:

number - The component number (0-indexed)

Throws:

DataTypeException - if the given element number is out of range.

getEntityIdentifier

public ST getEntityIdentifier()

Returns Entity Identifier (component 1). This is a convenience method that saves you from casting and handling an exception.

getEi1_EntityIdentifier

public ST getEi1_EntityIdentifier()

Returns Entity Identifier (component 1). This is a convenience method that saves you from casting and handling an exception.

getNamespaceID

public IS getNamespaceID()

Returns Namespace ID (component 2). This is a convenience method that saves you from casting and handling an exception.

getEi2_NamespaceID

public IS getEi2_NamespaceID()

Returns Namespace ID (component 2). This is a convenience method that saves you from casting and handling an exception.

getUniversalID

public ST getUniversalID()

Returns Universal ID (component 3). This is a convenience method that saves you from casting and handling an exception.

getEi3_UniversalID

public ST getEi3_UniversalID()

Returns Universal ID (component 3). This is a convenience method that saves you from casting and handling an exception.

getUniversalIDType

public ID getUniversalIDType()

Returns Universal ID Type (component 4). This is a convenience method that saves you from casting and handling an exception.

getEi4_UniversalIDType

public ID getEi4_UniversalIDType()

Returns Universal ID Type (component 4). This is a convenience method that saves you from casting and handling an exception.