OBX (HAPI - 04 - Generated Structures v2.3 2.0 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractSegment
  - - ca.uhn.hl7v2.model.v23.segment.OBX

All Implemented Interfaces:

Segment, Structure, Serializable
```
public class OBX
extends AbstractSegment
```
Represents an HL7 OBX message segment (Observation segment). This segment has the following fields:
- OBX-1: Set ID - OBX (SI) optional
- OBX-2: Value Type (ID)
- OBX-3: Observation Identifier (CE)
- OBX-4: Observation Sub-ID (ST) optional
- OBX-5: Observation Value (Varies) optional repeating
- OBX-6: Units (CE) optional
- OBX-7: References Range (ST) optional
- OBX-8: Abnormal Flags (ID) optional repeating
- OBX-9: Probability (NM) optional
- OBX-10: Nature of Abnormal Test (ID) optional
- OBX-11: Observ Result Status (ID)
- OBX-12: Date Last Obs Normal Values (TS) optional
- OBX-13: User Defined Access Checks (ST) optional
- OBX-14: Date/Time of the Observation (TS) optional
- OBX-15: Producer's ID (CE) optional
- OBX-16: Responsible Observer (XCN) optional
- OBX-17: Observation Method (CE) optional repeating
See Also:
Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description

OBX(Group parent, ModelClassFactory factory)
Creates a new OBX segment

Constructors
Constructor and Description
`OBX(Group parent, ModelClassFactory factory)` Creates a new OBX segment

Method Summary

Methods
Modifier and Type	Method and Description
`protected Type`	`createNewTypeWithoutReflection(int field)`
`ID[]`	`getAbnormalFlags()` Returns all repetitions of Abnormal Flags (OBX-8).
`ID`	`getAbnormalFlags(int rep)` Returns a specific repetition of OBX-8: "Abnormal Flags" - creates it if necessary
`int`	`getAbnormalFlagsReps()` Returns a count of the current number of repetitions of Abnormal Flags (OBX-8).
`TS`	`getDateLastObsNormalValues()` Returns OBX-12: "Date Last Obs Normal Values" - creates it if necessary
`TS`	`getDateTimeOfTheObservation()` Returns OBX-14: "Date/Time of the Observation" - creates it if necessary
`ID`	`getNatureOfAbnormalTest()` Returns OBX-10: "Nature of Abnormal Test" - creates it if necessary
`CE`	`getObservationIdentifier()` Returns OBX-3: "Observation Identifier" - creates it if necessary
`CE[]`	`getObservationMethod()` Returns all repetitions of Observation Method (OBX-17).
`CE`	`getObservationMethod(int rep)` Returns a specific repetition of OBX-17: "Observation Method" - creates it if necessary
`int`	`getObservationMethodReps()` Returns a count of the current number of repetitions of Observation Method (OBX-17).
`ST`	`getObservationSubID()` Returns OBX-4: "Observation Sub-ID" - creates it if necessary
`Varies[]`	`getObservationValue()` Returns all repetitions of Observation Value (OBX-5).
`Varies`	`getObservationValue(int rep)` Returns a specific repetition of OBX-5: "Observation Value" - creates it if necessary
`int`	`getObservationValueReps()` Returns a count of the current number of repetitions of Observation Value (OBX-5).
`ID`	`getObservResultStatus()` Returns OBX-11: "Observ Result Status" - creates it if necessary
`SI`	`getObx1_SetIDOBX()` Returns OBX-1: "Set ID - OBX" - creates it if necessary
`ID`	`getObx10_NatureOfAbnormalTest()` Returns OBX-10: "Nature of Abnormal Test" - creates it if necessary
`ID`	`getObx11_ObservResultStatus()` Returns OBX-11: "Observ Result Status" - creates it if necessary
`TS`	`getObx12_DateLastObsNormalValues()` Returns OBX-12: "Date Last Obs Normal Values" - creates it if necessary
`ST`	`getObx13_UserDefinedAccessChecks()` Returns OBX-13: "User Defined Access Checks" - creates it if necessary
`TS`	`getObx14_DateTimeOfTheObservation()` Returns OBX-14: "Date/Time of the Observation" - creates it if necessary
`CE`	`getObx15_ProducerSID()` Returns OBX-15: "Producer's ID" - creates it if necessary
`XCN`	`getObx16_ResponsibleObserver()` Returns OBX-16: "Responsible Observer" - creates it if necessary
`CE[]`	`getObx17_ObservationMethod()` Returns all repetitions of Observation Method (OBX-17).
`CE`	`getObx17_ObservationMethod(int rep)` Returns a specific repetition of OBX-17: "Observation Method" - creates it if necessary
`int`	`getObx17_ObservationMethodReps()` Returns a count of the current number of repetitions of Observation Method (OBX-17).
`ID`	`getObx2_ValueType()` Returns OBX-2: "Value Type" - creates it if necessary
`CE`	`getObx3_ObservationIdentifier()` Returns OBX-3: "Observation Identifier" - creates it if necessary
`ST`	`getObx4_ObservationSubID()` Returns OBX-4: "Observation Sub-ID" - creates it if necessary
`Varies[]`	`getObx5_ObservationValue()` Returns all repetitions of Observation Value (OBX-5).
`Varies`	`getObx5_ObservationValue(int rep)` Returns a specific repetition of OBX-5: "Observation Value" - creates it if necessary
`int`	`getObx5_ObservationValueReps()` Returns a count of the current number of repetitions of Observation Value (OBX-5).
`CE`	`getObx6_Units()` Returns OBX-6: "Units" - creates it if necessary
`ST`	`getObx7_ReferencesRange()` Returns OBX-7: "References Range" - creates it if necessary
`ID[]`	`getObx8_AbnormalFlags()` Returns all repetitions of Abnormal Flags (OBX-8).
`ID`	`getObx8_AbnormalFlags(int rep)` Returns a specific repetition of OBX-8: "Abnormal Flags" - creates it if necessary
`int`	`getObx8_AbnormalFlagsReps()` Returns a count of the current number of repetitions of Abnormal Flags (OBX-8).
`NM`	`getObx9_Probability()` Returns OBX-9: "Probability" - creates it if necessary
`NM`	`getProbability()` Returns OBX-9: "Probability" - creates it if necessary
`CE`	`getProducerSID()` Returns OBX-15: "Producer's ID" - creates it if necessary
`ST`	`getReferencesRange()` Returns OBX-7: "References Range" - creates it if necessary
`XCN`	`getResponsibleObserver()` Returns OBX-16: "Responsible Observer" - creates it if necessary
`SI`	`getSetIDOBX()` Returns OBX-1: "Set ID - OBX" - creates it if necessary
`CE`	`getUnits()` Returns OBX-6: "Units" - creates it if necessary
`ST`	`getUserDefinedAccessChecks()` Returns OBX-13: "User Defined Access Checks" - creates it if necessary
`ID`	`getValueType()` Returns OBX-2: "Value Type" - creates it if necessary
`ID`	`insertAbnormalFlags(int rep)` Inserts a repetition of OBX-8: "Abnormal Flags" at a specific index
`CE`	`insertObservationMethod(int rep)` Inserts a repetition of OBX-17: "Observation Method" at a specific index
`Varies`	`insertObservationValue(int rep)` Inserts a repetition of OBX-5: "Observation Value" at a specific index
`CE`	`insertObx17_ObservationMethod(int rep)` Inserts a repetition of OBX-17: "Observation Method" at a specific index
`Varies`	`insertObx5_ObservationValue(int rep)` Inserts a repetition of OBX-5: "Observation Value" at a specific index
`ID`	`insertObx8_AbnormalFlags(int rep)` Inserts a repetition of OBX-8: "Abnormal Flags" at a specific index
`ID`	`removeAbnormalFlags(int rep)` Removes a repetition of OBX-8: "Abnormal Flags" at a specific index
`CE`	`removeObservationMethod(int rep)` Removes a repetition of OBX-17: "Observation Method" at a specific index
`Varies`	`removeObservationValue(int rep)` Removes a repetition of OBX-5: "Observation Value" at a specific index
`CE`	`removeObx17_ObservationMethod(int rep)` Removes a repetition of OBX-17: "Observation Method" at a specific index
`Varies`	`removeObx5_ObservationValue(int rep)` Removes a repetition of OBX-5: "Observation Value" at a specific index
`ID`	`removeObx8_AbnormalFlags(int rep)` Removes a repetition of OBX-8: "Abnormal Flags" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment
add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure
getMessage, getParent

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.Structure
getMessage, getParent

- Constructor Detail
  - OBX
```
public OBX(Group parent,
   ModelClassFactory factory)
```
    Creates a new OBX segment
- Method Detail
  - getSetIDOBX
```
public SI getSetIDOBX()
```
    Returns OBX-1: "Set ID - OBX" - creates it if necessary
  - getObx1_SetIDOBX
```
public SI getObx1_SetIDOBX()
```
    Returns OBX-1: "Set ID - OBX" - creates it if necessary
  - getValueType
```
public ID getValueType()
```
    Returns OBX-2: "Value Type" - creates it if necessary
  - getObx2_ValueType
```
public ID getObx2_ValueType()
```
    Returns OBX-2: "Value Type" - creates it if necessary
  - getObservationIdentifier
```
public CE getObservationIdentifier()
```
    Returns OBX-3: "Observation Identifier" - creates it if necessary
  - getObx3_ObservationIdentifier
```
public CE getObx3_ObservationIdentifier()
```
    Returns OBX-3: "Observation Identifier" - creates it if necessary
  - getObservationSubID
```
public ST getObservationSubID()
```
    Returns OBX-4: "Observation Sub-ID" - creates it if necessary
  - getObx4_ObservationSubID
```
public ST getObx4_ObservationSubID()
```
    Returns OBX-4: "Observation Sub-ID" - creates it if necessary
  - getObservationValue
```
public Varies[] getObservationValue()
```
    Returns all repetitions of Observation Value (OBX-5).
  - getObx5_ObservationValue
```
public Varies[] getObx5_ObservationValue()
```
    Returns all repetitions of Observation Value (OBX-5).
  - getObservationValueReps
```
public int getObservationValueReps()
```
    Returns a count of the current number of repetitions of Observation Value (OBX-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - getObservationValue
```
public Varies getObservationValue(int rep)
```
    Returns a specific repetition of OBX-5: "Observation Value" - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed)
  - getObx5_ObservationValue
```
public Varies getObx5_ObservationValue(int rep)
```
    Returns a specific repetition of OBX-5: "Observation Value" - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed)
  - getObx5_ObservationValueReps
