Package ca.uhn.hl7v2.model.v23.segment

Class PRB

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v23.segment.PRB

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class PRB
extends AbstractSegment

Represents an HL7 PRB message segment (Problem Detail). This segment has the following fields:

• PRB-1: Action Code (ID)
• PRB-2: Action Date/Time (TS)
• PRB-3: Problem ID (CE)
• PRB-4: Problem Instance ID (EI)
• PRB-5: Episode of Care ID (EI) optional
• PRB-6: Problem List Priority (NM) optional
• PRB-7: Problem Established Date/Time (TS) optional
• PRB-8: Anticipated Problem Resolution Date/Time (TS) optional
• PRB-9: Actual Problem Resolution Date/Time (TS) optional
• PRB-10: Problem Classification (CE) optional
• PRB-11: Problem Management Discipline (CE) optional repeating
• PRB-12: Problem Persistence (CE) optional
• PRB-13: Problem Confirmation Status (CE) optional
• PRB-14: Problem Life Cycle Status (CE) optional
• PRB-15: Problem Life Cycle Status Date/Time (TS) optional
• PRB-16: Problem Date of Onset (TS) optional
• PRB-17: Problem Onset Text (ST) optional
• PRB-18: Problem Ranking (CE) optional
• PRB-19: Certainty of Problem (CE) optional
• PRB-20: Probability of Problem (0-1) (NM) optional
• PRB-21: Individual Awareness of Problem (CE) optional
• PRB-22: Problem Prognosis (CE) optional
• PRB-23: Individual Awareness of Prognosis (CE) optional
• PRB-24: Family/Significant Other Awareness of Problem/Prognosis (ST) optional
• PRB-25: Security/Sensitivity (CE) optional

See Also:

• Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor	Description
PRB(Group parent, ModelClassFactory factory)	Creates a new PRB segment

Method Summary

