Package ca.uhn.hl7v2.model.v22.segment

Class ORC

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

Represents an HL7 ORC message segment (COMMOM ORDER). This segment has the following fields:

  • ORC-1: Order Control (ID)
  • ORC-2: Placer Order Number (CM_PLACER) optional
  • ORC-3: Filler Order Number (CM_FILLER) optional
  • ORC-4: Placer Group Number (CM_GROUP_ID) optional
  • ORC-5: Order Status (ID) optional
  • ORC-6: Response Flag (ID) optional
  • ORC-7: Quantity / timing (TQ) optional repeating
  • ORC-8: Parent Order (CM_EIP) 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_PARENT_RESULT) optional
  • ORC-14: Call Back Phone Number (TN) 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 (CN) 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 CM_PLACER getPlacerOrderNumber()
      Returns ORC-2: "Placer Order Number" - creates it if necessary

    • getOrc2_PlacerOrderNumber

      public CM_PLACER getOrc2_PlacerOrderNumber()
      Returns ORC-2: "Placer Order Number" - creates it if necessary

    • getFillerOrderNumber

      public CM_FILLER getFillerOrderNumber()
      Returns ORC-3: "Filler Order Number" - creates it if necessary

    • getOrc3_FillerOrderNumber

      public CM_FILLER getOrc3_FillerOrderNumber()
      Returns ORC-3: "Filler Order Number" - creates it if necessary

    • getPlacerGroupNumber

      public CM_GROUP_ID getPlacerGroupNumber()
      Returns ORC-4: "Placer Group Number" - creates it if necessary

    • getOrc4_PlacerGroupNumber

      public CM_GROUP_ID 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).

    • getOrc7_QuantityTiming

      public TQ[] getOrc7_QuantityTiming()
      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()
      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.

    • 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 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 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_PARENT_RESULT getEntererSLocation()
      Returns ORC-13: "Enterer's Location" - creates it if necessary

    • getOrc13_EntererSLocation

      public CM_PARENT_RESULT 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)

    • 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 CN getActionBy()
      Returns ORC-19: "Action by" - creates it if necessary

    • getOrc19_ActionBy

      public CN getOrc19_ActionBy()
      Returns ORC-19: "Action by" - creates it if necessary

    • createNewTypeWithoutReflection

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