Worksafe Victoria attributes and Sample Transaction

Creating a transaction

Use function: medipassTransactionSDK.renderCreateTransaction()

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.

Field Type Required Description Example
funder String Yes Set to wsv for Worksafe Vic claims wsv
providerNumber String Yes 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 Valid values only
Standard or not-supplied
Defaults to "standard"		 not-supplied
funderData.wsv.referral.providerNumber String Referring provider's number 2429591K
funderData.wsv.referral.providerName String Name of the referring provider. Dr Dominic Reed
invoiceReference String Yes Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. Used for reconciliation purposes.
Patient object
patient.firstName String Yes Injured worker's first name as registered with wsv. Middle name is not supported. John
patient.lastName String Yes Injured worker's last name as registered with wsv. Curtain
patient.dob String Yes Injured worker's Date of Birth in 'YYYY-MM-DD' format. 1967-11-02
patient.mobile String 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 Yes Funder issued claim number which is unique to an injured worker and case. 1372913
OR
patient.refId String 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{Object} Array of fund claimable items.
claimableItems[].serviceDateString String Yes Date of the service in 'YYYY-MM-DD' format. 2022-01-12
claimableItems[].serviceTime String Time of service in 24 hour format: HH:MM. 12:30
claimableItems[].itemCode String Yes Item code - note item code must be valid for wsv, the provider registered profession and service date.Up to 12 characters AP001
claimableItems[].price String Yes Net (excluding GST) price each unit in $XX.XX format. $15.95
claimableItems[].quantity Number Yes 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 Description of the item or service. Biller must provide own description where "Description Override" = True
(Max length 128)		 Examples of item codes where description is required:
Physio : AP001 Pharmacy : OTC01 - OTC09 , ND01 - ND09
claimableItems[].gstInclusiveFlag Boolean Yes Set to true if GST tax is applicable.
Worksafe Victoria Additional attributes
claimableItems[]prescriberFirstName string Yes/No First Name of the Prescribing Practitioner
Mandatory only for Pharmacy where Item Type = "Private"**Up to 48 Characters**		 John
claimableItems[]prescriberLastName string Yes/No Surname of the Prescribing PractitionerMandatory only for Pharmacy where Item Type = "Private** Up to 96 Characters** Harris
claimableItems[]prescriberNumber string Yes/No 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"
NNNNNNAA
Up to 20 Characters
claimableItems[]scriptNumber string Unique number of the script issued by Prescribing Practitioner
Mandatory only for Pharmacy where Item Type = "Private"
NNNNNNAA
Up to 20 Characters
claimableItems[]authorityNumber string 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"
NNNNNNAA
Up to 20 Characters
claimableItems[]numberOfPatientsSeen Number Number of patients attending same service Only where "MBS Attendance Item Flag" =True
NNNNNNNNNN
Up to 3 Characters		 2

Sample Transaction

Copy
Copied
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 () { /* ... */ }
})

Claim response attributes

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 Format Example value Description
_id 128 characters 5ce4d63cb0a38c005582b838 Tyro Health Online unique transaction reference
patient {} Object
patient.firstName Up to 40 characters Willis Patient names as validated with WorkSafe Victoria
Patient first / given name as registered with WorkSafe Victoria.
patient.lastName Up to 40 characters Alphine Patient last / family name as registered with WorkSafe Victoria.
patient.dobString string 1991-13-06 Date of birth in YYYY-MM-DD format.
practice Object
practice.id string 61f7297f272329006343997e Internal practice ID
practice.fullName string Name of practice
claims Object
claims.status 256 characters Approved Description of overall claim/quote
claims.statusDescription Payment Approved Description of the status
claims.gatewayCode 00 Claim item gateway response code
claims.amountExpectedBenefitString integer 8000 / $80.00 Total claim benefit amount in cents or (string) in currency notation WorkSafe Victoria is expected to pay.
claimItems.amountActualBenefitString string $50.00 The amount WorkSafe Victoria has approved to pay in currency format. E.g. $119.95.
claims.amountGap/claims.amountGapString 6000 / $60.00 Total claim gap (employee payable) amount in cents or (string) in currency notation.
claims.claimItems Array For each claimed item, a separate line level response as below.
claims.claimItems.status 256 characters Approved Description of the claim/quote item level status
claims.claimItems.gatewayCode String 00 Claim gateway response code
claims.claimItems.amountActualBenefit / claims.claimItems.amountActualBenefitString 4000 / $40.00 Claim item benefit amount in cents or (string) in currency notation.
claims.claimItems.amountGap/ claims.claimItems.amountGapString 2500 / $25.00 Claim item gap (member payable) amount in cents or (string) in currency notation.