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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class RXC
extends AbstractSegment

Represents an HL7 RXC message segment (Pharmacy/Treatment Component Order). This segment has the following fields:

• RXC-1: RX Component Type (ID)
• RXC-2: Component Code (CE)
• RXC-3: Component Amount (NM)
• RXC-4: Component Units (CE)
• RXC-5: Component Strength (NM) optional
• RXC-6: Component Strength Units (CE) optional
• RXC-7: Supplementary Code (CE) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
NM	getComponentAmount() Returns RXC-3: "Component Amount" - creates it if necessary
CE	getComponentCode() Returns RXC-2: "Component Code" - creates it if necessary
NM	getComponentStrength() Returns RXC-5: "Component Strength" - creates it if necessary
CE	getComponentStrengthUnits() Returns RXC-6: "Component Strength Units" - creates it if necessary
CE	getComponentUnits() Returns RXC-4: "Component Units" - creates it if necessary
ID	getRxc1_RXComponentType() Returns RXC-1: "RX Component Type" - creates it if necessary
CE	getRxc2_ComponentCode() Returns RXC-2: "Component Code" - creates it if necessary
NM	getRxc3_ComponentAmount() Returns RXC-3: "Component Amount" - creates it if necessary
CE	getRxc4_ComponentUnits() Returns RXC-4: "Component Units" - creates it if necessary
NM	getRxc5_ComponentStrength() Returns RXC-5: "Component Strength" - creates it if necessary
CE	getRxc6_ComponentStrengthUnits() Returns RXC-6: "Component Strength Units" - creates it if necessary
CE	getRxc7_SupplementaryCode(int rep) Returns a specific repetition of RXC-7: "Supplementary Code" - creates it if necessary
int	getRxc7_SupplementaryCodeReps() Returns a count of the current number of repetitions of Supplementary Code (RXC-7).
ID	getRXComponentType() Returns RXC-1: "RX Component Type" - creates it if necessary
CE[]	getSupplementaryCode() Returns all repetitions of Supplementary Code (RXC-7).
CE	getSupplementaryCode(int rep) Returns a specific repetition of RXC-7: "Supplementary Code" - creates it if necessary
int	getSupplementaryCodeReps() Returns a count of the current number of repetitions of Supplementary Code (RXC-7).
CE	insertRxc7_SupplementaryCode(int rep) Inserts a repetition of RXC-7: "Supplementary Code" at a specific index
CE	insertSupplementaryCode(int rep) Inserts a repetition of RXC-7: "Supplementary Code" at a specific index
CE	removeRxc7_SupplementaryCode(int rep) Removes a repetition of RXC-7: "Supplementary Code" at a specific index
CE	removeSupplementaryCode(int rep) Removes a repetition of RXC-7: "Supplementary Code" 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

RXC

public RXC(Group parent,
           ModelClassFactory factory)

Creates a new RXC segment

Method Detail

getRXComponentType

public ID getRXComponentType()

Returns RXC-1: "RX Component Type" - creates it if necessary

getRxc1_RXComponentType

public ID getRxc1_RXComponentType()

Returns RXC-1: "RX Component Type" - creates it if necessary

getComponentCode

public CE getComponentCode()

Returns RXC-2: "Component Code" - creates it if necessary

getRxc2_ComponentCode

public CE getRxc2_ComponentCode()

Returns RXC-2: "Component Code" - creates it if necessary

getComponentAmount

public NM getComponentAmount()

Returns RXC-3: "Component Amount" - creates it if necessary

getRxc3_ComponentAmount

public NM getRxc3_ComponentAmount()

Returns RXC-3: "Component Amount" - creates it if necessary

getComponentUnits

public CE getComponentUnits()

Returns RXC-4: "Component Units" - creates it if necessary

getRxc4_ComponentUnits

public CE getRxc4_ComponentUnits()

Returns RXC-4: "Component Units" - creates it if necessary

getComponentStrength

public NM getComponentStrength()

Returns RXC-5: "Component Strength" - creates it if necessary

getRxc5_ComponentStrength

public NM getRxc5_ComponentStrength()

Returns RXC-5: "Component Strength" - creates it if necessary

getComponentStrengthUnits

public CE getComponentStrengthUnits()

Returns RXC-6: "Component Strength Units" - creates it if necessary

getRxc6_ComponentStrengthUnits

public CE getRxc6_ComponentStrengthUnits()

Returns RXC-6: "Component Strength Units" - creates it if necessary

getSupplementaryCode

public CE[] getSupplementaryCode()

Returns all repetitions of Supplementary Code (RXC-7).

getSupplementaryCodeReps

public int getSupplementaryCodeReps()

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

getSupplementaryCode

public CE getSupplementaryCode(int rep)

Returns a specific repetition of RXC-7: "Supplementary Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getRxc7_SupplementaryCode

public CE getRxc7_SupplementaryCode(int rep)

Returns a specific repetition of RXC-7: "Supplementary Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getRxc7_SupplementaryCodeReps

public int getRxc7_SupplementaryCodeReps()

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

insertSupplementaryCode

public CE insertSupplementaryCode(int rep)
                           throws HL7Exception

Inserts a repetition of RXC-7: "Supplementary Code" 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)

insertRxc7_SupplementaryCode

public CE insertRxc7_SupplementaryCode(int rep)
                                throws HL7Exception

Inserts a repetition of RXC-7: "Supplementary Code" 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)

removeSupplementaryCode

public CE removeSupplementaryCode(int rep)
                           throws HL7Exception

Removes a repetition of RXC-7: "Supplementary Code" 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)

removeRxc7_SupplementaryCode

public CE removeRxc7_SupplementaryCode(int rep)
                                throws HL7Exception

Removes a repetition of RXC-7: "Supplementary Code" 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)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment