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

Class URD

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

Represents an HL7 URD message segment (RESULTS/UPDATE DEFINITION). This segment has the following fields:

  • URD-1: R/U date / time (TS) optional
  • URD-2: Report Priority (ID) optional
  • URD-3: R/U Who Subject Definition (ST) repeating
  • URD-4: R/U What Subject Definition (ID) optional repeating
  • URD-5: R/U What Department Code (ST) optional repeating
  • URD-6: R/U display / print locations (ST) optional repeating
  • URD-7: R/U Results Level (ID) optional
See Also:

  • Constructor Details

  • Method Details

    • getRUDateTime

      public TS getRUDateTime()
      Returns URD-1: "R/U date / time" - creates it if necessary

    • getUrd1_RUDateTime

      public TS getUrd1_RUDateTime()
      Returns URD-1: "R/U date / time" - creates it if necessary

    • getReportPriority

      public ID getReportPriority()
      Returns URD-2: "Report Priority" - creates it if necessary

    • getUrd2_ReportPriority

      public ID getUrd2_ReportPriority()
      Returns URD-2: "Report Priority" - creates it if necessary

    • getRUWhoSubjectDefinition

      public ST[] getRUWhoSubjectDefinition()
      Returns all repetitions of R/U Who Subject Definition (URD-3).

    • getUrd3_RUWhoSubjectDefinition

      public ST[] getUrd3_RUWhoSubjectDefinition()
      Returns all repetitions of R/U Who Subject Definition (URD-3).

    • getRUWhoSubjectDefinitionReps

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

    • getRUWhoSubjectDefinition

      public ST getRUWhoSubjectDefinition(int rep)
      Returns a specific repetition of URD-3: "R/U Who Subject Definition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrd3_RUWhoSubjectDefinition

      public ST getUrd3_RUWhoSubjectDefinition(int rep)
      Returns a specific repetition of URD-3: "R/U Who Subject Definition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrd3_RUWhoSubjectDefinitionReps

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

    • insertRUWhoSubjectDefinition

      public ST insertRUWhoSubjectDefinition(int rep) throws HL7Exception
      Inserts a repetition of URD-3: "R/U Who 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)

    • insertUrd3_RUWhoSubjectDefinition

      public ST insertUrd3_RUWhoSubjectDefinition(int rep) throws HL7Exception
      Inserts a repetition of URD-3: "R/U Who 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)

    • removeRUWhoSubjectDefinition

      public ST removeRUWhoSubjectDefinition(int rep) throws HL7Exception
      Removes a repetition of URD-3: "R/U Who 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)

    • removeUrd3_RUWhoSubjectDefinition

      public ST removeUrd3_RUWhoSubjectDefinition(int rep) throws HL7Exception
      Removes a repetition of URD-3: "R/U Who 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)

    • getRUWhatSubjectDefinition

      public ID[] getRUWhatSubjectDefinition()
      Returns all repetitions of R/U What Subject Definition (URD-4).

    • getUrd4_RUWhatSubjectDefinition

      public ID[] getUrd4_RUWhatSubjectDefinition()
      Returns all repetitions of R/U What Subject Definition (URD-4).

    • getRUWhatSubjectDefinitionReps

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

    • getRUWhatSubjectDefinition

      public ID getRUWhatSubjectDefinition(int rep)
      Returns a specific repetition of URD-4: "R/U What Subject Definition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrd4_RUWhatSubjectDefinition

      public ID getUrd4_RUWhatSubjectDefinition(int rep)
      Returns a specific repetition of URD-4: "R/U What Subject Definition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrd4_RUWhatSubjectDefinitionReps

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

    • insertRUWhatSubjectDefinition

      public ID insertRUWhatSubjectDefinition(int rep) throws HL7Exception
      Inserts a repetition of URD-4: "R/U What 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)

    • insertUrd4_RUWhatSubjectDefinition

      public ID insertUrd4_RUWhatSubjectDefinition(int rep) throws HL7Exception
      Inserts a repetition of URD-4: "R/U What 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)

    • removeRUWhatSubjectDefinition

      public ID removeRUWhatSubjectDefinition(int rep) throws HL7Exception
      Removes a repetition of URD-4: "R/U What 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)

    • removeUrd4_RUWhatSubjectDefinition

      public ID removeUrd4_RUWhatSubjectDefinition(int rep) throws HL7Exception
      Removes a repetition of URD-4: "R/U What 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)

    • getRUWhatDepartmentCode

      public ST[] getRUWhatDepartmentCode()
      Returns all repetitions of R/U What Department Code (URD-5).

    • getUrd5_RUWhatDepartmentCode

      public ST[] getUrd5_RUWhatDepartmentCode()
      Returns all repetitions of R/U What Department Code (URD-5).

    • getRUWhatDepartmentCodeReps

      public int getRUWhatDepartmentCodeReps()
      Returns a count of the current number of repetitions of R/U What Department Code (URD-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRUWhatDepartmentCode

      public ST getRUWhatDepartmentCode(int rep)
      Returns a specific repetition of URD-5: "R/U What Department Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrd5_RUWhatDepartmentCode

      public ST getUrd5_RUWhatDepartmentCode(int rep)
      Returns a specific repetition of URD-5: "R/U What Department Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrd5_RUWhatDepartmentCodeReps

      public int getUrd5_RUWhatDepartmentCodeReps()
      Returns a count of the current number of repetitions of R/U What Department Code (URD-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRUWhatDepartmentCode

      public ST insertRUWhatDepartmentCode(int rep) throws HL7Exception
      Inserts a repetition of URD-5: "R/U What Department 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)

    • insertUrd5_RUWhatDepartmentCode

      public ST insertUrd5_RUWhatDepartmentCode(int rep) throws HL7Exception
      Inserts a repetition of URD-5: "R/U What Department 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)

    • removeRUWhatDepartmentCode

      public ST removeRUWhatDepartmentCode(int rep) throws HL7Exception
      Removes a repetition of URD-5: "R/U What Department 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)

    • removeUrd5_RUWhatDepartmentCode

      public ST removeUrd5_RUWhatDepartmentCode(int rep) throws HL7Exception
      Removes a repetition of URD-5: "R/U What Department 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)

    • getRUDisplayPrintLocations

      public ST[] getRUDisplayPrintLocations()
      Returns all repetitions of R/U display / print locations (URD-6).

    • getUrd6_RUDisplayPrintLocations

      public ST[] getUrd6_RUDisplayPrintLocations()
      Returns all repetitions of R/U display / print locations (URD-6).

    • getRUDisplayPrintLocationsReps

      public int getRUDisplayPrintLocationsReps()
      Returns a count of the current number of repetitions of R/U display / print locations (URD-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRUDisplayPrintLocations

      public ST getRUDisplayPrintLocations(int rep)
      Returns a specific repetition of URD-6: "R/U display / print locations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrd6_RUDisplayPrintLocations

      public ST getUrd6_RUDisplayPrintLocations(int rep)
      Returns a specific repetition of URD-6: "R/U display / print locations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUrd6_RUDisplayPrintLocationsReps

      public int getUrd6_RUDisplayPrintLocationsReps()
      Returns a count of the current number of repetitions of R/U display / print locations (URD-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRUDisplayPrintLocations

      public ST insertRUDisplayPrintLocations(int rep) throws HL7Exception
      Inserts a repetition of URD-6: "R/U display / print locations" 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)

    • insertUrd6_RUDisplayPrintLocations

      public ST insertUrd6_RUDisplayPrintLocations(int rep) throws HL7Exception
      Inserts a repetition of URD-6: "R/U display / print locations" 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)

    • removeRUDisplayPrintLocations

      public ST removeRUDisplayPrintLocations(int rep) throws HL7Exception
      Removes a repetition of URD-6: "R/U display / print locations" 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)

    • removeUrd6_RUDisplayPrintLocations

      public ST removeUrd6_RUDisplayPrintLocations(int rep) throws HL7Exception
      Removes a repetition of URD-6: "R/U display / print locations" 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)

    • getRUResultsLevel

      public ID getRUResultsLevel()
      Returns URD-7: "R/U Results Level" - creates it if necessary

    • getUrd7_RUResultsLevel

      public ID getUrd7_RUResultsLevel()
      Returns URD-7: "R/U Results Level" - creates it if necessary

    • createNewTypeWithoutReflection

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