Patient Call to Action

The patient call to action event will be dispatched when a patient is expected to take an action, such as performing a measurement or when their program or schedule has changed.

JSON Payload Example

{
  "eventType": "com.luscii.patient.call_to_action.v1",
  "eventId": "{eventId}",
  "datetime": "ISO-8601", // e.g. 2024-05-14T13:33:33Z
  "organizationId": "{organizationId}",
  "payload": {
    "url": "https://api.luscii.com/v1/patients/{patientId}",
    "resource": {
      "id": "{patientId}"
    },
    "type": "{type}",
    "identifiers": [
      {
        "system": "{system}",
        "value": "{value}"
      }
    ]
  }
}

Field Descriptions

Field	Description
eventId	Unique identifier for the event being dispatched.
organizationId	Unique identifier for the organization in which the patient is enrolled.
patientId	Unique identifier for the patient. Can be used to fetch additional information via the Public API.
type	The kind of call to action that was triggered. See supported values below.
identifiers	All FHIR identifiers associated with the patient.
identifiers[].system	The FHIR system URI for this identifier.
identifiers[].value	The identifier value within that system.

Supported `type` Values

Value	Description
`action_reminder`	The patient is due to perform a measurement.
`program_changed`	The patient's care program has changed.
`frequency_changed`	The patient's measurement frequency has changed.
`schedule_changed`	The patient's measurement schedule has changed.

Notes

A patient may receive multiple call to action events on the same day (e.g. a measurement reminder in the morning and a schedule change later in the day).
This event is suppressed while a patient is on holiday or absence.
This event fires regardless of the patient's personal notification preferences.

Updated about 6 hours ago

Did this page help you?