Integrated Private Health Fund claiming

Inside the PMS, allow the staff to select a provider and a patient and build up a list of services that have been provided to the patient. Once finalised, the PMS invokes iClient passing in the list of claim items (in JSON format) along with some other details. The iClient window appears, and the claim is passed through to the terminal for processing. The patient swipes their health fund card in the terminal when prompted, and the claim is sent off to the appropriate health fund for approval. Once approved, the terminal prints the claim receipt and shows the gap amount to the patient. On the PMS, iClient shows the gap amount and asks the operator to Accept or Reject the claim. Pressing the Accept button prompts the terminal to print the patient copy and finalise the claim. Pressing the Reject button prompts the terminal to void the claim and print receipts showing that the claim has been voided. In either case, the result of the original claim is returned to the PMS.

You are ready to start developing your integrated private health fund claiming feature now that you have successfully setup your POS to initiate and process requests through iClient in the test environment. Before you begin, please have a look at the certification criteria, which provide a checklist of the minimum requirements for the certification of integrated private health fund claiming with Tyro.

Certification Criteria for iClient Health

iClient API

Please refer to the Please refer to the iClient API for a sample HealthPoint claiming code. After downloading the zip folder, unzip it and click on the iclient-api folder, and then index. At the top left corner underneath the APIs, click on Classes, and then click on TYRO.IClientWithUI, scroll down until you see the index and method tabs, then click on index.

Claim Payloads

The API offered by iClient for PHF claims (described below) requires a number of parameters to be supplied including a JSON claim payload.

When cancelling claims, the payload must be the same as the one used for the original claim and can only be performed on the same day as the original claim.

HealthPoint Claiming Implementation

initiateHealthPointClaim(requestParams, transactionCallbacks) - Tell the terminal to start a HealthPoint claim.

Request Parameters

Request Parameters Type Description
claimItems String A list of claim items as a JSON array (max 16 items) as shown in the below claimItems table.
claimItemsCount int The total number of claim items.
mid Integer Optional - Required for headless pairing, multi-merchant, or if your browser does not support local storage.
tid Integer Optional - Required for headless pairing, multi-merchant, or if your browser does not support local storage.
integrationKey String Supply the integration key if your browser does not support local storage or if you have developed headless pairing or multi-merchant as a feature.
providerId String The 8 character id of the provider attending the patient.
serviceType String The 1 alphabetic character representing the category of service. See table below.
totalClaimAmount Int The total amount of all claim items in cents.
transactionid (optional) String Supply a transaction Id to be used for the transaction.
info

Callback functions that are only required when using TYRO.IClient. When using TYRO.IClientWithUI, status messages and questions are handled by the UI provided.

claimItems Table

Claim parameter Type Description
serviceReference String Body part or tooth number suffix - max 3 characters
claimAmount int Claim amount in cents - max 10 digits.
serviceDate String Claim date in YYYYMMDD format.
description String Description of item to appear on receipt - max 32 characters.
serviceCode String Item number service code - max 5 characters.
patientId String Patient ID on card - exactly 2 digits.

transactionCallbacks

transactionCompleteCallback Function:

Callback Name Type Description
transactionCompleteCallback Function Invoked when the transaction has been completed on the terminal.

statusMessageCallback Function:

Callback Name Type Description
statusMessageCallback Function Invoked to advertise what is happening on terminal, which is typically facing the customer rather than the merchant. Called with a single String argument. For example "Select account".

questionCallback Function:

Callback Name Type Description
questionCallback Function Invoked when the terminal requires the merchant to answer a question in order to proceed with the transaction.

Example

Copy
Copied
iclient.initiateHealthPointClaim({
    providerId: "1455813F", 
    serviceType: "P", 
    claimItemsCount: "2", 
    totalClaimAmount: "20100", 
    claimItems: [
        {
            "claimAmount": "10000",
            "serviceCode": "500",
            "description": "Assessment Consult",
            "serviceReference": "01",
            "patientId": "02",
            "serviceDate": "20240217"
        },
        {
            "claimAmount": "10100",
            "serviceCode": "505",
            "description": "Subsequent Consult",
            "serviceReference": "01",
            "patientId": "02",
            "serviceDate": "20240217"
        }
    ]}, {
    transactionCompleteCallback: yourPosCode.handleComplete,
    statusMessageCallback: yourPosCode.handleStatusMessage,
    questionCallback: yourPosCode.questionAsked
});

Item Numbers

