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

Class HD

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v251.datatype.HD

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class HD
extends AbstractComposite

Represents an HL7 HD (Hierarchic Designator) data type. This type consists of the following components:

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
HD(Message message)	Creates a new HD 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.
IS	getHd1_NamespaceID()	Returns Namespace ID (component 1).
ST	getHd2_UniversalID()	Returns Universal ID (component 2).
ID	getHd3_UniversalIDType()	Returns Universal ID Type (component 3).
IS	getNamespaceID()	Returns Namespace ID (component 1).
ST	getUniversalID()	Returns Universal ID (component 2).
ID	getUniversalIDType()	Returns Universal ID Type (component 3).

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

HD

public HD(Message message)

Creates a new HD 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.

getNamespaceID

public IS getNamespaceID()

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

getHd1_NamespaceID

public IS getHd1_NamespaceID()

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

getUniversalID

public ST getUniversalID()

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

getHd2_UniversalID

public ST getHd2_UniversalID()

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

getUniversalIDType

public ID getUniversalIDType()

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

getHd3_UniversalIDType

public ID getHd3_UniversalIDType()

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