patient.firstName |
string |
Yes |
Emily |
First name of patient |
patient.lastName |
string |
Yes |
Test |
Last name |
patient.refId |
string |
Yes |
12DB612A-2CBB-4FFA-B195-1F930F0A2E8B |
An optional unique patient reference as set by you. This can be used to save patient details for future payments instead of setting firstName, lastName and other patient details.Additionally the refId can be used within the PMS to pre-populate details entered during the online checkout experience including tokenised card information |
patient.email |
string |
Yes |
mavis@medipass.io |
Email address |
patient.dobString |
string |
Yes |
1990-01-01 |
Date of birth in YYYY-MM-DD format |
providerNumber |
string |
Yes |
2429581T |
Medicare registered provider number |
invoiceReference |
string |
Yes |
PMSTest123 |
Invoice unique reference - should align to invoice/transaction number set in the PMS and as shown to the provider. |
sendReceipt |
boolean |
O |
"true" or "false" |
If set to true, will automatically email a payment receipt. |
| For each claimable item |
each item as object in HealthPoint.claimItems array |
|
|
|
claimItems.serviceDate |
string |
Yes |
2020-06-16 |
Service date for item. If blank, auto populates to current date |
claimItems.itemCode |
string |
Yes |
852 |
The unique item code for the claim item |
claimItems.reference |
string |
Yes |
01 |
Order of items for checkout |
claimItems.displayName |
string |
Yes |
easyvision Lacrima Multifocal |
Display friendly name of the claim item. |
claimItems.chargeAmount |
string |
Yes |
$55 |
Price for item code |
| For each non claimable item |
additional items that are not claimable such as lens cleaner |
|
|
|
nonClaimableItems.serviceDate |
string |
Yes |
2020-06-16 |
Service date for item. If blank, auto populates to current date |
nonClaimableItems.reference |
string |
Yes |
01 |
Order of items for checkout |
nonClaimableItems.displayName |
string |
Yes |
Lens cleaner |
Display friendly name of the non claimable item. |
nonClaimableItems.chargeAmount |
string |
Yes |
$15 |
Price for item code |
shipping.shippingAmount |
string |
O |
$15 |
The shipping amount in currency format. |