```
public int getObx5_ObservationValueReps()
```
    Returns a count of the current number of repetitions of Observation Value (OBX-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - insertObservationValue
```
public Varies insertObservationValue(int rep)
                              throws HL7Exception
```
    Inserts a repetition of OBX-5: "Observation Value" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - insertObx5_ObservationValue
```
public Varies insertObx5_ObservationValue(int rep)
                                   throws HL7Exception
```
    Inserts a repetition of OBX-5: "Observation Value" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - removeObservationValue
```
public Varies removeObservationValue(int rep)
                              throws HL7Exception
```
    Removes a repetition of OBX-5: "Observation Value" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - removeObx5_ObservationValue
```
public Varies removeObx5_ObservationValue(int rep)
                                   throws HL7Exception
```
    Removes a repetition of OBX-5: "Observation Value" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - getUnits
```
public CE getUnits()
```
    Returns OBX-6: "Units" - creates it if necessary
  - getObx6_Units
```
public CE getObx6_Units()
```
    Returns OBX-6: "Units" - creates it if necessary
  - getReferencesRange
```
public ST getReferencesRange()
```
    Returns OBX-7: "References Range" - creates it if necessary
  - getObx7_ReferencesRange
```
public ST getObx7_ReferencesRange()
```
    Returns OBX-7: "References Range" - creates it if necessary
  - getAbnormalFlags
```
public ID[] getAbnormalFlags()
```
    Returns all repetitions of Abnormal Flags (OBX-8).
  - getObx8_AbnormalFlags
```
public ID[] getObx8_AbnormalFlags()
```
    Returns all repetitions of Abnormal Flags (OBX-8).
  - getAbnormalFlagsReps
```
public int getAbnormalFlagsReps()
```
    Returns a count of the current number of repetitions of Abnormal Flags (OBX-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - getAbnormalFlags
```
public ID getAbnormalFlags(int rep)
```
    Returns a specific repetition of OBX-8: "Abnormal Flags" - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed)
  - getObx8_AbnormalFlags
```
public ID getObx8_AbnormalFlags(int rep)
```
    Returns a specific repetition of OBX-8: "Abnormal Flags" - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed)
  - getObx8_AbnormalFlagsReps
