OBX (HAPI - Java HL7 API - Generated Structures v2.2 2.2 API)

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

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable
```
public class OBX
extends AbstractSegment
```
Represents an HL7 OBX message segment (OBSERVATION RESULT). This segment has the following fields:
- OBX-1: Set ID - Observational Simple (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
- 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: Observation result status (ID)
- OBX-12: Effective date last observation 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 (CN) optional
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`	`getDateTimeOfTheObservation()` Returns OBX-14: "Date / time of the observation" - creates it if necessary
`TS`	`getEffectiveDateLastObservationNormalValues()` Returns OBX-12: "Effective date last observation normal values" - 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
`ID`	`getObservationResultStatus()` Returns OBX-11: "Observation result status" - creates it if necessary
`ST`	`getObservationSubID()` Returns OBX-4: "Observation Sub-ID" - creates it if necessary
`Varies`	`getObservationValue()` Returns OBX-5: "Observation Value" - creates it if necessary
`SI`	`getObx1_SetIDObservationalSimple()` Returns OBX-1: "Set ID - Observational Simple" - creates it if necessary
`ID`	`getObx10_NatureOfAbnormalTest()` Returns OBX-10: "Nature of Abnormal Test" - creates it if necessary
`ID`	`getObx11_ObservationResultStatus()` Returns OBX-11: "Observation result status" - creates it if necessary
`TS`	`getObx12_EffectiveDateLastObservationNormalValues()` Returns OBX-12: "Effective date last observation 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
`CN`	`getObx16_ResponsibleObserver()` Returns OBX-16: "Responsible Observer" - creates it if necessary
`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 OBX-5: "Observation Value" - creates it if necessary
`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
`CN`	`getResponsibleObserver()` Returns OBX-16: "Responsible Observer" - creates it if necessary
`SI`	`getSetIDObservationalSimple()` Returns OBX-1: "Set ID - Observational Simple" - 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
`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
`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
accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, 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
  - getSetIDObservationalSimple
```
public SI getSetIDObservationalSimple()
```
    Returns OBX-1: "Set ID - Observational Simple" - creates it if necessary
  - getObx1_SetIDObservationalSimple
```
public SI getObx1_SetIDObservationalSimple()
```
    Returns OBX-1: "Set ID - Observational Simple" - 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 OBX-5: "Observation Value" - creates it if necessary
  - getObx5_ObservationValue
```
public Varies getObx5_ObservationValue()
```
    Returns OBX-5: "Observation Value" - creates it if necessary
  - 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
  - getObservationResultStatus
```
public ID getObservationResultStatus()
```
    Returns OBX-11: "Observation result status" - creates it if necessary
  - getObx11_ObservationResultStatus
```
public ID getObx11_ObservationResultStatus()
```
    Returns OBX-11: "Observation result status" - creates it if necessary
  - getEffectiveDateLastObservationNormalValues
```
public TS getEffectiveDateLastObservationNormalValues()
```
    Returns OBX-12: "Effective date last observation normal values" - creates it if necessary
  - getObx12_EffectiveDateLastObservationNormalValues
```
public TS getObx12_EffectiveDateLastObservationNormalValues()
```
    Returns OBX-12: "Effective date last observation 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 CN getResponsibleObserver()
```
    Returns OBX-16: "Responsible Observer" - creates it if necessary
  - getObx16_ResponsibleObserver
```
public CN getObx16_ResponsibleObserver()
```
    Returns OBX-16: "Responsible Observer" - creates it if necessary
  - 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

getSetIDObservationalSimple

getObx1_SetIDObservationalSimple

getValueType

getObx2_ValueType

getObservationIdentifier

getObx3_ObservationIdentifier

getObservationSubID

getObx4_ObservationSubID

getObservationValue

getObx5_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

getObservationResultStatus

getObx11_ObservationResultStatus

getEffectiveDateLastObservationNormalValues

getObx12_EffectiveDateLastObservationNormalValues

getUserDefinedAccessChecks

getObx13_UserDefinedAccessChecks

getDateTimeOfTheObservation

getObx14_DateTimeOfTheObservation

getProducerSID

getObx15_ProducerSID

getResponsibleObserver

getObx16_ResponsibleObserver

createNewTypeWithoutReflection