Overview
Our transactional API is designed to be used by third party applications for “transactional” use cases such as third party referral systems, check-in kiosks and other applications that the practice might want to use alongside Medicus.
Our Transactional API must NOT be used for:
- Bulk data extracts (use IM1 Bulk instead)
- Patient-facing services where patients view their own records (use IM1 PFS instead)
- Data migration purposes (use the NHS Data Migration standard)
We provide a range of different articles to help you understand our Transactional API:
Postman Collection
We have also created a Postman collection attached to this article which you can use to make sample requests.
Download the collection, import it into Postman and then follow the steps below to get it working:
1 ) Make sure that we have configured your application to make requests
2 ) Add your private key
3 ) Set the client_id variable to the application ID provided by us and double check the base URL (which is set to "MA Baird's" practice on our Staging environment
4 ) Make a request to the "Ping" endpoint to check everything is working as expected