```
public int getObx8_AbnormalFlagsReps()
```
    Returns a count of the current number of repetitions of Abnormal Flags (OBX-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - insertAbnormalFlags
```
public ID insertAbnormalFlags(int rep)
                       throws HL7Exception
```
    Inserts a repetition of OBX-8: "Abnormal Flags" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - insertObx8_AbnormalFlags
```
public ID insertObx8_AbnormalFlags(int rep)
                            throws HL7Exception
```
    Inserts a repetition of OBX-8: "Abnormal Flags" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - removeAbnormalFlags
```
public ID removeAbnormalFlags(int rep)
                       throws HL7Exception
```
    Removes a repetition of OBX-8: "Abnormal Flags" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - removeObx8_AbnormalFlags
```
public ID removeObx8_AbnormalFlags(int rep)
                            throws HL7Exception
```
    Removes a repetition of OBX-8: "Abnormal Flags" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - getProbability
```
public NM getProbability()
```
    Returns OBX-9: "Probability" - creates it if necessary
  - getObx9_Probability
```
public NM getObx9_Probability()
```
    Returns OBX-9: "Probability" - creates it if necessary
  - getNatureOfAbnormalTest
```
public ID getNatureOfAbnormalTest()
```
    Returns OBX-10: "Nature of Abnormal Test" - creates it if necessary
  - getObx10_NatureOfAbnormalTest
```
public ID getObx10_NatureOfAbnormalTest()
```
    Returns OBX-10: "Nature of Abnormal Test" - creates it if necessary
  - getObservResultStatus
```
public ID getObservResultStatus()
```
    Returns OBX-11: "Observ Result Status" - creates it if necessary
  - getObx11_ObservResultStatus
```
public ID getObx11_ObservResultStatus()
```
    Returns OBX-11: "Observ Result Status" - creates it if necessary
  - getDateLastObsNormalValues
```
public TS getDateLastObsNormalValues()
```
    Returns OBX-12: "Date Last Obs Normal Values" - creates it if necessary
  - getObx12_DateLastObsNormalValues
```
public TS getObx12_DateLastObsNormalValues()
```
    Returns OBX-12: "Date Last Obs Normal Values" - creates it if necessary
  - getUserDefinedAccessChecks
```
public ST getUserDefinedAccessChecks()
```
    Returns OBX-13: "User Defined Access Checks" - creates it if necessary
  - getObx13_UserDefinedAccessChecks
```
public ST getObx13_UserDefinedAccessChecks()
```
    Returns OBX-13: "User Defined Access Checks" - creates it if necessary
  - getDateTimeOfTheObservation
```
public TS getDateTimeOfTheObservation()
```
    Returns OBX-14: "Date/Time of the Observation" - creates it if necessary
  - getObx14_DateTimeOfTheObservation
```
public TS getObx14_DateTimeOfTheObservation()
```
    Returns OBX-14: "Date/Time of the Observation" - creates it if necessary
  - getProducerSID
```
public CE getProducerSID()
```
    Returns OBX-15: "Producer's ID" - creates it if necessary
  - getObx15_ProducerSID
```
public CE getObx15_ProducerSID()
```
    Returns OBX-15: "Producer's ID" - creates it if necessary
  - getResponsibleObserver
```
public XCN getResponsibleObserver()
```
    Returns OBX-16: "Responsible Observer" - creates it if necessary
  - getObx16_ResponsibleObserver
```
public XCN getObx16_ResponsibleObserver()
```
    Returns OBX-16: "Responsible Observer" - creates it if necessary
  - getObservationMethod
```
public CE[] getObservationMethod()
```
    Returns all repetitions of Observation Method (OBX-17).
  - getObx17_ObservationMethod
```
public CE[] getObx17_ObservationMethod()
```
    Returns all repetitions of Observation Method (OBX-17).
  - getObservationMethodReps
```
public int getObservationMethodReps()
```
    Returns a count of the current number of repetitions of Observation Method (OBX-17). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - getObservationMethod
```
public CE getObservationMethod(int rep)
```
    Returns a specific repetition of OBX-17: "Observation Method" - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed)
  - getObx17_ObservationMethod
```
public CE getObx17_ObservationMethod(int rep)
```
    Returns a specific repetition of OBX-17: "Observation Method" - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed)
  - getObx17_ObservationMethodReps
```
public int getObx17_ObservationMethodReps()
```
    Returns a count of the current number of repetitions of Observation Method (OBX-17). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - insertObservationMethod
```
public CE insertObservationMethod(int rep)
                           throws HL7Exception
```
    Inserts a repetition of OBX-17: "Observation Method" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - insertObx17_ObservationMethod
```
public CE insertObx17_ObservationMethod(int rep)
                                 throws HL7Exception
```
    Inserts a repetition of OBX-17: "Observation Method" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - removeObservationMethod
```
public CE removeObservationMethod(int rep)
                           throws HL7Exception
```
    Removes a repetition of OBX-17: "Observation Method" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - removeObx17_ObservationMethod
```
public CE removeObx17_ObservationMethod(int rep)
                                 throws HL7Exception
```
    Removes a repetition of OBX-17: "Observation Method" at a specific index
    
    Parameters:
    rep - The repetition index (0-indexed)
    
    Throws:
    
    HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)
  - createNewTypeWithoutReflection
```
protected Type createNewTypeWithoutReflection(int field)
```
    Overrides:
    
    createNewTypeWithoutReflection in class AbstractSegment

Class OBX

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OBX

Method Detail

getSetIDOBX

getObx1_SetIDOBX

getValueType

getObx2_ValueType

getObservationIdentifier

getObx3_ObservationIdentifier

getObservationSubID

getObx4_ObservationSubID

getObservationValue

getObx5_ObservationValue

getObservationValueReps

getObservationValue

getObx5_ObservationValue

getObx5_ObservationValueReps

insertObservationValue

insertObx5_ObservationValue

removeObservationValue

removeObx5_ObservationValue

getUnits

getObx6_Units

getReferencesRange

getObx7_ReferencesRange

getAbnormalFlags

getObx8_AbnormalFlags

getAbnormalFlagsReps

getAbnormalFlags

getObx8_AbnormalFlags

getObx8_AbnormalFlagsReps

insertAbnormalFlags

insertObx8_AbnormalFlags

removeAbnormalFlags

removeObx8_AbnormalFlags

getProbability

getObx9_Probability

getNatureOfAbnormalTest

getObx10_NatureOfAbnormalTest

getObservResultStatus

getObx11_ObservResultStatus

getDateLastObsNormalValues

getObx12_DateLastObsNormalValues

getUserDefinedAccessChecks

getObx13_UserDefinedAccessChecks

getDateTimeOfTheObservation

getObx14_DateTimeOfTheObservation

getProducerSID

getObx15_ProducerSID

getResponsibleObserver

getObx16_ResponsibleObserver

getObservationMethod

getObx17_ObservationMethod

getObservationMethodReps

getObservationMethod

getObx17_ObservationMethod

getObx17_ObservationMethodReps

insertObservationMethod

insertObx17_ObservationMethod

removeObservationMethod

removeObx17_ObservationMethod

createNewTypeWithoutReflection