The item numbers for claims should be known to and provided by the PMS. Attached is a pdf of item numbers for the various modalities. However, the item numbers change from time to time and vary between health funds, so it is incumbent on the PMS to provide an authoritative list to medical practice installations.

Modalities

Modalities are the various types of allied health services provided, e.g. dental, optical etc. Allied health providers will have been issued with a provider number for the modality that they specialise in. The modality needs to be passed through for each claim in the field serviceType. They are:

Modality Description
0 Dental Technician
1 Osteopath
3 Endodontist
4 Oral Surgeon
5 Orthodontist
6 Paedodontist (Paediatric)
7 Periodontist
8 Prosthodontist
B Acupuncturist / Chinese Medicine
C Chiropractor
D General Dentist
E Dietitian
F Podiatrist
G Medical Doctors (including GP claims for overseas cover)
H Occupational Therapist
J Myotherapy
M Remedial massage therapist
O Optometrist
P Physiotherapist
Q Counselling
S Speech Pathologist
U Exercise Physiology
V Audiology
Y Psychologist
Z Optical Dispenser

Settlement

A single settlement (aside from HCF who issues a separate settlement) is issued by HealthPoint the following business day as an approved claim. The settlement claims period is 00:00:00 to 23:59:59.

Health funds supported by Tyro Healthpoint

Health Fund Name Health Fund ID Identifying Digits
ACA PHF00010 0012
ADF Family Health PHF00510 0109
AHM PHF00550 0041
AUSTRALIAN UNITY PHF00040 0008
BUPA PHF00300 0007
BUPA PHF00260 0006
BUPA PHF00370 0003
CBHS PHF00070 0009
CBHS CORPORATE HEALTH PHF00075 0139
Credicare (see u by HBF) PHF00060 0045
Defence PHF00030 0020
Doctors Health Fund PHF00020 0005
EMERGENCY SERVICES HEALTH PHF00470 0140
GMF Health PHF00110 0040
GMHBA/FRANK/BUDGET PHF00100 0042
HBF PHF00180 0025
HCF PHF00200 0015
HCI PHF00140 0013
health.com.au PHF00500 0125
Health Partners PHF00450 0024
HIF PHF00160 0026
Latrobe PHF00220 0038
Lysaght / Peoplecare PHF00230 0016
MEDIBANK PRIVATE PHF00240 0004
Navy PHF00310 0010
nib (including brands AAMI, APIA, Australian Seniors, IMAN, ING Health, Priceline health insurance, QANTAS, Real Health insurance and Suncorp) PHF00290 0002
onemedifund PHF00460 0088
PHOENIX HEALTH PHF00330 0019
Police PHF00380 0021
QLD Country PHF00280 0022
Reserve Bank Health Society PHF00350 0089
RT PHF00350 0084
St Lukes / Astute Simplicity PHF00390 0044
Teachers UniHealth PHF00320 0011
TUH PHF00340 0018
Westfund PHF00440 0096
isoft Fund (for testing only) PHF00999 0099
info

The test health fund (ISOFT Fund) is PHF00999 and has identifying card digits of 0099 and only works in non-production environments.

HealthPoint Health funds by modality

specific criteria

*health funds marked as non consolidated in the PDF will not affect the Tyro merchants on consolidated settlement

Current list of supported funds by provider modality

Reference the following excel doc for a list of item codes and responses for each supported fund and modality:

Excel doc

Current list of supported funds by provider modality

Health funds not supported by Tyro Healthpoint

  • MDHA
  • GU Health *under migration to nib
  • CDH

Gap Payments

Once a claim has been approved, there is typically a gap between the benefit amount paid by the health fund and the amount charged by the practitioner. If the patient would like to use a card to pay for the gap amount, the standard purchase method can be used to process the payment. Please be sure to pass in the healthpointTransactionId which is the transactionId returned in the response to the original HealthPoint claim.

Testing Integrated Health Fund Claiming

Please use the following patient and provider details when testing your implementation::

Patient IDs on Card:

  • 00 John Citizen
  • 01 Judy Citizen
  • 02 Jack Citizen

Provider details:

Name Provider Number Service Type
Katy Cobrin 2159081W P
Leonore Marsh 1455813F P

HealthPoint Claiming Demo

Demo - JS Fiddle

JS Fiddle

Please don't click on the Save button if you make any changes in the JS Fiddle sample app. Instead, please press run if you have made any changes. If you click on save, it may break the functionality of the JS Fiddle.

Copyright © Tyro Payments 2019-2022. All right reserved.