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

Class URS

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

Represents an HL7 URS message segment (UNSOLICITED SELECTION). This segment has the following fields:

  • URS-1: R/U Where Subject Definition (ST) repeating
  • URS-2: R/U when data start date / time (TS) optional
  • URS-3: R/U when data end date / time (TS) optional
  • URS-4: R/U What User Qualifier (ST) optional repeating
  • URS-5: R/U Other Results Subject Definition (ST) optional repeating
  • URS-6: R/U which date / time qualifier (ID) optional repeating
  • URS-7: R/U which date / time status qualifier (ID) optional repeating
  • URS-8: R/U date / time selection qualifier (ID) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getRUWhereSubjectDefinition

      public ST[] getRUWhereSubjectDefinition()
      Returns all repetitions of R/U Where Subject Definition (URS-1).

    • getUrs1_RUWhereSubjectDefinition

      public ST[] getUrs1_RUWhereSubjectDefinition()
      Returns all repetitions of R/U Where Subject Definition (URS-1).

    • getRUWhereSubjectDefinitionReps

      public int getRUWhereSubjectDefinitionReps()
      Returns a count of the current number of repetitions of R/U Where Subject Definition (URS-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRUWhereSubjectDefinition

      public ST getRUWhereSubjectDefinition(int rep)
      Returns a specific repetition of URS-1: "R/U Where Subject Definition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs1_RUWhereSubjectDefinition

      public ST getUrs1_RUWhereSubjectDefinition(int rep)
      Returns a specific repetition of URS-1: "R/U Where Subject Definition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs1_RUWhereSubjectDefinitionReps

      public int getUrs1_RUWhereSubjectDefinitionReps()
      Returns a count of the current number of repetitions of R/U Where Subject Definition (URS-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRUWhereSubjectDefinition

      public ST insertRUWhereSubjectDefinition(int rep) throws HL7Exception
      Inserts a repetition of URS-1: "R/U Where Subject Definition" 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)

    • insertUrs1_RUWhereSubjectDefinition

      public ST insertUrs1_RUWhereSubjectDefinition(int rep) throws HL7Exception
      Inserts a repetition of URS-1: "R/U Where Subject Definition" 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)

    • removeRUWhereSubjectDefinition

      public ST removeRUWhereSubjectDefinition(int rep) throws HL7Exception
      Removes a repetition of URS-1: "R/U Where Subject Definition" 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)

    • removeUrs1_RUWhereSubjectDefinition

      public ST removeUrs1_RUWhereSubjectDefinition(int rep) throws HL7Exception
      Removes a repetition of URS-1: "R/U Where Subject Definition" 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)

    • getRUWhenDataStartDateTime

      public TS getRUWhenDataStartDateTime()
      Returns URS-2: "R/U when data start date / time" - creates it if necessary

    • getUrs2_RUWhenDataStartDateTime

      public TS getUrs2_RUWhenDataStartDateTime()
      Returns URS-2: "R/U when data start date / time" - creates it if necessary

    • getRUWhenDataEndDateTime

      public TS getRUWhenDataEndDateTime()
      Returns URS-3: "R/U when data end date / time" - creates it if necessary

    • getUrs3_RUWhenDataEndDateTime

      public TS getUrs3_RUWhenDataEndDateTime()
      Returns URS-3: "R/U when data end date / time" - creates it if necessary

    • getRUWhatUserQualifier

      public ST[] getRUWhatUserQualifier()
      Returns all repetitions of R/U What User Qualifier (URS-4).

    • getUrs4_RUWhatUserQualifier

      public ST[] getUrs4_RUWhatUserQualifier()
      Returns all repetitions of R/U What User Qualifier (URS-4).

    • getRUWhatUserQualifierReps

      public int getRUWhatUserQualifierReps()
      Returns a count of the current number of repetitions of R/U What User Qualifier (URS-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRUWhatUserQualifier

      public ST getRUWhatUserQualifier(int rep)
      Returns a specific repetition of URS-4: "R/U What User Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs4_RUWhatUserQualifier

      public ST getUrs4_RUWhatUserQualifier(int rep)
      Returns a specific repetition of URS-4: "R/U What User Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs4_RUWhatUserQualifierReps

      public int getUrs4_RUWhatUserQualifierReps()
      Returns a count of the current number of repetitions of R/U What User Qualifier (URS-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRUWhatUserQualifier

      public ST insertRUWhatUserQualifier(int rep) throws HL7Exception
      Inserts a repetition of URS-4: "R/U What User Qualifier" 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)

    • insertUrs4_RUWhatUserQualifier

      public ST insertUrs4_RUWhatUserQualifier(int rep) throws HL7Exception
      Inserts a repetition of URS-4: "R/U What User Qualifier" 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)

    • removeRUWhatUserQualifier

      public ST removeRUWhatUserQualifier(int rep) throws HL7Exception
      Removes a repetition of URS-4: "R/U What User Qualifier" 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)

    • removeUrs4_RUWhatUserQualifier

      public ST removeUrs4_RUWhatUserQualifier(int rep) throws HL7Exception
      Removes a repetition of URS-4: "R/U What User Qualifier" 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)

    • getRUOtherResultsSubjectDefinition

      public ST[] getRUOtherResultsSubjectDefinition()
      Returns all repetitions of R/U Other Results Subject Definition (URS-5).

    • getUrs5_RUOtherResultsSubjectDefinition

      public ST[] getUrs5_RUOtherResultsSubjectDefinition()
      Returns all repetitions of R/U Other Results Subject Definition (URS-5).

    • getRUOtherResultsSubjectDefinitionReps

      public int getRUOtherResultsSubjectDefinitionReps()
      Returns a count of the current number of repetitions of R/U Other Results Subject Definition (URS-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRUOtherResultsSubjectDefinition

      public ST getRUOtherResultsSubjectDefinition(int rep)
      Returns a specific repetition of URS-5: "R/U Other Results Subject Definition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs5_RUOtherResultsSubjectDefinition

      public ST getUrs5_RUOtherResultsSubjectDefinition(int rep)
      Returns a specific repetition of URS-5: "R/U Other Results Subject Definition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs5_RUOtherResultsSubjectDefinitionReps

      public int getUrs5_RUOtherResultsSubjectDefinitionReps()
      Returns a count of the current number of repetitions of R/U Other Results Subject Definition (URS-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRUOtherResultsSubjectDefinition

      public ST insertRUOtherResultsSubjectDefinition(int rep) throws HL7Exception
      Inserts a repetition of URS-5: "R/U Other Results Subject Definition" 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)

    • insertUrs5_RUOtherResultsSubjectDefinition

      public ST insertUrs5_RUOtherResultsSubjectDefinition(int rep) throws HL7Exception
      Inserts a repetition of URS-5: "R/U Other Results Subject Definition" 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)

    • removeRUOtherResultsSubjectDefinition

      public ST removeRUOtherResultsSubjectDefinition(int rep) throws HL7Exception
      Removes a repetition of URS-5: "R/U Other Results Subject Definition" 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)

    • removeUrs5_RUOtherResultsSubjectDefinition

      public ST removeUrs5_RUOtherResultsSubjectDefinition(int rep) throws HL7Exception
      Removes a repetition of URS-5: "R/U Other Results Subject Definition" 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)

    • getRUWhichDateTimeQualifier

      public ID[] getRUWhichDateTimeQualifier()
      Returns all repetitions of R/U which date / time qualifier (URS-6).

    • getUrs6_RUWhichDateTimeQualifier

      public ID[] getUrs6_RUWhichDateTimeQualifier()
      Returns all repetitions of R/U which date / time qualifier (URS-6).

    • getRUWhichDateTimeQualifierReps

      public int getRUWhichDateTimeQualifierReps()
      Returns a count of the current number of repetitions of R/U which date / time qualifier (URS-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRUWhichDateTimeQualifier

      public ID getRUWhichDateTimeQualifier(int rep)
      Returns a specific repetition of URS-6: "R/U which date / time qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs6_RUWhichDateTimeQualifier

      public ID getUrs6_RUWhichDateTimeQualifier(int rep)
      Returns a specific repetition of URS-6: "R/U which date / time qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs6_RUWhichDateTimeQualifierReps

      public int getUrs6_RUWhichDateTimeQualifierReps()
      Returns a count of the current number of repetitions of R/U which date / time qualifier (URS-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRUWhichDateTimeQualifier

      public ID insertRUWhichDateTimeQualifier(int rep) throws HL7Exception
      Inserts a repetition of URS-6: "R/U which date / time qualifier" 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)

    • insertUrs6_RUWhichDateTimeQualifier

      public ID insertUrs6_RUWhichDateTimeQualifier(int rep) throws HL7Exception
      Inserts a repetition of URS-6: "R/U which date / time qualifier" 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)

    • removeRUWhichDateTimeQualifier

      public ID removeRUWhichDateTimeQualifier(int rep) throws HL7Exception
      Removes a repetition of URS-6: "R/U which date / time qualifier" 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)

    • removeUrs6_RUWhichDateTimeQualifier

      public ID removeUrs6_RUWhichDateTimeQualifier(int rep) throws HL7Exception
      Removes a repetition of URS-6: "R/U which date / time qualifier" 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)

    • getRUWhichDateTimeStatusQualifier

      public ID[] getRUWhichDateTimeStatusQualifier()
      Returns all repetitions of R/U which date / time status qualifier (URS-7).

    • getUrs7_RUWhichDateTimeStatusQualifier

      public ID[] getUrs7_RUWhichDateTimeStatusQualifier()
      Returns all repetitions of R/U which date / time status qualifier (URS-7).

    • getRUWhichDateTimeStatusQualifierReps

      public int getRUWhichDateTimeStatusQualifierReps()
      Returns a count of the current number of repetitions of R/U which date / time status qualifier (URS-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRUWhichDateTimeStatusQualifier

      public ID getRUWhichDateTimeStatusQualifier(int rep)
      Returns a specific repetition of URS-7: "R/U which date / time status qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs7_RUWhichDateTimeStatusQualifier

      public ID getUrs7_RUWhichDateTimeStatusQualifier(int rep)
      Returns a specific repetition of URS-7: "R/U which date / time status qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs7_RUWhichDateTimeStatusQualifierReps

      public int getUrs7_RUWhichDateTimeStatusQualifierReps()
      Returns a count of the current number of repetitions of R/U which date / time status qualifier (URS-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRUWhichDateTimeStatusQualifier

      public ID insertRUWhichDateTimeStatusQualifier(int rep) throws HL7Exception
      Inserts a repetition of URS-7: "R/U which date / time status qualifier" 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)

    • insertUrs7_RUWhichDateTimeStatusQualifier

      public ID insertUrs7_RUWhichDateTimeStatusQualifier(int rep) throws HL7Exception
      Inserts a repetition of URS-7: "R/U which date / time status qualifier" 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)

    • removeRUWhichDateTimeStatusQualifier

      public ID removeRUWhichDateTimeStatusQualifier(int rep) throws HL7Exception
      Removes a repetition of URS-7: "R/U which date / time status qualifier" 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)

    • removeUrs7_RUWhichDateTimeStatusQualifier

      public ID removeUrs7_RUWhichDateTimeStatusQualifier(int rep) throws HL7Exception
      Removes a repetition of URS-7: "R/U which date / time status qualifier" 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)

    • getRUDateTimeSelectionQualifier

      public ID[] getRUDateTimeSelectionQualifier()
      Returns all repetitions of R/U date / time selection qualifier (URS-8).

    • getUrs8_RUDateTimeSelectionQualifier

      public ID[] getUrs8_RUDateTimeSelectionQualifier()
      Returns all repetitions of R/U date / time selection qualifier (URS-8).

    • getRUDateTimeSelectionQualifierReps

      public int getRUDateTimeSelectionQualifierReps()
      Returns a count of the current number of repetitions of R/U date / time selection qualifier (URS-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRUDateTimeSelectionQualifier

      public ID getRUDateTimeSelectionQualifier(int rep)
      Returns a specific repetition of URS-8: "R/U date / time selection qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs8_RUDateTimeSelectionQualifier

      public ID getUrs8_RUDateTimeSelectionQualifier(int rep)
      Returns a specific repetition of URS-8: "R/U date / time selection qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrs8_RUDateTimeSelectionQualifierReps

      public int getUrs8_RUDateTimeSelectionQualifierReps()
      Returns a count of the current number of repetitions of R/U date / time selection qualifier (URS-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRUDateTimeSelectionQualifier

      public ID insertRUDateTimeSelectionQualifier(int rep) throws HL7Exception
      Inserts a repetition of URS-8: "R/U date / time selection qualifier" 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)

    • insertUrs8_RUDateTimeSelectionQualifier

      public ID insertUrs8_RUDateTimeSelectionQualifier(int rep) throws HL7Exception
      Inserts a repetition of URS-8: "R/U date / time selection qualifier" 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)

    • removeRUDateTimeSelectionQualifier

      public ID removeRUDateTimeSelectionQualifier(int rep) throws HL7Exception
      Removes a repetition of URS-8: "R/U date / time selection qualifier" 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)

    • removeUrs8_RUDateTimeSelectionQualifier

      public ID removeUrs8_RUDateTimeSelectionQualifier(int rep) throws HL7Exception
      Removes a repetition of URS-8: "R/U date / time selection qualifier" 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