Modifier and Type	Method	Description
protected Type	createNewTypeWithoutReflection(int field)
ID	getActionCode()	Returns PRB-1: "Action Code" - creates it if necessary
TS	getActionDateTime()	Returns PRB-2: "Action Date/Time" - creates it if necessary
TS	getActualProblemResolutionDateTime()	Returns PRB-9: "Actual Problem Resolution Date/Time" - creates it if necessary
TS	getAnticipatedProblemResolutionDateTime()	Returns PRB-8: "Anticipated Problem Resolution Date/Time" - creates it if necessary
CE	getCertaintyOfProblem()	Returns PRB-19: "Certainty of Problem" - creates it if necessary
EI	getEpisodeOfCareID()	Returns PRB-5: "Episode of Care ID" - creates it if necessary
ST	getFamilySignificantOtherAwarenessOfProblemPrognosis()	Returns PRB-24: "Family/Significant Other Awareness of Problem/Prognosis" - creates it if necessary
CE	getIndividualAwarenessOfProblem()	Returns PRB-21: "Individual Awareness of Problem" - creates it if necessary
CE	getIndividualAwarenessOfPrognosis()	Returns PRB-23: "Individual Awareness of Prognosis" - creates it if necessary
ID	getPrb1_ActionCode()	Returns PRB-1: "Action Code" - creates it if necessary
CE	getPrb10_ProblemClassification()	Returns PRB-10: "Problem Classification" - creates it if necessary
CE[]	getPrb11_ProblemManagementDiscipline()	Returns all repetitions of Problem Management Discipline (PRB-11).
CE	getPrb11_ProblemManagementDiscipline(int rep)	Returns a specific repetition of PRB-11: "Problem Management Discipline" - creates it if necessary
int	getPrb11_ProblemManagementDisciplineReps()	Returns a count of the current number of repetitions of Problem Management Discipline (PRB-11).
CE	getPrb12_ProblemPersistence()	Returns PRB-12: "Problem Persistence" - creates it if necessary
CE	getPrb13_ProblemConfirmationStatus()	Returns PRB-13: "Problem Confirmation Status" - creates it if necessary
CE	getPrb14_ProblemLifeCycleStatus()	Returns PRB-14: "Problem Life Cycle Status" - creates it if necessary
TS	getPrb15_ProblemLifeCycleStatusDateTime()	Returns PRB-15: "Problem Life Cycle Status Date/Time" - creates it if necessary
TS	getPrb16_ProblemDateOfOnset()	Returns PRB-16: "Problem Date of Onset" - creates it if necessary
ST	getPrb17_ProblemOnsetText()	Returns PRB-17: "Problem Onset Text" - creates it if necessary
CE	getPrb18_ProblemRanking()	Returns PRB-18: "Problem Ranking" - creates it if necessary
CE	getPrb19_CertaintyOfProblem()	Returns PRB-19: "Certainty of Problem" - creates it if necessary
TS	getPrb2_ActionDateTime()	Returns PRB-2: "Action Date/Time" - creates it if necessary
NM	getPrb20_ProbabilityOfProblem()	Returns PRB-20: "Probability of Problem (0-1)" - creates it if necessary
CE	getPrb21_IndividualAwarenessOfProblem()	Returns PRB-21: "Individual Awareness of Problem" - creates it if necessary
CE	getPrb22_ProblemPrognosis()	Returns PRB-22: "Problem Prognosis" - creates it if necessary
CE	getPrb23_IndividualAwarenessOfPrognosis()	Returns PRB-23: "Individual Awareness of Prognosis" - creates it if necessary
ST	getPrb24_FamilySignificantOtherAwarenessOfProblemPrognosis()	Returns PRB-24: "Family/Significant Other Awareness of Problem/Prognosis" - creates it if necessary
CE	getPrb25_SecuritySensitivity()	Returns PRB-25: "Security/Sensitivity" - creates it if necessary
CE	getPrb3_ProblemID()	Returns PRB-3: "Problem ID" - creates it if necessary
EI	getPrb4_ProblemInstanceID()	Returns PRB-4: "Problem Instance ID" - creates it if necessary
EI	getPrb5_EpisodeOfCareID()	Returns PRB-5: "Episode of Care ID" - creates it if necessary
NM	getPrb6_ProblemListPriority()	Returns PRB-6: "Problem List Priority" - creates it if necessary
TS	getPrb7_ProblemEstablishedDateTime()	Returns PRB-7: "Problem Established Date/Time" - creates it if necessary
TS	getPrb8_AnticipatedProblemResolutionDateTime()	Returns PRB-8: "Anticipated Problem Resolution Date/Time" - creates it if necessary
TS	getPrb9_ActualProblemResolutionDateTime()	Returns PRB-9: "Actual Problem Resolution Date/Time" - creates it if necessary
NM	getProbabilityOfProblem()	Returns PRB-20: "Probability of Problem (0-1)" - creates it if necessary
CE	getProblemClassification()	Returns PRB-10: "Problem Classification" - creates it if necessary
CE	getProblemConfirmationStatus()	Returns PRB-13: "Problem Confirmation Status" - creates it if necessary
TS	getProblemDateOfOnset()	Returns PRB-16: "Problem Date of Onset" - creates it if necessary
TS	getProblemEstablishedDateTime()	Returns PRB-7: "Problem Established Date/Time" - creates it if necessary
CE	getProblemID()	Returns PRB-3: "Problem ID" - creates it if necessary
EI	getProblemInstanceID()	Returns PRB-4: "Problem Instance ID" - creates it if necessary
CE	getProblemLifeCycleStatus()	Returns PRB-14: "Problem Life Cycle Status" - creates it if necessary
TS	getProblemLifeCycleStatusDateTime()	Returns PRB-15: "Problem Life Cycle Status Date/Time" - creates it if necessary
NM	getProblemListPriority()	Returns PRB-6: "Problem List Priority" - creates it if necessary
CE[]	getProblemManagementDiscipline()	Returns all repetitions of Problem Management Discipline (PRB-11).
CE	getProblemManagementDiscipline(int rep)	Returns a specific repetition of PRB-11: "Problem Management Discipline" - creates it if necessary
int	getProblemManagementDisciplineReps()	Returns a count of the current number of repetitions of Problem Management Discipline (PRB-11).
ST	getProblemOnsetText()	Returns PRB-17: "Problem Onset Text" - creates it if necessary
CE	getProblemPersistence()	Returns PRB-12: "Problem Persistence" - creates it if necessary
CE	getProblemPrognosis()	Returns PRB-22: "Problem Prognosis" - creates it if necessary
CE	getProblemRanking()	Returns PRB-18: "Problem Ranking" - creates it if necessary
CE	getSecuritySensitivity()	Returns PRB-25: "Security/Sensitivity" - creates it if necessary
CE	insertPrb11_ProblemManagementDiscipline(int rep)	Inserts a repetition of PRB-11: "Problem Management Discipline" at a specific index
CE	insertProblemManagementDiscipline(int rep)	Inserts a repetition of PRB-11: "Problem Management Discipline" at a specific index
CE	removePrb11_ProblemManagementDiscipline(int rep)	Removes a repetition of PRB-11: "Problem Management Discipline" at a specific index
CE	removeProblemManagementDiscipline(int rep)	Removes a repetition of PRB-11: "Problem Management Discipline" at a specific index

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

accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

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

getMessage, getParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Details

PRB

public PRB(Group parent,
 ModelClassFactory factory)

Creates a new PRB segment

Method Details

getActionCode

public ID getActionCode()

Returns PRB-1: "Action Code" - creates it if necessary

getPrb1_ActionCode

public ID getPrb1_ActionCode()

Returns PRB-1: "Action Code" - creates it if necessary

getActionDateTime

public TS getActionDateTime()

Returns PRB-2: "Action Date/Time" - creates it if necessary

getPrb2_ActionDateTime

public TS getPrb2_ActionDateTime()

Returns PRB-2: "Action Date/Time" - creates it if necessary

getProblemID

public CE getProblemID()

Returns PRB-3: "Problem ID" - creates it if necessary

getPrb3_ProblemID

public CE getPrb3_ProblemID()

Returns PRB-3: "Problem ID" - creates it if necessary

getProblemInstanceID

public EI getProblemInstanceID()

Returns PRB-4: "Problem Instance ID" - creates it if necessary

getPrb4_ProblemInstanceID

public EI getPrb4_ProblemInstanceID()

Returns PRB-4: "Problem Instance ID" - creates it if necessary

getEpisodeOfCareID

public EI getEpisodeOfCareID()

Returns PRB-5: "Episode of Care ID" - creates it if necessary

getPrb5_EpisodeOfCareID

public EI getPrb5_EpisodeOfCareID()

Returns PRB-5: "Episode of Care ID" - creates it if necessary

getProblemListPriority

public NM getProblemListPriority()

Returns PRB-6: "Problem List Priority" - creates it if necessary

getPrb6_ProblemListPriority

public NM getPrb6_ProblemListPriority()

Returns PRB-6: "Problem List Priority" - creates it if necessary

getProblemEstablishedDateTime

public TS getProblemEstablishedDateTime()

Returns PRB-7: "Problem Established Date/Time" - creates it if necessary

getPrb7_ProblemEstablishedDateTime

public TS getPrb7_ProblemEstablishedDateTime()

Returns PRB-7: "Problem Established Date/Time" - creates it if necessary

getAnticipatedProblemResolutionDateTime

public TS getAnticipatedProblemResolutionDateTime()

Returns PRB-8: "Anticipated Problem Resolution Date/Time" - creates it if necessary

getPrb8_AnticipatedProblemResolutionDateTime

public TS getPrb8_AnticipatedProblemResolutionDateTime()

Returns PRB-8: "Anticipated Problem Resolution Date/Time" - creates it if necessary

getActualProblemResolutionDateTime

public TS getActualProblemResolutionDateTime()

Returns PRB-9: "Actual Problem Resolution Date/Time" - creates it if necessary

getPrb9_ActualProblemResolutionDateTime

public TS getPrb9_ActualProblemResolutionDateTime()

Returns PRB-9: "Actual Problem Resolution Date/Time" - creates it if necessary

getProblemClassification

public CE getProblemClassification()

Returns PRB-10: "Problem Classification" - creates it if necessary

getPrb10_ProblemClassification

public CE getPrb10_ProblemClassification()

Returns PRB-10: "Problem Classification" - creates it if necessary

getProblemManagementDiscipline

public CE[] getProblemManagementDiscipline()

Returns all repetitions of Problem Management Discipline (PRB-11).

getPrb11_ProblemManagementDiscipline

public CE[] getPrb11_ProblemManagementDiscipline()

Returns all repetitions of Problem Management Discipline (PRB-11).

getProblemManagementDisciplineReps

public int getProblemManagementDisciplineReps()

Returns a count of the current number of repetitions of Problem Management Discipline (PRB-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getProblemManagementDiscipline

public CE getProblemManagementDiscipline(int rep)

Returns a specific repetition of PRB-11: "Problem Management Discipline" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPrb11_ProblemManagementDiscipline

public CE getPrb11_ProblemManagementDiscipline(int rep)

Returns a specific repetition of PRB-11: "Problem Management Discipline" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPrb11_ProblemManagementDisciplineReps

public int getPrb11_ProblemManagementDisciplineReps()

Returns a count of the current number of repetitions of Problem Management Discipline (PRB-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertProblemManagementDiscipline

public CE insertProblemManagementDiscipline(int rep)
                                     throws HL7Exception

Inserts a repetition of PRB-11: "Problem Management Discipline" 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)

insertPrb11_ProblemManagementDiscipline

public CE insertPrb11_ProblemManagementDiscipline(int rep)
                                           throws HL7Exception

Inserts a repetition of PRB-11: "Problem Management Discipline" 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)

removeProblemManagementDiscipline

public CE removeProblemManagementDiscipline(int rep)
                                     throws HL7Exception

Removes a repetition of PRB-11: "Problem Management Discipline" 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)

removePrb11_ProblemManagementDiscipline

public CE removePrb11_ProblemManagementDiscipline(int rep)
                                           throws HL7Exception

Removes a repetition of PRB-11: "Problem Management Discipline" 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)

getProblemPersistence

public CE getProblemPersistence()

Returns PRB-12: "Problem Persistence" - creates it if necessary

getPrb12_ProblemPersistence

public CE getPrb12_ProblemPersistence()

Returns PRB-12: "Problem Persistence" - creates it if necessary

getProblemConfirmationStatus

public CE getProblemConfirmationStatus()

Returns PRB-13: "Problem Confirmation Status" - creates it if necessary

getPrb13_ProblemConfirmationStatus

public CE getPrb13_ProblemConfirmationStatus()

Returns PRB-13: "Problem Confirmation Status" - creates it if necessary

getProblemLifeCycleStatus

public CE getProblemLifeCycleStatus()

Returns PRB-14: "Problem Life Cycle Status" - creates it if necessary

getPrb14_ProblemLifeCycleStatus

public CE getPrb14_ProblemLifeCycleStatus()

Returns PRB-14: "Problem Life Cycle Status" - creates it if necessary

getProblemLifeCycleStatusDateTime

public TS getProblemLifeCycleStatusDateTime()

Returns PRB-15: "Problem Life Cycle Status Date/Time" - creates it if necessary

getPrb15_ProblemLifeCycleStatusDateTime

public TS getPrb15_ProblemLifeCycleStatusDateTime()

Returns PRB-15: "Problem Life Cycle Status Date/Time" - creates it if necessary

getProblemDateOfOnset

public TS getProblemDateOfOnset()

Returns PRB-16: "Problem Date of Onset" - creates it if necessary

getPrb16_ProblemDateOfOnset

public TS getPrb16_ProblemDateOfOnset()

Returns PRB-16: "Problem Date of Onset" - creates it if necessary

getProblemOnsetText

public ST getProblemOnsetText()

Returns PRB-17: "Problem Onset Text" - creates it if necessary

getPrb17_ProblemOnsetText

public ST getPrb17_ProblemOnsetText()

Returns PRB-17: "Problem Onset Text" - creates it if necessary

getProblemRanking

public CE getProblemRanking()

Returns PRB-18: "Problem Ranking" - creates it if necessary

getPrb18_ProblemRanking

public CE getPrb18_ProblemRanking()

Returns PRB-18: "Problem Ranking" - creates it if necessary

getCertaintyOfProblem

public CE getCertaintyOfProblem()

Returns PRB-19: "Certainty of Problem" - creates it if necessary

getPrb19_CertaintyOfProblem

public CE getPrb19_CertaintyOfProblem()

Returns PRB-19: "Certainty of Problem" - creates it if necessary

getProbabilityOfProblem

public NM getProbabilityOfProblem()

Returns PRB-20: "Probability of Problem (0-1)" - creates it if necessary

getPrb20_ProbabilityOfProblem

public NM getPrb20_ProbabilityOfProblem()

Returns PRB-20: "Probability of Problem (0-1)" - creates it if necessary

getIndividualAwarenessOfProblem

public CE getIndividualAwarenessOfProblem()

Returns PRB-21: "Individual Awareness of Problem" - creates it if necessary

getPrb21_IndividualAwarenessOfProblem

public CE getPrb21_IndividualAwarenessOfProblem()

Returns PRB-21: "Individual Awareness of Problem" - creates it if necessary

getProblemPrognosis

public CE getProblemPrognosis()

Returns PRB-22: "Problem Prognosis" - creates it if necessary

getPrb22_ProblemPrognosis

public CE getPrb22_ProblemPrognosis()

Returns PRB-22: "Problem Prognosis" - creates it if necessary

getIndividualAwarenessOfPrognosis

public CE getIndividualAwarenessOfPrognosis()

Returns PRB-23: "Individual Awareness of Prognosis" - creates it if necessary

getPrb23_IndividualAwarenessOfPrognosis

public CE getPrb23_IndividualAwarenessOfPrognosis()

Returns PRB-23: "Individual Awareness of Prognosis" - creates it if necessary

getFamilySignificantOtherAwarenessOfProblemPrognosis

public ST getFamilySignificantOtherAwarenessOfProblemPrognosis()

Returns PRB-24: "Family/Significant Other Awareness of Problem/Prognosis" - creates it if necessary

getPrb24_FamilySignificantOtherAwarenessOfProblemPrognosis

public ST getPrb24_FamilySignificantOtherAwarenessOfProblemPrognosis()

Returns PRB-24: "Family/Significant Other Awareness of Problem/Prognosis" - creates it if necessary

getSecuritySensitivity

public CE getSecuritySensitivity()

Returns PRB-25: "Security/Sensitivity" - creates it if necessary

getPrb25_SecuritySensitivity

public CE getPrb25_SecuritySensitivity()

Returns PRB-25: "Security/Sensitivity" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment