ORC (HAPI - Java HL7 API - Generated Structures v2.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractSegment
  - - ca.uhn.hl7v2.model.v21.segment.ORC

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable
```
public class ORC
extends AbstractSegment
```
Represents an HL7 ORC message segment (COMMON ORDER). This segment has the following fields:
- ORC-1: ORDER CONTROL (ST)
- ORC-2: PLACER ORDER # (CM) optional
- ORC-3: FILLER ORDER # (CM) optional
- ORC-4: PLACER GROUP # (CM) optional
- ORC-5: ORDER STATUS (ST) optional
- ORC-6: RESPONSE FLAG (ST) optional
- ORC-7: TIMING/QUANTITY (CM) optional
- ORC-8: PARENT (CM) optional
- ORC-9: DATE/TIME OF TRANSACTION (TS) optional
- ORC-10: ENTERED BY (CN) optional
- ORC-11: VERIFIED BY (CN) optional
- ORC-12: ORDERING PROVIDER (CN) optional
- ORC-13: ENTERER'S LOCATION (CM) optional
- ORC-14: CALL BACK PHONE NUMBER (TN) optional repeating
See Also:

Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`ORC(Group parent, ModelClassFactory factory)` Creates a new ORC segment

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Type`	`createNewTypeWithoutReflection(int field)`
`TN[]`	`getCALLBACKPHONENUMBER()` Returns all repetitions of CALL BACK PHONE NUMBER (ORC-14).
`TN`	`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
`CN`	`getENTEREDBY()` Returns ORC-10: "ENTERED BY" - creates it if necessary
`CM`	`getENTERERSLOCATION()` Returns ORC-13: "ENTERER'S LOCATION" - creates it if necessary
`CM`	`getFILLERORDER()` Returns ORC-3: "FILLER ORDER #" - creates it if necessary
`ST`	`getOrc1_ORDERCONTROL()` Returns ORC-1: "ORDER CONTROL" - creates it if necessary
`CN`	`getOrc10_ENTEREDBY()` Returns ORC-10: "ENTERED BY" - creates it if necessary
`CN`	`getOrc11_VERIFIEDBY()` Returns ORC-11: "VERIFIED BY" - creates it if necessary
`CN`	`getOrc12_ORDERINGPROVIDER()` Returns ORC-12: "ORDERING PROVIDER" - creates it if necessary
`CM`	`getOrc13_ENTERERSLOCATION()` Returns ORC-13: "ENTERER'S LOCATION" - creates it if necessary
`TN[]`	`getOrc14_CALLBACKPHONENUMBER()` Returns all repetitions of CALL BACK PHONE NUMBER (ORC-14).
`TN`	`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).
`CM`	`getOrc2_PLACERORDER()` Returns ORC-2: "PLACER ORDER #" - creates it if necessary
`CM`	`getOrc3_FILLERORDER()` Returns ORC-3: "FILLER ORDER #" - creates it if necessary
`CM`	`getOrc4_PLACERGROUP()` Returns ORC-4: "PLACER GROUP #" - creates it if necessary
`ST`	`getOrc5_ORDERSTATUS()` Returns ORC-5: "ORDER STATUS" - creates it if necessary
`ST`	`getOrc6_RESPONSEFLAG()` Returns ORC-6: "RESPONSE FLAG" - creates it if necessary
`CM`	`getOrc7_TIMINGQUANTITY()` Returns ORC-7: "TIMING/QUANTITY" - creates it if necessary
`CM`	`getOrc8_PARENT()` Returns ORC-8: "PARENT" - creates it if necessary
`TS`	`getOrc9_DATETIMEOFTRANSACTION()` Returns ORC-9: "DATE/TIME OF TRANSACTION" - creates it if necessary
`ST`	`getORDERCONTROL()` Returns ORC-1: "ORDER CONTROL" - creates it if necessary
`CN`	`getORDERINGPROVIDER()` Returns ORC-12: "ORDERING PROVIDER" - creates it if necessary
`ST`	`getORDERSTATUS()` Returns ORC-5: "ORDER STATUS" - creates it if necessary
`CM`	`getPARENT()` Returns ORC-8: "PARENT" - creates it if necessary
`CM`	`getPLACERGROUP()` Returns ORC-4: "PLACER GROUP #" - creates it if necessary
`CM`	`getPLACERORDER()` Returns ORC-2: "PLACER ORDER #" - creates it if necessary
`ST`	`getRESPONSEFLAG()` Returns ORC-6: "RESPONSE FLAG" - creates it if necessary
`CM`	`getTIMINGQUANTITY()` Returns ORC-7: "TIMING/QUANTITY" - creates it if necessary
`CN`	`getVERIFIEDBY()` Returns ORC-11: "VERIFIED BY" - creates it if necessary
`TN`	`insertCALLBACKPHONENUMBER(int rep)` Inserts a repetition of ORC-14: "CALL BACK PHONE NUMBER" at a specific index
`TN`	`insertOrc14_CALLBACKPHONENUMBER(int rep)` Inserts a repetition of ORC-14: "CALL BACK PHONE NUMBER" at a specific index
`TN`	`removeCALLBACKPHONENUMBER(int rep)` Removes a repetition of ORC-14: "CALL BACK PHONE NUMBER" at a specific index
`TN`	`removeOrc14_CALLBACKPHONENUMBER(int rep)` Removes a repetition of ORC-14: "CALL BACK PHONE NUMBER" 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
  - ORC
```
public ORC(Group parent,
           ModelClassFactory factory)
```
    Creates a new ORC segment
- Method Detail
  - getORDERCONTROL
```
public ST getORDERCONTROL()
```
    Returns ORC-1: "ORDER CONTROL" - creates it if necessary
  - getOrc1_ORDERCONTROL
```
public ST getOrc1_ORDERCONTROL()
```
    Returns ORC-1: "ORDER CONTROL" - creates it if necessary
  - getPLACERORDER
```
public CM getPLACERORDER()
```
    Returns ORC-2: "PLACER ORDER #" - creates it if necessary
  - getOrc2_PLACERORDER
```
public CM getOrc2_PLACERORDER()
```
    Returns ORC-2: "PLACER ORDER #" - creates it if necessary
  - getFILLERORDER
```
public CM getFILLERORDER()
```
    Returns ORC-3: "FILLER ORDER #" - creates it if necessary
  - getOrc3_FILLERORDER
```
public CM getOrc3_FILLERORDER()
```
    Returns ORC-3: "FILLER ORDER #" - creates it if necessary
  - getPLACERGROUP
```
public CM getPLACERGROUP()
```
    Returns ORC-4: "PLACER GROUP #" - creates it if necessary
  - getOrc4_PLACERGROUP
```
public CM getOrc4_PLACERGROUP()
```
    Returns ORC-4: "PLACER GROUP #" - creates it if necessary
  - getORDERSTATUS
```
public ST getORDERSTATUS()
```
    Returns ORC-5: "ORDER STATUS" - creates it if necessary
  - getOrc5_ORDERSTATUS
```
public ST getOrc5_ORDERSTATUS()
```
    Returns ORC-5: "ORDER STATUS" - creates it if necessary
  - getRESPONSEFLAG
```
public ST getRESPONSEFLAG()
```
    Returns ORC-6: "RESPONSE FLAG" - creates it if necessary
  - getOrc6_RESPONSEFLAG
```
public ST getOrc6_RESPONSEFLAG()
```
    Returns ORC-6: "RESPONSE FLAG" - creates it if necessary
  - getTIMINGQUANTITY
```
public CM getTIMINGQUANTITY()
```
    Returns ORC-7: "TIMING/QUANTITY" - creates it if necessary
  - getOrc7_TIMINGQUANTITY
```
public CM getOrc7_TIMINGQUANTITY()
```
    Returns ORC-7: "TIMING/QUANTITY" - creates it if necessary
  - getPARENT
```
public CM getPARENT()
```
    Returns ORC-8: "PARENT" - creates it if necessary
  - getOrc8_PARENT
```
public CM getOrc8_PARENT()
```
    Returns ORC-8: "PARENT" - 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 CN getENTEREDBY()
```
    Returns ORC-10: "ENTERED BY" - creates it if necessary
  - getOrc10_ENTEREDBY
```
public CN getOrc10_ENTEREDBY()
```
    Returns ORC-10: "ENTERED BY" - creates it if necessary
  - getVERIFIEDBY
```
public CN getVERIFIEDBY()
```
    Returns ORC-11: "VERIFIED BY" - creates it if necessary
  - getOrc11_VERIFIEDBY
```
public CN getOrc11_VERIFIEDBY()
```
    Returns ORC-11: "VERIFIED BY" - creates it if necessary
  - getORDERINGPROVIDER
```
public CN getORDERINGPROVIDER()
```
    Returns ORC-12: "ORDERING PROVIDER" - creates it if necessary
  - getOrc12_ORDERINGPROVIDER
```
public CN getOrc12_ORDERINGPROVIDER()
```
    Returns ORC-12: "ORDERING PROVIDER" - creates it if necessary
  - getENTERERSLOCATION
```
public CM getENTERERSLOCATION()
```
    Returns ORC-13: "ENTERER'S LOCATION" - creates it if necessary
  - getOrc13_ENTERERSLOCATION
```
public CM getOrc13_ENTERERSLOCATION()
```
    Returns ORC-13: "ENTERER'S LOCATION" - creates it if necessary
  - getCALLBACKPHONENUMBER
```
public TN[] getCALLBACKPHONENUMBER()
```
    Returns all repetitions of CALL BACK PHONE NUMBER (ORC-14).
  - getOrc14_CALLBACKPHONENUMBER
```
public TN[] getOrc14_CALLBACKPHONENUMBER()
```
    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 TN 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 TN 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()
```
    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.
  - insertCALLBACKPHONENUMBER
```
public TN 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 TN 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 TN 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 TN 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)
  - createNewTypeWithoutReflection
