NIB attributes and Sample Transaction

Creating a transaction

Use function: medipassTransactionSDK.renderCreateTransaction()

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

Attributes table:

Field	Type	Condition	Description	Example
Field	Type	Condition	Description	Example
`provider.providerNumber`	String	M	Servicing provider number or other registration identifier which must be valid and active in Tyro Health Online for a given funder. For nib, DVA, HICAPS, nib and icare, a nib issued provider number should be used where available. Where a nib provider number is not applicable, use the appropriate identifier: • WSV: nib-issued provider number • icare: SIRA number• NDIS: provider registration number • HICAPS: a Medibank or HICAPS issued provider number• For pharmacies: a nib issued Pharmacy ApprovalNumber (PAN) • Comcare: Tyro Health Provider Number for location-based providers • A unique invoice can include only one provider. • must be registered on Tyro Health Online and enabled for selected funder.	2429591L
`invoiceReference`	string	O	Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. Up to 16 characters	20200901ABCD
`patient.identity.countryCode`	String	O		Au
`patient.identity.dob`	String	M	Patient/employee's 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 nib patient claims, if the patient is <15 years old as at each serviceDate, an adult =>18 years old claimant is required.	1988-03-29
`patient.identity.firstName`	String	M	Patient first name as registered with nib. Middle name is not supported. If the patient has only one name, then set name in lastName field and set firstName to "Onlyname".Up to 40 characters	Emily
`patient.identity.lastName`	String	M	Patient last name as registered with nib.Up to 40 characters	Harris
`patient.identity.mobile`	String	O	The mobile phone number of the patient. Can be either international notation:	+61411111111or national notation: 0411111111
OR
`patient.identity.refId`	String	O But recommended	An optional but highly 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
`healthFundAccount.cardRank`	String	M	individual reference number, one digit of 1-9, as noted on physical card.	1
`healthFundAccount.membershipNumber`	String	M	nib: The customer number printed in a member's card.• A unique invoice can include only one membershipNumber.	12345788
`claimItems`	Array{Object}		Array of fund claimable items One or more claimItems must be specified for a claim
`claimItems.itemCode`	String	M	Any valid nib supported MBS code or published nib code for a given date of service.Only valid MBS items for a given serviceDate can be processed.	104
`claimItems.chargeAmount`	String	M	Item per unit pricing in $XX.XX format. Must be $0.00 or =>$1.00	$15.95
`claimItems.serviceDateString`	String	M	Date of the service in 'YYYY-MM-DD' format.• must be a valid date• must be within 2 year as at date of submission• must not be future dated• must not be before patient date of birth_	2022-01-12
`claimItems.unit`	Valid values only	O	Default is EA.	EA
`claimItems.numberOfPatientsSeen`		O	1 or 2 numbers, 1-99 The number of patients seen. Default value is 1.	2
			Applicable for pharmacy claims only
`claimItems.prescriberFirstName`	Up to 40 characters	O	First name of the prescriber	Tim
`claimItems.prescriberNumber`	Valid values only	O	Prescribers number	12324
`claimItems.prescriberLastName`	Up to 40 characters	O	Last name of the prescriber	Bourke
`claimItems.scriptNumber`	Valid values only	O		1
`claimItems.scriptDate`	YYYY-MM-DD	O	The date the script is issued	2020-08-25
			Applicable for ambulance claims only
`claimItems.pickupDateTime`	YYYY-MM-DD	M	Date and time of pick up	2020-08-25
`claimItems.pickUpAddress`	Up to 40 characters	M	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.	4 Duke Street
`claimItems.pickUpAddress2`	Up to 40 characters	O	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. •The value must contain at least one alpha or numeric character.	Unit 808
`claimItems.pickUpAddress.city`	Up to 40 characters	M	Also known as locality. • must be a valid city/locality • 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.	Windsor
`claimItems.pickUpAddress.state`	Valid values only	M	Must be valid	vic
`claimItems.pickUpAddress.postcode`	4 numbers	M	Postcode Must be valid	3121
`claimItems.pickUpAddress.country`	Up to 40 characters	M
`claimItems.dropoffDateTime`	YYYY-MM-DD	O	• Date and time of drop off • Can not be before drop of time and date	2020-08-25
`claimItems.dropoffAddress`	Up to 40 characters	O	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.	4 Duke Street

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