The treatment_plan.created
webhook is triggered when a treatment plan is activated.
Treatment plans are created in draft mode.
A practitioner or staff member activates a treatment plan to share it with the patient.
Scopes needed: | patients:treatment_plan_history |
Event payload: | a subset of the treatment plan object |
"event_payload": {
"event": {
"id": "x5xxxxx8-92x7-4xxx-9x0x-345x404x94x1",
"type": "treatment_plan.created",
"created_at": "2018-10-16T04:00:00.000Z",
"clinic_id": "xx7x357x-9x36-xxxx-x553-7x3xx398xxx",
"data": {
"treatment_plan": {
"id": "xx45x0xx-x840-41xx-9922-98xx6001507x",
"active": "true",
"available_at": "2018-03-02",
"recommendations": [
{
"variant_id": "xx2688x2-4303-4278-xx73-x7083x6146x1",
"refill": false,
"units_to_purchase": 10,
"take_with": "food",
"dosage": {
"amount": "1-2",
"frequency": "once per day",
"duration": null,
"format": "capsule",
"additional_info": "with food",
"time_of_day": [
"morning"
]
}
}
]
}
}
}
}