ORC (HAPI - 04 - Generated Structures v2.4 1.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

All Implemented Interfaces:: Segment, Structure, Serializable

public class ORC
extends AbstractSegment
extends AbstractSegment

Represents an HL7 ORC message segment (Common Order). This segment has the following fields:

ORC-1: Order Control (ID)
ORC-2: Placer Order Number (EI) optional
ORC-3: Filler Order Number (EI) optional
ORC-4: Placer Group Number (EI) optional
ORC-5: Order Status (ID) optional
ORC-6: Response Flag (ID) optional
ORC-7: Quantity/Timing (TQ) optional repeating
ORC-8: Parent Order (EIP) optional
ORC-9: Date/Time of Transaction (TS) optional
ORC-10: Entered By (XCN) optional repeating
ORC-11: Verified By (XCN) optional repeating
ORC-12: Ordering Provider (XCN) optional repeating
ORC-13: Enterer's Location (PL) optional
ORC-14: Call Back Phone Number (XTN) optional repeating
ORC-15: Order Effective Date/Time (TS) optional
ORC-16: Order Control Code Reason (CE) optional
ORC-17: Entering Organization (CE) optional
ORC-18: Entering Device (CE) optional
ORC-19: Action By (XCN) optional repeating
ORC-20: Advanced Beneficiary Notice Code (CE) optional
ORC-21: Ordering Facility Name (XON) optional repeating
ORC-22: Ordering Facility Address (XAD) optional repeating
ORC-23: Ordering Facility Phone Number (XTN) optional repeating
ORC-24: Ordering Provider Address (XAD) optional repeating
ORC-25: Order Status Modifier (CWE) optional

See Also:: Serialized Form

Constructor Summary
`ORC(Group parent, ModelClassFactory factory)` Creates a new ORC segment

Method Summary
`protected Type`	`createNewTypeWithoutReflection(int field)`
`XCN[]`	`getActionBy()` Returns all repetitions of Action By (ORC-19).
`XCN`	`getActionBy(int rep)` Returns a specific repetition of ORC-19: "Action By" - creates it if necessary
`int`	`getActionByReps()` Returns a count of the current number of repetitions of Action By (ORC-19).
`CE`	`getAdvancedBeneficiaryNoticeCode()` Returns ORC-20: "Advanced Beneficiary Notice Code" - creates it if necessary
`XTN[]`	`getCallBackPhoneNumber()` Returns all repetitions of Call Back Phone Number (ORC-14).
`XTN`	`getCallBackPhoneNumber(int rep)` Returns a specific repetition of ORC-14: "Call Back Phone Number" - creates it if necessary
`int`	`getCallBackPhoneNumberReps()` Returns a count of the current number of repetitions of Call Back Phone Number (ORC-14).
`TS`	`getDateTimeOfTransaction()` Returns ORC-9: "Date/Time of Transaction" - creates it if necessary
`XCN[]`	`getEnteredBy()` Returns all repetitions of Entered By (ORC-10).
`XCN`	`getEnteredBy(int rep)` Returns a specific repetition of ORC-10: "Entered By" - creates it if necessary
`int`	`getEnteredByReps()` Returns a count of the current number of repetitions of Entered By (ORC-10).
`PL`	`getEntererSLocation()` Returns ORC-13: "Enterer's Location" - creates it if necessary
`CE`	`getEnteringDevice()` Returns ORC-18: "Entering Device" - creates it if necessary
`CE`	`getEnteringOrganization()` Returns ORC-17: "Entering Organization" - creates it if necessary
`EI`	`getFillerOrderNumber()` Returns ORC-3: "Filler Order Number" - creates it if necessary
`ID`	`getOrc1_OrderControl()` Returns ORC-1: "Order Control" - creates it if necessary
`XCN`	`getOrc10_EnteredBy(int rep)` Returns a specific repetition of ORC-10: "Entered By" - creates it if necessary
`int`	`getOrc10_EnteredByReps()` Returns a count of the current number of repetitions of Entered By (ORC-10).
`XCN`	`getOrc11_VerifiedBy(int rep)` Returns a specific repetition of ORC-11: "Verified By" - creates it if necessary
`int`	`getOrc11_VerifiedByReps()` Returns a count of the current number of repetitions of Verified By (ORC-11).
`XCN`	`getOrc12_OrderingProvider(int rep)` Returns a specific repetition of ORC-12: "Ordering Provider" - creates it if necessary
`int`	`getOrc12_OrderingProviderReps()` Returns a count of the current number of repetitions of Ordering Provider (ORC-12).
`PL`	`getOrc13_EntererSLocation()` Returns ORC-13: "Enterer's Location" - creates it if necessary
`XTN`	`getOrc14_CallBackPhoneNumber(int rep)` Returns a specific repetition of ORC-14: "Call Back Phone Number" - creates it if necessary
`int`	`getOrc14_CallBackPhoneNumberReps()` Returns a count of the current number of repetitions of Call Back Phone Number (ORC-14).
`TS`	`getOrc15_OrderEffectiveDateTime()` Returns ORC-15: "Order Effective Date/Time" - creates it if necessary
`CE`	`getOrc16_OrderControlCodeReason()` Returns ORC-16: "Order Control Code Reason" - creates it if necessary
`CE`	`getOrc17_EnteringOrganization()` Returns ORC-17: "Entering Organization" - creates it if necessary
`CE`	`getOrc18_EnteringDevice()` Returns ORC-18: "Entering Device" - creates it if necessary
`XCN`	`getOrc19_ActionBy(int rep)` Returns a specific repetition of ORC-19: "Action By" - creates it if necessary
`int`	`getOrc19_ActionByReps()` Returns a count of the current number of repetitions of Action By (ORC-19).
`EI`	`getOrc2_PlacerOrderNumber()` Returns ORC-2: "Placer Order Number" - creates it if necessary
`CE`	`getOrc20_AdvancedBeneficiaryNoticeCode()` Returns ORC-20: "Advanced Beneficiary Notice Code" - creates it if necessary
`XON`	`getOrc21_OrderingFacilityName(int rep)` Returns a specific repetition of ORC-21: "Ordering Facility Name" - creates it if necessary
`int`	`getOrc21_OrderingFacilityNameReps()` Returns a count of the current number of repetitions of Ordering Facility Name (ORC-21).
`XAD`	`getOrc22_OrderingFacilityAddress(int rep)` Returns a specific repetition of ORC-22: "Ordering Facility Address" - creates it if necessary
`int`	`getOrc22_OrderingFacilityAddressReps()` Returns a count of the current number of repetitions of Ordering Facility Address (ORC-22).
`XTN`	`getOrc23_OrderingFacilityPhoneNumber(int rep)` Returns a specific repetition of ORC-23: "Ordering Facility Phone Number" - creates it if necessary
`int`	`getOrc23_OrderingFacilityPhoneNumberReps()` Returns a count of the current number of repetitions of Ordering Facility Phone Number (ORC-23).
`XAD`	`getOrc24_OrderingProviderAddress(int rep)` Returns a specific repetition of ORC-24: "Ordering Provider Address" - creates it if necessary
`int`	`getOrc24_OrderingProviderAddressReps()` Returns a count of the current number of repetitions of Ordering Provider Address (ORC-24).
`CWE`	`getOrc25_OrderStatusModifier()` Returns ORC-25: "Order Status Modifier" - creates it if necessary
`EI`	`getOrc3_FillerOrderNumber()` Returns ORC-3: "Filler Order Number" - creates it if necessary
`EI`	`getOrc4_PlacerGroupNumber()` Returns ORC-4: "Placer Group Number" - creates it if necessary
`ID`	`getOrc5_OrderStatus()` Returns ORC-5: "Order Status" - creates it if necessary
`ID`	`getOrc6_ResponseFlag()` Returns ORC-6: "Response Flag" - creates it if necessary
`TQ`	`getOrc7_QuantityTiming(int rep)` Returns a specific repetition of ORC-7: "Quantity/Timing" - creates it if necessary
`int`	`getOrc7_QuantityTimingReps()` Returns a count of the current number of repetitions of Quantity/Timing (ORC-7).
`EIP`	`getOrc8_ParentOrder()` Returns ORC-8: "Parent Order" - creates it if necessary
`TS`	`getOrc9_DateTimeOfTransaction()` Returns ORC-9: "Date/Time of Transaction" - creates it if necessary
`ID`	`getOrderControl()` Returns ORC-1: "Order Control" - creates it if necessary
`CE`	`getOrderControlCodeReason()` Returns ORC-16: "Order Control Code Reason" - creates it if necessary
`TS`	`getOrderEffectiveDateTime()` Returns ORC-15: "Order Effective Date/Time" - creates it if necessary
`XAD[]`	`getOrderingFacilityAddress()` Returns all repetitions of Ordering Facility Address (ORC-22).
`XAD`	`getOrderingFacilityAddress(int rep)` Returns a specific repetition of ORC-22: "Ordering Facility Address" - creates it if necessary
`int`	`getOrderingFacilityAddressReps()` Returns a count of the current number of repetitions of Ordering Facility Address (ORC-22).
`XON[]`	`getOrderingFacilityName()` Returns all repetitions of Ordering Facility Name (ORC-21).
`XON`	`getOrderingFacilityName(int rep)` Returns a specific repetition of ORC-21: "Ordering Facility Name" - creates it if necessary
`int`	`getOrderingFacilityNameReps()` Returns a count of the current number of repetitions of Ordering Facility Name (ORC-21).
`XTN[]`	`getOrderingFacilityPhoneNumber()` Returns all repetitions of Ordering Facility Phone Number (ORC-23).
`XTN`	`getOrderingFacilityPhoneNumber(int rep)` Returns a specific repetition of ORC-23: "Ordering Facility Phone Number" - creates it if necessary
`int`	`getOrderingFacilityPhoneNumberReps()` Returns a count of the current number of repetitions of Ordering Facility Phone Number (ORC-23).
`XCN[]`	`getOrderingProvider()` Returns all repetitions of Ordering Provider (ORC-12).
`XCN`	`getOrderingProvider(int rep)` Returns a specific repetition of ORC-12: "Ordering Provider" - creates it if necessary
`XAD[]`	`getOrderingProviderAddress()` Returns all repetitions of Ordering Provider Address (ORC-24).
`XAD`	`getOrderingProviderAddress(int rep)` Returns a specific repetition of ORC-24: "Ordering Provider Address" - creates it if necessary
`int`	`getOrderingProviderAddressReps()` Returns a count of the current number of repetitions of Ordering Provider Address (ORC-24).
`int`	`getOrderingProviderReps()` Returns a count of the current number of repetitions of Ordering Provider (ORC-12).
`ID`	`getOrderStatus()` Returns ORC-5: "Order Status" - creates it if necessary
`CWE`	`getOrderStatusModifier()` Returns ORC-25: "Order Status Modifier" - creates it if necessary
`EIP`	`getParentOrder()` Returns ORC-8: "Parent Order" - creates it if necessary
`EI`	`getPlacerGroupNumber()` Returns ORC-4: "Placer Group Number" - creates it if necessary
`EI`	`getPlacerOrderNumber()` Returns ORC-2: "Placer Order Number" - creates it if necessary
`TQ[]`	`getQuantityTiming()` Returns all repetitions of Quantity/Timing (ORC-7).
`TQ`	`getQuantityTiming(int rep)` Returns a specific repetition of ORC-7: "Quantity/Timing" - creates it if necessary
`int`	`getQuantityTimingReps()` Returns a count of the current number of repetitions of Quantity/Timing (ORC-7).
`ID`	`getResponseFlag()` Returns ORC-6: "Response Flag" - creates it if necessary
`XCN[]`	`getVerifiedBy()` Returns all repetitions of Verified By (ORC-11).
`XCN`	`getVerifiedBy(int rep)` Returns a specific repetition of ORC-11: "Verified By" - creates it if necessary
`int`	`getVerifiedByReps()` Returns a count of the current number of repetitions of Verified By (ORC-11).
`XCN`	`insertActionBy(int rep)` Inserts a repetition of ORC-19: "Action By" at a specific index
`XTN`	`insertCallBackPhoneNumber(int rep)` Inserts a repetition of ORC-14: "Call Back Phone Number" at a specific index
`XCN`	`insertEnteredBy(int rep)` Inserts a repetition of ORC-10: "Entered By" at a specific index
`XCN`	`insertOrc10_EnteredBy(int rep)` Inserts a repetition of ORC-10: "Entered By" at a specific index
`XCN`	`insertOrc11_VerifiedBy(int rep)` Inserts a repetition of ORC-11: "Verified By" at a specific index
`XCN`	`insertOrc12_OrderingProvider(int rep)` Inserts a repetition of ORC-12: "Ordering Provider" at a specific index
`XTN`	`insertOrc14_CallBackPhoneNumber(int rep)` Inserts a repetition of ORC-14: "Call Back Phone Number" at a specific index
`XCN`	`insertOrc19_ActionBy(int rep)` Inserts a repetition of ORC-19: "Action By" at a specific index
`XON`	`insertOrc21_OrderingFacilityName(int rep)` Inserts a repetition of ORC-21: "Ordering Facility Name" at a specific index
`XAD`	`insertOrc22_OrderingFacilityAddress(int rep)` Inserts a repetition of ORC-22: "Ordering Facility Address" at a specific index
`XTN`	`insertOrc23_OrderingFacilityPhoneNumber(int rep)` Inserts a repetition of ORC-23: "Ordering Facility Phone Number" at a specific index
`XAD`	`insertOrc24_OrderingProviderAddress(int rep)` Inserts a repetition of ORC-24: "Ordering Provider Address" at a specific index
`TQ`	`insertOrc7_QuantityTiming(int rep)` Inserts a repetition of ORC-7: "Quantity/Timing" at a specific index
`XAD`	`insertOrderingFacilityAddress(int rep)` Inserts a repetition of ORC-22: "Ordering Facility Address" at a specific index
`XON`	`insertOrderingFacilityName(int rep)` Inserts a repetition of ORC-21: "Ordering Facility Name" at a specific index
`XTN`	`insertOrderingFacilityPhoneNumber(int rep)` Inserts a repetition of ORC-23: "Ordering Facility Phone Number" at a specific index
`XCN`	`insertOrderingProvider(int rep)` Inserts a repetition of ORC-12: "Ordering Provider" at a specific index
`XAD`	`insertOrderingProviderAddress(int rep)` Inserts a repetition of ORC-24: "Ordering Provider Address" at a specific index
`TQ`	`insertQuantityTiming(int rep)` Inserts a repetition of ORC-7: "Quantity/Timing" at a specific index
`XCN`	`insertVerifiedBy(int rep)` Inserts a repetition of ORC-11: "Verified By" at a specific index
`XCN`	`removeActionBy(int rep)` Removes a repetition of ORC-19: "Action By" at a specific index
`XTN`	`removeCallBackPhoneNumber(int rep)` Removes a repetition of ORC-14: "Call Back Phone Number" at a specific index
`XCN`	`removeEnteredBy(int rep)` Removes a repetition of ORC-10: "Entered By" at a specific index
`XCN`	`removeOrc10_EnteredBy(int rep)` Removes a repetition of ORC-10: "Entered By" at a specific index
`XCN`	`removeOrc11_VerifiedBy(int rep)` Removes a repetition of ORC-11: "Verified By" at a specific index
`XCN`	`removeOrc12_OrderingProvider(int rep)` Removes a repetition of ORC-12: "Ordering Provider" at a specific index
`XTN`	`removeOrc14_CallBackPhoneNumber(int rep)` Removes a repetition of ORC-14: "Call Back Phone Number" at a specific index
`XCN`	`removeOrc19_ActionBy(int rep)` Removes a repetition of ORC-19: "Action By" at a specific index
`XON`	`removeOrc21_OrderingFacilityName(int rep)` Removes a repetition of ORC-21: "Ordering Facility Name" at a specific index
`XAD`	`removeOrc22_OrderingFacilityAddress(int rep)` Removes a repetition of ORC-22: "Ordering Facility Address" at a specific index
`XTN`	`removeOrc23_OrderingFacilityPhoneNumber(int rep)` Removes a repetition of ORC-23: "Ordering Facility Phone Number" at a specific index
`XAD`	`removeOrc24_OrderingProviderAddress(int rep)` Removes a repetition of ORC-24: "Ordering Provider Address" at a specific index
`TQ`	`removeOrc7_QuantityTiming(int rep)` Removes a repetition of ORC-7: "Quantity/Timing" at a specific index
`XAD`	`removeOrderingFacilityAddress(int rep)` Removes a repetition of ORC-22: "Ordering Facility Address" at a specific index
`XON`	`removeOrderingFacilityName(int rep)` Removes a repetition of ORC-21: "Ordering Facility Name" at a specific index
`XTN`	`removeOrderingFacilityPhoneNumber(int rep)` Removes a repetition of ORC-23: "Ordering Facility Phone Number" at a specific index
`XCN`	`removeOrderingProvider(int rep)` Removes a repetition of ORC-12: "Ordering Provider" at a specific index
`XAD`	`removeOrderingProviderAddress(int rep)` Removes a repetition of ORC-24: "Ordering Provider Address" at a specific index
`TQ`	`removeQuantityTiming(int rep)` Removes a repetition of ORC-7: "Quantity/Timing" at a specific index
`XCN`	`removeVerifiedBy(int rep)` Removes a repetition of ORC-11: "Verified By" 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

ORC

public ORC(Group parent,
           ModelClassFactory factory)

Creates a new ORC segment

Method Detail

getOrderControl

public ID getOrderControl()

Returns ORC-1: "Order Control" - creates it if necessary

getOrc1_OrderControl

public ID getOrc1_OrderControl()

Returns ORC-1: "Order Control" - creates it if necessary

getPlacerOrderNumber

public EI getPlacerOrderNumber()

Returns ORC-2: "Placer Order Number" - creates it if necessary

getOrc2_PlacerOrderNumber

public EI getOrc2_PlacerOrderNumber()

Returns ORC-2: "Placer Order Number" - creates it if necessary

getFillerOrderNumber

public EI getFillerOrderNumber()

Returns ORC-3: "Filler Order Number" - creates it if necessary

getOrc3_FillerOrderNumber

public EI getOrc3_FillerOrderNumber()

Returns ORC-3: "Filler Order Number" - creates it if necessary

getPlacerGroupNumber

public EI getPlacerGroupNumber()

Returns ORC-4: "Placer Group Number" - creates it if necessary

getOrc4_PlacerGroupNumber

public EI getOrc4_PlacerGroupNumber()

Returns ORC-4: "Placer Group Number" - creates it if necessary

getOrderStatus

public ID getOrderStatus()

Returns ORC-5: "Order Status" - creates it if necessary

getOrc5_OrderStatus

public ID getOrc5_OrderStatus()

Returns ORC-5: "Order Status" - creates it if necessary

getResponseFlag

public ID getResponseFlag()

Returns ORC-6: "Response Flag" - creates it if necessary

getOrc6_ResponseFlag

public ID getOrc6_ResponseFlag()

Returns ORC-6: "Response Flag" - creates it if necessary

getQuantityTiming

public TQ[] getQuantityTiming()

Returns all repetitions of Quantity/Timing (ORC-7).

getQuantityTimingReps

public int getQuantityTimingReps()

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

getQuantityTiming

public TQ getQuantityTiming(int rep)

Returns a specific repetition of ORC-7: "Quantity/Timing" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc7_QuantityTiming

public TQ getOrc7_QuantityTiming(int rep)

Returns a specific repetition of ORC-7: "Quantity/Timing" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc7_QuantityTimingReps

public int getOrc7_QuantityTimingReps()

insertQuantityTiming

public TQ insertQuantityTiming(int rep)
                        throws HL7Exception

Inserts a repetition of ORC-7: "Quantity/Timing" 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)

