APS Status Notes Notification

The Health Intelligence Platform can send notifications when new APS status or progress notes become available. To enable this feature for your HIP client application, please contact your account manager. Webhook notifications will follow this format:

[
  {

      "timestamp": "2025-12-28T20:50:41.251000",
      "eventId": "9fa4a64c-77f6-4e3b-8f1c-2583f0b6855b",
      "orderId": "8a1c7e40-dc21-11f0-b4ad-8d600f27aa39",
      "eventType": "integrations.VendorNoteCreated",
      "eventPayload": {
          "note": "IMAGE 20251228123154_123456 WAS RECEIVED AND APPENDED TO SPECIAL AUTHO SECTION FOR RP # 123456 BECAUSE THERE IS ALREADY A FILE IN THE AUTHO SECTION",
          "providerIds": [],
          "providerNames": [
              "Kaiser Permanente"
          ],
          "clientProviderId": "HAPI-12345"
      },
      "eventGroup": "offline",
      "userId": "694415c711cf101c483ef80b",
      "clientUserId": "HAPI-12345",
      "humanId": "2409147570db13a47994489eb57efa54",
      "clientId": "12990dca36b501031b7a2c9ccae6fb0a9dcb6748",
      "clientData": {
        "clientDataProperty1": "Property value",
        "clientDataProperty2": "Property value"
      }
  }
]

Description for the APS status note object

Property	Description	Type/Format	Value
clientId	Customer's application id	string
timestamp	Timestamp to when the property was updated	ISO 8601 timestamp of when the event was generated
humanId	Human API identifier	string
clientUserId	Customer unique identifier like policy number or unique Id	string
userId	Human API identifier	string
eventId	Id of the event	uuid
orderId	Id of the order	uuid
eventType	Type of event, used to identify the eventPayload	string	`integrations.VendorNoteCreated`
eventPayload	Specific event details	object
eventGroup	A version of the channel relevant to the customer. One of: `portal`, `ehr`, `offline`	string	`offline`
clientData	Custom data submitted at order creation	object

Description for `eventPayload`

Property	Description	Type/Format	Value
note	Status or progress note text from the vendor	string
providerNames	List of provider names associated with the order	array of strings
providerIds	List of provider identifiers associated with the order	array of strings
clientProviderId	Customer's provider identifier, if available	string

Updated 5 days ago