Package ca.uhn.hl7v2.model.v24.segment

Class PTH

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v24.segment.PTH

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class PTH
extends AbstractSegment

Represents an HL7 PTH message segment (Pathway). This segment has the following fields:

• PTH-1: Action Code (ID)
• PTH-2: Pathway ID (CE)
• PTH-3: Pathway Instance ID (EI)
• PTH-4: Pathway Established Date/Time (TS)
• PTH-5: Pathway Life Cycle Status (CE) optional
• PTH-6: Change Pathway Life Cycle Status Date/Time (TS) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Type	createNewTypeWithoutReflection(int field)
ID	getActionCode()	Returns PTH-1: "Action Code" - creates it if necessary
TS	getChangePathwayLifeCycleStatusDateTime()	Returns PTH-6: "Change Pathway Life Cycle Status Date/Time" - creates it if necessary
TS	getPathwayEstablishedDateTime()	Returns PTH-4: "Pathway Established Date/Time" - creates it if necessary
CE	getPathwayID()	Returns PTH-2: "Pathway ID" - creates it if necessary
EI	getPathwayInstanceID()	Returns PTH-3: "Pathway Instance ID" - creates it if necessary
CE	getPathwayLifeCycleStatus()	Returns PTH-5: "Pathway Life Cycle Status" - creates it if necessary
ID	getPth1_ActionCode()	Returns PTH-1: "Action Code" - creates it if necessary
CE	getPth2_PathwayID()	Returns PTH-2: "Pathway ID" - creates it if necessary
EI	getPth3_PathwayInstanceID()	Returns PTH-3: "Pathway Instance ID" - creates it if necessary
TS	getPth4_PathwayEstablishedDateTime()	Returns PTH-4: "Pathway Established Date/Time" - creates it if necessary
CE	getPth5_PathwayLifeCycleStatus()	Returns PTH-5: "Pathway Life Cycle Status" - creates it if necessary
TS	getPth6_ChangePathwayLifeCycleStatusDateTime()	Returns PTH-6: "Change Pathway Life Cycle Status Date/Time" - creates it if necessary

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 Details

PTH

public PTH(Group parent,
 ModelClassFactory factory)

Creates a new PTH segment

Method Details

getActionCode

public ID getActionCode()

Returns PTH-1: "Action Code" - creates it if necessary

getPth1_ActionCode

public ID getPth1_ActionCode()

Returns PTH-1: "Action Code" - creates it if necessary

getPathwayID

public CE getPathwayID()

Returns PTH-2: "Pathway ID" - creates it if necessary

getPth2_PathwayID

public CE getPth2_PathwayID()

Returns PTH-2: "Pathway ID" - creates it if necessary

getPathwayInstanceID

public EI getPathwayInstanceID()

Returns PTH-3: "Pathway Instance ID" - creates it if necessary

getPth3_PathwayInstanceID

public EI getPth3_PathwayInstanceID()

Returns PTH-3: "Pathway Instance ID" - creates it if necessary

getPathwayEstablishedDateTime

public TS getPathwayEstablishedDateTime()

Returns PTH-4: "Pathway Established Date/Time" - creates it if necessary

getPth4_PathwayEstablishedDateTime

public TS getPth4_PathwayEstablishedDateTime()

Returns PTH-4: "Pathway Established Date/Time" - creates it if necessary

getPathwayLifeCycleStatus

public CE getPathwayLifeCycleStatus()

Returns PTH-5: "Pathway Life Cycle Status" - creates it if necessary

getPth5_PathwayLifeCycleStatus

public CE getPth5_PathwayLifeCycleStatus()

Returns PTH-5: "Pathway Life Cycle Status" - creates it if necessary

getChangePathwayLifeCycleStatusDateTime

public TS getChangePathwayLifeCycleStatusDateTime()

Returns PTH-6: "Change Pathway Life Cycle Status Date/Time" - creates it if necessary

getPth6_ChangePathwayLifeCycleStatusDateTime

public TS getPth6_ChangePathwayLifeCycleStatusDateTime()

Returns PTH-6: "Change Pathway Life Cycle Status Date/Time" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment