Use function:
To process a Comcare 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 comcare for comcare claims | comcare |
providerNumber | String | M | Medicare provider number for individual providers Or Tyro Health generated provider number for location level claiming | General Practice: 2429591L Pharmacy:T243536Y |
invoiceReference | String | M | Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. | INV-20220315-001 |
patient {} object | ||||
patient.firstName | String | M | Patient/employee's first name | Emily |
patient.lastName | String | M | Patient/employee's last name as registered with comcare. | Harris |
patient.dob | String YYYY-MM-DD | M | Patient/employee's Date of Birth in 'YYYY-MM-DD' format. | 1988-03-29 |
patient.accountNumber | String | M | Patient claim number /case number. The claim number is presented first followed by a forward slash and case number. If the case number is not known, use /01. | 987654/01 |
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 | ||||
claimableItems[].itemCode | String Up to 8 characters | M | Comcare supported pay code which includes MBS/PBS/Comcare/Private derived item codes. Item code must be valid for Comcare, the provider registered profession and service date. | 10102Q |
claimableItems[].serviceDate | String YYYY-MM-DD | M | Date of the service in 'YYYY-MM-DD' format. | 2022-01-12 |
claimableItems[].item.price | String Currency notation | M | 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 | O | Default is false. When true, GST of 10% will be applied to the gross item amount. | True |
claimableItems[].quantity | Number | O | 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.5 302 2.5 packets |
claimableItems[].customDescription | String Up to 128 characters | O | If the item code being used has the ability to accept a custom description, you can enter it here. This is typically used on generic item codes that need further elaboration. | Initial physiotherapy assessment |
funderData {} object | ||||
funderData.comcare {} object | ||||
funderData.comcare.serviceNote | String Up to 512 characters | O | 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. | Current medications:Hydrochlorothiazide |
medipassTransactionSDK.renderCreateTransaction({
funder: string,
providerNumber: string,
invoiceReference: string,
patient: {
firstName: string,
lastName: string,
dob: string,
claimNumber: string,
},
funderData: {
comcare: {
serviceNotes: string
},
},
claimableItems: [
{
itemCode: string,
serviceDate: string,
price:string,
description: string
}
],
webhooks: [
{
url: string,
event: 'healthInvoiceCancelled' | '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 first / given name as registered with Comcare. | Willis |
patient.lastName | Up to 40 characters | Patient last / family name as registered with Comcare. | Curtin |
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 Comcare is expected to pay. | 8000 / $80.00 |
claimItems.amountActualBenefitString | String Currency notation | The amount Comcare 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 |