Here are two formats of our API documentation
Patient Procedure Imports
Patient Procedure imports are typically done so that FollowApp receives enough information regarding the patient and the patient’s associated procedure type in order for us to send out Aftercare or Feedback communications on behalf of your organisation.
Aftercare or Feedback messages are queued up and sent to patients after a record from Patient Procedures has been successfully imported. The imported record should provide sufficient information about the patient and the patient’s appointment to dictate the type of messages received by the patient.
The purpose of these messages is to monitor the patient’s recovery process after their treatment and to alert staff members at your organisation when a patient requires further attention based on their responses to the messages.
The timing and frequency of the messages triggered by the successful Patient Procedure imports are dependent on the patient’s treatment type.
1. Am I meant to write an automated scheduled script? What is the big picture here?
Yes, the objective is to write a scheduled script to execute automatically based on the main filtering parameter:
2. Can I include multiple Patient Procedure records in the same JSON? Or do they all have to be imported in individual JSONS, one for each record?
You may import multiple Patient Procedures within the same JSON import, they do not need to be imported separately.
3. What does the ‘contacts’ object mean and what do I input for the ‘level’ and ‘providerCode’ fields within this object?
The ‘contacts’ object indicates who should be associated with this particular Patient Procedure. In most cases, it will be the doctor for this patient’s treatment. However, there are situations where you may want to have multiple personnel associated with the patient’s treatment (ie. a hygienist).
All contacts must already exist in FollowApp, which is why Member imports must be performed prior to the Patient Procedure imports to ensure Members are created/updated.
For the first contact, the ‘level’ field should always be ‘primary’ or simply ‘0’.
The ‘providerCode’ field is how you can associate this Patient Procedure record to a Member.
Here is an example of what this object would look like if you have a Member/doctor record with providerCode 1234:
If you would like a second contact to be included for this Patient Procedure, you may indicate the level as ‘secondary’ or simply ‘1’. For example, if this Patient Procedure had a doctor with providerCode 1234, and a Hygienist with a providerCode 2345, then the object would look like this:
4. What do I put for the ‘procedureId’ field?
This field indicates what kind of treatment the patient has undergone. You can usually find a list of treatments and their associated IDs/codes in your Practice Management Software (PMS).
Please import to us all appointments that are created at the participating clinics.
Appointments with procedureIds that are not participating in Aftercare at your organisation will be automatically filtered out by FollowApp and messages will not be sent.
5. What does the ‘status’ appointment mean, and what does each status indicate?
Each appointment should have a status, indicating the most up to date status of an appointment. Depending on the status of an appointment, messages may be queued in FollowApp or halted.
Pending = The appointment has been created (can also be used as the status if the appointment has been rescheduled)
Cancelled = The appointment was cancelled
Attended = The patient has attended the appointment
Missed = The patient did not attend the appointment
6. How do I know when to import Patient Procedures and which Patient Procedures to import?
You will need to import all appointments for which you would like to send communications.
It is generally recommended to import all appointments, relying on FollowApp to filter the imported appointments based on your organisation’s configuration in our platform. Appointment data can be sent as soon as it is created/updated, or can be sent in batches.
An important consideration is that if the data is batched this may prevent messages from being sent in a timely fashion. For example if appointment import is a daily batch, then any appointment booked and attended on the same day may not receive communications until the day after the appointment. If appointment import is immediate then FollowApp can send welcome messages and treatment-specific information immediately, allowing important information to reach even emergency and short-notice patients.
7. How do I test my patient Procedure imports?
Once you are ready for testing, we will be providing you credentials to your own Sandbox testing environment to test your imports against.
8. What to do when going live?
Before going live, it is important to speak to your FollowApp Customer Success Representative (or if you have been in touch directly with our Integration team then please contact them) confirming timing and frequency of Patient Procedure imports.
Before going live, we will provide you with:
URLs for the production environment
Your Client ID
Your Client Secret
Do you have more questions? Please contact email@example.com!