ca.uhn.hl7v2.model.v24.datatype
Class CWE

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v24.datatype.CWE

All Implemented Interfaces:

Composite, Type, Serializable

public class CWE
extends AbstractType
implements Composite

Represents an HL7 CWE (coded with exceptions) data type. This type consists of the following components:

• identifier (ST) (ST)
• text (ST)
• name of coding system (IS)
• alternate identifier (ST) (ST)
• alternate text (ST)
• name of alternate coding system (IS)
• coding system version ID (ST)
• alternate coding system version ID (ST)
• original text (ST)

See Also:

Serialized Form

Constructor Summary

CWE(Message message)
Creates a new CWE type

Method Summary

ST	getAlternateCodingSystemVersionID() Returns alternate coding system version ID (component #8).
ST	getAlternateIdentifier() Returns alternate identifier (ST) (component #4).
ST	getAlternateText() Returns alternate text (component #5).
ST	getCodingSystemVersionID() Returns coding system version ID (component #7).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
ST	getCwe1_Identifier() Returns identifier (ST) (component #1).
ST	getCwe2_Text() Returns text (component #2).
IS	getCwe3_NameOfCodingSystem() Returns name of coding system (component #3).
ST	getCwe4_AlternateIdentifier() Returns alternate identifier (ST) (component #4).
ST	getCwe5_AlternateText() Returns alternate text (component #5).
IS	getCwe6_NameOfAlternateCodingSystem() Returns name of alternate coding system (component #6).
ST	getCwe7_CodingSystemVersionID() Returns coding system version ID (component #7).
ST	getCwe8_AlternateCodingSystemVersionID() Returns alternate coding system version ID (component #8).
ST	getCwe9_OriginalText() Returns original text (component #9).
ST	getIdentifier() Returns identifier (ST) (component #1).
IS	getNameOfAlternateCodingSystem() Returns name of alternate coding system (component #6).
IS	getNameOfCodingSystem() Returns name of coding system (component #3).
ST	getOriginalText() Returns original text (component #9).
ST	getText() Returns text (component #2).

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

clear, encode, getExtraComponents, getMessage, getName, parse

Methods inherited from class java.lang.Object

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

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

clear, encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

CWE

public CWE(Message message)

Creates a new CWE type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

Specified by:

getComponents in interface Composite

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Specified by:

getComponent in interface Composite

Parameters:

number - The component number (0-indexed)

Throws:

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

getIdentifier

public ST getIdentifier()

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

getCwe1_Identifier

public ST getCwe1_Identifier()

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

getText

public ST getText()

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

getCwe2_Text

public ST getCwe2_Text()

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

getNameOfCodingSystem

public IS getNameOfCodingSystem()

Returns name of coding system (component #3). This is a convenience method that saves you from casting and handling an exception.

getCwe3_NameOfCodingSystem

public IS getCwe3_NameOfCodingSystem()

Returns name of coding system (component #3). This is a convenience method that saves you from casting and handling an exception.

getAlternateIdentifier

public ST getAlternateIdentifier()

Returns alternate identifier (ST) (component #4). This is a convenience method that saves you from casting and handling an exception.

getCwe4_AlternateIdentifier

public ST getCwe4_AlternateIdentifier()

Returns alternate identifier (ST) (component #4). This is a convenience method that saves you from casting and handling an exception.

getAlternateText

public ST getAlternateText()

Returns alternate text (component #5). This is a convenience method that saves you from casting and handling an exception.

getCwe5_AlternateText

public ST getCwe5_AlternateText()

Returns alternate text (component #5). This is a convenience method that saves you from casting and handling an exception.

getNameOfAlternateCodingSystem

public IS getNameOfAlternateCodingSystem()

Returns name of alternate coding system (component #6). This is a convenience method that saves you from casting and handling an exception.

getCwe6_NameOfAlternateCodingSystem

public IS getCwe6_NameOfAlternateCodingSystem()

Returns name of alternate coding system (component #6). This is a convenience method that saves you from casting and handling an exception.

getCodingSystemVersionID

public ST getCodingSystemVersionID()

Returns coding system version ID (component #7). This is a convenience method that saves you from casting and handling an exception.

getCwe7_CodingSystemVersionID

public ST getCwe7_CodingSystemVersionID()

Returns coding system version ID (component #7). This is a convenience method that saves you from casting and handling an exception.

getAlternateCodingSystemVersionID

public ST getAlternateCodingSystemVersionID()

Returns alternate coding system version ID (component #8). This is a convenience method that saves you from casting and handling an exception.

getCwe8_AlternateCodingSystemVersionID

public ST getCwe8_AlternateCodingSystemVersionID()

Returns alternate coding system version ID (component #8). This is a convenience method that saves you from casting and handling an exception.

getOriginalText

public ST getOriginalText()

Returns original text (component #9). This is a convenience method that saves you from casting and handling an exception.

getCwe9_OriginalText

public ST getCwe9_OriginalText()

Returns original text (component #9). This is a convenience method that saves you from casting and handling an exception.