Here are two formats of our API documentation
“Member imports” refer to the importation of staff data from your organisation to the FollowApp Care platform. Your organisation’s staff members, referred to here simply as Members, need to be imported so that we can create them as users on our platform, and so medical personnel can be associated with appointments and relevant communications can be sent to them.
Our Member importation process ensures that members, in particular those who will be associated with appointments (i.e. medical personnel), are properly created or updated before each import of the Patient Procedures so that each procedure can be matched to the correct Member record.
There will be 3 endpoints for Member imports - Create, Update and Upsert. For more information, please use the Swagger links provided.
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. How are ‘Members’ defined?
Members are any users for the platform (for example, Centre Managers, Receptionists, and etc), as well as medical personnel at your organisation. Currently, the Member import endpoints are mostly used to import doctors, while Centre Managers, Receptionists can be added via the platform interphase.
3. Which endpoint should I use to import my members?
In general, we would recommend using the Upsert endpoint, which can create Members who do not already exist in FollowApp, and update Members who already exist/have previously been created in the FollowApp system.
4. What if I do not wish for my doctors to login to the platform? Are we still required to import them?
Yes, it is mandatory. All doctors must be imported to the FollowApp system in order for Patient Procedures to be mapped properly to a doctor, even if simply for informational purposes by the users of the platform. .
Importing a member creates a user on the platform. If you do not want doctors to be able to login to the platform, you should leave the ‘email’ field within the ‘members’ object empty. If you do include the ‘email’ field, then an account enabling doctors to log-in will be created, and a Welcome Email will be sent to the email address of the doctor for them to confirm their email, create a password, and log in to FollowApp.
5. Does the externalID field in the ‘member’ object have to be unique? To what degree?
Yes, the externalID field in the ‘member’ object must be unique to the whole organisation - no other Members in your organisation should have the same ID to identify the Member.
6. How should I fill out the ‘memberRoles’ object?
If a Member is part of the medical staff (ie. doctors), please fill out the ‘id’ and ‘name’ fields within the ‘memberRoles’ accordingly like this (please input the correct centerExternalId of your organisation):
For any other Member types please email your FollowApp Customer Success Representative for more information.
7. What are “Provider Codes”?
Provider Codes are unique IDs for the doctor at each centre. Provider Codes only need to be unique across the centre. This is currently a mandatory field.
If you do not have a Provider Code concept at your organisation, you may choose to do a combination of the Member’s externalID + centerExternalId.
For example, if a Member has an externalID of 000 and a centerExternalId of TEST, the Member’s Provider Code may be 000TEST
8. What if my doctors work in multiple centres?
If your doctors work in multiple centres, then you must ensure that these fields in the ‘memberRoles’ object are repeated for each centre the doctor works at: ‘id’, ‘name’, and ‘centerExternalId’. For example, if the doctor work at both CentreA and CentreB, then:
The same concept must be applied for the ‘ProviderCodes’ object:
9. How do I know when to import Members and which Members to import?
You will need to import all staff members who will be used as contacts for appointments you intend to import.
The recommended approach is to send all newly created or updated members as soon as they are available. It is also acceptable to send member data in a batch, with any frequency you choose (e.g. hourly or daily).
Bear in mind that any members which have not yet been imported to FollowApp cannot be used as a contact on an appointment, so to accommodate situations where rapid onboarding of staff is required we recommend sending member data immediately that it is available.
10. How do I test my Member imports?
Once you are ready for testing, we will be providing you credentials to your own Sandbox testing environment to test your imports against.
11. Can I include multiple doctors or Members records in the same JSON? Or do they all have to be imported in individual JSONS, one for each record?
You may import multiple members within the same JSON import, they do not need to be imported individually/separately.
12. 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 Member imports.
Before going live, we will provide you with:
URLs for the production environment
Your Client ID
Your Client Secret
Upon going live, it would be advised to do a one time ‘bulk’ upload of all doctor type members via the API to ensure all doctors are imported and ready to be mapped to a Patient Procedure.
Do you have more questions? Please contact email@example.com!