ca.uhn.hl7v2.model.v24.segment
Class URD

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.URD

All Implemented Interfaces:

Segment, Structure, 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 (XCN) repeating
• URD-4: R/U What Subject Definition (CE) optional repeating
• URD-5: R/U What Department Code (CE) optional repeating
• URD-6: R/U Display/Print Locations (ST) optional repeating
• URD-7: R/U Results Level (ID) optional

See Also:

Serialized Form

Constructor Summary

URD(Group parent, ModelClassFactory factory)
Creates a new URD segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ID	getReportPriority() Returns URD-2: "Report Priority" - creates it if necessary
TS	getRUDateTime() Returns URD-1: "R/U Date/Time" - creates it if necessary
ST[]	getRUDisplayPrintLocations() Returns all repetitions of R/U Display/Print Locations (URD-6).
ST	getRUDisplayPrintLocations(int rep) Returns a specific repetition of URD-6: "R/U Display/Print Locations" - creates it if necessary
int	getRUDisplayPrintLocationsReps() Returns a count of the current number of repetitions of R/U Display/Print Locations (URD-6).
ID	getRUResultsLevel() Returns URD-7: "R/U Results Level" - creates it if necessary
CE[]	getRUWhatDepartmentCode() Returns all repetitions of R/U What Department Code (URD-5).
CE	getRUWhatDepartmentCode(int rep) Returns a specific repetition of URD-5: "R/U What Department Code" - creates it if necessary
int	getRUWhatDepartmentCodeReps() Returns a count of the current number of repetitions of R/U What Department Code (URD-5).
CE[]	getRUWhatSubjectDefinition() Returns all repetitions of R/U What Subject Definition (URD-4).
CE	getRUWhatSubjectDefinition(int rep) Returns a specific repetition of URD-4: "R/U What Subject Definition" - creates it if necessary
int	getRUWhatSubjectDefinitionReps() Returns a count of the current number of repetitions of R/U What Subject Definition (URD-4).
XCN[]	getRUWhoSubjectDefinition() Returns all repetitions of R/U Who Subject Definition (URD-3).
XCN	getRUWhoSubjectDefinition(int rep) Returns a specific repetition of URD-3: "R/U Who Subject Definition" - creates it if necessary
int	getRUWhoSubjectDefinitionReps() Returns a count of the current number of repetitions of R/U Who Subject Definition (URD-3).
TS	getUrd1_RUDateTime() Returns URD-1: "R/U Date/Time" - creates it if necessary
ID	getUrd2_ReportPriority() Returns URD-2: "Report Priority" - creates it if necessary
XCN	getUrd3_RUWhoSubjectDefinition(int rep) Returns a specific repetition of URD-3: "R/U Who Subject Definition" - creates it if necessary
int	getUrd3_RUWhoSubjectDefinitionReps() Returns a count of the current number of repetitions of R/U Who Subject Definition (URD-3).
CE	getUrd4_RUWhatSubjectDefinition(int rep) Returns a specific repetition of URD-4: "R/U What Subject Definition" - creates it if necessary
int	getUrd4_RUWhatSubjectDefinitionReps() Returns a count of the current number of repetitions of R/U What Subject Definition (URD-4).
CE	getUrd5_RUWhatDepartmentCode(int rep) Returns a specific repetition of URD-5: "R/U What Department Code" - creates it if necessary
int	getUrd5_RUWhatDepartmentCodeReps() Returns a count of the current number of repetitions of R/U What Department Code (URD-5).
ST	getUrd6_RUDisplayPrintLocations(int rep) Returns a specific repetition of URD-6: "R/U Display/Print Locations" - creates it if necessary
int	getUrd6_RUDisplayPrintLocationsReps() Returns a count of the current number of repetitions of R/U Display/Print Locations (URD-6).
ID	getUrd7_RUResultsLevel() Returns URD-7: "R/U Results Level" - creates it if necessary
ST	insertRUDisplayPrintLocations(int rep) Inserts a repetition of URD-6: "R/U Display/Print Locations" at a specific index
CE	insertRUWhatDepartmentCode(int rep) Inserts a repetition of URD-5: "R/U What Department Code" at a specific index
CE	insertRUWhatSubjectDefinition(int rep) Inserts a repetition of URD-4: "R/U What Subject Definition" at a specific index
XCN	insertRUWhoSubjectDefinition(int rep) Inserts a repetition of URD-3: "R/U Who Subject Definition" at a specific index
XCN	insertUrd3_RUWhoSubjectDefinition(int rep) Inserts a repetition of URD-3: "R/U Who Subject Definition" at a specific index
CE	insertUrd4_RUWhatSubjectDefinition(int rep) Inserts a repetition of URD-4: "R/U What Subject Definition" at a specific index
CE	insertUrd5_RUWhatDepartmentCode(int rep) Inserts a repetition of URD-5: "R/U What Department Code" at a specific index
ST	insertUrd6_RUDisplayPrintLocations(int rep) Inserts a repetition of URD-6: "R/U Display/Print Locations" at a specific index
ST	removeRUDisplayPrintLocations(int rep) Removes a repetition of URD-6: "R/U Display/Print Locations" at a specific index
CE	removeRUWhatDepartmentCode(int rep) Removes a repetition of URD-5: "R/U What Department Code" at a specific index
CE	removeRUWhatSubjectDefinition(int rep) Removes a repetition of URD-4: "R/U What Subject Definition" at a specific index
XCN	removeRUWhoSubjectDefinition(int rep) Removes a repetition of URD-3: "R/U Who Subject Definition" at a specific index
XCN	removeUrd3_RUWhoSubjectDefinition(int rep) Removes a repetition of URD-3: "R/U Who Subject Definition" at a specific index
CE	removeUrd4_RUWhatSubjectDefinition(int rep) Removes a repetition of URD-4: "R/U What Subject Definition" at a specific index
CE	removeUrd5_RUWhatDepartmentCode(int rep) Removes a repetition of URD-5: "R/U What Department Code" at a specific index
ST	removeUrd6_RUDisplayPrintLocations(int rep) Removes a repetition of URD-6: "R/U Display/Print Locations" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

URD

public URD(Group parent,
           ModelClassFactory factory)

Creates a new URD segment

Method Detail

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 XCN[] getRUWhoSubjectDefinition()

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 XCN 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 XCN 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 XCN 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 XCN 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 XCN 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 XCN 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 CE[] getRUWhatSubjectDefinition()

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 CE 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 CE 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 CE 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 CE 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 CE 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 CE 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 CE[] getRUWhatDepartmentCode()

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 CE 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 CE 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 CE 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 CE 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 CE 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 CE 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).

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