insertOrc7_QuantityTiming

public TQ insertOrc7_QuantityTiming(int rep)
                             throws HL7Exception

Inserts a repetition of ORC-7: "Quantity/Timing" 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)

removeQuantityTiming

public TQ removeQuantityTiming(int rep)
                        throws HL7Exception

Removes a repetition of ORC-7: "Quantity/Timing" 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)

removeOrc7_QuantityTiming

public TQ removeOrc7_QuantityTiming(int rep)
                             throws HL7Exception

Removes a repetition of ORC-7: "Quantity/Timing" 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)

getParentOrder

public EIP getParentOrder()

Returns ORC-8: "Parent Order" - creates it if necessary

getOrc8_ParentOrder

public EIP getOrc8_ParentOrder()

Returns ORC-8: "Parent Order" - creates it if necessary

getDateTimeOfTransaction

public TS getDateTimeOfTransaction()

Returns ORC-9: "Date/Time of Transaction" - creates it if necessary

getOrc9_DateTimeOfTransaction

public TS getOrc9_DateTimeOfTransaction()

Returns ORC-9: "Date/Time of Transaction" - creates it if necessary

getEnteredBy

public XCN[] getEnteredBy()

Returns all repetitions of Entered By (ORC-10).

getEnteredByReps

public int getEnteredByReps()

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

