ca.uhn.hl7v2.model.v281.segment

Class EQU

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v281.segment.EQU

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class EQU
extends AbstractSegment

Represents an HL7 EQU message segment (Equipment Detail). This segment has the following fields:

• EQU-1: Equipment Instance Identifier (EI) repeating
• EQU-2: Event Date/Time (DTM)
• EQU-3: Equipment State (CWE) optional
• EQU-4: Local/Remote Control State (CWE) optional
• EQU-5: Alert Level (CWE) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
EQU(Group parent, ModelClassFactory factory) Creates a new EQU segment

Method Summary

Modifier and Type	Method and Description
protected Type	createNewTypeWithoutReflection(int field)
CWE	getAlertLevel() Returns EQU-5: "Alert Level" - creates it if necessary
EI[]	getEqu1_EquipmentInstanceIdentifier() Returns all repetitions of Equipment Instance Identifier (EQU-1).
EI	getEqu1_EquipmentInstanceIdentifier(int rep) Returns a specific repetition of EQU-1: "Equipment Instance Identifier" - creates it if necessary
int	getEqu1_EquipmentInstanceIdentifierReps() Returns a count of the current number of repetitions of Equipment Instance Identifier (EQU-1).
DTM	getEqu2_EventDateTime() Returns EQU-2: "Event Date/Time" - creates it if necessary
CWE	getEqu3_EquipmentState() Returns EQU-3: "Equipment State" - creates it if necessary
CWE	getEqu4_LocalRemoteControlState() Returns EQU-4: "Local/Remote Control State" - creates it if necessary
CWE	getEqu5_AlertLevel() Returns EQU-5: "Alert Level" - creates it if necessary
EI[]	getEquipmentInstanceIdentifier() Returns all repetitions of Equipment Instance Identifier (EQU-1).
EI	getEquipmentInstanceIdentifier(int rep) Returns a specific repetition of EQU-1: "Equipment Instance Identifier" - creates it if necessary
int	getEquipmentInstanceIdentifierReps() Returns a count of the current number of repetitions of Equipment Instance Identifier (EQU-1).
CWE	getEquipmentState() Returns EQU-3: "Equipment State" - creates it if necessary
DTM	getEventDateTime() Returns EQU-2: "Event Date/Time" - creates it if necessary
CWE	getLocalRemoteControlState() Returns EQU-4: "Local/Remote Control State" - creates it if necessary
EI	insertEqu1_EquipmentInstanceIdentifier(int rep) Inserts a repetition of EQU-1: "Equipment Instance Identifier" at a specific index
EI	insertEquipmentInstanceIdentifier(int rep) Inserts a repetition of EQU-1: "Equipment Instance Identifier" at a specific index
EI	removeEqu1_EquipmentInstanceIdentifier(int rep) Removes a repetition of EQU-1: "Equipment Instance Identifier" at a specific index
EI	removeEquipmentInstanceIdentifier(int rep) Removes a repetition of EQU-1: "Equipment Instance Identifier" 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

EQU

public EQU(Group parent,
           ModelClassFactory factory)

Creates a new EQU segment

Method Detail

getEquipmentInstanceIdentifier

public EI[] getEquipmentInstanceIdentifier()

Returns all repetitions of Equipment Instance Identifier (EQU-1).

getEqu1_EquipmentInstanceIdentifier

public EI[] getEqu1_EquipmentInstanceIdentifier()

Returns all repetitions of Equipment Instance Identifier (EQU-1).

getEquipmentInstanceIdentifierReps

public int getEquipmentInstanceIdentifierReps()

Returns a count of the current number of repetitions of Equipment Instance Identifier (EQU-1). 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 EQU-1: "Equipment Instance Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getEqu1_EquipmentInstanceIdentifier

public EI getEqu1_EquipmentInstanceIdentifier(int rep)

Returns a specific repetition of EQU-1: "Equipment Instance Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getEqu1_EquipmentInstanceIdentifierReps

public int getEqu1_EquipmentInstanceIdentifierReps()

Returns a count of the current number of repetitions of Equipment Instance Identifier (EQU-1). 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 EQU-1: "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)

insertEqu1_EquipmentInstanceIdentifier

public EI insertEqu1_EquipmentInstanceIdentifier(int rep)
                                          throws HL7Exception

Inserts a repetition of EQU-1: "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 EQU-1: "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)

removeEqu1_EquipmentInstanceIdentifier

public EI removeEqu1_EquipmentInstanceIdentifier(int rep)
                                          throws HL7Exception

Removes a repetition of EQU-1: "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)

getEventDateTime

public DTM getEventDateTime()

Returns EQU-2: "Event Date/Time" - creates it if necessary

getEqu2_EventDateTime

public DTM getEqu2_EventDateTime()

Returns EQU-2: "Event Date/Time" - creates it if necessary

getEquipmentState

public CWE getEquipmentState()

Returns EQU-3: "Equipment State" - creates it if necessary

getEqu3_EquipmentState

public CWE getEqu3_EquipmentState()

Returns EQU-3: "Equipment State" - creates it if necessary

getLocalRemoteControlState

public CWE getLocalRemoteControlState()

Returns EQU-4: "Local/Remote Control State" - creates it if necessary

getEqu4_LocalRemoteControlState

public CWE getEqu4_LocalRemoteControlState()

Returns EQU-4: "Local/Remote Control State" - creates it if necessary

getAlertLevel

public CWE getAlertLevel()

Returns EQU-5: "Alert Level" - creates it if necessary

getEqu5_AlertLevel

public CWE getEqu5_AlertLevel()

Returns EQU-5: "Alert Level" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment