Learn about the key concepts of the Impilo API.
This guide is designed to help you understand how patients can be created, updated, and managed, and how to utilize webhooks and external identifiers for effective patient tracking.
Before diving into patient management, it’s important to understand the primary entity associated with patient operations:
To create a patient, you’ll interact with a specific endpoint designed for this purpose. This endpoint allows you to initiate and configure patient profiles based on your requirements.
For a successful patient creation, you must ensure the following required attributes are correctly provided:
name
, dateOfBirth
, and gender
must be included.The following request contains the bare minimum for creating a patient.
To update a patient, you’ll use a specific endpoint that allows modifying existing patient profiles. This can be useful for updating patient information as required.
The following request contains the minimum required for updating a patient.
Impilo supports webhooks to notify your system when a patient is updated. This allows you to keep your system in sync with any changes in patient data. For more information see the webhook management guide.
To set up a webhook, register a URL endpoint in your system that can receive POST requests from Impilo.
When a patient is updated, a POST request will be sent to your registered webhook URL with the following payload:
To effectively track individual patients using customer specific identifiers, the external identifiers field can be used. This can be particularly useful for ensuring uniqueness and consistency in a way that matches external systems.
For example purposes, a customer system may use email addresses and phone numbers as a way to track patients. The external identifier field could hold a hash of these two values:
You can use the generated hash as an external identifier in your patient profiles to uniquely identify and track patients within Impilo.