You are here: Foswiki>Main Web>ServiceProviderInterface (revision 1)EditAttach

Service Provider Interface

SmartOffice integrates with medical service providers in text-based NAILBA format. Due to NAILBA restrictions, the industry is adopting the XML-based ACORD standard for electronic ordering. The XML messages can be extended within the structure defined by ACORD to meet the requirements of order processing workflows. SmartOffice features an integration layer for submitting electronic orders to service providers and receiving status updates from service providers. The message transfer is based on Simple Object Access Protocol (SOAP) to connect the web services. This page provides developers with the format of ACORD XML messages along with SOAP envelopes and Ebix's test web service details. This web service is not restricted to SmartOffice; it can be used for integrating other Ebix Exchange products with service provider web services.

SmartOffice Data Interactions

  • SmartOffice user selects underwriting requirement and clicks ‘eOrder’ button to submit the order request electronically to the service provider's web service. [ACORD 121 TXLifeRequest]
  • The service provider's web service acknowledges the receipt of the order. [ACORD 121 TXLifeResponse]
  • The service provider sends intermediate status updates to Ebix web service. [ACORD 1122]
  • The intermediate status updates are posted to SmartOffice.
  • The service provider sends a final status when the request is fulfilled.

Use Cases

sp_use_cases.png

Message Structure

Top-Level Object Number of Occurrences Description
TXLife 1 Root element
UserAuthRequest 1 This section contains information identifying the Fulfilling System, or the channel over which the transaction is being transmitted.
TXLifeRequest 1 This section identifies the type of transaction (i.e., TransType 121), and also contains a TransRefGUID which is generated by the Ordering System, passed to the Fulfilling System, and used by both Ordering and Fulfilling Systems to identify the acknowledging TXLifeResponse.
Holding 1 Represents a holding in SmartOffice with which the underwriting requirement is associated.
Policy 1 Represents the pending case.
ApplicationInfo 1  
RequirementInfo 1 or more Represents the underwriting requirement.
Party 1 or more Represents following entities (interest parties):
  • The Applicant
  • The order Requester (an Organization)
  • The requester contact
  • The Fulfiller (an Organization – Service Provider)
  • Agent, Agency associated with the Policy
Relation 1 or more

Four Relations are required in a 121 order:

  • A link between the Holding and the Applicant
  • A link between the Holding and the Agent
  • A link between the Holding and the Agency
  • Optionally, if a carrier is specified, a link between the Holding and the Carrier

Hierarchy Diagram

sp_hierarchy.png

Message Examples

Request Order – ACORD 121 TXLifeRequest

<?xml version="1.0" encoding="UTF-8"?>
<TXLife xmlns:bo="http://ACORD.org/Standards/Life/2"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://ACORD.org/Standards/Life/2 TXLife2.10.00.XSD">
    <UserAuthRequest>
        <UserLoginName>NONE</UserLoginName>
        <UserPswd>
            <CryptPswd>NONE</CryptPswd>
        </UserPswd>
        <UserDate>2010-08-17</UserDate>
        <UserTime>06:50:40+00:00</UserTime>
        <VendorApp>
            <VendorName VendorCode="019">Ebix Inc</VendorName>
            <AppName>Ebix CRM - SmartOffice</AppName>
            <AppVer>7.2 </AppVer>
        </VendorApp>
    </UserAuthRequest>
    <TXLifeRequest>
        <TransRefGUID>10001-15001-2010_12_34</TransRefGUID>
        <TransType tc="121">General Requirement Order Request</TransType>
        <TransExeDate>2010-08-17</TransExeDate>
        <TransExeTime>06:50:40+00:00</TransExeTime>
        <TransMode tc="2">Original</TransMode>
        <TestIndicator tc="1">YES</TestIndicator>
        <OLifE>
            <SourceInfo>
                <CreationDate>2010-08-17</CreationDate>
                <CreationTime>06:50:40+00:00</CreationTime>
                <SourceInfoName>Ebix CRM</SourceInfoName>
                <SourceInfoDescription/>
            </SourceInfo>
            <Holding id="Holding_1">
                <HoldingTypeCode tc="2">Policy</HoldingTypeCode>
                <Policy CarrierPartyID="Party2010_22" id="Policy2010_12">
                    <PolNumber>0082292470</PolNumber>
                    <ProductType tc="2">Term</ProductType>
                    <ProductCode>EMAX3GP</ProductCode>
                    <CarrierCode>PML</CarrierCode>
                    <PlanName>UNIVERSAL LIFE</PlanName>
                    <EffDate>2010-05-17</EffDate>
                    <PaymentMode tc="9">Single Payment</PaymentMode>
                    <PaymentMethod tc="2">Regular Billing/Direct Bill</PaymentMethod>
                    <Life>
                        <InitialPremAmt>41813.17</InitialPremAmt>
                        <FaceAmt>1000000</FaceAmt>
                        <DivType tc="2147483647">0</DivType>
                        <Coverage id="Coverage1_2">
                            <IndicatorCode tc="1">Base</IndicatorCode>
                            <DeathBenefitOptType tc="0">Unknown</DeathBenefitOptType>
                            <LifeParticipant PartyID="Party2010_13">
                                <LifeParticipantRoleCode tc="1">Primary Insured</LifeParticipantRoleCode>
                                <SmokerStat tc="2">Prior tobacco user</SmokerStat>
                                <UnderwritingClass tc="2147483647">Other</UnderwritingClass>
                            </LifeParticipant>
                        </Coverage>
                    </Life>
                    <ApplicationInfo>
                        <TrackingID>10001-15001-2010_12_34</TrackingID>
                        <ApplicationJurisdiction tc="45">PA</ApplicationJurisdiction>
                        <SignedDate>2010-05-17</SignedDate>
                    </ApplicationInfo>
                    <RequirementInfo AppliesToParticipantID="Party2010_13" AppliesToPartyID="Party2010_13"
