Submitting batch files with Tyro Health Online

Tyro Health Online supports bulk transmission of invoices to healthcare funders. Batched invoices are processed individually according to funder rules.

A single batch file can support multiple invoices and claimed items. For all invoices, it’s important to note:

Files must be in a CSV format. Double quoted fields (i.e. using quotes as text qualifiers) are optional, but recommended when dealing with text columns (like descriptions).
Template and example CSV files for each funder are posted on Tyro Health Online.
The first row must be a header record and must conform to template values provided.
Each row’s columns must be ordered according to the header record.
Up to 10,000 rows can be included in a single file.
Fields listed as mandatory for each funder must be complete and valid for successful upload.
After uploading to Tyro Health Online, invoices that pass business rule validation will be created as a Draft in a Ready to submit status. Select those invoices and click submit to process.
Invoices that fail validation will be in an Incomplete status and require attention prior to submission.

Importantly, if you create, open or save the file using Microsoft Excel or other spreadsheet programs, please note that date and time fields may be automatically updated to a format that is not accepted - be sure to save the file in the formats defined below.

Invoice guidelines:

An invoice will result in a single unique Tyro Health Online transaction identifier, invoice date and status;
An invoice will have a single unique invoiceReference as nominated by you;
An invoice will have a single patient and health fund account;
An invoice will have a single provider and payee;
An invoice will have one or more claimed items;
Each item will have at least a unique reference , serviceDate , itemCode and price ; and
Additional item attributes can be set.

To support invoices with multiple claimed items:

Invoices with the same invoiceReference will be grouped into a single invoice for submission to a funder.
Rows for a unique invoice should be grouped together sequentially and each item should use a unique claimItems.reference for that invoice.
For invoice level (but not item level) attributes that repeat, only the first instance of those values will be used.

For those that create batch files using Microsoft Excel, Apple Numbers or Google Sheets:

All fields should use a format of “Plan Text” or “Text” .
Special care should be taken while entering serviceDate , time of service and other date/time numbered fields as these tools may apply an automatic format different from expected.
Files must be saved/exported as:
- Microsoft Excel - Windows: CSV Comma delimited ( * .csv)
- Microsoft Excel - Mac: Comma-separated Values (.csv)
- Apple Numbers: CSV, Text Encoding: Unicode (UTF-8)
- Google Sheets: Comma-separated values (.csv, current sheet)

Medicare invoices

Both Medicare Bulk Billed and Patient Claims are supported for batch submission. However, it is more typical for Patient Claims to be submitted immediately post consultation so that patients/claimants can understand their Medicare benefit status.

Field	Required?	Format	Example value	Notes	Key constraints
`invoiceReference`	Mandatory	Up to 16 characters	20200901ABCD	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.
`sequenceNumber`	Optional	Up to 4 numbers	1	Row counter starting with 1. Unique and sequential within a batch file. Used to identify row level errors/mistakes. Leading zeros NOT permitted. If not supplied, the row count will be used to identify processing issues.
`providerNumber`	Mandatory	Up to 16 alphanumeric characters	0065431A	Servicing provider number which must be valid and active in Tyro Health Online for a given funder. A Medicare issued provider number is required for Medicare claims.	• A unique invoice can include only one provider.• must be registered on Tyro Health Online and enabled for selected funder.
`funder`	Mandatory	Valid values only	medicare	Set to medicare for both Medicare bulk billed and patient claims.	• A unique invoice can include only one funder. If multiple funders are required, such as a customer payment request for a Medicare patient claim, use a different invoiceReference for each part. • Must be enabled on Tyro Health Online for selected funder.
`paymentMethod`	Optional	Valid values only	in-person	Flag used for Patient Claims to indicate that the patient has already paid for the service.	• Valid for Patient Claims only.• Must be either blank or "in-person".
`patient._id`	Optional	33 alphanumeric characters	6BE1F0653B5F4B47 A88633F3A0DC1712	Tyro Health Online generated value to represent a unique patient. Can be used as an alternative to submitting patient and health fund account details but only if a previous successful transaction processed against a patient. Otherwise, do not use.	• A unique invoice can include only one patient.
`patient.refId`	Optional but highly recommended	Up to 128 characters	3DE2D2BC-17CC-4978-A79D-2151DC417B2F	A unique patient identifier generated by your system such as a UUID. 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.	• A unique invoice can include only one patient.
`patient.firstName`	Optional	Up to 40 characters	Emily	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.• At least one alpha or numeric character required.
`patient.lastName`	Mandatory	Up to 40 characters	Harris	Patient last / family name as registered with funder.	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.• At least one alpha or numeric character required.
`patient.dobString`	Mandatory	YYYY-MM-DD	2010-09-01	Date of birth in YYYY-MM-DD format.	• must be a valid date• must not be a date in the future• must not be after each serviceDateFor Medicare patient claims, if patient is <15 years old as at each serviceDate, an adult =>18 years old claimant is also required.
`patient.sex`	Optional	Valid values only	F	One of:M: MaleF: FemaleO: OtherNull/not set: not determined (default)
`healthFundAccount.healthFundCode`	Mandatory	Valid values only	MDC	For Medicare set to MDC.	• A unique invoice can include only one healthFundCode.
`healthFundAccount.membershipNumber`	Mandatory	10 numeric	2953878061	The value supplied must be 10 numeric and conform to the Medicare Card check digit routine which will be validated in Tyro Health Online.	• A unique invoice can include only one membershipNumber.
`healthFundAccount.cardRank`	Mandatory	1 numeric	2	The Medicare individual reference number, one digit of 1-9, as noted on physical card.
`medicare.claimType`	Mandatory	Valid values only	bulkbill	One of: -bulkbill - patientclaim	All claimed service items for a given invoice must be bulkbill or patientclaim
`medicare.claimItems.reference`	Optional	Up to 128 alphanumeric characters	01	Line item reference as nominated by you. Assists with reconciliation where multiple of the same item code and service date claimed.	This reference should be unique within a given invoice.
`medicare.claimItems.serviceDate`	Mandatory	YYYY-MM-DD	2020-08-25	Date of service in YYYY-MM-DD format.	• must be a valid date• must be within 2 years as at date of submission• must not be future dated• must not be before patient date of birth
`medicare.claimItems.itemCode`	Mandatory	Up to 8 alphanumeric characters	AA020	Any MBS supported item code.	Only valid item codes for a given serviceDate can be processed.
`medicare.claimItems.price`	Mandatory	Currency notation, up to 6 numeric and 2 decimal digits	50.67	Item charge amount.	Must be =>1.00.
	Applicable for bulk bill only
`medicare.benefitPayee.providerNumber`	Optional	Up to 8 alphanumeric characters	3452232B	Generally only valid for bulk billed claims, where the payee provider is different from the servicing provider. Benefits will be paid to the benefitProvider's bank account. Note: this provider number must also be registered with Tyro Health Online.	• A unique invoice can include only one benefitPayee.• Provider number must be registered with Tyro Health Online and enabled for Medicare.benefitPayee is the servicing provider by default.
`medicare.benefitPayee.providerName`	Optional	Up to 30 alphanumeric characters & select special characters	Dr. Dominic Smith	Full name of provider including or excluding title. Will appear on assignment of benefit statement (DB4).
	Applicable for patient claims only