getEnteredBy

public XCN getEnteredBy(int rep)

Returns a specific repetition of ORC-10: "Entered By" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc10_EnteredBy

public XCN getOrc10_EnteredBy(int rep)

Returns a specific repetition of ORC-10: "Entered By" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc10_EnteredByReps

public int getOrc10_EnteredByReps()

insertEnteredBy

public XCN insertEnteredBy(int rep)
                    throws HL7Exception

Inserts a repetition of ORC-10: "Entered By" 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)

insertOrc10_EnteredBy

public XCN insertOrc10_EnteredBy(int rep)
                          throws HL7Exception

Inserts a repetition of ORC-10: "Entered By" 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)

removeEnteredBy

public XCN removeEnteredBy(int rep)
                    throws HL7Exception

Removes a repetition of ORC-10: "Entered By" 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)

removeOrc10_EnteredBy

public XCN removeOrc10_EnteredBy(int rep)
                          throws HL7Exception

Removes a repetition of ORC-10: "Entered By" 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)

getVerifiedBy

public XCN[] getVerifiedBy()

Returns all repetitions of Verified By (ORC-11).

getVerifiedByReps

public int getVerifiedByReps()

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

getVerifiedBy

public XCN getVerifiedBy(int rep)

Returns a specific repetition of ORC-11: "Verified By" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc11_VerifiedBy

