cdac.medinfo.sdk.hl7282.baselibs.segments

Class SGH

java.lang.Object

cdac.medinfo.sdk.hl7282.baselibs.segments.Segment

cdac.medinfo.sdk.hl7282.baselibs.segments.SGH

All Implemented Interfaces:

ISegment

public class SGH
extends Segment

SGH - Segment Group Header

This segment segment is only used to provide information about the instantiated message structure to indicate that a new segment group begins and subsequent segments should be interpreted accordingly. It does not contain any patient related data.

Represents an HL7 SGH message segment. This segment has the following fields:

SGH-1: Set ID - SGH (SI)Required
SGH-2: Segment Group Name (ST)Optional
This class provides mechanism to validate message against HL7 v 2.8.2 standard. The class provides accessors & mutators for the elements mentioned above. The class has validate method which validates Message against HL7 v 2.8.2 standard.

User can also create Segment through SegmentFactory

Constructor Summary

Constructors

Constructor and Description
SGH() Constructs the SGH segment.

Method Summary

Methods

Modifier and Type	Method and Description
ST	getSegmentGroupName() Retrieves the Segment Group Name.
SI	getSetID_SGH() Retrieves the Set ID SGH.
void	setSegmentGroupName(ST objSegmentGroupName) Set the Segment Group Name.
void	setSegmentGroupName(java.lang.String strSegmentGroupName) Set the Segment Group Name.
void	setSetID_SGH(SI objSetID_SGH) Set the Set ID SGH.
void	setSetID_SGH(java.lang.String strSetID_SGH) Set the Set ID SGH.
boolean	validate() Validates HL7 Message objects .

Methods inherited from class cdac.medinfo.sdk.hl7282.baselibs.segments.Segment

addUnRecognizedField, dumpSegment, getFields, getName, getUnrecognizedFields, moveToNextSegment, parse, removeDataElement, removeDataElement, serialize, setName, setUnRecognizedField, updateDataElement, updateDataElement, writeToXML

Methods inherited from class java.lang.Object

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

Constructor Detail

SGH

public SGH()

Constructs the SGH segment.

Method Detail

getSetID_SGH

public SI getSetID_SGH()

Retrieves the Set ID SGH. For the first segment group transmitted, the sequence number shall be 1; for the second , it shall be 2; and so on.

Returns:

String - setID_SGH

setSetID_SGH

public void setSetID_SGH(java.lang.String strSetID_SGH)

Set the Set ID SGH. For the first segment group transmitted, the sequence number shall be 1; for the second , it shall be 2; and so on.

Parameters:

strSetID_SGH - This field contains the number that identifies SGH transaction.

setSetID_SGH

public void setSetID_SGH(SI objSetID_SGH)

Set the Set ID SGH. For the first segment group transmitted, the sequence number shall be 1; for the second , it shall be 2; and so on.

Parameters:

objSetID_SGH - Object of Set ID SGH.

getSegmentGroupName

public ST getSegmentGroupName()

Retrieves the Segment Group Name. This field contains the name of the segment group.

Returns:

String - SegmentGroupName

setSegmentGroupName

public void setSegmentGroupName(java.lang.String strSegmentGroupName)

Set the Segment Group Name. This field contains the name of the segment group.

Parameters:

strSegmentGroupName - String value of Segment Group Name

setSegmentGroupName

public void setSegmentGroupName(ST objSegmentGroupName)

Set the Segment Group Name. This field contains the name of the segment group.

Parameters:

objSegmentGroupName - Segment Group Name

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 interface ISegment

Overrides:

validate in class Segment

Returns:

boolean - true or false.

Throws:

InvalidSegmentException - Throws when Segment Validation fails.