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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class EVN
extends AbstractSegment

Represents an HL7 EVN message segment (Event Type). This segment has the following fields:

• EVN-1: Event Type Code (ID) optional
• EVN-2: Recorded Date/Time (TS)
• EVN-3: Date/Time Planned Event (TS) optional
• EVN-4: Event Reason Code (IS) optional
• EVN-5: Operator ID (XCN) optional repeating
• EVN-6: Event Occurred (TS) optional
• EVN-7: Event Facility (HD) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
TS	getDateTimePlannedEvent() Returns EVN-3: "Date/Time Planned Event" - creates it if necessary
HD	getEventFacility() Returns EVN-7: "Event Facility" - creates it if necessary
TS	getEventOccurred() Returns EVN-6: "Event Occurred" - creates it if necessary
IS	getEventReasonCode() Returns EVN-4: "Event Reason Code" - creates it if necessary
ID	getEventTypeCode() Returns EVN-1: "Event Type Code" - creates it if necessary
ID	getEvn1_EventTypeCode() Returns EVN-1: "Event Type Code" - creates it if necessary
TS	getEvn2_RecordedDateTime() Returns EVN-2: "Recorded Date/Time" - creates it if necessary
TS	getEvn3_DateTimePlannedEvent() Returns EVN-3: "Date/Time Planned Event" - creates it if necessary
IS	getEvn4_EventReasonCode() Returns EVN-4: "Event Reason Code" - creates it if necessary
XCN	getEvn5_OperatorID(int rep) Returns a specific repetition of EVN-5: "Operator ID" - creates it if necessary
int	getEvn5_OperatorIDReps() Returns a count of the current number of repetitions of Operator ID (EVN-5).
TS	getEvn6_EventOccurred() Returns EVN-6: "Event Occurred" - creates it if necessary
HD	getEvn7_EventFacility() Returns EVN-7: "Event Facility" - creates it if necessary
XCN[]	getOperatorID() Returns all repetitions of Operator ID (EVN-5).
XCN	getOperatorID(int rep) Returns a specific repetition of EVN-5: "Operator ID" - creates it if necessary
int	getOperatorIDReps() Returns a count of the current number of repetitions of Operator ID (EVN-5).
TS	getRecordedDateTime() Returns EVN-2: "Recorded Date/Time" - creates it if necessary
XCN	insertEvn5_OperatorID(int rep) Inserts a repetition of EVN-5: "Operator ID" at a specific index
XCN	insertOperatorID(int rep) Inserts a repetition of EVN-5: "Operator ID" at a specific index
XCN	removeEvn5_OperatorID(int rep) Removes a repetition of EVN-5: "Operator ID" at a specific index
XCN	removeOperatorID(int rep) Removes a repetition of EVN-5: "Operator ID" 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

EVN

public EVN(Group parent,
           ModelClassFactory factory)

Creates a new EVN segment

Method Detail

getEventTypeCode

public ID getEventTypeCode()

Returns EVN-1: "Event Type Code" - creates it if necessary

getEvn1_EventTypeCode

public ID getEvn1_EventTypeCode()

Returns EVN-1: "Event Type Code" - creates it if necessary

getRecordedDateTime

public TS getRecordedDateTime()

Returns EVN-2: "Recorded Date/Time" - creates it if necessary

getEvn2_RecordedDateTime

public TS getEvn2_RecordedDateTime()

Returns EVN-2: "Recorded Date/Time" - creates it if necessary

getDateTimePlannedEvent

public TS getDateTimePlannedEvent()

Returns EVN-3: "Date/Time Planned Event" - creates it if necessary

getEvn3_DateTimePlannedEvent

public TS getEvn3_DateTimePlannedEvent()

Returns EVN-3: "Date/Time Planned Event" - creates it if necessary

getEventReasonCode

public IS getEventReasonCode()

Returns EVN-4: "Event Reason Code" - creates it if necessary

getEvn4_EventReasonCode

public IS getEvn4_EventReasonCode()

Returns EVN-4: "Event Reason Code" - creates it if necessary

getOperatorID

public XCN[] getOperatorID()

Returns all repetitions of Operator ID (EVN-5).

getOperatorIDReps

public int getOperatorIDReps()

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

getOperatorID

public XCN getOperatorID(int rep)

Returns a specific repetition of EVN-5: "Operator ID" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getEvn5_OperatorID

public XCN getEvn5_OperatorID(int rep)

Returns a specific repetition of EVN-5: "Operator ID" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getEvn5_OperatorIDReps

public int getEvn5_OperatorIDReps()

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

insertOperatorID

public XCN insertOperatorID(int rep)
                     throws HL7Exception

Inserts a repetition of EVN-5: "Operator ID" 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)

insertEvn5_OperatorID

public XCN insertEvn5_OperatorID(int rep)
                          throws HL7Exception

Inserts a repetition of EVN-5: "Operator ID" 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)

removeOperatorID

public XCN removeOperatorID(int rep)
                     throws HL7Exception

Removes a repetition of EVN-5: "Operator ID" 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)

removeEvn5_OperatorID

public XCN removeEvn5_OperatorID(int rep)
                          throws HL7Exception

Removes a repetition of EVN-5: "Operator ID" 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)

getEventOccurred

public TS getEventOccurred()

Returns EVN-6: "Event Occurred" - creates it if necessary

getEvn6_EventOccurred

public TS getEvn6_EventOccurred()

Returns EVN-6: "Event Occurred" - creates it if necessary

getEventFacility

public HD getEventFacility()

Returns EVN-7: "Event Facility" - creates it if necessary

getEvn7_EventFacility

public HD getEvn7_EventFacility()

Returns EVN-7: "Event Facility" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment