# WorkCover Queensland attributes and sample transaction

## Creating a transaction

**Use function**: medipassTransactionSDK.renderCreateTransaction() 

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.

## Attributes table:

**Required column values:**

| Value | Description |
|  --- | --- |
| M | Mandatory |
| O | Optional |
| C | Conditional |


| **Field** | **Type/Format** | **Required** | **Description** | **Example** |
|  --- | --- | --- | --- | --- |
| `funder` | String | M | Set to **wcq** for WorkCover Queensland claims. | wcq |
| `providerNumber` | String 8 characters | M | For medical or allied healthcare providers, this is usually a Medicare issued provider number - 8 characters alpha-numeric. 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. | 1234565X |
| `invoiceReference` | String Up to 20 characters | O | 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 | 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". | Tanya |
| `patient.lastName` | String | M | Patient last name as registered with fund. | Smith |
| `patient.dob` | String YYYY-MM-DD | M | Patient Date of Birth in 'YYYY-MM-DD' format. | 1967-11-02 |
| `patient.mobile` | String | O | The mobile phone number of the patient. Can be either international notation: +61411111111 or national notation: 0411111111 | +61411111111 or 0411111111 |
| `patient.accountNumber` | String Up to 11 characters | M | Set to the WorkCover Queensland issued Claim Number. Usually, these are formatted like `SNNAANNNNNN` or `DNNAANNNNNN` where N = numeric and A = alpha character. | S12AA34567 |
| `patient.accidentDate` | String YYYY-MM-DD | O | Date of accident/injury in 'YYYY-MM-DD' format. | 2022-01-15 |
| OR |  |  |  |  |
| `patient.refId` | String | O | 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 | 5AD5E2AF-69D2-43D3-9321-428495205E5E |
| claimableItems [] array - Array of fund claimable items. |  |  |  |  |
| `claimableItems[].reference` | String | O | Unique item reference for reconciliation in your system, such as `001`. This reference must be unique for each item in the claim. | 001 |
| `claimableItems[].serviceDateString` | String YYYY-MM-DD | M | Date of the service in 'YYYY-MM-DD' format. | 2022-03-15 |
| `claimableItems[].itemCode` | String Up to 10 characters | M | Item code - note item code must be valid for funder, the provider registered profession and service date. | 110 |
| `claimableItems[].price` | String Currency notation | M | Net (excluding GST) price each unit in $XX.XX format. | $15.95 |
| `claimableItems[].quantity` | Number | O | 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. | 1 |
| `claimableItems[].isTaxable` | Boolean | O | Set to `true` if GST tax is applicable. | true |
| `claimableItems[].serviceText` | String Up to 2000 characters | O | Additional item level description or commentary. | Initial consultation for back injury |
| `claimableItems[].isGross` | Boolean | O | 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. | false |
| `claimableItems[].isExtendedPrice` | Boolean | O | 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. | false |


> 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.


## Sample transaction


```js
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 () { /* ... */ }
})
```