WorkCover Queensland attributes and sample transaction

To process a WorkCover Queensland workers insurance claim, the following fields apply. Any required field not passed to the SDK will be prompted at the Tyro Health Online submission page.

Field	Type	Max length	Required?	Notes
`funder`	String		Required	Set to wcq for WorkCover Queensland claims.
`providerNumber`	String		Required	For medical or allied healthcare providers, this is usually a Medicare issued provider number - 8 characters alpha-numeric such as 1234565X. If Medicare provider number is not applicable, WorkCover Queensland account numbers (Pxxxxxxxxxx) for non-medical providers and AHPRA numbers are also supported if that same number was registered with Tyro Health Online
.
`invoiceReference`	String	20		Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. Used for reconciliation purposed.
-----
`patient`	Object
`patient.firstName`	String		Required	Patient first name as registered with fund. Middle name is not supported. If patient has only one name, then set name in lastName field and set firstName to “Onlyname”.
`patient.lastName`	String		Required	Patient last name as registered with fund.
`patient.dob`	String		Required	Patient Date of Birth in ‘YYYY-MM-DD’ format. Example: ‘1967-11-02’
`patient.mobile`	String			The mobile phone number of the patient. Can be either international notation: +61411111111 or national notation: 0411111111
`patient.accountNumber`	String	11	Required	Set to the WorkCover Queensland issued Claim Number. Usually, these are formatted like `SNNAANNNNNN` or `DNNAANNNNNN` where N = numeric and A = alpha character.
`patient.accidentDate`	String			Date of accident/injury in 'YYYY-MM-DD' format.
OR
`patient.refId`	String			A patient unique reference as set by you. 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
-----
`claimableItems`	Array{Object}			Array of fund claimable items.
`claimableItems[].reference`	String			Unique item reference for reconciliation in your system, such as `001`. This reference must be unique for each item in the claim.
`claimableItems[].serviceDateString`	String		Required	Date of the service in 'YYYY-MM-DD' format.
`claimableItems[].itemCode`	String	10	Required	Item code - note item code must be valid for funder, the provider registered profession and service date.
`claimableItems[].price`	String		Required	Net (excluding GST) price each unit in $XX.XX format. Example ‘$15.95’.
`claimableItems[].quantity`	Number			Denotes number of services or pieces of equipment or other unit of measure as part of this service. Where funder has item code set to ignore quantity, field is ignored.
`claimableItems[].isTaxable`	Boolean			Set to `true` if GST tax is applicable.
`claimableItems[].serviceText`	String	2000		Additional item level description or commentary.
`claimableItems[].isGross`	Boolean			If set to `true`, this will indicate the `price` is the gross amount including GST tax for the item submitted. For example, if set to true and price is $11.00, item price excluding tax is $10.00 and GST of 10% / $1.00 is applied.
`claimableItems[].isExtendedPrice`	Boolean			If set to true, this will indicate the price is extended/aggregate price for all quantities submitted. For example, if set to true, and price is $20.00 with three quantity (effectively $6.66666 per unit) as sent to a funder. Otherwise, if set to false or omitted the price field will be multiplied per quantity claimed. For example, if set to false, price is $20.00 with three quantity, each item price is $20.00 which will make extended price $60.00 as sent to a funder.

At present, WorkCover Queensland is not returning the outcome of a claim decision - approved, declined or otherwise. Updates on the claim and any payment remittance to providers will be supplied directly by WorkCover Queensland either via email or their Provider Connect web portal. Providers can manually mark a claim as approved/paid in Tyro Health Online which will trigger a webhook event.

Schema

Copy

Copied

medipassTransactionSDK.renderCreateTransaction({
  funder: string,
  providerNumber: string,
  invoiceReference: string,
  patient: {
    refId: string,
    firstName: string,
    lastName: string,
    mobile: string,
    dob: string,
    accountNumber: string,
    accidentDate: string
  },

  claimableItems: [{
    reference: string,
    itemCode: string,
    serviceDateString: string,
    price: string,
    quantity: number,
    isTaxable: boolean,
    serviceText: string,
    isGross: boolean,
    isExtendedPrice: boolean
  }],

  webhooks: [{
    url: string,
    event:
      'invoiceCompleted' |
    method: 'GET' | 'PUT' | 'POST' | 'DELETE',
    headers: { [key: string]: string }
  }],

}, {
  onSuccess: function (transaction) { /* ... */ },
  onError: function (error) { /* ... */ },
  onCancel: function () { /* ... */ }
})