Patient Portal: Webhooks



Patient Portal

Import Message

Event


 import_message 



Payload

1{
2  "accountId": "",
3  "userId": "",
4  "messageId": <long>,
5  "patientId": ""
6}

Description


 Push notification event to partner when an item (such as a CCD) is sent to the patient portal

Payload Summary


  • accountId: the unique identifier of the account

  • userId: the unique identifier of the user importing a message to patient portal

  • messageId: the unique identifier of the import

  • patientId: the unique identifier of the patient receiving the import


Patient Portal Item

Event

patient_portal_item 

Payload
 
1{
2  "patientId": "",
3  "accountId": "",
4  "timestamp": "<YYYY-MM-ddThh:mm:ss.SSSZ>"
5}


Description

Push notification event to partner when a new item has appeared in patient portal inbox.

Payload Summary

  • patientId: the unique identifier of the patient receiving the new patient portal item

  • accountId: the unique identifier of the account

  • timestamp: the date/time of the patient portal item


Patient Portal Reinvite

Event


patient_portal_reinvite

Payload
 
1{
2  "patientId": "",
3  "accountId": "",
4  "timestamp": "<YYYY-MM-ddThh:mm:ss.SSSZ>"
5}

Description


Push notification event to a partner that a patient portal invitation was reissued

Payload Summary


  • patientId: the unique identifier of the patient receiving the invitation

  • accountId: the unique identifier of the account

  • timestamp: the date/time of the invitation