FulfillerPartyID="Party2010_26" id="Req2010_34">
                        <ReqCode tc="184">APS # 5 Order</ReqCode>
                        <RequirementInfoUniqueID>2010_12_34</RequirementInfoUniqueID>
                        <ReqStatus tc="4">Outstanding</ReqStatus>
                        <RequestedDate>2010-08-13</RequestedDate>
                        <RequestedScheduleDate>2010-08-14</RequestedScheduleDate>
                        <ReleasePartyOrgCode>SERVICE_PROVIDER</ReleasePartyOrgCode>
                        <RequirementAcctNum>EX2010</RequirementAcctNum>
                    </RequirementInfo>
                </Policy>
                <Attachment>
                    <Description/>
                    <AttachmentType tc="2">Comment</AttachmentType>
                    <MimeTypeTC tc="11">image/tiff</MimeTypeTC>
                    <TransferEncodingTypeTC tc="4">Base64</TransferEncodingTypeTC>
                    <AttachmentLocation tc="1">Inline Data</AttachmentLocation>
                    <AttachmentData>Pz8/PwAQSkZJRgABAQEAYABgAAA/PwBDAAgGBgcGBQgHBwcJCQgMFAwLCwwZEhMPFB0a</AttachmentData>
                </Attachment>
            </Holding>
            <Party id="Party2010_12">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <GovtID>***-**-****</GovtID>
                <GovtIDTC tc="1">Social Security Number US</GovtIDTC>
                <Person>
                    <FirstName>Ronald</FirstName>
                    <LastName>Logan</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="1">M</Gender>
                    <BirthDate>YYYY-mm-DD</BirthDate>
                    <Age>76</Age>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseNum>12345</DriversLicenseNum>
                    <DriversLicenseState tc="6">CA</DriversLicenseState>
                </Person>
                <Address>
                    <AddressTypeCode tc="2">Business</AddressTypeCode>
                    <Line1>918 E. Green Street</Line1>
                    <City>Pasadena</City>
                    <AddressStateTC tc="6">CA</AddressStateTC>
                    <Zip>91106</Zip>
                    <PrefAddr tc="1"/>
                </Address>
                <Phone id="InterestParty.2010.12_Phone.2010.12">
                    <PhoneTypeCode tc="2">Business</PhoneTypeCode>
                    <DialNumber>897564263</DialNumber>
                    <PrefPhone tc="1"/>
                </Phone>
                <EMailAddress>
                    <EMailType tc="1"/>
                    <AddrLine>First.Last@domain.com</AddrLine>
                    <PrefEMailAddr tc="1"/>
                </EMailAddress>
            </Party>
            <Party id="Party2010_13">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <GovtID>***-**-****</GovtID>
                <GovtIDTC tc="1">Social Security Number US</GovtIDTC>
                <Person>
                    <FirstName>Ronald</FirstName>
                    <LastName>Logan</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="1">M</Gender>
                    <BirthDate> YYYY-mm-DD </BirthDate>
                    <Age>76</Age>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseNum>12345</DriversLicenseNum>
                    <DriversLicenseState tc="6">CA</DriversLicenseState>
                </Person>
                <Address>
                    <AddressTypeCode tc="2">Business</AddressTypeCode>
                    <Line1>918 E. Green St.</Line1>
                    <City>Pasadena</City>
                    <AddressStateTC tc="6">CA</AddressStateTC>
                    <Zip>91106</Zip>
                    <PrefAddr tc="1"/>
                </Address>
                <Phone id="InterestParty.2010.13_Phone.2010.12">
                    <PhoneTypeCode tc="2">Business</PhoneTypeCode>
                    <DialNumber>897564263</DialNumber>
                    <PrefPhone tc="1"/>
                </Phone>
                <EMailAddress>
                    <EMailType tc="1"/>
                    <AddrLine>first.last@domain.com</AddrLine>
                    <PrefEMailAddr tc="1"/>
                </EMailAddress>
            </Party>
            <Party id="Party2010_14">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <GovtID>123-45-6789</GovtID>
                <GovtIDTC tc="1">Social Security Number US</GovtIDTC>
                <Person>
                    <FirstName>Jill</FirstName>
                    <MiddleName>F</MiddleName>
                    <LastName>Brosnan</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="2147483647">0</Gender>
                    <BirthDate> YYYY-mm-DD </BirthDate>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseState tc="2147483647">Other</DriversLicenseState>
                </Person>
            </Party>
            <Party id="Party2010_15">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <GovtID>***-**-****</GovtID>
                <GovtIDTC tc="1">Social Security Number US</GovtIDTC>
                <Person>
                    <FirstName>John</FirstName>
                    <MiddleName>L</MiddleName>
                    <LastName>Brosnan</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="2147483647">0</Gender>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseState tc="2147483647">Other</DriversLicenseState>
                </Person>
            </Party>
            <Party id="Party2010_16">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <Person>
                    <FirstName>Cathy</FirstName>
                    <LastName>Brosnan</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="2147483647">0</Gender>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseState tc="2147483647">Other</DriversLicenseState>
                </Person>
            </Party>
            <Party id="Party2010_17">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <GovtID>***-**-****</GovtID>
                <GovtIDTC tc="1">Social Security Number US</GovtIDTC>
                <Person>
                    <FirstName>Mary</FirstName>
                    <MiddleName>K</MiddleName>
                    <LastName>Logan</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="2">F</Gender>
                    <BirthDate> YYYY-mm-DD </BirthDate>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseState tc="2147483647">Other</DriversLicenseState>
                </Person>
            </Party>
            <Party id="Party2010_18">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <GovtID>***-**-****</GovtID>
                <GovtIDTC tc="1">Social Security Number US</GovtIDTC>
                <Person>
                    <FirstName>Mary</FirstName>
                    <MiddleName>K</MiddleName>
                    <LastName>Logan</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="2">F</Gender>
                    <BirthDate> YYYY-mm-DD </BirthDate>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseState tc="2147483647">Other</DriversLicenseState>
                </Person>
            </Party>
            <Party id="Party2010_19">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <GovtID>123-45-6789</GovtID>
                <GovtIDTC tc="1">Social Security Number US</GovtIDTC>
                <Person>
                    <FirstName>ALEXANDER</FirstName>
                    <LastName>BATISTA</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="2147483647">0</Gender>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseState tc="2147483647">Other</DriversLicenseState>
                </Person>
                <Address>
                    <AddressTypeCode tc="2">Business</AddressTypeCode>
                    <Line1>MIHAN, MADC Building, SEZ</Line1>
                    <City>Nagpur</City>
                    <AddressStateTC tc="2147483647">MS</AddressStateTC>
                    <Zip>4400100</Zip>
                    <PrefAddr tc="1"/>
                </Address>
                <Phone id="InterestParty.2010.19_Phone.2010.13">
                    <PhoneTypeCode tc="2">Business</PhoneTypeCode>
                    <DialNumber>12365489</DialNumber>
                    <PrefPhone tc="1"/>
                </Phone>
                <EMailAddress>
                    <EMailType tc="1"/>
                    <AddrLine>ashish.arankar@ebix.com</AddrLine>
                    <PrefEMailAddr tc="1"/>
                </EMailAddress>
            </Party>
            <Party id="Party2010_20">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <GovtID>123-45-6789</GovtID>
                <GovtIDTC tc="1">Social Security Number US</GovtIDTC>
                <Person>
                    <FirstName>ALEXANDER</FirstName>
                    <LastName>BATISTA</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="2147483647">0</Gender>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseState tc="2147483647">Other</DriversLicenseState>
                </Person>
                <Address>
                    <AddressTypeCode tc="2">Business</AddressTypeCode>
                    <Line1>MIHAN, MADC Building, SEZ</Line1>
                    <City>Nagpur</City>
                    <AddressStateTC tc="2147483647">MS</AddressStateTC>
                    <Zip>4400100</Zip>
                    <PrefAddr tc="1"/>
                </Address>
                <Phone id="InterestParty.2010.20_Phone.2010.13">
                    <PhoneTypeCode tc="2">Business</PhoneTypeCode>
                    <DialNumber>12365489</DialNumber>
                    <PrefPhone tc="1"/>
                </Phone>
                <EMailAddress>
                    <EMailType tc="1"/>
                    <AddrLine>ashish.arankar@ebix.com</AddrLine>
                    <PrefEMailAddr tc="1"/>
                </EMailAddress>
            </Party>
            <Party id="Party2010_21">
                <PartyTypeCode tc="1">Person</PartyTypeCode>
                <GovtID>123-45-6789</GovtID>
                <GovtIDTC tc="1">Social Security Number US</GovtIDTC>
                <Person>
                    <FirstName>ALEXANDER</FirstName>
                    <LastName>BATISTA</LastName>
                    <MarStat tc="2147483647">0</MarStat>
                    <Gender tc="2147483647">0</Gender>
                    <Citizenship tc="2147483647">Other</Citizenship>
                    <DriversLicenseState tc="2147483647">Other</DriversLicenseState>
                </Person>
                <Address>
                    <AddressTypeCode tc="2">Business</AddressTypeCode>
                    <Line1>MIHAN, MADC Building, SEZ</Line1>
                    <City>Nagpur</City>
                    <AddressStateTC tc="2147483647">MS</AddressStateTC>
                    <Zip>4400100</Zip>
                    <PrefAddr tc="1"/>
                </Address>
                <Phone id="InterestParty.2010.21_Phone.2010.13">
                    <PhoneTypeCode tc="2">Business</PhoneTypeCode>
                    <DialNumber>12365489</DialNumber>
                    <PrefPhone tc="1"/>
                </Phone>
                <EMailAddress>
                    <EMailType tc="1"/>
                    <AddrLine>ashish.arankar@ebix.com</AddrLine>
                    <PrefEMailAddr tc="1"/>
                </EMailAddress>
            </Party>
            <Party id="Party2010_22">
                <PartyTypeCode tc="2">Organization</PartyTypeCode>
                <FullName>PML</FullName>
                <Organization>
                    <AbbrName xmlns:bo="http://ACORD.org/Standards/Life/2">PML</AbbrName>
                </Organization>
                <Carrier>
                    <CarrierCode>PML</CarrierCode>
                    <NAICCode/>
                </Carrier>
            </Party>
            <Party id="Party2010_26">
                <PartyTypeCode tc="2">Organization</PartyTypeCode>
                <FullName>Service Provider</FullName>
                <Organization>
                    <AbbrName xmlns:bo="http://ACORD.org/Standards/Life/2">SP</AbbrName>
                </Organization>
            </Party>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_12" id="Relation1_0">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="260">Primary Contact</RelationRoleCode>
            </Relation>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_13" id="Relation1_1">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="32">Insured</RelationRoleCode>
            </Relation>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_14" id="Relation1_2">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="8">Owner</RelationRoleCode>
            </Relation>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_15" id="Relation1_3">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="31">Payer</RelationRoleCode>
            </Relation>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_16" id="Relation1_4">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="34">Beneficiary</RelationRoleCode>
            </Relation>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_17" id="Relation1_5">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="189">Joint Insured</RelationRoleCode>
            </Relation>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_18" id="Relation1_6">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="2147483647">Other</RelationRoleCode>
            </Relation>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_19" id="Relation1_7">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="11">Agent</RelationRoleCode>
            </Relation>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_20" id="Relation1_8">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="38">Primary Servicing Agent</RelationRoleCode>
            </Relation>
            <Relation OriginatingObjectID="Holding_1" RelatedObjectID="Party2010_21" id="Relation1_9">
                <OriginatingObjectType tc="4">Holding</OriginatingObjectType>
                <RelatedObjectType tc="6">Party</RelatedObjectType>
                <RelationRoleCode tc="52">Additional Writing Agent</RelationRoleCode>
            </Relation>
        </OLifE>
    </TXLifeRequest>
