Package ca.uhn.hl7v2.model.v23.segment

Class ORC

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v23.segment.ORC
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class ORC extends AbstractSegment

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

  • ORC-1: Order Control (ID)
  • ORC-2: Placer Order Number (EI) optional repeating
  • 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)
  • ORC-8: Parent Order (CM_EIP) optional
  • ORC-9: Date/Time of Transaction (TS) optional
  • ORC-10: Entered By (XCN) optional
  • ORC-11: Verified By (XCN) optional
  • 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
See Also:

  • Constructor Details

  • Method Details

    • 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 all repetitions of Placer Order Number (ORC-2).

    • getOrc2_PlacerOrderNumber

      public EI[] getOrc2_PlacerOrderNumber()
      Returns all repetitions of Placer Order Number (ORC-2).

    • getPlacerOrderNumberReps

      public int getPlacerOrderNumberReps()
      Returns a count of the current number of repetitions of Placer Order Number (ORC-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPlacerOrderNumber

      public EI getPlacerOrderNumber(int rep)
      Returns a specific repetition of ORC-2: "Placer Order Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOrc2_PlacerOrderNumber

      public EI getOrc2_PlacerOrderNumber(int rep)
      Returns a specific repetition of ORC-2: "Placer Order Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOrc2_PlacerOrderNumberReps

      public int getOrc2_PlacerOrderNumberReps()
      Returns a count of the current number of repetitions of Placer Order Number (ORC-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPlacerOrderNumber

      public EI insertPlacerOrderNumber(int rep) throws HL7Exception
      Inserts a repetition of ORC-2: "Placer Order 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)

    • insertOrc2_PlacerOrderNumber

      public EI insertOrc2_PlacerOrderNumber(int rep) throws HL7Exception
      Inserts a repetition of ORC-2: "Placer Order 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)

    • removePlacerOrderNumber

      public EI removePlacerOrderNumber(int rep) throws HL7Exception
      Removes a repetition of ORC-2: "Placer Order 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)

    • removeOrc2_PlacerOrderNumber

      public EI removeOrc2_PlacerOrderNumber(int rep) throws HL7Exception
      Removes a repetition of ORC-2: "Placer Order 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)

    • 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 ORC-7: "Quantity/Timing" - creates it if necessary

    • getOrc7_QuantityTiming

      public TQ getOrc7_QuantityTiming()
      Returns ORC-7: "Quantity/Timing" - creates it if necessary

    • getParentOrder

      public CM_EIP getParentOrder()
      Returns ORC-8: "Parent Order" - creates it if necessary

    • getOrc8_ParentOrder

      public CM_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 ORC-10: "Entered By" - creates it if necessary

    • getOrc10_EnteredBy

      public XCN getOrc10_EnteredBy()
      Returns ORC-10: "Entered By" - creates it if necessary

    • getVerifiedBy

      public XCN getVerifiedBy()
      Returns ORC-11: "Verified By" - creates it if necessary

    • getOrc11_VerifiedBy

      public XCN getOrc11_VerifiedBy()
      Returns ORC-11: "Verified By" - creates it if necessary

    • getOrderingProvider

      public XCN[] getOrderingProvider()
      Returns all repetitions of Ordering Provider (ORC-12).

    • getOrc12_OrderingProvider

      public XCN[] getOrc12_OrderingProvider()
      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()
      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.

    • 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).

    • getOrc14_CallBackPhoneNumber

      public XTN[] 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 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()
      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 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 ORC-19: "Action By" - creates it if necessary

    • getOrc19_ActionBy

      public XCN getOrc19_ActionBy()
      Returns ORC-19: "Action By" - creates it if necessary

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment