Generic SGIN2 Business Object

The SGIN2 Business Object is a representation of the HL7 V2.4 SGIN2 segment.

Business object structure

The generic SGIN2 business object is a hierarchical business object. Each of its attributes is either an HL7 datatype business object or a native type.

SGIN2 includes the following attributes:  

Business object attributes
Name Type Key Cardinality Comment
Insureds_Employee_ID DTCX TRUE n contains the employee ID of the insured
Insureds_Social_Security_Number String FALSE 1
Insureds_Employers_Name_And_ID DTXCN FALSE n "contains the name and ID of the insured's employer or the person who purchased the insurance for the insured
Employer_Information_Data String FALSE 1 contains the required employer information data for UB82 form locator 71. Refer to User-defined Table 0139 - Employer information data
Mail_Claim_Party DTArray_IS FALSE n contains the party to which the claim should be mailed. Refer to User-defined Table 0137 - Mail claim party
Medicare_Health_Ins_Card_Number String FALSE 1 contains the Medicare Health Insurance Number (HIN)
Medicaid_Case_Name DTXPN FALSE n contains the Medicaid case name
Medicaid_Case_Number String FALSE 1 contains the Medicaid case number
Military_Sponsor_Name DTXPN FALSE n defined by HCFA or other regulatory agencies
Military_ID_Number String FALSE 1 contains the military ID number
Dependent_Of_Military_Recipient DTCE FALSE 1 defined by HCFA or other regulatory agencies. Refer to User-defined Table 0342 - Military recipient
Military_Organization String FALSE 1 defined by HCFA or other regulatory agencies
Military_Station String FALSE 1 defined by HCFA or other regulatory agencies
Military_Service String FALSE 1 refers to the military branch of service. Refer to User-defined Table 0140 - Military service
Military_Rank_Grade String FALSE 1 military rank/grade of the insured. Refer to User-defined Table 0141 - Military rank/grade
Military_Status String FALSE 1 Refer to User-defined Table 0142 - Military status
Military_Retire_Date String FALSE 1 defined by HCFA or other regulatory agencies
Military_Non_Avail_Cert_On_File String FALSE 1 Refer to HL7 table 0136 - Yes/no indicator
Baby_Coverage String FALSE 1 Refer to HL7 table 0136 - Yes/no indicator
Combine_Baby_Bill String FALSE 1 Refer to HL7 table 0136 - Yes/no indicator
Blood_Deductible String FALSE 1 "Use this field instead of UB1-2 - blood deductible
Special_Coverage_Approval_Name DTXPN FALSE n contains the name of the individual who approves any special coverage
Special_Coverage_Approval_Title String FALSE 1 contains the title of the person who approves special coverage
Non_Covered_Insurance_Code DTArray_IS FALSE n contains the code that describes why a service is not covered. Refer to User-defined Table 0143 - Non-covered insurance code
Payor_ID DTCX FALSE n "In the US this field is required for ENVOY Corporation (a US claims clearing house) processing
Payor_Subscriber_ID DTCX FALSE n "In the US this field is required for ENVOY Corporation processing
Eligibility_Source String FALSE 1 "In the US this field is required for ENVOY Corporation processing
Room_Coverage_Type_Amount DTCM_RC FALSE n Use this field instead of IN1-40 - room rate-semi-private and IN1-41 - room rate-private
Policy_Type_Amount DTCM_PT FALSE n "contains the policy type (e.g.
Daily_Deductible DTCM_DD FALSE 1 "contains the number of days after which the daily deductible begins
Living_Dependency String FALSE 1 identifies the specific living conditions for the insured. Refer to User-defined Table 0223 - Living dependency
Ambulatory_Status DTArray_IS FALSE n field identifies the insured's state of mobility. Refer to User-defined Table 0009 - Ambulatory status
Citizenship DTCE FALSE n contains the code that identifies the insured's citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship
Primary_Language DTCE FALSE 1 identifies the insured's primary speaking language. HL7 recommends using ISO table 639 as the suggested values in User-defined Table 0296 - Primary language
Living_Arrangement String FALSE 1 indicates the situation in which the insured person lives at his primary residence. Refer to User-defined Table 0220 - Living arrangement
Publicity_Code DTCE FALSE 1 "contains a user-defined code indicating what level of publicity is allowed (e.g.
Protection_Indicator String FALSE 1 identifies the insured's protection. Refer to HL7 table 0136 - Yes/no indicator
Student_Indicator String FALSE 1 "identifies whether the insured is currently a student or not
Religion DTCE FALSE 1 indicates the type of religion practiced by the insured. Refer to User-defined Table 0006 - Religion
Mothers_Maiden_Name DTXPN FALSE n indicates the insured's mother's maiden name
Nationality DTCE FALSE 1 contains a code that identifies the nation or national grouping to which the insured person belongs. refer User-defined Table 0212 - Nationality
Ethnic_Group DTCE FALSE n field indicates the insured's ethnic group. Refer to User-defined Table 0189 - Ethnic group
Marital_Status DTCE FALSE n contains the insured's marital status. Refer to User-defined Table 0002 - Marital status
Insureds_Employment_Start_Date String FALSE 1 indicates the date on which the insured's employment with a particular employer began.
Employment_Stop_Date String FALSE 1 indicates the date on which the person's employment with a particular employer ended.
Job_Title String FALSE 1 contains a descriptive name for the insured's occupation
Job_Code_Class DTJCC FALSE 1 indicates a code that identifies the insured's job code. Refer to User-defined Tables 0327 - Job code and 0328 - Employee classification
Job_Status String FALSE 1 indicates a code that identifies the insured's current job status. Refer to User-defined Table 0311 - Job status
Employer_Contact_Person_Name DTXPN FALSE n name of the contact person that should be contacted at the insured's place of employment
Employer_Contact_Person_Phone_Number DTXTN FALSE n
Employer_Contact_Reason String FALSE 1 "contains the reason(s) that Sue Jones should be contacted on behalf of Joe Smith
Insureds_Contact_Persons_Name DTXPN FALSE n contains the contact person for the insured
Insureds_Contact_Person_Phone_Number DTXTN FALSE n
Insureds_Contact_Person_Reason DTArray_IS FALSE n contains the reason(s) the person should be contacted regarding the insured. Refer to User-defined Table 0222 - Contact reason
Relationship_To_The_Patient_Start_Date String FALSE 1 indicates the date on which the insured's patient relationship (defined in IN1-17 - insured's relationship to patient) became effective
Relationship_To_The_Patient_Stop_Date String FALSE 1 indicates the date after which the relationship (defined in IN1-17 - insured's relationship to patient) is no longer effective
Insurance_Co_Contact_Reason String FALSE 1 contains a user-defined code that specifies how the contact should be used. Refer to User-defined Table 0232 - Insurance company contact reason
Insurance_Co_Contact_Phone_Number DTXTN FALSE 1
Policy_Scope String FALSE 1 "contains a user-defined code designating the extent of the coverage for a participating member (e.g.
Policy_Source String FALSE 1 user-defined field identifies how the policy information got established. Refer to User-defined Table 0313 - Policy source
Patient_Member_Number DTCX FALSE 1 contains an identifying number assigned by the payor for each individual covered by the insurance policy issued to the insured
Guarantors_Relationship_To_Insured DTCE FALSE 1 specifies the relationship of the guarantor to the insurance subscriber. Refer to User-defined Table 0063 - Relationship
Insureds_Phone_Number_Home DTXTN FALSE n represents the insured's telephone number
Insureds_Employer_Phone_Number DTXTN FALSE n represents the insured's employer's telephone number
Military_Handicapped_Program DTCE FALSE 1 indicates the military program for the handicapped in which the patient is enrolled. Refer to User-defined Table 0343 - Military handicapped program code
Suspend_Flag String FALSE 1 indicates whether charges should be suspended for a patient. Refer to HL7 table 0136 - Yes/no indicator
Copay_Limit_Flag String FALSE 1 indicates if the patient has reached the co-pay limit so that no more co-pay charges should be calculated for the patient. Refer to HL7 table 0136 - Yes/no indicator
Stoploss_Limit_Flag String FALSE 1 indicates if the patient has reached the stoploss limit established in the Contract Master. Refer to HL7 table 0136 - Yes/no indicator
Insured_Organization_Name_And_ID DTXON FALSE n indicates the name of the insured if the insured/subscriber is an organization
Insured_Employer_Organization_Name_And_ID DTXON FALSE n "indicates the name of the insured's employer
Race DTCE FALSE n Refer to User-defined Table 0005 - Race
HCFA_Patients_Relationship_To_Insured DTCE FALSE 1 indicates the relationship of the patient to the insured. Refer to User-defined Table 0344 - Patient's relationship to insured
ObjectEventId String FALSE 1

Supported verbs

The generic SGIN2 business object supports the following verbs:

Examining the object

To examine a listing of the attributes of the generic business object, use IBM WebSphere Interchange Server System Manager or IBM WebSphere Interchange Server Business Object Designer.

Related reference

For more information on related business objects, see the following documents:

  • Generic DTCX Business Object
  • Generic DTXCN Business Object
  • Generic DTArray_IS Business Object
  • Generic DTXPN Business Object
  • Generic DTCE Business Object
  • Generic DTCM_RC Business Object
  • Generic DTCM_PT Business Object
  • Generic DTCM_DD Business Object
  • Generic DTJCC Business Object
  • Generic DTXTN Business Object
  • Generic DTXON Business Object
  • Copyright IBM Corp. 2002, 2003