PHI SDK integration changes

Earlier this year we moved our Private Health Insurance claiming from HICAPS to HealthPoint. As part of the move, we made some changes to data models that would have exposed breaking changes for our integration partners. We temporarily masked these changes to give partners more flexibility to schedule the required changes at a time that suits their development timelines. We are now asking our partners to complete the below changes, test and deploy to production by June 30th 2023.

What’s changed

1. New value for funder - we’re removing the ‘hicaps’ funder and replacing it with ‘phi’.
2. We’ve removed the funderData object and restructured the payload to fit with a simplified model.

Steps to upgrade

1. Complete the following code changes. There’s a sample Before and After payload below to clarify the changes.
   a) change funder , from hicaps to phi
   b) if using funderData.hicaps.transactionMethod , set it at paymentMethod instead
   c) if using funderData.hicaps.patient.healthFundCode , set it at patient.healthFundCode instead
   d) remove funderData
2. Reach out to the partnerships team when you’re ready to test the changes. We’ll validate the transactions in our test environment and confirm you’ve switched to the new model.
3. Once testing is completed and you’re ready for production. We’d appreciate your letting us know once you’ve completed your release.

Example payloads

Before:

{
  funder: "hicaps",
  platform: "funder",
  providerNumber: "2470314T",
  patient: {
    firstName: "Paul",
    lastName: "Wong",
    reference: "01",
    dob: "2000-01-01"
  },
  funderData: {
    hicaps: {
      transactionMethod: "phone",
      patient: {
         healthFundCode: "BUP"
      }
    }
  }
  claimableItems: [
    {
      itemCode: "011",
      price: "$201"
    }
  ]
}

After:

{
  funder: "phi",
  platform: "funder",
  providerNumber: "2470314T",
  paymentMethod: "phone",
  patient: {
    firstName: "Paul",
    lastName: "Wong",
    reference: "01",
    dob: "2000-01-01",
    healthFundCode: "BUP"
  },
  claimableItems: [
    {
      itemCode: "011",
      price: "$201"
    }
  ]
}