public XCN getOrc11_VerifiedBy(int rep)

Returns a specific repetition of ORC-11: "Verified By" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc11_VerifiedByReps

public int getOrc11_VerifiedByReps()

insertVerifiedBy

public XCN insertVerifiedBy(int rep)
                     throws HL7Exception

Inserts a repetition of ORC-11: "Verified By" 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)

insertOrc11_VerifiedBy

public XCN insertOrc11_VerifiedBy(int rep)
                           throws HL7Exception

Inserts a repetition of ORC-11: "Verified By" 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)

removeVerifiedBy

public XCN removeVerifiedBy(int rep)
                     throws HL7Exception

Removes a repetition of ORC-11: "Verified By" 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)

removeOrc11_VerifiedBy

public XCN removeOrc11_VerifiedBy(int rep)
                           throws HL7Exception

Removes a repetition of ORC-11: "Verified By" 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)

getOrderingProvider

public XCN[] getOrderingProvider()

Returns all repetitions of Ordering Provider (ORC-12).

getOrderingProviderReps

public int getOrderingProviderReps()

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

getOrderingProvider

public XCN getOrderingProvider(int rep)

Returns a specific repetition of ORC-12: "Ordering Provider" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc12_OrderingProvider

public XCN getOrc12_OrderingProvider(int rep)

Returns a specific repetition of ORC-12: "Ordering Provider" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc12_OrderingProviderReps

public int getOrc12_OrderingProviderReps()

insertOrderingProvider

public XCN insertOrderingProvider(int rep)
                           throws HL7Exception

Inserts a repetition of ORC-12: "Ordering Provider" 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)

insertOrc12_OrderingProvider

public XCN insertOrc12_OrderingProvider(int rep)
                                 throws HL7Exception

Inserts a repetition of ORC-12: "Ordering Provider" 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)

removeOrderingProvider

public XCN removeOrderingProvider(int rep)
                           throws HL7Exception

Removes a repetition of ORC-12: "Ordering Provider" 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)

removeOrc12_OrderingProvider

public XCN removeOrc12_OrderingProvider(int rep)
                                 throws HL7Exception

Removes a repetition of ORC-12: "Ordering Provider" 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)

getEntererSLocation

public PL getEntererSLocation()

Returns ORC-13: "Enterer's Location" - creates it if necessary

getOrc13_EntererSLocation

public PL getOrc13_EntererSLocation()

Returns ORC-13: "Enterer's Location" - creates it if necessary

getCallBackPhoneNumber

public XTN[] getCallBackPhoneNumber()

Returns all repetitions of Call Back Phone Number (ORC-14).

