TPA Service Category API | Administrative - SOAP

The TpaServiceCategoryservice provides functionality to manage service categories at the admin level, providing you the ability to integrate your existing systems with WCA in real time.

Service web methods

The following is a list of methods that are available for the TPAServiceCategory service.

AddTpaServiceCategory- This method is used to add a new service category for an administrator.
AddTpaServiceCategoryCode- This method is used to add a new service category code for an administrator.
DeleteTpaServiceCategory - This method is used to delete an existing administrator’s service category.
DeleteTpaServiceCategoryCode - This method is used to delete an existing administrator’s service category code.
UpdateTpaServiceCategory - This method is used to update an existing administrator’s service category.
UpdateTpaServiceCategoryCode - This method is used to update an existing administrator’s service category code.
GetServiceCategoryTemplate- Retrieves all default service category templates associated with your administrator instance of WCA.
GetServiceCategoryCodes - Retrieves default SCCs associated with service category templates.
GetMerchantCategoryCodes- Retrieves default MCCs associated with service category templates.

Service assumptions/business rules

The TPAServiceCategory service makes the following assumptions and enforces the following business rules:

Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus and the administrator.
Clients shall format SOAP messages in a document/literal format over HTTPS.
Clients shall have already created a valid user ID and password.
Clients shall have a valid session ID after being authenticated by the system. The session ID needs to be passed in the proper manner as described in the manager service guide.
If the administrator uses the same user ID and password for all of their clients, they are responsible for managing the security of the data.
Clients should validate data before submitting a request to this service. This facilitates better performance and accurate processing on both systems.
Clients shall not attempt to use this service for batch processing of large amounts of data. The service is designed for synchronous calls that send or retrieve small chunks of data. If batch processing is required, then the EDI process should be used.
If any method fails, the service returns a SOAP fault describing the problem.

AddTpaServiceCategory

This method is used to add a new service category for an administrator.

History

The AddTpaServiceCategory methods are listed below:

Request messages

AddTpaServiceCategory request

Response messages

AddTpaServiceCategory response

AddTpaServiceCategory request/response messages

The AddTpaServiceCategory method requires the following request and response messages (input and output data).

The table below includes the following request messages:

AddTpaServiceCategoryRequest

Request Body

TpaId String required

Unique identifier WCA assigns to you.

First Available Version: AddTpaServiceCategory
ServiceCategoryId String required

Unique identifier for the Service Category

First Available Version: AddTpaServiceCategory
ServiceCategoryName String required

Descriptive name for the service category (ex.: Medical, Dental, Vision, etc.)

First Available Version: AddTpaServiceCategory
ServiceCategoryMaximumTransactionAmount Decimal

Default Maximum per transaction amount that a participant may have in this specific service category. May be overridden at the plan level.

First Available Version: AddTpaServiceCategory
ServiceCategoryMaximumTotalAmount Decimal

Default Maximum total amount that a participant may have in this specific service category for the plan year. May be overridden at the plan level.

First Available Version: AddTpaServic eCategory

Response Message: Empty Message

Example of AddTpaServiceCategory SOAP Request Message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>string</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <AddTpaServiceCategory
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Request/2008/0
            7">
            <request>
                <TpaId>string</TpaId>
                <ServiceCategoryId>string</ServiceCategoryId>
                <ServiceCategoryName>string</ServiceCategoryName>
                <ServiceCategoryMaximumTransactionAmount>decimal</ServiceCategoryMaximumTransactionAmount
                >
                <ServiceCategoryMaximumTotalAmount>decimal</ServiceCategoryMaximumTotalAmount>
            </request>
        </AddTpaServiceCategory>
    </soap:Body>
</soap:Envelope>

Example of AddTpaServiceCategory SOAP Response Message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MessageId>string</MessageId>
        </MBIMessageIdHeader>
    </soap:Header>
    <soap:Body>
        <AddTpaServiceCategoryResponse
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Response/2008/
            07">
            <AddTpaServiceCategoryResult />
        </AddTpaServiceCategoryResponse>
    </soap:Body>
</soap:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when submitting calling the AddTpaServiceCategory web method.

try
{
    // create new SOAP header for the user’s current session id
    localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
    // create the proxy object for the service
    localhost.TpaServiceCategoryService proxy = new localhost.TpaServiceCategoryService();
    // create a new request object for the method’s parameters
    localhost.AddTpaServiceCategory request = new localhost.AddTpaServiceCategory();
    // set the parameters for the web method call
    request.TpaId = "T00021";
    request.ServiceCategoryId = "MedSC";
    request.ServiceCategoryName = "Medical";
    request.ServiceCategoryMaximumTransactionAmount = 20.00D;
    request.ServiceCategoryMaximumTotalAmount = 100.00D;
    // Add the session SOAP header so that the service knows who we are.
    // Note that we stored the session ID in a member variable after
    // logged in to the system for future web method calls.
    sh.MBISessionID = _sessionID;  proxy.MBISessionHeaderValue = sh;
    // Call the web method.
    proxy.AddTpaServiceCategory(request);
    MessageBox.Show("Finished");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

AddTpaServiceCategoryCode

This method is used to create a new service category code for an administrator.

History

The AddTpaServiceCategoryCode methods are listed below:

Request Messages

AddTpaServiceCategoryCodeRequest

Response Messages

AddTpaServiceCategoryCodeResponse

AddTpaServiceCategoryCode Request/Response Messages

The AddTpaServiceCategoryCode method requires the following request and response messages (input and output data).

The table below includes the following request messages:

AddTpaServiceCategoryCodeRequest

Request Body

TpaId string required

Unique identifier WCA assigns to you.

First Available Version: AddTpaServiceCategoryCodeRequest
ServiceCategoryId string required

Unique identifier for the Service Category

First Available Version: AddTpaServiceCategoryCodeRequest
ServiceCategoryCode string required

Unique identifier for the Service Category Code.

First Available Version: AddTpaServiceCategoryCodeRequest
ServiceCategoryCodeDescription string required

Descriptive name for the service category code (ex.: Dr. Visit, Labs, RX, etc.).

First Available Version: AddTpaServiceCategoryCodeRequest
BypassDeductible boolean

This assigns a value to an individual Service Category Code (SCC), overriding the value set at the Service Category (SC) level.
0= No, Apply claim to the deductible where applicable.
1 = Yes, Bypass the deductible and attempt to reimburse claim regardless of whether the deductible has been met.
The default behavior for this record type is "0" or to apply the claim to the deductible.
The Administrator must specify a 1 if they wish to bypass the deductible for this Service Category Code.

First Available Version: AddTpaServiceCategoryCodeRequest

Response Message: Empty message.

Example of AddTpaServiceCategoryCode SOAP request message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>string</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <AddTpaServiceCategoryCode
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Request/2008/07">
            <request>
                <TpaId>string</TpaId>
                <ServiceCategoryId>string</ServiceCategoryId>
                <ServiceCategoryCode>string</ServiceCategoryCode>
                <ServiceCategoryCodeDescription>string</ServiceCategoryCodeDescription>
                <BypassDeductible>boolean</BypassDeductible>
            </request>
        </AddTpaServiceCategoryCode>
    </soap:Body>
</soap:Envelope>

Example of AddTpaServiceCategoryCode SOAP response message:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MessageId>string</MessageId>
        </MBIMessageIdHeader>
    </soap:Header>
    <soap:Body>
        <AddTpaServiceCategoryCodeResponse
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Response/2008/07">
            <AddTpaServiceCategoryCodeResult />
        </AddTpaServiceCategoryCodeResponse>
    </soap:Body>
</soap:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when submitting calling the AddTpaServiceCategoryCode web method.

try
{
    // create new SOAP header for the user’s current session id
    localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
    // create the proxy object for the service
    localhost.TpaServiceCategoryService proxy = new localhost.TpaServiceCategoryService();
    // create a new request object for the method’s parameters
    localhost.AddTpaServiceCategoryCode request = new localhost.AddTpaServiceCategoryCode();
    // set the parameters for the web method call
    request.TpaId = "T00021";
    request.ServiceCategoryId = "MedSC";
    request.ServiceCategoryCode = "MDC";
    request.ServiceCategoryCodeDescription = "MDC – medical descript";
    request.BypassDeductible = true
    // Add the session SOAP header so that the service knows who we are.
    // Note that we stored the session ID in a member variable after
    // logged in to the system for future web method calls.
    sh.MBISessionID = _sessionID;
    proxy.MBISessionHeaderValue = sh;
    // Call the web method.
    proxy.AddTpaServiceCategoryCode(request);
    MessageBox.Show("Finished");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

DeleteTpaServiceCategory

This method is used to delete an existing service category.

History

The DeleteTpaServiceCategory methods are listed below:

Request Messages

DeleteTpaServiceCategoryRequest

Response Messages

DeleteTpaServiceCategoryResponse

DeleteTpaServiceCategory request/response messages

The DeleteTpaServiceCategory method requires the following request and response messages (input and output data).

The table below includes the following request messages:

DeleteTpaServiceCategoryRequest

Request Body

TpaId string required

Unique identifier WCA assigns to you.

First Available Version: DeleteTpaServiceCategoryRequest
ServiceCategoryId string required

Unique identifier for the Service Category

First Available Version: DeleteTpaServiceCategoryRequest

Response Message: Empty message.

Example of DeleteTpaServiceCategory SOAP request message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>string</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <DeleteTpaServiceCategory
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Request/2008/07">
            <request>
                <TpaId>string</TpaId>
                <ServiceCategoryId>string</ServiceCategoryId>
            </request>
        </DeleteTpaServiceCategory>
    </soap:Body>
</soap:Envelope>

Example of DeleteTpaServiceCategory SOAP response message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MessageId>string</MessageId>
        </MBIMessageIdHeader>
    </soap:Header>
    <soap:Body>
        <DeleteTpaServiceCategoryResponse
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Response/2008/07">
            <DeleteTpaServiceCategoryResult />
        </DeleteTpaServiceCategoryResponse>
    </soap:Body>
</soap:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when submitting calling the DeleteTpaServiceCategory web method.

try
{
    // create new SOAP header for the user’s current session id
    localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
    // create the proxy object for the service
    localhost.TpaServiceCategoryService proxy = new localhost.TpaServiceCategoryService();
    // create a new request object for the method’s parameters
    localhost.DeleteTpaServiceCategory request = new localhost.DeleteTpaServiceCategory();
    // set the parameters for the web method call
    request.TpaId = "T00021";
    request.ServiceCategoryId = "MedSC";
    // Add the session SOAP header so that the service knows who we are.
    // Note that we stored the session ID in a member variable after
    // logged in to the system for future web method calls.
    sh.MBISessionID = _sessionID;
    proxy.MBISessionHeaderValue = sh;
    // Call the web method.
    proxy.DeleteTpaServiceCategory(request);
    MessageBox.Show("Finished");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

DeleteTpaServiceCategoryCode

This method is used to delete an existing Administrator’s Service Category Code.

History

The DeleteTpaServiceCategoryCode methods are listed below:

Request Messages

DeleteTpaServiceCategoryCodeRequest

Response Messages

DeleteTpaServiceCategoryCodeResponse

DeleteTpaServiceCategoryCode request/response messages

The DeleteTpaServiceCategoryCode method requires the following request and response messages (input and output data).

The table below includes the following request messages:

DeleteTpaServiceCategoryCodeRequest

Request Body

TpaId String required

Unique identifier WCA assigns to you.

First Available Version: DeleteTpaServiceCategoryCodeRequest
ServiceCategoryId string required

Unique identifier for the Service Category

First Available Version: DeleteTpaServiceCategoryCodeRequest
ServiceCategoryCode string required

Unique identifier for the Service Category Code.

First Available Version: DeleteTpaServiceCategoryCodeRequest

Response Message: Empty message.

Example of DeleteTpaServiceCategoryCode SOAP request message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>string</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <DeleteTpaServiceCodeCategory
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Request/2008/07">
            <request>
                <TpaId>string</TpaId>
                <ServiceCategoryId>string</ServiceCategoryId>
                <ServiceCategoryCode>string</ServiceCategoryCode>
            </request>
        </DeleteTpaServiceCodeCategory>
    </soap:Body>
</soap:Envelope>

Example of DeleteTpaServiceCategoryCode SOAP response message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MessageId>string</MessageId>
        </MBIMessageIdHeader>
    </soap:Header>
    <soap:Body>
        <DeleteTpaServiceCategoryCodeResponse
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Response/2008/07">
            <DeleteTpaServiceCategoryCodeResult />
        </DeleteTpaServiceCategoryCodeResponse>
    </soap:Body>
</soap:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when submitting calling the DeleteTpaServiceCategoryCode web method.

try
{
    // create new SOAP header for the user’s current session id
    localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
    // create the proxy object for the service
    localhost.TpaServiceCategoryService proxy = new localhost.TpaServiceCategoryService();
    // create a new request object for the method’s parameters
    localhost.DeleteTpaServiceCategoryCode request = new localhost.DeleteTpaServiceCategoryCode();
    // set the parameters for the web method call
    request.TpaId = "T00021";
    request.ServiceCategoryId = "MedSC";
    request.ServiceCategoryCode = “SCCDE”
    // Add the session SOAP header so that the service knows who we are.
    // Note that we stored the session ID in a member variable after
    // logged in to the system for future web method calls.
    sh.MBISessionID = _sessionID;
    proxy.MBISessionHeaderValue = sh;
    // Call the web method.
    proxy.DeleteTpaServiceCategoryCode(request);
    MessageBox.Show("Finished");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

UpdateTpaServiceCategory

The method is used to update an existing service category.

History

The UpdateTpaServiceCategory methods are listed below:

Request messages

UpdateTpaServiceCategoryRequest

Response messages

UpdateTpaServiceCategoryResponse

UpdateTpaServiceCategory request/response messages

The UpdateTpaServiceCategory method requires the following request and response messages (input and output data).

The table below includes the following request messages:

UpdateTpaServiceCategoryRequest

Request Body

TpaId string required

Unique identifier WCA assigns to you.

First Available Version: UpdateTpaServiceCategoryRequest
ServiceCategoryId string required

Unique identifier for the Service Category

First Available Version: UpdateTpaServiceCategoryRequest
ServiceCategoryName string required

Descriptive name for the service category (ex.: Medical, Dental, Vision, etc.)

First Available Version: UpdateTpaServiceCategoryRequest
ServiceCategoryMaximumTransactionAmount decimal

Default Maximum per transaction amount that a participant may have in this specific service category. May be overridden at the plan level.

First Available Version: UpdateTpaServiceCategoryRequest
ServiceCategoryMaximumTotalAmount decimal

Default Maximum total amount that a participant may have in this specific service category for the plan year. May be overridden at the plan level.

First Available Version: UpdateTpaServiceCategoryRequest

Response message: Empty message.

Example of UpdateTpaServiceCategory SOAP request message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>string</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <UpdateTpaServiceCategory
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Request/2008/07">
            <request>
                <TpaId>string</TpaId>
                <ServiceCategoryId>string</ServiceCategoryId>
                <ServiceCategoryName>string</ServiceCategoryName>
                <ServiceCategoryMaximumTransactionAmount>decimal</ServiceCategoryMaximumTransactionAmount>
                <ServiceCategoryMaximumTotalAmount>decimal</ServiceCategoryMaximumTotalAmount>
            </request>
        </UpdateTpaServiceCategory>
    </soap:Body>
</soap:Envelope>

Example of UpdateTpaServiceCategory SOAP response message

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MessageId>string</MessageId>
        </MBIMessageIdHeader>
    </soap:Header>
    <soap:Body>
        <UpdateTpaServiceCategoryResponse
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Response/2008/07">
            <UpdateTpaServiceCategoryResult />
        </UpdateTpaServiceCategoryResponse>
    </soap:Body>
</soap:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when submitting calling the UpdateTpaServiceCategory web method.

try
{
    // create new SOAP header for the user’s current session id
    localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
    // create the proxy object for the service
    localhost.TpaServiceCategoryService proxy = new localhost.TpaServiceCategoryService();
    // create a new request object for the method’s parameters
    localhost.UpdateTpaServiceCategory request = new localhost.UpdateTpaServiceCategory();
    // set the parameters for the web method call
    request.TpaId = "T00021";
    request.ServiceCategoryId = "MedSC";
    request.ServiceCategoryName = "Medical";
    request.ServiceCategoryMaximumTransactionAmount = 20.00D;
    request.ServiceCategoryMaximumTotalAmount = 100.00D;
    // Add the session SOAP header so that the service knows who we are.
    // Note that we stored the session ID in a member variable after
    // logged in to the system for future web method calls.
    sh.MBISessionID = _sessionID;
    proxy.MBISessionHeaderValue = sh;
    // Call the web method.
    proxy.UpdateTpaServiceCategory(request);
    MessageBox.Show("Finished");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

UpdateTpaServiceCategoryCode

This method is used to update an existing service category code.

History

The UpdateTpaServiceCategoryCode methods are listed below:

Request messages

UpdateTpaServiceCategoryCodeRequest

Response messages

UpdateTpaServiceCategoryCodeResponse

TpaServiceCategoryCode request/response messages

The table below includes the following request messages:

UpdateTpaServiceCategoryRequest

Request Body

TpaId string required

Unique identifier WCA assigns to you.

First Available Version: UpdateTpaServiceCategoryRequest
ServiceCategoryId string required

Unique identifier for the Service Category

First Available Version: UpdateTpaServiceCategoryRequest
ServiceCategoryCode string required

Unique identifier for the Service Category Code.

First Available Version: UpdateTpaServiceCategoryRequest
ServiceCategoryCodeDescription string required

Descriptive name for the service category code (ex.: Dr. Visit, Labs, RX, etc.).

First Available Version: UpdateTpaServiceCategoryRequest
BypassDeductible boolean

This assigns a value to an individual Service Category Code (SCC), overriding the value set at the Service Category (SC) level.
0= No, Apply claim to the deductible where applicable.
1 = Yes, Bypass the deductible and attempt to reimburse claim regardless of whether the deductible has been met.
The default behavior for this record type is “0” or to apply the claim to the deductible.
The Administrator must specify a 1 if they wish to bypass the deductible for this Service Category Code.

First Available Version: UpdateTpaServiceCategoryRequest

Response message: Empty message.

Example of UpdateTpaServiceCategoryCode SOAP request message

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>string</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <UpdateTpaServiceCategoryCode
            xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Request/2008/07">
            <request>
                <TpaId>string</TpaId>
                <ServiceCategoryId>string</ServiceCategoryId>
                <ServiceCategoryCode>string</ServiceCategoryCode>
                <ServiceCategoryCodeDescription>string</ServiceCategoryCodeDescription>
                <BypassDeductible>boolean</BypassDeductible>
            </request>
        </UpdateTpaServiceCategoryCode>
    </soap:Body>
</soap:Envelope>

Example of UpdateTpaServiceCategoryCode SOAP response message

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MessageId>string</MessageId>
        </MBIMessageIdHeader>
    </soap:Header>
    <soap:Body>
        <UpdateTpaServiceCategoryCodeResponse xmlns="http://www.medibank.com/MBIWebServices/Tpa/Messages/TpaServiceCategory/Response/2008/07">
            <UpdateTpaServiceCategoryCodeResult />
        </UpdateTpaServiceCategoryCodeResponse>
    </soap:Body>
</soap:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when submitting calling the UpdateTpaServiceCategoryCode web method.

try
{
    // create new SOAP header for the user’s current session id
    localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
    // create the proxy object for the service
    localhost.TpaServiceCategoryService proxy = new localhost.TpaServiceCategoryService();
    // create a new request object for the method’s parameters
    localhost.UpdateTpaServiceCategoryCode request = new localhost.UpdateTpaServiceCategoryCode();
    // set the parameters for the web method call
    request.TpaId = "T00021";
    request.ServiceCategoryId = "MedSC";
    request.ServiceCategoryCode = "MDC";
    request.ServiceCategoryCodeDescription = "MDC – medical descript";
    request.BypassDeductible = true;
    // Add the session SOAP header so that the service knows who we are.
    // Note that we stored the session ID in a member variable after
    // logged in to the system for future web method calls.
    sh.MBISessionID = _sessionID;
    proxy.MBISessionHeaderValue = sh;
    // Call the web method.
    proxy.UpdateTpaServiceCategoryCode(request);
    MessageBox.Show("Finished");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

GetServiceCategoryTemplate

Retrieves all default service category templates associated with your administrator instance of WCA.

History

The GetServiceCategoryTemplate methods are listed below:

Request messages

GetServiceCategoryTemplateRequest

Response messages

GetServiceCategoryTemplateResponse

GetServiceCategoryTemplate request/response messages

The GetServiceCategoryTemplate method requires the following request and response messages (input and output data).

The table below includes the following request messages:

GetServiceCategoryTemplateRequest

Request Body

TpaId String required

Administrator’s unique ID in WCA

First Available Version:	GetServiceCategoryTemplateRequest
Max Length:	`6`

The table below includes the following response messages:

GetServiceCategoryTemplateResponse

Response Body

TpaId String

Administrator’s unique ID in WCA

First Available Version: GetServiceCategoryTemplateResponse
TemplateID String

Unique identifier for default service category template.

First Available Version: GetServiceCategoryTemplateResponse
TemplateName String

Template name

First Available Version: GetServiceCategoryTemplateResponse
ServiceCategoryId String

Unique identifier for the service category

First Available Version: GetServiceCategoryTemplateResponse
ServiceCategoryName String

Descriptive name for the service category (ex.: medical, dental, vision, etc.)

First Available Version: GetServiceCategoryTemplateResponse
ServiceCategoryMaximumTransactionAmount Decimal

Default maximum per transaction amount that a participant may have in this specific service category. May be overridden at the plan level.

First Available Version: GetServiceCategoryTemplateResponse
ServiceCategoryMaximumTotalAmount Decimal

Default maximum total amount that a participant may have in this specific service category for the plan year. May be overridden at the plan level.

First Available Version: GetServiceCategoryTemplateResponse

GetServiceCategoryCodes

Retrieves default SCCs associated with service category templates.

History

The GetServiceCategoryCodes methods are listed below:

Request messages

GetServiceCategoryCodesRequest

Response messages

GetServiceCategoryCodesResponse

GetServiceCategoryCodes Request/Response Messages

The GetServiceCategoryCodes method requires the following request and response messages (input and output data).

The table below includes the following request messages:

GetServiceCategoryCodesRequest

Request Body

TpaId String required

Administrator’s unique ID in WCA

First Available Version:	GetServiceCategoryCodesRequest
Max Length:	`6`

TemplateID String conditionally required

Unique identifier for default service category template. *Required if AccountTypeCode is not supplied.

First Available Version:	GetServiceCategoryCodesRequest
Max Length:	`18`

AccountTypeCode String conditionally required

FSA, DCA, etc. *Required if TemplateId is not supplied.

First Available Version:	GetServiceCategoryCodesRequest
Max Length:	`4`

The table below includes the following response messages:

GetServiceCategoryCodesResponse

Response Body

TpaId String

Administrator’s unique ID in WCA

First Available Version: GetServiceCategoryCodesResponse
TemplateID String

Unique identifier for default service category template.

First Available Version: GetServiceCategoryCodesResponse
AccountTypeCode String

FSA, DCA, etc.

First Available Version: GetServiceCategoryCodesResponse
ServiceCategoryId String

Unique identifier for the service category

First Available Version: GetServiceCategoryCodesResponse
ServiceCategoryCode String

Unique identifier for the service category code.

First Available Version: GetServiceCategoryCodesResponse
ServiceCategoryCodeDescription String

Descriptive name for the service category code (ex.: Dr. Visit, Labs, RX, etc.).

First Available Version: GetServiceCategoryCodesResponse
BypassDeductible Boolean

Assigns a value to an individual service category code (SCC), overriding the value set at the service category level.
0 - No, apply claim to the deductible where applicable.
1 - Yes, bypass the deductible and attempt to reimburse claim regardless of whether the deductible has been met.

First Available Version: GetServiceCategoryCodesResponse

GetMerchantCategoryCodes

Retrieves default MCCs associated with service category templates.

History

The GetMerchantCategoryCodes methods are listed below:

Request messages

GetMerchantCategoryCodesRequest

Response messages

GetMerchantCategoryCodesResponse

GetMerchantCategoryCodes request/response messages

The GetMerchantCategoryCodes method requires the following request and response messages (input and output data).

The table below includes the following request messages:

GetMerchantCategoryCodesRequest

Request Body

TpaId String required

Administrator’s unique ID in WCA

First Available Version:	GetMerchantCategoryCodesRequest
Max Length:	`6`

TemplateID String conditionally required

Unique identifier for default service category template. *Required if AccountTypeCode is not supplied.

First Available Version:	GetMerchantCategoryCodesRequest
Max Length:	`18`

AccountTypeCode String conditionally required

FSA, DCA, etc. *Required if TemplateId is not supplied.

First Available Version:	GetMerchantCategoryCodesRequest
Max Length:	`4`

The table below includes the following response messages:

GetServiceCategoryCodesResponse

Response Body

TpaId String

Administrator’s unique ID in WCA

First Available Version: GetServiceCategoryCodesResponse
TemplateID String

Unique identifier for default service category template.

First Available Version: GetServiceCategoryCodesResponse
AccountTypeCode String

FSA, DCA, etc.

First Available Version: GetServiceCategoryCodesResponse
ServiceCategoryId String

Unique identifier for the service category

First Available Version: GetServiceCategoryCodesResponse
ServiceCategoryName String

Descriptive name for the service category (ex.: medical, dental, vision, etc.)

First Available Version: GetServiceCategoryCodesResponse
MccId String

Unique identifier for the merchant category code.

First Available Version: GetServiceCategoryCodesResponse
MccDescription String

Descriptive name for the merchant category code (ex.: Dr. Visit, Labs, RX, etc.).

First Available Version: GetServiceCategoryCodesResponse

TPA Service Category API | Administrative - SOAP

AddTpaServiceCategory

Request Body

AddTpaServiceCategoryCode

AddTpaServiceCategoryCode Request/Response Messages

Request Body

DeleteTpaServiceCategory

History

Request Body

DeleteTpaServiceCategoryCode

Request Body

UpdateTpaServiceCategory

Request Body

UpdateTpaServiceCategoryCode

Request Body

GetServiceCategoryTemplate

Request Body

Response Body

GetServiceCategoryCodes

Request Body

Response Body

GetMerchantCategoryCodes

Request Body

Response Body

AI Assistant Preview

AI Assistant ^Preview