QBE attributes and Sample Transaction

Creating a transaction

Use function: medipassTransactionSDK.renderCreateTransaction()

To process a QBE insurance claim, the following fields apply. Any required field not passed to the SDK will be prompted at the TyroHealth submission page.

Field	Type	Condition	Description	Example
`funder`	Valid values only	Mandatory	All qbe claims should have the funder set to qbe.	qbe
`invoiceReference`	Up to 16 characters	Optional	Your unique invoice/transaction reference. Typically generated from a practice management or accounting system. This value will be traced through to settlement reporting and is separate from any funder defined transaction identifier or claim reference. Where multiple service items exist for an invoice, all rows for a unique invoiceReference will be grouped into a single invoice and the first occurrence of repeating invoice level (but not service level) details will be used. Note: these rows should be grouped sequentially.	20200901ABCD
`providerNumber`	Up to 16 alphanumeric characters	Mandatory	Servicing provider number or other registration identifier which must be valid and active in Tyro Health Online for a given funder. For QBE, a Medicare issued provider number should be used where available. Where a Medicare provider number is not applicable, use the Tyro Health Online-generated provider number allocated during onboarding. • A unique invoice can include only one provider.	0065431A
`patient.dob`	YYYY-MM-DD	Mandatory		27-10-2021
`patient.firstName`	Up to 50 characters	Optional	Patient first / given name as registered with funder. If patient has only one name, use "Onlyname" as placeholder in firstName field. • A unique invoice can include only one patient. • Can only contain alpha (A-Z and a-z), numeric (0- 9), space ( ), apostrophe (') and hyphen (- ) characters • Spaces must not appear before or after apostrophes, hyphens, other spaces or the supplied value. A unique invoice can include only one patient.	Dominic
`patient.lastName`	Up to 25 characters	Mandatory	Patient last / family name as registered with the funder. • Can only contain alpha (A-Z and a-z), numeric (0- 9), space ( ), apostrophe (') and hyphen (- ) characters • Spaces must not appear before or after apostrophes, hyphens, other spaces or the supplied value. • At least one alpha or numeric character required.	Harris
`patient.mobile`	String	Optional	The mobile phone number of the patient. Can be either international notation:	+61411111111or national notation: 0411111111
`patient.email`	Email address	Optional	Any valid email address	mm@Tyro Health Online.io
`patient.refId`	Up to 128 characters	Optional, but strongly recommended	A unique patient identifier generated by your system. By setting this value you can uniquely search and sort transactions by patient. Future transactions can also be processed using refId rather than providing patient and health fund account details. Any differing patient details for a given refId will update the patient record on Tyro Health Online. To prevent creation of duplicate patient records in Tyro Health Online, set a unique refId per patient.	3DE2D2BC-17CC-4978-A79D-2151DC417B2F
`patient.membershipNumber`	Mandatory	Up to 30 alphanumeric characters	The QBE Workers Compensation (WC) Claim Number. These numbers look different depending on state . Workers Comp Claims: TAS - WCC1HOxxxxxxx WA - WCC1PExxxxxxx NT - WCC1ADxxxxxxx ACT - WCC1CAxxxxxxx If your QBE claim number looks like the above but without the WCC1 prefix, add the WCC1 prefix when trying to verify the the claim number. QBE Compulsory Third Party (CTP) Claim Numbers QBE CTP claim numbers also look different depending on state: CTP SA: 94xxxxxxxxxx CTP NSW: 36xxxxxxxxxx CTP QLD: 71xxxxxxxxxx	CTP SA: 940006867801
`claimableItems[].itemCode`	String	Mandatory	Any qbe supported Payment codes	AA020
`claimableItems[].serviceDate`	String	Mandatory	Date of the service in 'YYYY-MM-DD' format.	2022-01-12
`claimableItems[].customDescription`	String		Up to 128 alphanumeric characters. Custom item description. • Description may be required for some items. For example, this field is required on reporting, "other" and generic items.	Bandages for arm
`claimableItems[].item.price`	String	Mandatory	Item per unit pricing. This value will be deemed tax-inclusive if the isTaxable field is set to 'true'. If isExtendedPrice is set to 'true' this will be the aggregate amount for all quantity set. For example if the price without tax for an item per unit is $9.00, this field would have $9.00 and isTaxable = false if tax is not to be charged. If tax is to be charged, this field would show $9.90 and isTaxable = true.price each unit in $XX.XX format.	$15.95
`claimableItems[].isTaxable`	Boolean		Default is false. When true, GST of 10% will be applied to the gross item amount.	True
`claimableItems[].isGross`	Boolean		If set to true, this will indicate the price is the gross amount (including GST).	True
`claimableItems[].isExtendedPrice`	Boolean		Default is false. If set to true, this will indicate the price is extended/aggregate price for all quantities submitted. Otherwise, if set to false or omitted the price field will be multiplied per quantity claimed.	"Examples: • if true, and price is $20.00 with three quantity (effectively $6.66666 per unit) as sent to a funder. • if false, and 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."
`claimableItems[].quantity`	Number	Conditional	Quantity of the item or service relevant to the item's unit of Measure:Item based (consultations etc, quantity value must be 1 )Hours (Time based services)Kilometres (Travel per KMs)Quantity Dispensed(Medications)Can include up to 2 decimal places eg 1.75 (used of medications))	1 1.5302 2.5packets
*funderData*	*Object*
_funderData.qbe	*Object*
`funderData.qbe.serviceNote`	string		Invoice level notes for the transaction. Usually used to explain why, for example, two consults were done on the same day. Think of this as a note you would add to an invoice to help get the invoice paid.Up to 512 characters.	Current medications:Hydrochlorothiazide

Sample Transaction

Copy

Copied

medipassTransactionSDK.renderCreateTransaction({
    funder: ‘string,
    providerNumber: 'string',
    invoiceReference: "string",
   
    patient: {
      firstName: 'string',
      lastName: 'string',
      dob: 'string',
      mobile: '+string',
      accountNumber: 'string',     
      refId: 'string'
    },
    claimableItems: [
      {
        serviceDateString: 'string',
        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 () { /* ... */ }
})