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

Class QRI

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

Represents an HL7 QRI message segment (Query Response Instance). This segment has the following fields:

  • QRI-1: Candidate Confidence (NM) optional
  • QRI-2: Match Reason Code (IS) optional repeating
  • QRI-3: Algorithm Descriptor (CE) optional
See Also:

  • Constructor Details

  • Method Details

    • getCandidateConfidence

      public NM getCandidateConfidence()
      Returns QRI-1: "Candidate Confidence" - creates it if necessary

    • getQri1_CandidateConfidence

      public NM getQri1_CandidateConfidence()
      Returns QRI-1: "Candidate Confidence" - creates it if necessary

    • getMatchReasonCode

      public IS[] getMatchReasonCode()
      Returns all repetitions of Match Reason Code (QRI-2).

    • getQri2_MatchReasonCode

      public IS[] getQri2_MatchReasonCode()
      Returns all repetitions of Match Reason Code (QRI-2).

    • getMatchReasonCodeReps

      public int getMatchReasonCodeReps()
      Returns a count of the current number of repetitions of Match Reason Code (QRI-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getMatchReasonCode

      public IS getMatchReasonCode(int rep)
      Returns a specific repetition of QRI-2: "Match Reason Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQri2_MatchReasonCode

      public IS getQri2_MatchReasonCode(int rep)
      Returns a specific repetition of QRI-2: "Match Reason Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQri2_MatchReasonCodeReps

      public int getQri2_MatchReasonCodeReps()
      Returns a count of the current number of repetitions of Match Reason Code (QRI-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertMatchReasonCode

      public IS insertMatchReasonCode(int rep) throws HL7Exception
      Inserts a repetition of QRI-2: "Match Reason Code" 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)

    • insertQri2_MatchReasonCode

      public IS insertQri2_MatchReasonCode(int rep) throws HL7Exception
      Inserts a repetition of QRI-2: "Match Reason Code" 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)

    • removeMatchReasonCode

      public IS removeMatchReasonCode(int rep) throws HL7Exception
      Removes a repetition of QRI-2: "Match Reason Code" 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)

    • removeQri2_MatchReasonCode

      public IS removeQri2_MatchReasonCode(int rep) throws HL7Exception
      Removes a repetition of QRI-2: "Match Reason Code" 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)

    • getAlgorithmDescriptor

      public CE getAlgorithmDescriptor()
      Returns QRI-3: "Algorithm Descriptor" - creates it if necessary

    • getQri3_AlgorithmDescriptor

      public CE getQri3_AlgorithmDescriptor()
      Returns QRI-3: "Algorithm Descriptor" - creates it if necessary

    • createNewTypeWithoutReflection

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