`medicare.claimant.refId`	OptionalBut highly recommended	Up to 128 characters	3DE2D2BC-17CC-4978-A79D-2151DC417B2F	A unique patient identifier generated by your system such as a UUID. 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.	• A unique invoice can include only one patient.
`medicare.claimant.firstName`	Optional	Up to 40 characters	Mila	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.• At least one alpha or numeric character required.
`medicare.claimant.lastName`	Optional	Up to 40 characters	Willis	Patient last / family name as registered with funder.	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.• At least one alpha or numeric character required.
`medicare.claimant.dobString`	Optional	YYYY-MM-DD	2010-09-01	Date of birth in YYYY-MM-DD format.	• must be a valid date• must not be a date in the future• must not be after each serviceDatean adult =>18 years old claimant is required.
`medicare.claimant.sex`	Optional	Valid values only	F	One of:M: MaleF: FemaleO: OtherNull/not set: not determined (default)
`medicare.claimant.healthFundAccount.membershipNumber`	Optional	10 numbers	1234567890	Medicare card number - 10 digits	• A unique invoice can include only one membershipNumber. • value must adhere to Medicare Card check digit routine.
`medicare.claimant.healthFundAccount.cardRank`	Optional	1 number	1	Medicare individual reference number, one digit of 1-9, as noted on physical card.
`medicare.claimant.postalAddress.address`	Optional	Up to 40 characters	4 Duke Street	A valid street address.	• The value supplied must be alpha (A-Z and a-z), numeric (0-9), space ( ), apostrophe ('), hyphen (-) and other special characters (/ , . : ; ) only. • Spaces must not appear before or after other spaces or the supplied value.• The value must contain at least one alpha or numeric character.
`medicare.claimant.postalAddress.address2`	Optional	Up to 40 characters	Unit 827	Address line 2, typically unit or apartment number.	• The value supplied must be alpha (A-Z and a-z), numeric (0-9), space ( ), apostrophe ('), hyphen (-) and other special characters (/ , . : ; ) only. • Spaces must not appear before or after other spaces or the supplied value.
`medicare.claimant.postalAddress.city`	Optional	Up to 40 alphanumeric characters	Windsor	Also known as locality.	• must be a valid city/locality as defined by Medicare• The value supplied must be alpha (A-Z and a-z), numeric (0-9), space ( ), apostrophe ('), hyphen (-) and other special characters (/ , . : ; ) only. • Spaces must not appear before or after other spaces or the supplied value.• The value must contain at least one alpha or numeric character.
`medicare.claimant.postalAddress.postcode`	Optional	4 numbers	3181	Postcode	Must be valid.
`medicare.claimant.bankAccount.bankName`	Optional	Up to 30 characters	NAB	bank name not processed by Medicare, but we use for validation to show in claim
`medicare.claimant.bankAccount.accountName`	Optional	Up to 30 characters	Charles Willis	Name of account holder.	• The value supplied must be alpha (A-Z and a-z), numeric (0- 9), space ( ), apostrophe ('), hyphen (-) and other special characters (.,/) only. • Spaces must not appear before or after the supplied value.
`medicare.claimant.bankAccount.bsb`	Optional	6 numbers	023456	Six digit BSB number.	Must be a valid BSB.
`medicare.claimant.bankAccount.accountNumber`	Optional	Up to 9 numbers	987654321	Account number.	• The value supplied must be alpha (A-Z and a-z), numeric (0- 9), space ( ), apostrophe ('), hyphen (-) and other special characters (.,/) only. • Spaces must not appear before or after the supplied value.
`medicare.claimItems.patientContributionAmount`	Optional	Currency notation, up to 5 numeric and 2 decimal digits	30.67	Amount paid by claimant, if not full payment.	• The value supplied must be less than the chargeAmount.If set to <price (charge amount), then this will initiate a Pay Doctor Via Cheque (PDVC) request to Medicare.
`Applicable (and required) for referred services`
`medicare.referral.issueDateString`	Optional	YYYY-MM-DD	2020-07-23	Date of referral/request issuance in YYYY-MM-DD. Only used where referral is required.	• must be a valid date• must be greater than or equal to the Patient dob• must be present if Referral details supplied• must not be a date in the future• must not be after each serviceDate• must be present for referred services
`medicare.referral.periodType`	Optional	Valid values only	S	Period type code as defined by Medicare and only used where referral used. Valid values:• S: Standard – 12 months for GP or 3 months for Specialist referrals (Default value)• N: Non-standard, if set must supply duration in serviceText field• I: Indefinite	• must be present if Referral details supplied• If N or I, details are required in serviceText
`medicare.referral.providerNumber`	Optional	Up to 8 alphanumeric characters	4452232B	Referring provider number. Note this must be a valid provider number, but the provider number does not need to be registered with Tyro Health Online.	• must be present if Referral details supplied• must be a valid provider number
`medicare.referral.providerFullName`	Optional	Up to 30 alphanumeric characters	Dr Emily Tay	Full name of referring provider, with or without title. Will appear on printed statements.	• must be present if Referral details supplied
`medicare.referral.referrerType`	Optional	Valid values only	specialist	Either: GP for General PractitionerOr specialist	• must be present if Referral details supplied
`medicare.nonReferral.reason`	Optional	Valid values only	H	Only for exception claims normally requiring a referral. One of: E: Emergency H: Hospital in-patient referral (isInHospital should be Y for all services) L: Lost N: Not required, non-standard referral	• Only used where referral normally required and replaces referral details. • If Referral Override Code is set to H (Hospital) then Hospital Indicator must be set to Y (In Hospital)
`medicare.nonReferral.description`	Optional	Up to 40 alpha characters	Royal Melbourne Hospital	Description of non-referral reason. Where:H: name of hospitalL: text	• must be present if nonReferral details supplied
	Optional attributes and overrides for each claimable item
`medicare.claimItems.serviceText`	Optional	Up to 50 alphanumeric characters	Not duplicate	Free text for additional information on claim assessment.	• The value supplied must be alpha (A-Z and a- z), numeric (0-9), space ( ), and special characters @ # $ % + = : ; , . -. • Spaces must not appear before or after other spaces or the supplied value.
`medicare.claimItems.isInHospital`	Optional	Valid values only	Y	Hospital Indicator - whether or not the service(s) rendered to the patient was for treatment provided within a hospital facility. Valid values:Y = In Hospital	• If Referral Override Code is set to H (Hospital) then Hospital Indicator must be set to Y (In Hospital)
`medicare.claimItems.numberOfPatientsSeen`	Optional	1 or 2 numbers, 1-99	2	The number of patients seen. Must be set for group attendance items (e.g. counselling) or visits (home, hospital or institution) to ensure the correct payment is made.	• Only applicable for General or Specialist Services.• Number of Patients Seen and Time Duration must not be set against the same service
`medicare.claimItems.restrictiveOverride`	Optional	Valid values only	SP	This code is used to allow payment for services where the account provides indication that the service is not restrictive with another service either within the same claim or on the patient history. Valid values: SP= Separate Sites NR= Not Related to consult NC= Not for Comparison	• Only applicable for General or Specialist Services.
`medicare.claimItems.afterCareOverride`	Optional	Valid values only	Y	Indicates whether the service was performed as part of normal aftercare for the patient. Valid values:Y = Not Normal Aftercare	• Only applicable for General or Specialist Services.
`medicare.claimItems.duplicateServiceOverride`	Optional	Valid values only	Y	Indicates whether multiple services performed on the same day, by the same Service provider and should be treated as separate services. Valid values:Y = duplicate service override	• If Duplicate Service Override Indicator is set to Y (Not Duplicate) then Medical Event Time or additional information in serviceText is required to support the reason for the override.• Only applicable for General or Specialist Services.
`medicare.claimItems.multipleProcedureOverride`	Optional	Valid values only	Y	Indicates whether the multiple services rule must or must not be applied to the service being claimed. Valid values:Y = Not Multiple	• Only applicable for General or Specialist Services.• If Multiple Procedure Override Indicator is set to Y (Not Multiple) then must list serviceText providing the reason
`medicare.claimItems.accountReferenceNumber`	Optional	1-9 alphanumeric characters	19-1125B	Account Reference (ACRF). A reference used by the claim submitter to identify a claim.	• The value supplied must be alpha (A-Z and a-z), numeric (0-9), space ( ), and special characters @ # $ % + = : ; , . - only. • Spaces must not appear before or after other spaces or the supplied value.
`medicare.claimItems.selfDeemed`	Optional	Valid values only	SD	A Self Deemed service is an additional service to a valid request. A substituted service is a service provided that has replaced the original service requested..Valid values: SD= Self Deemed SS= Substituted Service	• Self Deemed Code must not be set when Referral Override Code is set
`medicare.claimItems.timeOfService`	Optional	HHMM	1425	Time of service in in 24 hour format: HHMM as in Australian time zone. Used if multiple of same items claimed on same day, by same provider, for same patient.	• The time supplied must reflect the time zone in Australia, the transaction was created in.
`medicare.claimItems.fieldQuantity`	Optional	1 or 2 numbers, 1-99	4	The number of fields irradiated or the quantity of (15 minute) time blocks or derived fee intrathecal or epidural infusion services (e.g. items 18219 and 18227).	• Only applicable for General or Specialist Services. • Field Quantity and Number of Patients Seen or Time Duration must not be set against the same service.