Package ca.uhn.hl7v2.model.v251.segment

Class RCP

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

Represents an HL7 RCP message segment (Response Control Parameter). This segment has the following fields:

  • RCP-1: Query Priority (ID) optional
  • RCP-2: Quantity Limited Request (CQ) optional
  • RCP-3: Response Modality (CE) optional
  • RCP-4: Execution and Delivery Time (TS) optional
  • RCP-5: Modify Indicator (ID) optional
  • RCP-6: Sort-by Field (SRT) optional repeating
  • RCP-7: Segment group inclusion (ID) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getQueryPriority

      public ID getQueryPriority()
      Returns RCP-1: "Query Priority" - creates it if necessary

    • getRcp1_QueryPriority

      public ID getRcp1_QueryPriority()
      Returns RCP-1: "Query Priority" - creates it if necessary

    • getQuantityLimitedRequest

      public CQ getQuantityLimitedRequest()
      Returns RCP-2: "Quantity Limited Request" - creates it if necessary

    • getRcp2_QuantityLimitedRequest

      public CQ getRcp2_QuantityLimitedRequest()
      Returns RCP-2: "Quantity Limited Request" - creates it if necessary

    • getResponseModality

      public CE getResponseModality()
      Returns RCP-3: "Response Modality" - creates it if necessary

    • getRcp3_ResponseModality

      public CE getRcp3_ResponseModality()
      Returns RCP-3: "Response Modality" - creates it if necessary

    • getExecutionAndDeliveryTime

      public TS getExecutionAndDeliveryTime()
      Returns RCP-4: "Execution and Delivery Time" - creates it if necessary

    • getRcp4_ExecutionAndDeliveryTime

      public TS getRcp4_ExecutionAndDeliveryTime()
      Returns RCP-4: "Execution and Delivery Time" - creates it if necessary

    • getModifyIndicator

      public ID getModifyIndicator()
      Returns RCP-5: "Modify Indicator" - creates it if necessary

    • getRcp5_ModifyIndicator

      public ID getRcp5_ModifyIndicator()
      Returns RCP-5: "Modify Indicator" - creates it if necessary

    • getSortByField

      public SRT[] getSortByField()
      Returns all repetitions of Sort-by Field (RCP-6).

    • getRcp6_SortByField

      public SRT[] getRcp6_SortByField()
      Returns all repetitions of Sort-by Field (RCP-6).

    • getSortByFieldReps

      public int getSortByFieldReps()
      Returns a count of the current number of repetitions of Sort-by Field (RCP-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSortByField

      public SRT getSortByField(int rep)
      Returns a specific repetition of RCP-6: "Sort-by Field" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRcp6_SortByField

      public SRT getRcp6_SortByField(int rep)
      Returns a specific repetition of RCP-6: "Sort-by Field" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRcp6_SortByFieldReps

      public int getRcp6_SortByFieldReps()
      Returns a count of the current number of repetitions of Sort-by Field (RCP-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSortByField

      public SRT insertSortByField(int rep) throws HL7Exception
      Inserts a repetition of RCP-6: "Sort-by Field" 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)

    • insertRcp6_SortByField

      public SRT insertRcp6_SortByField(int rep) throws HL7Exception
      Inserts a repetition of RCP-6: "Sort-by Field" 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)

    • removeSortByField

      public SRT removeSortByField(int rep) throws HL7Exception
      Removes a repetition of RCP-6: "Sort-by Field" 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)

    • removeRcp6_SortByField

      public SRT removeRcp6_SortByField(int rep) throws HL7Exception
      Removes a repetition of RCP-6: "Sort-by Field" 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)

    • getSegmentGroupInclusion

      public ID[] getSegmentGroupInclusion()
      Returns all repetitions of Segment group inclusion (RCP-7).

    • getRcp7_SegmentGroupInclusion

      public ID[] getRcp7_SegmentGroupInclusion()
      Returns all repetitions of Segment group inclusion (RCP-7).

    • getSegmentGroupInclusionReps

      public int getSegmentGroupInclusionReps()
      Returns a count of the current number of repetitions of Segment group inclusion (RCP-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSegmentGroupInclusion

      public ID getSegmentGroupInclusion(int rep)
      Returns a specific repetition of RCP-7: "Segment group inclusion" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRcp7_SegmentGroupInclusion

      public ID getRcp7_SegmentGroupInclusion(int rep)
      Returns a specific repetition of RCP-7: "Segment group inclusion" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRcp7_SegmentGroupInclusionReps

      public int getRcp7_SegmentGroupInclusionReps()
      Returns a count of the current number of repetitions of Segment group inclusion (RCP-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSegmentGroupInclusion

      public ID insertSegmentGroupInclusion(int rep) throws HL7Exception
      Inserts a repetition of RCP-7: "Segment group inclusion" 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)

    • insertRcp7_SegmentGroupInclusion

      public ID insertRcp7_SegmentGroupInclusion(int rep) throws HL7Exception
      Inserts a repetition of RCP-7: "Segment group inclusion" 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)

    • removeSegmentGroupInclusion

      public ID removeSegmentGroupInclusion(int rep) throws HL7Exception
      Removes a repetition of RCP-7: "Segment group inclusion" 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)

    • removeRcp7_SegmentGroupInclusion

      public ID removeRcp7_SegmentGroupInclusion(int rep) throws HL7Exception
      Removes a repetition of RCP-7: "Segment group inclusion" 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