Skip to main content
GET
Get Care Plan Logs

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

care_plan_id
string
required

Response

Successful Response

id
string
required
carePlanId
string
required
action
enum<string>
required

What kind of change was made to a care plan or one of its steps.

Available options:
CREATED,
REMOVED,
FIELD_CHANGED,
STATUS_CHANGED,
CYCLE_CREATED,
CYCLE_UPDATED,
CYCLE_REMOVED
source
enum<string>
required

How a care plan change was triggered.

Available options:
USER,
PATIENT_SELF_SCHEDULE,
EVENT_SYNC,
TASK_SYNC,
BRANCH_SELECTION,
CYCLE_EDIT_THIS,
CYCLE_EDIT_FUTURE,
CYCLE_EDIT_ALL,
CYCLE_PROPAGATION,
CYCLE_MATERIALIZATION
createdDate
string<date-time>
required
stepId
string | null
fieldName
enum<string> | null

Identifies which field was modified in a FIELD_CHANGED or STATUS_CHANGED log entry.

Available options:
NAME,
DESCRIPTION,
START_DATE,
TAG_IDS,
LOCATION_ID,
ASSIGNED_BY_ID,
STEP_NUMBER,
STEP_TYPE,
STEP_DESCRIPTION,
MESSAGE_TYPE,
MINUTES_AFTER_PREVIOUS,
PARENT_STEP_ID,
SOURCE_SERVICE_ID,
SCHEDULED_DATE,
STATUS,
EVENT_ID,
TASK_ID,
TASK_TITLE,
TASK_PRIORITY,
TASK_ASSIGNEE_ID,
TASK_TEAM_ID,
TASK_DESCRIPTION,
TASK_DUE_DATE,
TASK_START_DATE,
TASK_STATUS,
SERVICE_IDS,
MEDICATION_IDS,
MEASUREMENTS,
SMS_BODY,
BRANCH_SELECTED,
BRANCH_ID,
BRANCH_NAME,
BRANCH_POSITION,
BRANCH_TAG_IDS,
CYCLE_PASS_COUNT,
CYCLE_GAP_MINUTES
oldValue
string | null
oldValueId
string | null
newValue
string | null
newValueId
string | null
batchId
string | null
createdById
string | null
cycleId
string | null
cyclePass
integer | null