icare attributes
Creating a transaction
Use function:
To process a icare 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 icare for icare claims | icare |
providerNumber |
String | Yes | Medicare provider number for individual providers Or Tyro Health generated provider number for location level claiming |
General Practice: 2429591L Pharmacy:T243536Y |
invoiceReference |
string | Yes | Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. | |
| Patient | Object | |||
patient.firstName |
String | Yes | Patient/employee's first name | Emily |
patient.lastName |
String | Yes | Patient/employee's last name as registered with icare. | Harris |
patient.accountNumber |
String | Yes | claim number or approval number | 7777777 |
patient.healthFundCode |
String | Yes | icare insurance scheme. Currently, only workers insurance claims are enabled in production. | IWC |
| 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[].itemCode |
String | Yes | icare supported pay code which includes MBS/PBS/icare/Private derived item codes.Item code must be valid for icare, the provider registered profession and service date.Up to 8 characters | 10102Q |
claimableItems[].serviceDate |
String | Yes | 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 | Yes | 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." |
|
| funderData | Object | |||
| funderData.icare | Object | |||
funderData.icare.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 |