cdac.medinfo.sdk.hl725.hl7model.segments
Class PRB

java.lang.Object
  extended by cdac.medinfo.sdk.hl725.hl7model.segments.Segment
      extended by cdac.medinfo.sdk.hl725.hl7model.segments.PRB
All Implemented Interfaces:
ISegment

public class PRB
extends Segment

PRB - Problem Detail Segment. The problem detail segment contains the data necessary to add, update, correct, and delete the problems of a given individual. Represents an HL7 PRB message segment. 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)
PRB-6: Problem List Priority (NM)
PRB-7: Problem Established Date/Time (TS)
PRB-8: Anticipated Problem Resolution Date/Time (TS)
PRB-9: Actual Problem Resolution Date/Time (TS)
PRB-10: Problem Classification (CE)
PRB-11: Problem Management Discipline (CE)
PRB-12: Problem Persistence (CE)
PRB-13: Problem Confirmation Status (CE)
PRB-14: Problem Life Cycle Status (CE)
PRB-15: Problem Life Cycle Status Date/Time (TS)
PRB-16: Problem Date of Onset (TS)
PRB-17: Problem Onset Text (ST)
PRB-18: Problem Ranking (CE)
PRB-19: Certainty of Problem (CE)
PRB-20: Probability of Problem (0-1) (NM)
PRB-21: Individual Awareness of Problem (CE)
PRB-22: Problem Prognosis (CE)
PRB-23: Individual Awareness of Prognosis (CE)
PRB-24: Family/Significant Other Awareness of Problem/Prognosis (ST)
PRB-25: Security/Sensitivity (CE)
This class provides mechanism to serialize, parse and validate message against HL7 v 2.5 standard. The class provides accessors & mutators for the elements mentioned above. These elements can be easily populated & populated values can be easily retrieved. The class has validate method which validates Message against HL7 v 2.5 standard. It provides user with serialize method to serialize message object to any stream & parse method to obtain fully populated & validated Message object from any stream.


Field Summary
protected  ID actionCode
           
protected  TS actionDateOrTime
           
protected  TS actualProblemResolutionDateOrTime
           
protected  TS anticipatedProblemResolutionDateOrTime
           
protected  CE certaintyOfProblem
           
protected  EI episodeOfCareID
           
protected  ST familyOrSignificantOtherAwarenessOfProblemOrPrognosis
           
protected  CE individualAwarenessOfProblem
           
protected  CE individualAwarenessOfPrognosis
           
protected  NM probabilityOfProblem
           
protected  CE problemClassification
           
protected  CE problemConfirmationStatus
           
protected  TS problemDateOfOnset
           
protected  TS problemEstablishedDateOrTime
           
protected  CE problemID
           
protected  EI problemInstanceID
           
protected  CE problemLifeCycleStatus
           
protected  TS problemLifeCycleStatusDateOrTime
           
protected  NM problemListPriority
           
protected  ISingleCollection<CE> problemManagementDiscipline
           
protected  ST problemOnsetText
           
protected  CE problemPersistence
           
protected  CE problemPrognosis
           
protected  CE problemRanking
           
protected  CE securityOrSensitivity
           
protected  SI setID_PRB
           
 
Fields inherited from class cdac.medinfo.sdk.hl725.hl7model.segments.Segment
enumSegments
 
Constructor Summary
PRB()
          Constucts the PRB segment.
 
Method Summary
 ID getActionCode()
          Retrieves the Action Code.
 TS getActionDateOrTime()
          Retrieves the Action Date Or Time.
 TS getActualProblemResolutionDateOrTime()
          Retrieves the Actual Problem Resolution Date Or Time.
 TS getAnticipatedProblemResolutionDateOrTime()
          Retrieves the Anticipated Problem Resolution Date Or Time.
 CE getCertaintyOfProblem()
          Retrieves the Certainty Of Problem.
 EI getEpisodeOfCareID()
          Retrieves the Episode Of Care ID.
 ST getFamilyOrSignificantOtherAwarenessOfProblemOrPrognosis()
          Retrieves the Family Or Significant Other Awareness Of Problem Or Prognosis.
 CE getIndividualAwarenessOfProblem()
          Retrieves the Individual Awareness Of Problem.
 CE getIndividualAwarenessOfPrognosis()
          Retrieves the Individual Awareness Of Prognosis.
 NM getProbabilityOfProblem()
          Retrieves the Probability Of Problem.
 CE getProblemClassification()
          Retrieves the Problem Classification.
 CE getProblemConfirmationStatus()
          Retrieves the Problem Confirmation Status.
 TS getProblemDateOfOnset()
          Retrieves the Problem Date Of Onset.
 TS getProblemEstablishedDateOrTime()
          Retrieves the Problem Established Date Or Time.
 CE getProblemID()
          Retrieves the Problem ID.
 EI getProblemInstanceID()
          Retrieves the Problem Instance ID.
 CE getProblemLifeCycleStatus()
          Retrieves the Problem Life Cycle Status.
 TS getProblemLifeCycleStatusDateOrTime()
          Retrieves the Problem Life Cycle Status Date Or Time.
 NM getProblemListPriority()
          Retrieves the Problem List Priority.
 ISingleCollection<CE> getProblemManagementDiscipline()
          Retrieves the Problem Management Discipline.
 ST getProblemOnsetText()
          Retrieves the Problem On set Text.
 CE getProblemPersistence()
          Retrieves the Problem Persistence.
 CE getProblemPrognosis()
          Retrieves the Problem Prognosis.
 CE getProblemRanking()
          Retrieves the Problem Ranking.
 CE getSecurityOrSensitivity()
          Retrieves the Security Or Sensitivity.
 int parse(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)
          Parses HL7 Segment Strings from any Stream into HL7 Segment object.
 int serialize(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)
          Serializes HL7 Message objects.
 int setActionCode(java.lang.String strAtionCode)
          Set the Action Code.
 int setActionDateOrTime(java.lang.String strTime, java.lang.String strDegreeOfPrecision)
          Set the Action Date Or Time.
 int setActualProblemResolutionDateOrTime(java.lang.String strTime, java.lang.String strDegreeOfPrecision)
          Set the Actual Problem Resolution Date Or Time.
 int setAnticipatedProblemResolutionDateOrTime(java.lang.String strTime, java.lang.String strDegreeOfPrecision)
          Set the Anticipated Problem Resolution Date Or Time.
 int setCertaintyOfProblem(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Certainty Of Problem.
 int setEpisodeOfCareID(java.lang.String strEntityIdentifier, java.lang.String strNamespaceId, java.lang.String strUniversalId, java.lang.String strUniversalIdType)
          Set the Episode Of Care ID.
 int setFamilyOrSignificantOtherAwarenessOfProblemOrPrognosis(java.lang.String strFamilyOrSignificantOtherAwarenessOfProblemOrPrognosis)
          Set the Family Or Significant Other Awareness Of Problem Or Prognosis.
 int setIndividualAwarenessOfProblem(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Individual Awareness Of Problem.
 int setIndividualAwarenessOfPrognosis(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Individual Awareness Of Prognosis.
 int setProbabilityOfProblem(java.lang.String strProbabilityOfProblem)
          Set the Probability Of Problem.
 int setProblemClassification(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Problem Classification.
 int setProblemConfirmationStatus(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Problem Confirmation Status.
 int setProblemDateOfOnset(java.lang.String strTime, java.lang.String strDegreeOfPrecision)
          Set the Problem Date Of Onset.
 int setProblemEstablishedDateOrTime(java.lang.String strTime, java.lang.String strDegreeOfPrecision)
          Set the Problem Established Date Or Time.
 int setProblemID(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Problem ID.
 int setProblemInstanceID(java.lang.String strEntityIdentifier, java.lang.String strNamespaceId, java.lang.String strUniversalId, java.lang.String strUniversalIdType)
          Set the Problem Instance ID.
 int setProblemLifeCycleStatus(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Problem Life Cycle Status.
 int setProblemLifeCycleStatusDateOrTime(java.lang.String strTime, java.lang.String strDegreeOfPrecision)
          Set the Problem Life Cycle Status Date Or Time.
 int setProblemListPriority(java.lang.String strProblemListPriority)
          Set the Problem List Priority.
 int setProblemManagementDiscipline(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Problem Management Discipline.
 int setProblemOnsetText(java.lang.String strProblemOnsetText)
          Set the Problem On set Text.
 int setProblemPersistence(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Problem Persistence.
 int setProblemPrognosis(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Problem Prognosis.
 int setProblemRanking(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Problem Ranking.
 int setSecurityOrSensitivity(java.lang.String strIdentifier, java.lang.String strText, java.lang.String strNameOfCodingSystem, java.lang.String strAlternateIdentifier, java.lang.String strAlternateText, java.lang.String strNameOfAlternateCodingSystem)
          Set the Security Or Sensitivity.
 boolean validate()
          Validates HL7 Message objects .
 
Methods inherited from class cdac.medinfo.sdk.hl725.hl7model.segments.Segment
getName, moveToNextSegment, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

setID_PRB

protected SI setID_PRB

actionCode

protected ID actionCode

actionDateOrTime

protected TS actionDateOrTime

problemID

protected CE problemID

problemInstanceID

protected EI problemInstanceID

episodeOfCareID

protected EI episodeOfCareID

problemListPriority

protected NM problemListPriority

problemEstablishedDateOrTime

protected TS problemEstablishedDateOrTime

anticipatedProblemResolutionDateOrTime

protected TS anticipatedProblemResolutionDateOrTime

actualProblemResolutionDateOrTime

protected TS actualProblemResolutionDateOrTime

problemClassification

protected CE problemClassification

problemManagementDiscipline

protected ISingleCollection<CE> problemManagementDiscipline

problemPersistence

protected CE problemPersistence

problemConfirmationStatus

protected CE problemConfirmationStatus

problemLifeCycleStatus

protected CE problemLifeCycleStatus

problemLifeCycleStatusDateOrTime

protected TS problemLifeCycleStatusDateOrTime

problemDateOfOnset

protected TS problemDateOfOnset

problemOnsetText

protected ST problemOnsetText

problemRanking

protected CE problemRanking

certaintyOfProblem

protected CE certaintyOfProblem

probabilityOfProblem

protected NM probabilityOfProblem

individualAwarenessOfProblem

protected CE individualAwarenessOfProblem

problemPrognosis

protected CE problemPrognosis

individualAwarenessOfPrognosis

protected CE individualAwarenessOfPrognosis

familyOrSignificantOtherAwarenessOfProblemOrPrognosis

protected ST familyOrSignificantOtherAwarenessOfProblemOrPrognosis

securityOrSensitivity

protected CE securityOrSensitivity
Constructor Detail

PRB

public PRB()
Constucts the PRB segment.

Method Detail

getActionCode

public ID getActionCode()
Retrieves the Action Code.

Returns:
String - actionCode

getActionDateOrTime

public TS getActionDateOrTime()
Retrieves the Action Date Or Time.

Returns:
TS - actionDateOrTime

getActualProblemResolutionDateOrTime

public TS getActualProblemResolutionDateOrTime()
Retrieves the Actual Problem Resolution Date Or Time. This field contains the date/time that the problem is actually resolved.

Returns:
TS - actualProblemResolutionDateOrTime

getAnticipatedProblemResolutionDateOrTime

public TS getAnticipatedProblemResolutionDateOrTime()
Retrieves the Anticipated Problem Resolution Date Or Time. This field contains the estimated date/time for resolving the stated problem.

Returns:
TS - anticipatedProblemResolutionDateOrTime

getCertaintyOfProblem

public CE getCertaintyOfProblem()
Retrieves the Certainty Of Problem. This field contains a qualitative representation of the certainty of a problem.

Returns:
CE - certaintyOfProblem

getEpisodeOfCareID

public EI getEpisodeOfCareID()
Retrieves the Episode Of Care ID. This field uniquely identifies the episode of care to which this problem applies.

Returns:
EI - episodeOfCareID

getFamilyOrSignificantOtherAwarenessOfProblemOrPrognosis

public ST getFamilyOrSignificantOtherAwarenessOfProblemOrPrognosis()
Retrieves the Family Or Significant Other Awareness Of Problem Or Prognosis.

Returns:
String - familyOrSignificantOtherAwarenessOfProblemOrPrognosis

getIndividualAwarenessOfProblem

public CE getIndividualAwarenessOfProblem()
Retrieves the Individual Awareness Of Problem. This field contains the individualís comprehension of the problem(e.g., full, marginal, partial, etc.).

Returns:
CE - individualAwarenessOfProblem

getIndividualAwarenessOfPrognosis

public CE getIndividualAwarenessOfPrognosis()
Retrieves the Individual Awareness Of Prognosis. This field contains the individualís comprehension of the prognosis for the problem (e.g., full, marginal, partial, etc.).

Returns:
CE - individualAwarenessOfPrognosis

getProbabilityOfProblem

public NM getProbabilityOfProblem()
Retrieves the Probability Of Problem. This field contains a quantitative or numeric representation of the certainty that the problem exists for this patient.

Returns:
String - probabilityOfProblem

getProblemClassification

public CE getProblemClassification()
Retrieves the Problem Classification.

Returns:
CE - problemClassification

getProblemConfirmationStatus

public CE getProblemConfirmationStatus()
Retrieves the Problem Confirmation Status.

Returns:
CE - problemConfirmationStatus

getProblemDateOfOnset

public TS getProblemDateOfOnset()
Retrieves the Problem Date Of Onset.

Returns:
TS - problemDateOfOnset

getProblemEstablishedDateOrTime

public TS getProblemEstablishedDateOrTime()
Retrieves the Problem Established Date Or Time.

Returns:
TS - problemEstablishedDateOrTime

getProblemID

public CE getProblemID()
Retrieves the Problem ID.

Returns:
CE - problemID

getProblemInstanceID

public EI getProblemInstanceID()
Retrieves the Problem Instance ID. This field contains the identifier assigned by an initiating system to an instance of a problem.

Returns:
EI - problemInstanceID

getProblemLifeCycleStatus

public CE getProblemLifeCycleStatus()
Retrieves the Problem Life Cycle Status. This field contains the current status of the problem at this particular date/time.

Returns:
CE - problemLifeCycleStatus

getProblemLifeCycleStatusDateOrTime

public TS getProblemLifeCycleStatusDateOrTime()
Retrieves the Problem Life Cycle Status Date Or Time.

Returns:
TS - problemLifeCycleStatusDateOrTime

getProblemListPriority

public NM getProblemListPriority()
Retrieves the Problem List Priority. This field prioritizes this problem on a list that is maintained for the individual.

Returns:
String - problemListPriority

getProblemManagementDiscipline

public ISingleCollection<CE> getProblemManagementDiscipline()
Retrieves the Problem Management Discipline. This field indicates the category of caregiver with responsibility for managing this specific problem.

Returns:
ISingleCollection - problemManagementDiscipline

getProblemOnsetText

public ST getProblemOnsetText()
Retrieves the Problem On set Text. This field allows for a textual representation of the time when the problem begin.

Returns:
String - problemOnsetText

getProblemPersistence

public CE getProblemPersistence()
Retrieves the Problem Persistence. This field contains the perseverance of a problem (e.g., acute, chronic, etc.).

Returns:
CE - problemPersistence

getProblemPrognosis

public CE getProblemPrognosis()
Retrieves the Problem Prognosis. This field contains the prognosis for the individualís problem (e.g., good, poor, etc.).

Returns:
CE - problemPrognosis

getProblemRanking

public CE getProblemRanking()
Retrieves the Problem Ranking. This field contains a user-defined prioritization of a problem.

Returns:
CE - problemRanking

getSecurityOrSensitivity

public CE getSecurityOrSensitivity()
Retrieves the Security Or Sensitivity. This field contains information about the level of security and/or sensitivity surrounding the problem (e.g., highly sensitive, not sensitive, sensitive, etc.).

Returns:
CE - securityOrSensitivity

setActionCode

public int setActionCode(java.lang.String strAtionCode)
                  throws InvalidFieldException
Set the Action Code.

Parameters:
strAtionCode - Specifies the the intent of the message
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setActionDateOrTime

public int setActionDateOrTime(java.lang.String strTime,
                               java.lang.String strDegreeOfPrecision)
                        throws InvalidFieldException
Set the Action Date Or Time.

Parameters:
strTime - Specifies a point in time using a 24-hour clock notation.
strDegreeOfPrecision - The degree of precision of the time stamp .Suggested Values Y,L,D,H,M,S [Refer to HL7 Table 0529].
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setActualProblemResolutionDateOrTime

public int setActualProblemResolutionDateOrTime(java.lang.String strTime,
                                                java.lang.String strDegreeOfPrecision)
                                         throws InvalidFieldException
Set the Actual Problem Resolution Date Or Time. This field contains the date/time that the problem is actually resolved.

Parameters:
strTime - Specifies a point in time using a 24-hour clock notation.
strDegreeOfPrecision - The degree of precision of the time stamp .Suggested Values Y,L,D,H,M,S [Refer to HL7 Table 0529].
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setAnticipatedProblemResolutionDateOrTime

public int setAnticipatedProblemResolutionDateOrTime(java.lang.String strTime,
                                                     java.lang.String strDegreeOfPrecision)
                                              throws InvalidFieldException
Set the Anticipated Problem Resolution Date Or Time. This field contains the estimated date/time for resolving the stated problem.

Parameters:
strTime - Specifies a point in time using a 24-hour clock notation.
strDegreeOfPrecision - The degree of precision of the time stamp .Suggested Values Y,L,D,H,M,S [Refer to HL7 Table 0529].
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setCertaintyOfProblem

public int setCertaintyOfProblem(java.lang.String strIdentifier,
                                 java.lang.String strText,
                                 java.lang.String strNameOfCodingSystem,
                                 java.lang.String strAlternateIdentifier,
                                 java.lang.String strAlternateText,
                                 java.lang.String strNameOfAlternateCodingSystem)
                          throws InvalidFieldException
Set the Certainty Of Problem. This field contains a qualitative representation of the certainty of a problem.

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setEpisodeOfCareID

public int setEpisodeOfCareID(java.lang.String strEntityIdentifier,
                              java.lang.String strNamespaceId,
                              java.lang.String strUniversalId,
                              java.lang.String strUniversalIdType)
                       throws InvalidFieldException
Set the Episode Of Care ID. This field uniquely identifies the episode of care to which this problem applies.

Parameters:
strEntityIdentifier - Specifies to be unique within the series of identifiers created by the assigning authority, defined by a hierarchic designator
strNamespaceId - Specifies the assigning authority is a unique identifier of the system (or organization or agency or department) that creates the data.
strUniversalId - Specifies a string formatted according to the scheme defined by the third component universal ID type. It is intended to be unique over time within the UID type.
strUniversalIdType - Governs the interpretation of the Universal ID.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setFamilyOrSignificantOtherAwarenessOfProblemOrPrognosis

public int setFamilyOrSignificantOtherAwarenessOfProblemOrPrognosis(java.lang.String strFamilyOrSignificantOtherAwarenessOfProblemOrPrognosis)
                                                             throws InvalidFieldException
Set the Family Or Significant Other Awareness Of Problem Or Prognosis.

Parameters:
strFamilyOrSignificantOtherAwarenessOfProblemOrPrognosis - Comprehension of the actual problem/prognosis
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setIndividualAwarenessOfProblem

public int setIndividualAwarenessOfProblem(java.lang.String strIdentifier,
                                           java.lang.String strText,
                                           java.lang.String strNameOfCodingSystem,
                                           java.lang.String strAlternateIdentifier,
                                           java.lang.String strAlternateText,
                                           java.lang.String strNameOfAlternateCodingSystem)
                                    throws InvalidFieldException
Set the Individual Awareness Of Problem. This field contains the individualís comprehension of the problem(e.g., full, marginal, partial, etc.).

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies the descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setIndividualAwarenessOfPrognosis

public int setIndividualAwarenessOfPrognosis(java.lang.String strIdentifier,
                                             java.lang.String strText,
                                             java.lang.String strNameOfCodingSystem,
                                             java.lang.String strAlternateIdentifier,
                                             java.lang.String strAlternateText,
                                             java.lang.String strNameOfAlternateCodingSystem)
                                      throws InvalidFieldException
Set the Individual Awareness Of Prognosis. This field contains the individualís comprehension of the prognosis for the problem (e.g., full, marginal, partial, etc.).

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProbabilityOfProblem

public int setProbabilityOfProblem(java.lang.String strProbabilityOfProblem)
                            throws InvalidFieldException
Set the Probability Of Problem. This field contains a quantitative or numeric representation of the certainty that the problem exists for this patient.

Parameters:
strProbabilityOfProblem - A quantitative or numeric representation of the certainty that the problem exists for this patient
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemClassification

public int setProblemClassification(java.lang.String strIdentifier,
                                    java.lang.String strText,
                                    java.lang.String strNameOfCodingSystem,
                                    java.lang.String strAlternateIdentifier,
                                    java.lang.String strAlternateText,
                                    java.lang.String strNameOfAlternateCodingSystem)
                             throws InvalidFieldException
Set the Problem Classification.

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemConfirmationStatus

public int setProblemConfirmationStatus(java.lang.String strIdentifier,
                                        java.lang.String strText,
                                        java.lang.String strNameOfCodingSystem,
                                        java.lang.String strAlternateIdentifier,
                                        java.lang.String strAlternateText,
                                        java.lang.String strNameOfAlternateCodingSystem)
                                 throws InvalidFieldException
Set the Problem Confirmation Status.

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies the descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemDateOfOnset

public int setProblemDateOfOnset(java.lang.String strTime,
                                 java.lang.String strDegreeOfPrecision)
                          throws InvalidFieldException
Set the Problem Date Of Onset.

Parameters:
strTime - Specifies a point in time using a 24-hour clock notation.
strDegreeOfPrecision - The degree of precision of the time stamp .Suggested Values Y,L,D,H,M,S [Refer to HL7 Table 0529].
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemEstablishedDateOrTime

public int setProblemEstablishedDateOrTime(java.lang.String strTime,
                                           java.lang.String strDegreeOfPrecision)
                                    throws InvalidFieldException
Set the Problem Established Date Or Time.

Parameters:
strTime - Specifies a point in time using a 24-hour clock notation.
strDegreeOfPrecision - The degree of precision of the time stamp .Suggested Values Y,L,D,H,M,S [Refer to HL7 Table 0529].
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemID

public int setProblemID(java.lang.String strIdentifier,
                        java.lang.String strText,
                        java.lang.String strNameOfCodingSystem,
                        java.lang.String strAlternateIdentifier,
                        java.lang.String strAlternateText,
                        java.lang.String strNameOfAlternateCodingSystem)
                 throws InvalidFieldException
Set the Problem ID.

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemInstanceID

public int setProblemInstanceID(java.lang.String strEntityIdentifier,
                                java.lang.String strNamespaceId,
                                java.lang.String strUniversalId,
                                java.lang.String strUniversalIdType)
                         throws InvalidFieldException
Set the Problem Instance ID. This field contains the identifier assigned by an initiating system to an instance of a problem.

Parameters:
strEntityIdentifier - Specifies to be unique within the series of identifiers created by the assigning authority, defined by a hierarchic designator
strNamespaceId - Specifies the assigning authority is a unique identifier of the system (or organization or agency or department) that creates the data.
strUniversalId - Specifies a string formatted according to the scheme defined by the third component universal ID type. It is intended to be unique over time within the UID type.
strUniversalIdType - Governs the interpretation of the Universal ID.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemLifeCycleStatus

public int setProblemLifeCycleStatus(java.lang.String strIdentifier,
                                     java.lang.String strText,
                                     java.lang.String strNameOfCodingSystem,
                                     java.lang.String strAlternateIdentifier,
                                     java.lang.String strAlternateText,
                                     java.lang.String strNameOfAlternateCodingSystem)
                              throws InvalidFieldException
Set the Problem Life Cycle Status. This field contains the current status of the problem at this particular date/time.

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemLifeCycleStatusDateOrTime

public int setProblemLifeCycleStatusDateOrTime(java.lang.String strTime,
                                               java.lang.String strDegreeOfPrecision)
                                        throws InvalidFieldException
Set the Problem Life Cycle Status Date Or Time.

Parameters:
strTime - Specifies a point in time using a 24-hour clock notation.
strDegreeOfPrecision - The degree of precision of the time stamp .Suggested Values Y,L,D,H,M,S [Refer to HL7 Table 0529].
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemListPriority

public int setProblemListPriority(java.lang.String strProblemListPriority)
                           throws InvalidFieldException
Set the Problem List Priority. This field prioritizes this problem on a list that is maintained for the individual.

Parameters:
strProblemListPriority - Specifies priority of problem
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemManagementDiscipline

public int setProblemManagementDiscipline(java.lang.String strIdentifier,
                                          java.lang.String strText,
                                          java.lang.String strNameOfCodingSystem,
                                          java.lang.String strAlternateIdentifier,
                                          java.lang.String strAlternateText,
                                          java.lang.String strNameOfAlternateCodingSystem)
                                   throws InvalidFieldException
Set the Problem Management Discipline. This field indicates the category of caregiver with responsibility for managing this specific problem.

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemOnsetText

public int setProblemOnsetText(java.lang.String strProblemOnsetText)
                        throws InvalidFieldException
Set the Problem On set Text.

Parameters:
strProblemOnsetText - A textual representation of the time when the problem began
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemPersistence

public int setProblemPersistence(java.lang.String strIdentifier,
                                 java.lang.String strText,
                                 java.lang.String strNameOfCodingSystem,
                                 java.lang.String strAlternateIdentifier,
                                 java.lang.String strAlternateText,
                                 java.lang.String strNameOfAlternateCodingSystem)
                          throws InvalidFieldException
Set the Problem Persistence. This field contains the perseverance of a problem (e.g., acute, chronic, etc.).

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemPrognosis

public int setProblemPrognosis(java.lang.String strIdentifier,
                               java.lang.String strText,
                               java.lang.String strNameOfCodingSystem,
                               java.lang.String strAlternateIdentifier,
                               java.lang.String strAlternateText,
                               java.lang.String strNameOfAlternateCodingSystem)
                        throws InvalidFieldException
Set the Problem Prognosis. This field contains the prognosis for the individualís problem (e.g., good, poor, etc.).

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setProblemRanking

public int setProblemRanking(java.lang.String strIdentifier,
                             java.lang.String strText,
                             java.lang.String strNameOfCodingSystem,
                             java.lang.String strAlternateIdentifier,
                             java.lang.String strAlternateText,
                             java.lang.String strNameOfAlternateCodingSystem)
                      throws InvalidFieldException
Set the Problem Ranking. This field contains a user-defined prioritization of a problem.

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

setSecurityOrSensitivity

public int setSecurityOrSensitivity(java.lang.String strIdentifier,
                                    java.lang.String strText,
                                    java.lang.String strNameOfCodingSystem,
                                    java.lang.String strAlternateIdentifier,
                                    java.lang.String strAlternateText,
                                    java.lang.String strNameOfAlternateCodingSystem)
                             throws InvalidFieldException
Set the Security Or Sensitivity. This field contains information about the level of security and/or sensitivity surrounding the problem (e.g., highly sensitive, not sensitive, sensitive, etc.).

Parameters:
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.
strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.
strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.
strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.
Returns:
int - function status [success/failure].
Throws:
InvalidFieldException - Thrown when Field Validation fails.

parse

public int parse(IHL7Stream objIHL7Stream,
                 IDelimiter objIDelimiter)
          throws java.io.IOException,
                 InvalidSegmentException
Parses HL7 Segment Strings from any Stream into HL7 Segment object. During parsing the HL7 Segment object is validated against its Corresponding HL7 Attribute table mentioed in HL7 v2.5 docs. This method checks for the Repetition of the fields in the Segment. It also checks for the optionality of the fields as whether they are mandatory or optional. Successful parsing of the segment populates the object with the data present on the stream and provides easy accessor and mutator methods to navigate the message. It also leads to failure if version of given HL7 Message is not 2.5. This method raises exception if there is Segment which is not valid as per HL7 v 2.5 standard.

Specified by:
parse in class Segment
Parameters:
objIHL7Stream - Object of HL7Stream.
objIDelimiter - Object of class Delimiter.
Returns:
int - Success if segment is valid. - Fail if segment in not valid.
Throws:
InvalidSegmentException - Thrown when Segment Validation Fails.
java.io.IOException - Signals that an I/O exception of some sort has occurred.

validate

public boolean validate()
                 throws InvalidSegmentException
Validates HL7 Message objects . Validate method checks for validation each and every segments in side the Message object against specified message Structure. Validation chcecks include optionality of segment or group. It also verifies the number of times segment or group is repeated in message. e.g {PSH} while parsing PSH segment validate method will check for its mandatory presence. [PSH] in this case validate will throw exception if one tries to enter more than one PSH segment.

Specified by:
validate in class Segment
Returns:
boolean - true or false.
Throws:
InvalidSegmentException - Throws when Segment Validation fails.

serialize

public int serialize(IHL7Stream objIHL7Stream,
                     IDelimiter objIDelimiter)
              throws SerializeException,
                     java.io.IOException
Serializes HL7 Message objects. Before serializaton it validates Message as per HL7 v2.5 standard. For successfull serialization , Message Object should follow order of segments as per its corresponding Message Structure. Serialize method fails if given stream is null. It mandates presence of required segments and the number of occurences specified by the standard. This method also checks for presence of Mandatory Groups.It also verifies repeatability of Group.

Specified by:
serialize in class Segment
Parameters:
objIHL7Stream - Object of HL7Stream class
objIDelimiter - Object of Delimiter class present as inner class in MSG class
Returns:
int - function status [success/failure].
Throws:
SerializeException - Thrown when serialization of Message fails.
java.io.IOException - Signals that an I/O exception of some sort has occurred.