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

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

All Implemented Interfaces:

Composite, Type, Serializable

public class OSD
extends AbstractType
implements Composite

Represents an HL7 OSD (order sequence) data type. This type consists of the following components:

• sequence/results flag (ID)
• placer order number: entity identifier (ST)
• placer order number: namespace ID (IS)
• filler order number: entity identifier (ST)
• filler order number: namespace ID (IS)
• sequence condition value (ST)
• maximum number of repeats (NM)
• placer order number: universal ID (ST)
• placer order number; universal ID type (ID)
• filler order number: universal ID (ST)
• filler order number: universal ID type (ID)

See Also:

Serialized Form

Constructor Summary

OSD(Message message)
Creates a new OSD type

Method Summary

Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
ST	getFillerOrderNumberEntityIdentifier() Returns filler order number: entity identifier (component #4).
IS	getFillerOrderNumberNamespaceID() Returns filler order number: namespace ID (component #5).
ST	getFillerOrderNumberUniversalID() Returns filler order number: universal ID (component #10).
ID	getFillerOrderNumberUniversalIDType() Returns filler order number: universal ID type (component #11).
NM	getMaximumNumberOfRepeats() Returns maximum number of repeats (component #7).
ID	getOsd1_SequenceResultsFlag() Returns sequence/results flag (component #1).
ST	getOsd10_FillerOrderNumberUniversalID() Returns filler order number: universal ID (component #10).
ID	getOsd11_FillerOrderNumberUniversalIDType() Returns filler order number: universal ID type (component #11).
ST	getOsd2_PlacerOrderNumberEntityIdentifier() Returns placer order number: entity identifier (component #2).
IS	getOsd3_PlacerOrderNumberNamespaceID() Returns placer order number: namespace ID (component #3).
ST	getOsd4_FillerOrderNumberEntityIdentifier() Returns filler order number: entity identifier (component #4).
IS	getOsd5_FillerOrderNumberNamespaceID() Returns filler order number: namespace ID (component #5).
ST	getOsd6_SequenceConditionValue() Returns sequence condition value (component #6).
NM	getOsd7_MaximumNumberOfRepeats() Returns maximum number of repeats (component #7).
ST	getOsd8_PlacerOrderNumberUniversalID() Returns placer order number: universal ID (component #8).
ID	getOsd9_PlacerOrderNumberUniversalIDType() Returns placer order number; universal ID type (component #9).
ST	getPlacerOrderNumberEntityIdentifier() Returns placer order number: entity identifier (component #2).
IS	getPlacerOrderNumberNamespaceID() Returns placer order number: namespace ID (component #3).
ST	getPlacerOrderNumberUniversalID() Returns placer order number: universal ID (component #8).
ID	getPlacerOrderNumberUniversalIDType() Returns placer order number; universal ID type (component #9).
ST	getSequenceConditionValue() Returns sequence condition value (component #6).
ID	getSequenceResultsFlag() Returns sequence/results flag (component #1).

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

OSD

public OSD(Message message)

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

getSequenceResultsFlag

public ID getSequenceResultsFlag()

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

getOsd1_SequenceResultsFlag

public ID getOsd1_SequenceResultsFlag()

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

getPlacerOrderNumberEntityIdentifier

public ST getPlacerOrderNumberEntityIdentifier()

Returns placer order number: entity identifier (component #2). This is a convenience method that saves you from casting and handling an exception.

getOsd2_PlacerOrderNumberEntityIdentifier

public ST getOsd2_PlacerOrderNumberEntityIdentifier()

Returns placer order number: entity identifier (component #2). This is a convenience method that saves you from casting and handling an exception.

getPlacerOrderNumberNamespaceID

public IS getPlacerOrderNumberNamespaceID()

Returns placer order number: namespace ID (component #3). This is a convenience method that saves you from casting and handling an exception.

getOsd3_PlacerOrderNumberNamespaceID

public IS getOsd3_PlacerOrderNumberNamespaceID()

Returns placer order number: namespace ID (component #3). This is a convenience method that saves you from casting and handling an exception.

getFillerOrderNumberEntityIdentifier

public ST getFillerOrderNumberEntityIdentifier()

Returns filler order number: entity identifier (component #4). This is a convenience method that saves you from casting and handling an exception.

getOsd4_FillerOrderNumberEntityIdentifier

public ST getOsd4_FillerOrderNumberEntityIdentifier()

Returns filler order number: entity identifier (component #4). This is a convenience method that saves you from casting and handling an exception.

getFillerOrderNumberNamespaceID

public IS getFillerOrderNumberNamespaceID()

Returns filler order number: namespace ID (component #5). This is a convenience method that saves you from casting and handling an exception.

getOsd5_FillerOrderNumberNamespaceID

public IS getOsd5_FillerOrderNumberNamespaceID()

Returns filler order number: namespace ID (component #5). This is a convenience method that saves you from casting and handling an exception.

getSequenceConditionValue

public ST getSequenceConditionValue()

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

getOsd6_SequenceConditionValue

public ST getOsd6_SequenceConditionValue()

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

getMaximumNumberOfRepeats

public NM getMaximumNumberOfRepeats()

Returns maximum number of repeats (component #7). This is a convenience method that saves you from casting and handling an exception.

getOsd7_MaximumNumberOfRepeats

public NM getOsd7_MaximumNumberOfRepeats()

Returns maximum number of repeats (component #7). This is a convenience method that saves you from casting and handling an exception.

getPlacerOrderNumberUniversalID

public ST getPlacerOrderNumberUniversalID()

Returns placer order number: universal ID (component #8). This is a convenience method that saves you from casting and handling an exception.

getOsd8_PlacerOrderNumberUniversalID

public ST getOsd8_PlacerOrderNumberUniversalID()

Returns placer order number: universal ID (component #8). This is a convenience method that saves you from casting and handling an exception.

getPlacerOrderNumberUniversalIDType

public ID getPlacerOrderNumberUniversalIDType()

Returns placer order number; universal ID type (component #9). This is a convenience method that saves you from casting and handling an exception.

getOsd9_PlacerOrderNumberUniversalIDType

public ID getOsd9_PlacerOrderNumberUniversalIDType()

Returns placer order number; universal ID type (component #9). This is a convenience method that saves you from casting and handling an exception.

getFillerOrderNumberUniversalID

public ST getFillerOrderNumberUniversalID()

Returns filler order number: universal ID (component #10). This is a convenience method that saves you from casting and handling an exception.

getOsd10_FillerOrderNumberUniversalID

public ST getOsd10_FillerOrderNumberUniversalID()

Returns filler order number: universal ID (component #10). This is a convenience method that saves you from casting and handling an exception.

getFillerOrderNumberUniversalIDType

public ID getFillerOrderNumberUniversalIDType()

Returns filler order number: universal ID type (component #11). This is a convenience method that saves you from casting and handling an exception.

getOsd11_FillerOrderNumberUniversalIDType

public ID getOsd11_FillerOrderNumberUniversalIDType()

Returns filler order number: universal ID type (component #11). This is a convenience method that saves you from casting and handling an exception.