</TXLife>

Service Provider Acknowledge Message

<?xml version="1.0" encoding="UTF-8"?>
<TXLife xmlns="http://ACORD.org/Standards/Life/2" xmlns:n="http://ACORD.org/Standards/Life/2"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ACORD.org/Standards/Life/2
TXLife2.10.00enum.xsd">
    <UserAuthResponse>
        <TransResult>
            <ResultCode tc="1">Success</ResultCode>
        </TransResult>
    </UserAuthResponse>
    <TXLifeResponse>
        <TransRefGUID>11-DC8E-45B7-8087-4DDE1406307D</TransRefGUID>
        <TransType tc="121">General Requirement Order Request</TransType>
        <TransExeDate>2010-08-17</TransExeDate>
        <TransExeTime>16:36:55-05:00</TransExeTime>
        <TransMode tc="2">Original</TransMode>
        <TransResult>
            <ResultCode tc="1">Success</ResultCode>
        </TransResult>
    </TXLifeResponse>
</TXLife>

Intermediate Status Updates from Service Provider [ACORD 1122]

Currently unavailable

Ebix Web Service Details for Posting Order Status Events

The Testbed can be used for testing the SOAP message for sending intermediate order status to SmartOffice.
Edit | Attach | Print version | History: r4 < r3 < r2 < r1 | Backlinks | View wiki text | Edit WikiText | More topic actions...
Topic revision: 03 Mar 2016, DinosLambropoulos
 

This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback