ca.uhn.hl7v2.model.v24.segment
Class OBX

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.OBX

All Implemented Interfaces:

Segment, Structure, Serializable

public class OBX
extends AbstractSegment

Represents an HL7 OBX message segment (Observation/Result). This segment has the following fields:

• OBX-1: Set ID - OBX (SI) optional
• OBX-2: Value Type (ID) optional
• 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 (IS) optional
• OBX-9: Probability (NM) optional repeating
• OBX-10: Nature of Abnormal Test (ID) optional
• OBX-11: Observation Result Status (ID)
• OBX-12: Date Last Observation Normal Value (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
• OBX-18: Equipment Instance Identifier (EI) optional repeating
• OBX-19: Date/Time of the Analysis (TS) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
IS	getAbnormalFlags() Returns OBX-8: "Abnormal Flags" - creates it if necessary
TS	getDateLastObservationNormalValue() Returns OBX-12: "Date Last Observation Normal Value" - creates it if necessary
TS	getDateTimeOfTheAnalysis() Returns OBX-19: "Date/Time of the Analysis" - creates it if necessary
TS	getDateTimeOfTheObservation() Returns OBX-14: "Date/Time of the Observation" - creates it if necessary
EI[]	getEquipmentInstanceIdentifier() Returns all repetitions of Equipment Instance Identifier (OBX-18).
EI	getEquipmentInstanceIdentifier(int rep) Returns a specific repetition of OBX-18: "Equipment Instance Identifier" - creates it if necessary
int	getEquipmentInstanceIdentifierReps() Returns a count of the current number of repetitions of Equipment Instance Identifier (OBX-18).
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).
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 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).
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_ObservationResultStatus() Returns OBX-11: "Observation Result Status" - creates it if necessary
TS	getObx12_DateLastObservationNormalValue() Returns OBX-12: "Date Last Observation Normal Value" - 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(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).
EI	getObx18_EquipmentInstanceIdentifier(int rep) Returns a specific repetition of OBX-18: "Equipment Instance Identifier" - creates it if necessary
int	getObx18_EquipmentInstanceIdentifierReps() Returns a count of the current number of repetitions of Equipment Instance Identifier (OBX-18).
TS	getObx19_DateTimeOfTheAnalysis() Returns OBX-19: "Date/Time of the Analysis" - 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(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
IS	getObx8_AbnormalFlags() Returns OBX-8: "Abnormal Flags" - creates it if necessary
NM	getObx9_Probability(int rep) Returns a specific repetition of OBX-9: "Probability" - creates it if necessary
int	getObx9_ProbabilityReps() Returns a count of the current number of repetitions of Probability (OBX-9).
NM[]	getProbability() Returns all repetitions of Probability (OBX-9).
NM	getProbability(int rep) Returns a specific repetition of OBX-9: "Probability" - creates it if necessary
int	getProbabilityReps() Returns a count of the current number of repetitions of Probability (OBX-9).
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
EI	insertEquipmentInstanceIdentifier(int rep) Inserts a repetition of OBX-18: "Equipment Instance Identifier" 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
EI	insertObx18_EquipmentInstanceIdentifier(int rep) Inserts a repetition of OBX-18: "Equipment Instance Identifier" at a specific index
Varies	insertObx5_ObservationValue(int rep) Inserts a repetition of OBX-5: "Observation Value" at a specific index
NM	insertObx9_Probability(int rep) Inserts a repetition of OBX-9: "Probability" at a specific index
NM	insertProbability(int rep) Inserts a repetition of OBX-9: "Probability" at a specific index
EI	removeEquipmentInstanceIdentifier(int rep) Removes a repetition of OBX-18: "Equipment Instance Identifier" 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
EI	removeObx18_EquipmentInstanceIdentifier(int rep) Removes a repetition of OBX-18: "Equipment Instance Identifier" at a specific index
Varies	removeObx5_ObservationValue(int rep) Removes a repetition of OBX-5: "Observation Value" at a specific index
NM	removeObx9_Probability(int rep) Removes a repetition of OBX-9: "Probability" at a specific index
NM	removeProbability(int rep) Removes a repetition of OBX-9: "Probability" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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).

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 IS getAbnormalFlags()

