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

Class OCD

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v251.datatype.OCD

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class OCD
extends AbstractComposite

Represents an HL7 OCD (Occurrence Code and Date) data type. This type consists of the following components:

• Occurrence Code (CNE)
• Occurrence Date (DT)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OCD(Message message)	Creates a new OCD 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.
CNE	getOccurrenceCode()	Returns Occurrence Code (component 1).
DT	getOccurrenceDate()	Returns Occurrence Date (component 2).
CNE	getOcd1_OccurrenceCode()	Returns Occurrence Code (component 1).
DT	getOcd2_OccurrenceDate()	Returns Occurrence Date (component 2).

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

OCD

public OCD(Message message)

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

getOccurrenceCode

public CNE getOccurrenceCode()

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

getOcd1_OccurrenceCode

public CNE getOcd1_OccurrenceCode()

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

getOccurrenceDate

public DT getOccurrenceDate()

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

getOcd2_OccurrenceDate

public DT getOcd2_OccurrenceDate()

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