Create Note
Creates a note for a given appointment.
Notes are created in the provider’s EMR using RPA via a headless browser. Creating notes this way is not instantaneous like an API call. In our experience, it can take ~30-90 seconds to create a note depending on the complexity of the EMR.
Instead of leaving your POST request hanging until note transfer completion, we immediately return a success response if the request is properly formed. We then notify you via a webhook when the note processing has completed.
This gives you flexibility around your user experience. For example, when you first make the /notes
call you can display a Processing status to your user and when you get the webhook notification you can update that to Completed.
Formatting Note Content
When providing the note
content, it’s important to use \n
for line breaks if you want those line breaks to be reflected in the EMR. For example, if you want the note to appear in the EMR as:
You should send the following in the note
field:
Example Request
Example Response
Webhook Notifications
When the note processing is complete, we will send a webhook to your registered endpoint. Here are examples of what those webhook payloads will look like:
Success
Failure
Authorizations
Body
Response
Successful response
The response is of type object
.