Returns OBX-8: "Abnormal Flags" - creates it if necessary

getObx8_AbnormalFlags

public IS getObx8_AbnormalFlags()

Returns OBX-8: "Abnormal Flags" - creates it if necessary

getProbability

public NM[] getProbability()

Returns all repetitions of Probability (OBX-9).

getProbabilityReps

public int getProbabilityReps()

Returns a count of the current number of repetitions of Probability (OBX-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getProbability

public NM getProbability(int rep)

Returns a specific repetition of OBX-9: "Probability" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getObx9_Probability

public NM getObx9_Probability(int rep)

Returns a specific repetition of OBX-9: "Probability" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getObx9_ProbabilityReps

public int getObx9_ProbabilityReps()

Returns a count of the current number of repetitions of Probability (OBX-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertProbability

public NM insertProbability(int rep)
                     throws HL7Exception

Inserts a repetition of OBX-9: "Probability" 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)

insertObx9_Probability

public NM insertObx9_Probability(int rep)
                          throws HL7Exception

Inserts a repetition of OBX-9: "Probability" 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)

removeProbability

public NM removeProbability(int rep)
                     throws HL7Exception

Removes a repetition of OBX-9: "Probability" 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)

removeObx9_Probability

public NM removeObx9_Probability(int rep)
                          throws HL7Exception

Removes a repetition of OBX-9: "Probability" 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)

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

getDateLastObservationNormalValue

public TS getDateLastObservationNormalValue()

Returns OBX-12: "Date Last Observation Normal Value" - creates it if necessary

getObx12_DateLastObservationNormalValue

public TS getObx12_DateLastObservationNormalValue()

Returns OBX-12: "Date Last Observation Normal Value" - 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).

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)

getEquipmentInstanceIdentifier

public EI[] getEquipmentInstanceIdentifier()

Returns all repetitions of Equipment Instance Identifier (OBX-18).

getEquipmentInstanceIdentifierReps

public int getEquipmentInstanceIdentifierReps()

Returns a count of the current number of repetitions of Equipment Instance Identifier (OBX-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getEquipmentInstanceIdentifier

public EI getEquipmentInstanceIdentifier(int rep)

Returns a specific repetition of OBX-18: "Equipment Instance Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getObx18_EquipmentInstanceIdentifier

public EI getObx18_EquipmentInstanceIdentifier(int rep)

Returns a specific repetition of OBX-18: "Equipment Instance Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getObx18_EquipmentInstanceIdentifierReps

public int getObx18_EquipmentInstanceIdentifierReps()

Returns a count of the current number of repetitions of Equipment Instance Identifier (OBX-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertEquipmentInstanceIdentifier

public EI insertEquipmentInstanceIdentifier(int rep)
                                     throws HL7Exception

Inserts a repetition of OBX-18: "Equipment Instance Identifier" 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)

insertObx18_EquipmentInstanceIdentifier

public EI insertObx18_EquipmentInstanceIdentifier(int rep)
                                           throws HL7Exception

Inserts a repetition of OBX-18: "Equipment Instance Identifier" 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)

removeEquipmentInstanceIdentifier

public EI removeEquipmentInstanceIdentifier(int rep)
                                     throws HL7Exception

Removes a repetition of OBX-18: "Equipment Instance Identifier" 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)

removeObx18_EquipmentInstanceIdentifier

public EI removeObx18_EquipmentInstanceIdentifier(int rep)
                                           throws HL7Exception

Removes a repetition of OBX-18: "Equipment Instance Identifier" 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)

getDateTimeOfTheAnalysis

public TS getDateTimeOfTheAnalysis()

Returns OBX-19: "Date/Time of the Analysis" - creates it if necessary

getObx19_DateTimeOfTheAnalysis

public TS getObx19_DateTimeOfTheAnalysis()

Returns OBX-19: "Date/Time of the Analysis" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment