THELMA Web Services API

Last updated: Sep 11th, 2018


Use THELMA web services to integrate to Medicare/ECLIPSE for all your patient checking and billing. Why go through the rigorous accreditation process required by Medicare (and maintain that accreditation) when we can take care of that for you. We provide an easy to use and comprehensive API to Medicare/ECLIPSE via our award-winning THELMA portal that has been successfully used by our clients for over 10 years. Features include:

  • Eligibility checking to all ECLIPSE enabled funds and to Australian Unity (who are not ECLIPSE enabled)
  • Batchwise claim submission to the THELMA portal enables transmission of hundreds of claims in one webservice request.
  • Claims are validated using our powerful THELMA validation engine which applies all Medicare rules to each claim and includes auto-correction of patient details.
  • Auto-cancellation option operates on failed claims in a batch. This important in Bulk Bill and DVA batchwise medical claiming as it allows the remainder of the batch to still be transmitted to Medicare.
  • Asynchronous claims are held in the THELMA portal and transmitted to Medicare/ECLIPSE after COB giving users the flexibility to logon and modify a batch (eg cancel claim or entire batch) during business hours.
  • Design allows “hybrid” implementations combining the web-services API and the THELMA web GUI. Eg deliver claims to THELMA using web-services but manage reports using THELMA web GUI

Patient Checking

These are all synchronous transactions – the result of the check is returned as an immediate response to the request.

Eligibility Service

OEC (online eligibility check). Checks a patient’s hospital cover with a health fund

SOAP Request

<soapenv:Envelope xmlns:soapenv="" xmlns:ws1="" xmlns:impl="">
SOAP Response

<soap:Envelope xmlns:soap="" xmlns:xsd="" xmlns:xsi="">
      <ns1:submitEligibilityType1Response xmlns:ns1="">
            <benefitLimitationDescription xsi:nil="true"/>
            <coPaymentDescription>Co-payment not Applicable</coPaymentDescription>
            <excessDescription>Excess Bonus used to reduce excess amount payable. Capped each calendar year at once per adult when amount has been met in full. The excess does not apply on admissions for services with a minimum benefit, approved hospital ambulatory programs or to approved psychiatric and rehabilitation day programs in private hospitals only. Excess will apply for all overnight and day services in a public hospital. The excess does not apply to any child dependant covered on the membership.</excessDescription>
            <exclusionDescription xsi:nil="true"/>
            <fundName>BUPA Australia</fundName>
            <fundTableDescription>**Members First Network Hospitals**: Full cover for hospital accommodation and theatre fees.**Public Hospitals**: Minimum Benefits for shared room accommodation, as set by the Australian government plus a fixed benefit per day for private overnight room accommodation.**All hospitals**: Excluded Services, including cosmetic surgery that is not clinically required, receive no benefits. Minimum Benefit services, including surgery by podiatrists,receive share room rate Minimum Benefits for accommodation. If Minimum benefit (shared room rate) is paid, excess is not deducted. Excess does not apply for children. Special Benefits that help pay for certain in-hospital parent/partner accommodation or meals apply.</fundTableDescription>
            <fundTableName>Top Hospital with $250 Excess and General Extras</fundTableName>
            <patientName>GRACE HENDRICKS</patientName>
            <providerName>Sun Hill Hospital</providerName>
            <responseDescription>Eligibility successful - Please retain Ref #</responseDescription>
            <senderReferenceId>GRACE HENDRICKS</senderReferenceId>
            <serviceCodeDescription xsi:nil="true"/>
            <statusDescription>eligibility submission successful</statusDescription>
                  <supplementaryDetailDescription>ELIGIBLE FOR SERVICE SELECTED</supplementaryDetailDescription>


Patient Verification Service

PVM (Patient Verification Fund). Patient details check to Medicare.

PVV (Patient Verification DVA). Patient details check to Dept. of Veteran Affairs.

PVF (Patient Verification Fund). Patient details check to health fund.

SOAP Request

<soapenv:Envelope xmlns:soapenv="" xmlns:ws2="" xmlns:pvf="">
SOAP Response

<soap:Envelope xmlns:soap="" xmlns:xsd="" xmlns:xsi="">
            <statusDescription>Eligibility successful - Please retain Ref #</statusDescription>


Thelma Webservice API supports the following Medical claims and Hospital claims;

  • Bulk Bill claims
  • IMC (In-patient Medical Claim)
  • DVA Medical Claims
  • PCI (Patient Claim Interactive)
  • IHC (In-patient Hospital Claim)

Medical Claims Service

OMC (Bulk Bill claim) is an asynchronous transaction. The result of the claim is made available later through retrieved reports

SOAP Request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="" xmlns:ws2="">
   <soapenv:Header />
         <ws2:claimData><![CDATA[<MCV Version="1.14" Timestamp="2018-03-03T12:00:00" SenderID="3531390Y" ContactName="John Smith" ContactPhone="99995555">
							<ProviderName>Dr Hugh Slastonae</ProviderName>
							<ProviderName>DR IKE CHEMEISSE</ProviderName>
SOAP Response

<soap:Envelope xmlns:soap="" xmlns:xsd="" xmlns:xsi="">
      <ns1:submitOutpatientMedicalClaimBatchResponse xmlns:ns1="">
            <clientBatchId xmlns="">20282</clientBatchId>
            <guid xmlns="">D839E565-4F6D-5D39-2BF6-3D4C20D5D6A4</guid>
            <status xmlns="">0</status>
            <statusDescription xmlns="">claim submission successful</statusDescription>
            <thelmaBatchId xmlns="">16442420</thelmaBatchId>
            <timestamp xmlns="">2018-03-03T12:30:24.673+11:00</timestamp>

IMC (In-patient Medical Claim) is an asynchronous claim transaction. The result of the claim is made available later through retrieved reports

DVAC (Medical Claims (Medical Paperless Streamlined) is an asynchronous claim transaction. The result of the claim is made available later through retrieved reports

PCI (Patient Claim Interactive) is a synchronous claim transaction, the results are made available immediately in the response.

SOAP Request

SOAP Response


Hospital Claims Service

IHC (In-patient Hospital Claim) is an asynchronous transaction. The result of the claim is made available later through retrieved reports

SOAP Request

SOAP Response



Transaction Retrieval Service

The results of asynchronous claims are retrieved in reports when they are made available by Medicare/ECLIPSE. All asynchronous transaction types receive an assessment report (or statement of benefit) and a remittance report. Eg An IHC claim will receive a statement of benefit report IHCSOB and a remittance report IHCRMT.

SOAP Request

SOAP Response

SOAP Request

SOAP Response

Available reports are:

Status Checking

Claim Status Service

Allows the checking of the status of individual claims within a batch after claim submission to THELMA.

SOAP Request

SOAP Response


Claim Cancellation

Claim Cancellation Service

PCI claims transmitted to Medicare can be cancelled on the same day. This is a synchronous transaction.

SOAP Request

SOAP Response


Interested in more information?

The above overview and examples are intended to give the developer a feel for the THELMA APIs available. Full API documentation and an end-to-end test environment are available on request. We will also give assistance for all integration projects.

For assistance please contact the helpdesk on 02 9902 7700 or