getCallBackPhoneNumberReps

public int getCallBackPhoneNumberReps()

Returns a count of the current number of repetitions of Call Back Phone Number (ORC-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getCallBackPhoneNumber

public XTN getCallBackPhoneNumber(int rep)

Returns a specific repetition of ORC-14: "Call Back Phone Number" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc14_CallBackPhoneNumber

public XTN getOrc14_CallBackPhoneNumber(int rep)

Returns a specific repetition of ORC-14: "Call Back Phone Number" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc14_CallBackPhoneNumberReps

public int getOrc14_CallBackPhoneNumberReps()

insertCallBackPhoneNumber

public XTN insertCallBackPhoneNumber(int rep)
                              throws HL7Exception

Inserts a repetition of ORC-14: "Call Back Phone Number" 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)

insertOrc14_CallBackPhoneNumber

public XTN insertOrc14_CallBackPhoneNumber(int rep)
                                    throws HL7Exception

Inserts a repetition of ORC-14: "Call Back Phone Number" 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)

removeCallBackPhoneNumber

public XTN removeCallBackPhoneNumber(int rep)
                              throws HL7Exception

Removes a repetition of ORC-14: "Call Back Phone Number" 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)

removeOrc14_CallBackPhoneNumber

public XTN removeOrc14_CallBackPhoneNumber(int rep)
                                    throws HL7Exception

Removes a repetition of ORC-14: "Call Back Phone Number" 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)

getOrderEffectiveDateTime

public TS getOrderEffectiveDateTime()

Returns ORC-15: "Order Effective Date/Time" - creates it if necessary

getOrc15_OrderEffectiveDateTime

public TS getOrc15_OrderEffectiveDateTime()

Returns ORC-15: "Order Effective Date/Time" - creates it if necessary

getOrderControlCodeReason

public CE getOrderControlCodeReason()

Returns ORC-16: "Order Control Code Reason" - creates it if necessary

getOrc16_OrderControlCodeReason

public CE getOrc16_OrderControlCodeReason()

Returns ORC-16: "Order Control Code Reason" - creates it if necessary

getEnteringOrganization

public CE getEnteringOrganization()

Returns ORC-17: "Entering Organization" - creates it if necessary

getOrc17_EnteringOrganization

public CE getOrc17_EnteringOrganization()

Returns ORC-17: "Entering Organization" - creates it if necessary

getEnteringDevice

public CE getEnteringDevice()

Returns ORC-18: "Entering Device" - creates it if necessary

getOrc18_EnteringDevice

public CE getOrc18_EnteringDevice()

Returns ORC-18: "Entering Device" - creates it if necessary

getActionBy

public XCN[] getActionBy()

Returns all repetitions of Action By (ORC-19).

getActionByReps

public int getActionByReps()

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

getActionBy

public XCN getActionBy(int rep)

Returns a specific repetition of ORC-19: "Action By" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc19_ActionBy

public XCN getOrc19_ActionBy(int rep)

Returns a specific repetition of ORC-19: "Action By" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc19_ActionByReps

public int getOrc19_ActionByReps()

insertActionBy

public XCN insertActionBy(int rep)
                   throws HL7Exception

Inserts a repetition of ORC-19: "Action By" 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)

insertOrc19_ActionBy

public XCN insertOrc19_ActionBy(int rep)
                         throws HL7Exception

Inserts a repetition of ORC-19: "Action By" 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)

removeActionBy

public XCN removeActionBy(int rep)
                   throws HL7Exception

