Use function:
To process a Worksafe Victoria insurance claim, the following fields apply. Any required field not passed to the SDK will be prompted at the TyroHealth submission page.
Required column values:
| Value | Description |
|---|---|
| M | Mandatory |
| O | Optional |
| C | Conditional |
| Field | Type/Format | Required | Description | Example |
|---|---|---|---|---|
funder | String | M | Set to wsv for Worksafe Vic claims | wsv |
providerNumber | String | M | Physiotherapists and General Practitioners are registered with their medicare provider ID. Pharmacies will need to obtain a Worksafe Vic issued provider number linked to their ABN and last name. | 2429591L |
funderData.wsv.referral.referrerType | String | O | Valid values only Standard or not-supplied Defaults to "standard" | not-supplied |
funderData.wsv.referral.providerNumber | String | O | Referring provider's number | 2429591K |
funderData.wsv.referral.providerName | String | O | Name of the referring provider. | Dr Dominic Reed |
invoiceReference | String | M | Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. Used for reconciliation purposes. | INV-20220315-001 |
| patient {} object | ||||
patient.firstName | String | M | Injured worker's first name as registered with wsv. Middle name is not supported. | John |
patient.lastName | String | M | Injured worker's last name as registered with wsv. | Curtain |
patient.dob | String YYYY-MM-DD | M | Injured worker's Date of Birth in 'YYYY-MM-DD' format. | 1967-11-02 |
patient.mobile | String | O | Optional mobile phone number of the injured worker. This can be used for patient searches in the Tyro Health Online portal International or national notation supported. | +61411111111 or 0411111111 |
patient.accountNumber | String | M | Funder issued claim number which is unique to an injured worker and case. | 1372913 |
OR | ||||
patient.refId | String | O | An optional but recommended patient unique reference as set by you, such as a UUID. This value is used to uniquely identify a patient in Tyro Health Online. Omitting refId will cause duplicate patient records to be created and could make patient searches more difficult for providers who also use the Tyro Health Online portal to check on status of a claim and remittance. If supplied and valid, this value will pre-populate patient details from the patient record in the business as set in any prior claim. Any patient details sent for an existing patient record will update those values. | 5AD5E2AF-69D2-43D3-9321-428495205E5E |
claimableItems [] array - Array of fund claimable items. | ||||
claimableItems[].serviceDateString | String YYYY-MM-DD | M | Date of the service in 'YYYY-MM-DD' format. | 2022-01-12 |
claimableItems[].serviceTime | String HH:MM | O | Time of service in 24 hour format: HH:MM. | 12:30 |
claimableItems[].itemCode | String Up to 12 characters | M | Item code - note item code must be valid for wsv, the provider registered profession and service date. | AP001 |
claimableItems[].price | String Currency notation | M | Net (excluding GST) price each unit in $XX.XX format. | $15.95 |
claimableItems[].quantity | Number | M | Quantity of the item or service relevant to the item's unit of Measure: Item based (consultations etc, quantity value must be 1) Kilometres(Travel per KMs) Minutes (Time based services) Quantity Dispensed(Medications) | 1 2 60 2 |
claimableItems[].description | String Max length 128 | O | Description of the item or service. Biller must provide own description where "Description Override" = True | Examples of item codes where description is required: Physio : AP001 Pharmacy : OTC01 - OTC09 , ND01 - ND09 |
claimableItems[].gstInclusiveFlag | Boolean | M | Set to true if GST tax is applicable. | true |
| Worksafe Victoria Additional attributes | ||||
claimableItems[].prescriberFirstName | String Up to 48 Characters | C* | First Name of the Prescribing Practitioner Mandatory only for Pharmacy where Item Type = "Private" | John |
claimableItems[].prescriberLastName | String Up to 96 Characters | C* | Surname of the Prescribing Practitioner Mandatory only for Pharmacy where Item Type = "Private" | Harris |
claimableItems[].prescriberNumber | String Up to 20 Characters NNNNNNAA | C* | The Prescriber Number of the Prescribing Practitioner as assigned by Services Australia. This is in addition to their Medicare Provider Numbers (Stem & Suffixes). Mandatory only for Pharmacy where Item Type ="Private" | 1234567AB |
claimableItems[].scriptNumber | String Up to 20 Characters NNNNNNAA | C* | Unique number of the script issued by Prescribing Practitioner Mandatory only for Pharmacy where Item Type = "Private" | 9876543CD |
claimableItems[].authorityNumber | String Up to 20 Characters NNNNNNAA | O | Unique authority number supplied to authorise the individual prescription. Only particular sub-sets of prescribed drugs require this additional authorisation number to be captured. Optional for Pharmacy where Item Type = "Private" | 1122334EF |
claimableItems[].numberOfPatientsSeen | Number Up to 3 Characters NNNNNNNNNN | O | Number of patients attending same service Only where "MBS Attendance Item Flag" =True | 2 |
medipassTransactionSDK.renderCreateTransaction({
funder: 'string',
providerNumber: 'string',
invoiceReference: 'string',
funderData: {
wsv: {
referral: {
referrerType: 'string',
providerNumber: 'string',
providerName: 'string'
},
patient: {
firstName: 'string',
lastName: 'string',
dob: 'string',
mobile: '+string',
accountNumber: 'string',
refId: 'string'
},
claimableItems: [
{
itemCode: 'string',
price: 'string'
}
],
webhooks: [
{
url: 'string',
event: 'invoiceCancelled,healthFundApprovedInvoice,healthFundRejectedInvoice',
method: 'POST',
headers: { [Key: string] : your string }
}],
}, {
onSuccess: function (transaction) { /* ... */ },
onError: function (error) { /* ... */ },
onCancel: function () { /* ... */ }
})When a transaction is processed, the SDK will pass through the transaction details to the first parameter of the onSuccess callback.
The response payload contains a number of attributes with a complete description of the transaction model in our online API documentation.
Key response attributes include
| Field | Type/Format | Description | Example |
|---|---|---|---|
_id | 128 characters | Tyro Health Online unique transaction reference | 5ce4d63cb0a38c005582b838 |
| patient {} object | |||
patient.firstName | Up to 40 characters | Patient names as validated with WorkSafe Victoria Patient first / given name as registered with WorkSafe Victoria. | Willis |
patient.lastName | Up to 40 characters | Patient last / family name as registered with WorkSafe Victoria. | Alphine |
patient.dobString | String YYYY-MM-DD | Date of birth in YYYY-MM-DD format. | 1991-13-06 |
| practice {} object | |||
practice.id | String | Internal practice ID | 61f7297f272329006343997e |
practice.fullName | String | Name of practice | Mavis Medical Practice |
| claims {} object | |||
claims.status | 256 characters | Description of overall claim/quote | Approved |
claims.statusDescription | String | Description of the status | Payment Approved |
claims.gatewayCode | String | Claim item gateway response code | 00 |
claims.amountExpectedBenefitString | String Currency notation | Total claim benefit amount in cents or (string) in currency notation WorkSafe Victoria is expected to pay. | 8000 / $80.00 |
claimItems.amountActualBenefitString | String Currency notation | The amount WorkSafe Victoria has approved to pay in currency format. E.g. $119.95. | $50.00 |
claims.amountGap/claims.amountGapString | String Currency notation | Total claim gap (employee payable) amount in cents or (string) in currency notation. | 6000 / $60.00 |
claims.claimItems [] array - For each claimed item, a separate line level response as below. | |||
claims.claimItems.status | 256 characters | Description of the claim/quote item level status | Approved |
claims.claimItems.gatewayCode | String | Claim gateway response code | 00 |
claims.claimItems.amountActualBenefit / claims.claimItems.amountActualBenefitString | String Currency notation | Claim item benefit amount in cents or (string) in currency notation. | 4000 / $40.00 |
claims.claimItems.amountGap/ claims.claimItems.amountGapString | String Currency notation | Claim item gap (member payable) amount in cents or (string) in currency notation. | 2500 / $25.00 |