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

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

All Implemented Interfaces:

Composite, Type, Serializable

public class CX
extends AbstractType
implements Composite

Represents an HL7 CX (extended composite ID with check digit) data type. This type consists of the following components:

• ID (ST)
• check digit (ST) (ST)
• code identifying the check digit scheme employed (ID)
• assigning authority (HD)
• identifier type code (ID) (ID)
• assigning facility (HD)
• effective date (DT) (DT)
• expiration date (DT)

See Also:

Serialized Form

Constructor Summary

CX(Message message)
Creates a new CX type

Method Summary

HD	getAssigningAuthority() Returns assigning authority (component #4).
HD	getAssigningFacility() Returns assigning facility (component #6).
ST	getCheckDigit() Returns check digit (ST) (component #2).
ID	getCodeIdentifyingTheCheckDigitSchemeEmployed() Returns code identifying the check digit scheme employed (component #3).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
ST	getCx1_ID() Returns ID (component #1).
ST	getCx2_CheckDigit() Returns check digit (ST) (component #2).
ID	getCx3_CodeIdentifyingTheCheckDigitSchemeEmployed() Returns code identifying the check digit scheme employed (component #3).
HD	getCx4_AssigningAuthority() Returns assigning authority (component #4).
ID	getCx5_IdentifierTypeCode() Returns identifier type code (ID) (component #5).
HD	getCx6_AssigningFacility() Returns assigning facility (component #6).
DT	getCx7_EffectiveDate() Returns effective date (DT) (component #7).
DT	getCx8_ExpirationDate() Returns expiration date (component #8).
DT	getEffectiveDate() Returns effective date (DT) (component #7).
DT	getExpirationDate() Returns expiration date (component #8).
ST	getID() Returns ID (component #1).
ID	getIdentifierTypeCode() Returns identifier type code (ID) (component #5).

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

CX

public CX(Message message)

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

getID

public ST getID()

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

getCx1_ID

public ST getCx1_ID()

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

getCheckDigit

public ST getCheckDigit()

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

getCx2_CheckDigit

public ST getCx2_CheckDigit()

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

getCodeIdentifyingTheCheckDigitSchemeEmployed

public ID getCodeIdentifyingTheCheckDigitSchemeEmployed()

Returns code identifying the check digit scheme employed (component #3). This is a convenience method that saves you from casting and handling an exception.

getCx3_CodeIdentifyingTheCheckDigitSchemeEmployed

public ID getCx3_CodeIdentifyingTheCheckDigitSchemeEmployed()

Returns code identifying the check digit scheme employed (component #3). This is a convenience method that saves you from casting and handling an exception.

getAssigningAuthority

public HD getAssigningAuthority()

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

getCx4_AssigningAuthority

public HD getCx4_AssigningAuthority()

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

getIdentifierTypeCode

public ID getIdentifierTypeCode()

Returns identifier type code (ID) (component #5). This is a convenience method that saves you from casting and handling an exception.

getCx5_IdentifierTypeCode

public ID getCx5_IdentifierTypeCode()

Returns identifier type code (ID) (component #5). This is a convenience method that saves you from casting and handling an exception.

getAssigningFacility

public HD getAssigningFacility()

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

getCx6_AssigningFacility

public HD getCx6_AssigningFacility()

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

getEffectiveDate

public DT getEffectiveDate()

Returns effective date (DT) (component #7). This is a convenience method that saves you from casting and handling an exception.

getCx7_EffectiveDate

public DT getCx7_EffectiveDate()

Returns effective date (DT) (component #7). This is a convenience method that saves you from casting and handling an exception.

getExpirationDate

public DT getExpirationDate()

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

getCx8_ExpirationDate

public DT getCx8_ExpirationDate()

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