Removes a repetition of ORC-19: "Action By" 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)

removeOrc19_ActionBy

public XCN removeOrc19_ActionBy(int rep)
                         throws HL7Exception

Removes a repetition of ORC-19: "Action By" 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)

getAdvancedBeneficiaryNoticeCode

public CE getAdvancedBeneficiaryNoticeCode()

Returns ORC-20: "Advanced Beneficiary Notice Code" - creates it if necessary

getOrc20_AdvancedBeneficiaryNoticeCode

public CE getOrc20_AdvancedBeneficiaryNoticeCode()

Returns ORC-20: "Advanced Beneficiary Notice Code" - creates it if necessary

getOrderingFacilityName

public XON[] getOrderingFacilityName()

Returns all repetitions of Ordering Facility Name (ORC-21).

getOrderingFacilityNameReps

public int getOrderingFacilityNameReps()

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

getOrderingFacilityName

public XON getOrderingFacilityName(int rep)

Returns a specific repetition of ORC-21: "Ordering Facility Name" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc21_OrderingFacilityName

public XON getOrc21_OrderingFacilityName(int rep)

Returns a specific repetition of ORC-21: "Ordering Facility Name" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc21_OrderingFacilityNameReps

public int getOrc21_OrderingFacilityNameReps()

insertOrderingFacilityName

public XON insertOrderingFacilityName(int rep)
                               throws HL7Exception

Inserts a repetition of ORC-21: "Ordering Facility Name" 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)

insertOrc21_OrderingFacilityName

public XON insertOrc21_OrderingFacilityName(int rep)
                                     throws HL7Exception

Inserts a repetition of ORC-21: "Ordering Facility Name" 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)

removeOrderingFacilityName

public XON removeOrderingFacilityName(int rep)
                               throws HL7Exception

Removes a repetition of ORC-21: "Ordering Facility Name" 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)

removeOrc21_OrderingFacilityName

public XON removeOrc21_OrderingFacilityName(int rep)
                                     throws HL7Exception

Removes a repetition of ORC-21: "Ordering Facility Name" 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)

getOrderingFacilityAddress

public XAD[] getOrderingFacilityAddress()

Returns all repetitions of Ordering Facility Address (ORC-22).

getOrderingFacilityAddressReps

public int getOrderingFacilityAddressReps()

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

getOrderingFacilityAddress

public XAD getOrderingFacilityAddress(int rep)

Returns a specific repetition of ORC-22: "Ordering Facility Address" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc22_OrderingFacilityAddress

public XAD getOrc22_OrderingFacilityAddress(int rep)

Returns a specific repetition of ORC-22: "Ordering Facility Address" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc22_OrderingFacilityAddressReps

public int getOrc22_OrderingFacilityAddressReps()

insertOrderingFacilityAddress

public XAD insertOrderingFacilityAddress(int rep)
                                  throws HL7Exception

Inserts a repetition of ORC-22: "Ordering Facility Address" 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)

insertOrc22_OrderingFacilityAddress

public XAD insertOrc22_OrderingFacilityAddress(int rep)
                                        throws HL7Exception

Inserts a repetition of ORC-22: "Ordering Facility Address" 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)

removeOrderingFacilityAddress

public XAD removeOrderingFacilityAddress(int rep)
                                  throws HL7Exception

Removes a repetition of ORC-22: "Ordering Facility Address" 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)

removeOrc22_OrderingFacilityAddress

public XAD removeOrc22_OrderingFacilityAddress(int rep)
                                        throws HL7Exception

Removes a repetition of ORC-22: "Ordering Facility Address" 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)

getOrderingFacilityPhoneNumber

public XTN[] getOrderingFacilityPhoneNumber()

Returns all repetitions of Ordering Facility Phone Number (ORC-23).

getOrderingFacilityPhoneNumberReps

public int getOrderingFacilityPhoneNumberReps()

Returns a count of the current number of repetitions of Ordering Facility Phone Number (ORC-23). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getOrderingFacilityPhoneNumber

public XTN getOrderingFacilityPhoneNumber(int rep)

Returns a specific repetition of ORC-23: "Ordering Facility Phone Number" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc23_OrderingFacilityPhoneNumber

public XTN getOrc23_OrderingFacilityPhoneNumber(int rep)

Returns a specific repetition of ORC-23: "Ordering Facility Phone Number" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc23_OrderingFacilityPhoneNumberReps

public int getOrc23_OrderingFacilityPhoneNumberReps()

insertOrderingFacilityPhoneNumber

public XTN insertOrderingFacilityPhoneNumber(int rep)
                                      throws HL7Exception

Inserts a repetition of ORC-23: "Ordering Facility Phone Number" 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)

insertOrc23_OrderingFacilityPhoneNumber

public XTN insertOrc23_OrderingFacilityPhoneNumber(int rep)
                                            throws HL7Exception