```
protected Type createNewTypeWithoutReflection(int field)
```
    Overrides:
    
    createNewTypeWithoutReflection in class AbstractSegment

Class ORC

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

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

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.hl7v2.model.Structure

Constructor Detail

ORC

Method Detail

getORDERCONTROL

getOrc1_ORDERCONTROL

getPLACERORDER

getOrc2_PLACERORDER

getFILLERORDER

getOrc3_FILLERORDER

getPLACERGROUP

getOrc4_PLACERGROUP

getORDERSTATUS

getOrc5_ORDERSTATUS

getRESPONSEFLAG

getOrc6_RESPONSEFLAG

getTIMINGQUANTITY

getOrc7_TIMINGQUANTITY

getPARENT

getOrc8_PARENT

getDATETIMEOFTRANSACTION

getOrc9_DATETIMEOFTRANSACTION

getENTEREDBY

getOrc10_ENTEREDBY

getVERIFIEDBY

getOrc11_VERIFIEDBY

getORDERINGPROVIDER

getOrc12_ORDERINGPROVIDER

getENTERERSLOCATION

getOrc13_ENTERERSLOCATION

getCALLBACKPHONENUMBER

getOrc14_CALLBACKPHONENUMBER

getCALLBACKPHONENUMBERReps

getCALLBACKPHONENUMBER

getOrc14_CALLBACKPHONENUMBER

getOrc14_CALLBACKPHONENUMBERReps

insertCALLBACKPHONENUMBER

insertOrc14_CALLBACKPHONENUMBER

removeCALLBACKPHONENUMBER

removeOrc14_CALLBACKPHONENUMBER

createNewTypeWithoutReflection