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

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

All Implemented Interfaces:

Composite, Type, Serializable

public class SPS
extends AbstractType
implements Composite

Represents an HL7 SPS (specimen source) data type. This type consists of the following components:

• specimen source name or code (CE)
• additives (TX)
• freetext (TX)
• body site (CE)
• site modifier (CE)
• collection modifier method code (CE)
• specimen role (CE)

See Also:

Serialized Form

Constructor Summary

SPS(Message message)
Creates a new SPS type

Method Summary

TX	getAdditives() Returns additives (component #2).
CE	getBodySite() Returns body site (component #4).
CE	getCollectionModifierMethodCode() Returns collection modifier method code (component #6).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
TX	getFreetext() Returns freetext (component #3).
CE	getSiteModifier() Returns site modifier (component #5).
CE	getSpecimenRole() Returns specimen role (component #7).
CE	getSpecimenSourceNameOrCode() Returns specimen source name or code (component #1).
CE	getSps1_SpecimenSourceNameOrCode() Returns specimen source name or code (component #1).
TX	getSps2_Additives() Returns additives (component #2).
TX	getSps3_Freetext() Returns freetext (component #3).
CE	getSps4_BodySite() Returns body site (component #4).
CE	getSps5_SiteModifier() Returns site modifier (component #5).
CE	getSps6_CollectionModifierMethodCode() Returns collection modifier method code (component #6).
CE	getSps7_SpecimenRole() Returns specimen role (component #7).

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

SPS

public SPS(Message message)

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

getSpecimenSourceNameOrCode

public CE getSpecimenSourceNameOrCode()

Returns specimen source name or code (component #1). This is a convenience method that saves you from casting and handling an exception.

getSps1_SpecimenSourceNameOrCode

public CE getSps1_SpecimenSourceNameOrCode()

Returns specimen source name or code (component #1). This is a convenience method that saves you from casting and handling an exception.

getAdditives

public TX getAdditives()

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

getSps2_Additives

public TX getSps2_Additives()

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

getFreetext

public TX getFreetext()

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

getSps3_Freetext

public TX getSps3_Freetext()

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

getBodySite

public CE getBodySite()

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

getSps4_BodySite

public CE getSps4_BodySite()

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

getSiteModifier

public CE getSiteModifier()

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

getSps5_SiteModifier

public CE getSps5_SiteModifier()

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

getCollectionModifierMethodCode

public CE getCollectionModifierMethodCode()

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

getSps6_CollectionModifierMethodCode

public CE getSps6_CollectionModifierMethodCode()

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

getSpecimenRole

public CE getSpecimenRole()

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

getSps7_SpecimenRole

public CE getSps7_SpecimenRole()

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