Inserts a repetition of ORC-23: "Ordering Facility Phone Number" 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)

removeOrderingFacilityPhoneNumber

public XTN removeOrderingFacilityPhoneNumber(int rep)
                                      throws HL7Exception

Removes a repetition of ORC-23: "Ordering Facility Phone Number" 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)

removeOrc23_OrderingFacilityPhoneNumber

public XTN removeOrc23_OrderingFacilityPhoneNumber(int rep)
                                            throws HL7Exception

Removes a repetition of ORC-23: "Ordering Facility Phone Number" 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)

getOrderingProviderAddress

public XAD[] getOrderingProviderAddress()

Returns all repetitions of Ordering Provider Address (ORC-24).

getOrderingProviderAddressReps

public int getOrderingProviderAddressReps()

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

getOrderingProviderAddress

public XAD getOrderingProviderAddress(int rep)

Returns a specific repetition of ORC-24: "Ordering Provider Address" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc24_OrderingProviderAddress

public XAD getOrc24_OrderingProviderAddress(int rep)

Returns a specific repetition of ORC-24: "Ordering Provider Address" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getOrc24_OrderingProviderAddressReps

public int getOrc24_OrderingProviderAddressReps()

insertOrderingProviderAddress

public XAD insertOrderingProviderAddress(int rep)
                                  throws HL7Exception

Inserts a repetition of ORC-24: "Ordering Provider Address" 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)

insertOrc24_OrderingProviderAddress

public XAD insertOrc24_OrderingProviderAddress(int rep)
                                        throws HL7Exception

Inserts a repetition of ORC-24: "Ordering Provider Address" 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)

removeOrderingProviderAddress

public XAD removeOrderingProviderAddress(int rep)
                                  throws HL7Exception

Removes a repetition of ORC-24: "Ordering Provider Address" 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)

removeOrc24_OrderingProviderAddress

public XAD removeOrc24_OrderingProviderAddress(int rep)
                                        throws HL7Exception

Removes a repetition of ORC-24: "Ordering Provider Address" 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)

getOrderStatusModifier

public CWE getOrderStatusModifier()

Returns ORC-25: "Order Status Modifier" - creates it if necessary

getOrc25_OrderStatusModifier

public CWE getOrc25_OrderStatusModifier()

Returns ORC-25: "Order Status Modifier" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:: createNewTypeWithoutReflection in class AbstractSegment

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

ORC

getOrderControl

getOrc1_OrderControl

getPlacerOrderNumber

getOrc2_PlacerOrderNumber

getFillerOrderNumber

getOrc3_FillerOrderNumber

getPlacerGroupNumber

getOrc4_PlacerGroupNumber

getOrderStatus

getOrc5_OrderStatus

getResponseFlag

getOrc6_ResponseFlag

getQuantityTiming

getQuantityTimingReps

getQuantityTiming

getOrc7_QuantityTiming

getOrc7_QuantityTimingReps

insertQuantityTiming

insertOrc7_QuantityTiming

removeQuantityTiming

removeOrc7_QuantityTiming

getParentOrder

getOrc8_ParentOrder

getDateTimeOfTransaction

getOrc9_DateTimeOfTransaction

getEnteredBy

getEnteredByReps

getEnteredBy

getOrc10_EnteredBy

getOrc10_EnteredByReps

insertEnteredBy

insertOrc10_EnteredBy

removeEnteredBy

removeOrc10_EnteredBy

getVerifiedBy

getVerifiedByReps

getVerifiedBy

getOrc11_VerifiedBy

getOrc11_VerifiedByReps

insertVerifiedBy

insertOrc11_VerifiedBy

removeVerifiedBy

removeOrc11_VerifiedBy

getOrderingProvider

getOrderingProviderReps

getOrderingProvider

getOrc12_OrderingProvider

getOrc12_OrderingProviderReps

insertOrderingProvider

insertOrc12_OrderingProvider

removeOrderingProvider

removeOrc12_OrderingProvider

getEntererSLocation

getOrc13_EntererSLocation

getCallBackPhoneNumber

getCallBackPhoneNumberReps

getCallBackPhoneNumber

getOrc14_CallBackPhoneNumber

getOrc14_CallBackPhoneNumberReps

insertCallBackPhoneNumber

insertOrc14_CallBackPhoneNumber

removeCallBackPhoneNumber

removeOrc14_CallBackPhoneNumber

getOrderEffectiveDateTime

getOrc15_OrderEffectiveDateTime

getOrderControlCodeReason

getOrc16_OrderControlCodeReason

getEnteringOrganization

getOrc17_EnteringOrganization

getEnteringDevice

getOrc18_EnteringDevice

getActionBy

getActionByReps

getActionBy

getOrc19_ActionBy

getOrc19_ActionByReps

insertActionBy

insertOrc19_ActionBy

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