Event List

Events are triggered in Capable Health when your users take specific actions. You can subscribe to these events with a webhook. You can set up a webhook in your Capable admin portal or via our API. After creating a webhook, all the Capable Health events listed below will be sent to that webhook address. There is currently no option for subscribing to only a subset of events.

If the endpoint for one of your webhooks cannot be reached, Capable Health will try to resend events roughly 10 times over the course of three days. We will alert you if this happens to make sure you know your webhook endpoint is down.

Capable also offers an integration with Freshpaint. If you use this integration, the same events listed below will also be sent to Freshpaint and can be passed downstream to other platforms, such as vendors for user analytics and marketing campaigns.

Acuity Orders

Acuity Order Completed

{
  "event_name": "Acuity Order Completed",
  "event_type": "acuity_order",
  "patient_identity_id": "e5182e20-72bc-4acb-a498-83d5f3407fb8",
  "payload": {
    "total": 100,
    "time": "2021-12-10 13:40:27",
    "first_name": "Nate",
    "last_name": "Test",
    "phone": "(123) 456-7890",
    "email": "[email protected]",
    "notes": "",
    "status": "paid",
    "title": "PT subscription",
    "products": [
      {
        "id": 1193825,
        "name": "PT subscription",
        "quantity": 1,
        "total": 100
      }
    ],
    "order_id": "83300919",
    "topic": "completed"
  },
  "time": 1652375138
}

Appointments

Appointment Canceled

{
  "event_name": "Appointment Canceled",
  "event_type": "appointment",
  "patient_identity_id": "e5182e20-72bc-4acb-a498-83d5f3407fb8",
  "payload": {
    "id": 805108836,
    "topic": "canceled",
    "appointment_id": 805108836,
    "start": "2022-05-31 10:15:00 -0400",
    "end": "2022-05-31 10:45:00 -0400",
    "appointment_type": "Virtual Initial Consultation",
    "appointment_type_id": 29748772,
    "calendar": "Dr Test",
    "calendar_id": 6625762,
    "location": "https://capablehealt-dev.daily.co/SmW2TwOmvBKOP4iLR09l?t=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyIjoiU21XMlR3T212QktPUDRpTFIwOWwiLCJkIjoiOWQwMjg0NGUtZTMyMy00Yzk1LTk4MmMtODZhNTZhZDczMzVlIiwiaWF0IjoxNjQ5Nzg0MjY3fQ.U-qK9SNTN_4u3WX9LOk5eNyK29I01o0kNmq5iW2hRR0",
    "attendees": [
      {
        "id": "a1db6f4c-f2c6-45c0-af8c-e9465e5f72e8",
        "type": "Patient"
      }
    ]
  },
  "time": 1652375138
}

Appointment Rescheduled

{
  "event_name": "Appointment Rescheduled",
  "event_type": "appointment",
  "patient_identity_id": "e5182e20-72bc-4acb-a498-83d5f3407fb8",
  "payload": {
    "id": 805108836,
    "topic": "rescheduled",
    "appointment_id": 805108836,
    "start": "2022-05-31 10:15:00 -0400",
    "end": "2022-05-31 10:45:00 -0400",
    "appointment_type": "Virtual Initial Consultation",
    "appointment_type_id": 29748772,
    "calendar": "Dr Test",
    "calendar_id": 6625762,
    "location": "https://capablehealt-dev.daily.co/SmW2TwOmvBKOP4iLR09l?t=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyIjoiU21XMlR3T212QktPUDRpTFIwOWwiLCJkIjoiOWQwMjg0NGUtZTMyMy00Yzk1LTk4MmMtODZhNTZhZDczMzVlIiwiaWF0IjoxNjQ5Nzg0MjY3fQ.U-qK9SNTN_4u3WX9LOk5eNyK29I01o0kNmq5iW2hRR0",
    "attendees": [
      {
        "id": "a1db6f4c-f2c6-45c0-af8c-e9465e5f72e8",
        "type": "Patient"
      }
    ]
  },
  "time": 1652375138
}

Appointment Scheduled

{
  "event_name": "Appointment Scheduled",
  "event_type": "appointment",
  "patient_identity_id": "e5182e20-72bc-4acb-a498-83d5f3407fb8",
  "payload": {
    "id": 805108836,
    "topic": "scheduled",
    "appointment_id": 805108836,
    "start": "2022-05-31 10:15:00 -0400",
    "end": "2022-05-31 10:45:00 -0400",
    "appointment_type": "Virtual Initial Consultation",
    "appointment_type_id": 29748772,
    "calendar": "Dr Test",
    "calendar_id": 6625762,
    "location": "",
    "attendees": [
      {
        "id": "a1db6f4c-f2c6-45c0-af8c-e9465e5f72e8",
        "type": "Patient"
      }
    ]
  },
  "time": 1652375138
}

Care Plans

Care Plan Create

{
  "event_name": "Care Plan Create",
  "event_type": "care_plan",
  "patient_identity_id": "e653b779-403b-4e68-a480-5d2b14f9e317",
  "payload": {
    "id": "b8fe1cee-b359-4cc3-a19e-88629577bb31",
    "name": "Lubowitz and Sons",
    "description": null,
    "status": "active",
    "created_at": "2022-05-12T17:05:37.696Z",
    "updated_at": "2022-05-12T17:05:37.696Z",
    "tag_list": [
    ],
    "cms_entry_id": null,
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375137
}

Care Plan Update

{
  "event_name": "Care Plan Update",
  "event_type": "care_plan",
  "patient_identity_id": "e653b779-403b-4e68-a480-5d2b14f9e317",
  "payload": {
    "id": "b8fe1cee-b359-4cc3-a19e-88629577bb31",
    "name": "Lubowitz and Sons",
    "description": null,
    "status": "completed",
    "created_at": "2022-05-12T17:05:37.696Z",
    "updated_at": "2022-05-12T17:05:37.720Z",
    "tag_list": [
    ],
    "cms_entry_id": null,
    "before_update": {
      "id": "b8fe1cee-b359-4cc3-a19e-88629577bb31",
      "name": "Lubowitz and Sons",
      "description": null,
      "status": "active",
      "created_at": null,
      "updated_at": "2022-05-12T17:05:37.696Z",
      "tag_list": [
      ],
      "cms_entry_id": null
    },
    "topic": "update",
    "version": "1.0"
  },
  "time": 1652375137
}

Goals

Goal Create

{
  "event_name": "Goal Create",
  "event_type": "goal",
  "patient_identity_id": "e6b770ce-dbc0-4586-996d-d3ff030372f7",
  "payload": {
    "id": "358a1a63-e513-48a1-ab4e-735a3794860a",
    "name": "Red Delight",
    "description": null,
    "achievement_status": "in_progress",
    "start_on": null,
    "due_on": null,
    "care_plan_id": "fbcfa1b8-f484-4c54-ab90-19883fa06d8f",
    "tag_list": [
    ],
    "cms_entry_id": null,
    "created_at": "2022-05-12T17:05:38.980Z",
    "updated_at": "2022-05-12T17:05:38.980Z",
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375139
}

Goal Update

{
  "event_name": "Goal Update",
  "event_type": "goal",
  "patient_identity_id": "e6b770ce-dbc0-4586-996d-d3ff030372f7",
  "payload": {
    "id": "358a1a63-e513-48a1-ab4e-735a3794860a",
    "name": "Red Delight",
    "description": null,
    "achievement_status": "not_achieved",
    "start_on": null,
    "due_on": null,
    "care_plan_id": "fbcfa1b8-f484-4c54-ab90-19883fa06d8f",
    "tag_list": [
    ],
    "cms_entry_id": null,
    "created_at": "2022-05-12T17:05:38.980Z",
    "updated_at": "2022-05-12T17:05:39.004Z",
    "before_update": {
      "id": "358a1a63-e513-48a1-ab4e-735a3794860a",
      "name": "Red Delight",
      "description": null,
      "achievement_status": "in_progress",
      "start_on": null,
      "due_on": null,
      "care_plan_id": "fbcfa1b8-f484-4c54-ab90-19883fa06d8f",
      "tag_list": [
      ],
      "cms_entry_id": null,
      "created_at": null,
      "updated_at": "2022-05-12T17:05:38.980Z"
    },
    "topic": "update",
    "version": "1.0"
  },
  "time": 1652375139
}

Lab Test Orders

The following events are related to lab test orders. They are triggered by analogous events sent to Capable Health by a lab test vendor. They will only be sent if you have set up an account with a lab test vendor and create lab test orders through Capable Health.

The value of order_status will always be one of the following: draft, order_placed, shipped_to_patient, delivered_to_patient, shipped_to_lab, delivered_to_lab, and results_ready

They will only be sent if you have set up an account with Curexa and create medication orders through Capable Health.

event_name: "Lab Test Order Create", order_status: "draft"

event_name: "Lab Test Order Update", order_status: "order_placed"

event_name: "Lab Test Order Update", order_status: "shipped_to_patient"

event_name: "Lab Test Order Update", order_status: "delivered_to_patient"

event_name: "Lab Test Order Update", order_status: "shipped_to_lab"

event_name: "Lab Test Order Update", order_status: "delivered_to_lab"

event_name: "Lab Test Order Update", order_status: "results_ready"

Alternatively, you could have some error status: on_hold, cancelled
In that case, you should refer to the order#status_details property to know more

Lab Test Order Create

{
  "event_name": "Lab Test Order Create",
  "event_type": "lab_test_order",
  "patient_identity_id": "643bc0d3-e645-4945-b3dc-85c298aa629f",
  "payload": {
    "id": "c0030089-6b63-41a5-9d33-66247b49b6f6",
    "order_status": null,
    "patient_id": "e0bc2c7e-e7e2-423f-91d9-736f7e135484",
    "patient_lab_tests": [
      {
        "id": "ea8fbb6c-c9ed-43fb-9434-a9a0c23ea631",
        "product_id": "b4e8f96d-1c33-48ae-9351-01d911514193",
        "lab_test_order_id": "c0030089-6b63-41a5-9d33-66247b49b6f6",
        "provider_product_id": "9296725a-2944-497c-b9d7-e6b6f3d6a10d",
        "provider_product_type": "lab_test",
        "created_at": "2022-05-12T17:05:38.310Z",
        "updated_at": "2022-05-12T17:05:38.310Z"
      }
    ],
    "provider_order_id": null,
    "created_at": "2022-05-12T17:05:38.304Z",
    "updated_at": "2022-05-12T17:05:38.304Z",
    "observation_ids": [
    ],
    "carrier_service": null,
    "tracking_number": null,
    "status_details": null,
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375138
}

Lab Test Order Update

{
  "event_name": "Lab Test Order Update",
  "event_type": "lab_test_order",
  "patient_identity_id": "643bc0d3-e645-4945-b3dc-85c298aa629f",
  "payload": {
    "id": "c0030089-6b63-41a5-9d33-66247b49b6f6",
    "order_status": null,
    "patient_id": "e0bc2c7e-e7e2-423f-91d9-736f7e135484",
    "patient_lab_tests": [
      {
        "id": "ea8fbb6c-c9ed-43fb-9434-a9a0c23ea631",
        "product_id": "b4e8f96d-1c33-48ae-9351-01d911514193",
        "lab_test_order_id": "c0030089-6b63-41a5-9d33-66247b49b6f6",
        "provider_product_id": "9296725a-2944-497c-b9d7-e6b6f3d6a10d",
        "provider_product_type": "lab_test",
        "created_at": "2022-05-12T17:05:38.310Z",
        "updated_at": "2022-05-12T17:05:38.310Z"
      }
    ],
    "provider_order_id": null,
    "created_at": "2022-05-12T17:05:38.304Z",
    "updated_at": "2022-05-12T17:05:38.304Z",
    "observation_ids": [
    ],
    "carrier_service": null,
    "tracking_number": null,
    "status_details": null,
    "before_update": {
      "id": null,
      "order_status": null,
      "patient_id": null,
      "patient_lab_tests": [
      ],
      "provider_order_id": null,
      "created_at": null,
      "updated_at": null,
      "observation_ids": [
      ],
      "carrier_service": null,
      "tracking_number": null,
      "status_details": null
    },
    "topic": "update",
    "version": "1.0"
  },
  "time": 1652375138
}

Medication Cases

The following events are related to patient cases. They are triggered by analogous events sent to Capable Health by MD Integrations. They will only be sent if you have set up an account with MDI and create patient cases through Capable Health.

Medication Case Assigned

{
  "event_name": "Medication Case Assigned",
  "event_type": "medication_case",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "case_id": "7e335b30-ffc9-4754-9049-fc689c2d7272"
  },
  "time": 1652375138
}

Medication Case Canceled

{
  "event_name": "Medication Case Canceled",
  "event_type": "medication_case",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "case_id": "d2a97c2f-f2cb-4a98-aa7a-085ac4df2963"
  },
  "time": 1652375138
}

Medication Case Completed

{
  "event_name": "Medication Case Completed",
  "event_type": "medication_case",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "case_id": "5cb90c58-7bd4-4fa8-9254-bda529e7bc00"
  },
  "time": 1652375138
}

Medication Case Created

{
  "event_name": "Medication Case Created",
  "event_type": "medication_case",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "prioritized_at": null,
    "prioritized_reason": null,
    "created_at": "2021-10-14T16:57:49.000000Z",
    "case_type": "follow-up",
    "is_sync": false,
    "metadata": null,
    "case_id": "f4db87c8-93e0-4581-9d7e-bdda348909ab",
    "patient": {
      "first_name": "Darth",
      "last_name": "Vader",
      "email": "[email protected]",
      "date_of_birth": "1983-10-17",
      "gender": 1,
      "phone_number": "(816) 679-2211",
      "phone_type": "2",
      "active": true,
      "weight": null,
      "height": null,
      "dosespot_sync_status": "success",
      "current_medications": "Prilosec",
      "allergies": null,
      "pregnancy": true,
      "metadata": null,
      "patient_id": "16175715-bc7a-463c-81ac-8bd506022c3d",
      "gender_label": "Male",
      "driver_license": null,
      "address": {
        "address": "1 swamprat rd",
        "zip_code": "40207",
        "city_name": "Lousiville",
        "address2": null,
        "address_id": "74029344-d2e9-41b1-b642-2979e4187526",
        "state": {
          "name": "Kentucky",
          "abbreviation": "KY",
          "state_id": "79e8cd04-f6bd-4732-8b97-a83748af5ea9"
        }
      }
    },
    "partner": {
      "name": "Get Cleared",
      "has_messaging_capability": true,
      "has_support_capability": true,
      "support_email": null,
      "partner_id": "23060d80-bda0-4256-a823-9e1bd0fdc152"
    },
    "case_status": {
      "name": "assigned",
      "reason": null,
      "updated_at": "2021-10-14T16:57:50.000000Z"
    },
    "case_assignment": {
      "reason": "Initial assignment.",
      "created_at": "2021-10-14T16:57:50.000000Z",
      "case_assignment_id": "e958de2b-1def-49dc-8834-90fb56d96a2f",
      "clinician": {
        "specialty": "Staging Clinician",
        "clinician_id": "fafc3211-ffb1-4a40-99d5-02c52c72da3c",
        "full_name": "Get Cleared Staging Clinician",
        "photo": null
      }
    },
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375138
}

Medication Case Message

{
  "event_name": "Medication Case Message",
  "event_type": "medication_case",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "case_id": "2f51b2c8-5abf-4160-b3c8-bf6cfe11f37c",
    "case_message_id": "fff92b2a-6e1a-4133-b058-28246da60b76"
  },
  "time": 1652375138
}

Medication Case Processing

{
  "event_name": "Medication Case Processing",
  "event_type": "medication_case",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "case_id": "f45d2739-7a4e-4a12-be67-cdc120900b3d"
  },
  "time": 1652375138
}

Medication Case Submitted

{
  "event_name": "Medication Case Submitted",
  "event_type": "medication_case",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "case_id": "8c52c8e0-67ea-4455-9baa-f3ae9a49bd02",
    "prescriptions": [
      {
        "dosespot_prescription_id": null,
        "refills": 2,
        "quantity": 99,
        "days_supply": 30,
        "directions": "Take one at the morning and another before bed...",
        "dosespot_prescription_sync_status": "pending",
        "dosespot_sent_pharmacy_sync_status": "pending",
        "no_substitutions": true,
        "pharmacy_notes": "This medication might not be suitable for people with...",
        "dosespot_confirmation_status": "pending",
        "dosespot_confirmation_status_details": null,
        "thank_you_note": "lorem ipsum",
        "clinical_note": "lorem ipsum",
        "dispense_unit_id": 15,
        "pharmacy_id": 13012,
        "medication": {
          "dosespot_medication_id": "1495316",
          "dispense_unit_id": 26,
          "dose_form": "tablet",
          "route": "sublingual",
          "strength": "2800 BAU",
          "generic_product_name": "timothy grass pollen allergen extract 2800 BAU sublingual tablet",
          "lexi_gen_product_id": 29589,
          "lexi_drug_syn_id": 219792,
          "lexi_synonym_type_id": 60,
          "lexi_gen_drug_id": "d08256",
          "rx_cui": "1495316",
          "otc": false,
          "ndc": "52709150103",
          "schedule": "0",
          "display_name": "Grastek 2800 BAU sublingual tablet",
          "monograph_path": null,
          "drug_classification": "allergenics",
          "state_schedules": [
          ],
          "metadata": "Lorem ipum",
          "partner_medication_id": "29394cf1-379d-4767-abc0-982343980646"
        },
        "partner_compound": null
      }
    ],
    "case_services": [
      {
        "title": "teste",
        "service_type": "device",
        "directions": "direction teste",
        "description": "description testante",
        "additional_note": null,
        "case_service_id": "747664a4-c6d0-4e7f-8b2a-67880a647edd"
      },
      {
        "title": "teste device",
        "service_type": "device",
        "directions": "asdadsd",
        "description": "asdads",
        "additional_note": "asdads",
        "case_service_id": "c42ca85b-3b98-4988-a283-cb3e9ab44eca"
      }
    ]
  },
  "time": 1652375138
}

Medication Case Transfered

{
  "event_name": "Medication Case Transfered",
  "event_type": "medication_case",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "case_id": "ab887787-e2ee-4be5-810f-d7384cc7f132"
  },
  "time": 1652375138
}

Medication Case Waiting

{
  "event_name": "Medication Case Waiting",
  "event_type": "medication_case",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "case_id": "18f8d661-c4da-4621-8bcf-4e3eca56d603"
  },
  "time": 1652375138
}

Medication Case Patients

MDI Patient Update

{
  "event_name": "MDI Patient Update",
  "event_type": "medication_case_patient",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
  },
  "time": 1652375138
}

Medication Orders

The following events are related to medication orders. They are triggered by analogous events sent to Capable Health by the Curexa pharmacy. They will only be sent if you have set up an account with Curexa and create medication orders through Capable Health.

The value of order_status will always be one of the following: draft, order_placed, awaiting_shipment, shipped, delivered, cancelled, or on_hold. If an order progresses as expected, the following sequence of events will be triggered:

event_name: "Medication Order Create", order_status: "draft"

event_name: "Medication Order Update", order_status: "order_placed"

event_name: "Medication Order Update", order_status: "awaiting_shipment"

event_name: "Medication Order Update", order_status: "shipped"

event_name: "Medication Order Update", order_status: "delivered"

Medication Order Create

{
  "event_name": "Medication Order Create",
  "event_type": "medication_order",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "id": "3f0835f4-3ceb-423d-a8f6-f29c18fb4cdf",
    "order_status": "draft",
    "carrier": null,
    "carrier_service": null,
    "tracking_number": null,
    "status_details": null,
    "created_at": "2022-05-12T17:05:38.512Z",
    "updated_at": "2022-05-12T17:05:38.512Z",
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375138
}

Medication Order Update

{
  "event_name": "Medication Order Update",
  "event_type": "medication_order",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "id": "3f0835f4-3ceb-423d-a8f6-f29c18fb4cdf",
    "order_status": "shipped",
    "carrier": null,
    "carrier_service": null,
    "tracking_number": null,
    "status_details": null,
    "created_at": "2022-05-12T17:05:38.512Z",
    "updated_at": "2022-05-12T17:05:38.671Z",
    "before_update": {
      "id": "3f0835f4-3ceb-423d-a8f6-f29c18fb4cdf",
      "order_status": "draft",
      "carrier": null,
      "carrier_service": null,
      "tracking_number": null,
      "status_details": null,
      "created_at": null,
      "updated_at": "2022-05-12T17:05:38.512Z"
    },
    "topic": "update",
    "version": "1.0"
  },
  "time": 1652375138
}

Messages

Message Added

{
  "event_name": "Message Added",
  "event_type": "message",
  "patient_identity_id": "e3252652-e5ad-429e-a5ef-ca975630b03b",
  "payload": {
    "msg_author_type": "patient",
    "msg_author_email": "[email protected]",
    "msg_author_phone": "4206918365",
    "msg_author_id": "e3252652-e5ad-429e-a5ef-ca975630b03b",
    "msg_date_created": "2022-02-15T21:48:21.911Z",
    "conversation_id": "7e1d4ed0-08fd-4524-b9c1-b5cb09c759df",
    "twillio_message_sid": "IM312c67acdd2c45a8a7cabecd577da886"
  },
  "time": 1652375138
}

Observations

Observation Create

{
  "event_name": "Observation Create",
  "event_type": "observation",
  "patient_identity_id": "fab00867-95a7-4adf-9e6f-93c9a6be08ba",
  "payload": {
    "id": "d337dfde-1f1c-45a1-8be4-9b3fa7e35b40",
    "target_id": null,
    "observation_type_id": "9fbb72aa-007e-4f3a-8ba3-cd6ffd891599",
    "observed_value": "2021-09-15",
    "observed_date": "2022-05-12T17:05:37.580Z",
    "created_at": "2022-05-12T17:05:37.580Z",
    "source_type": "User",
    "source_id": "76c2cbcc-94e4-4809-b7e6-288bdde50c14",
    "note": null,
    "data_type": "datetime",
    "unit": null,
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375137
}

Patients

Patient Invitee Invite

{
  "event_name": "Patient Invitee Invite",
  "event_type": "patient",
  "patient_identity_id": "4f835954-ff74-4fdf-9631-3422006af3f0",
  "payload": {
    "inviter": {
      "identity_id": "5dbbf0c1-fb6b-40a0-b9bf-82c551ddb2e0",
      "email": "[email protected]",
      "first_name": null,
      "middle_name": null,
      "last_name": null,
      "birth_date": null,
      "addresses": [
      ],
      "phones": [
      ],
      "administrative_gender": null,
      "gender_identity": null,
      "organization_ids": [
      ],
      "external_id": null,
      "created_at": "2022-05-12T17:05:39.169Z",
      "updated_at": "2022-05-12T17:05:39.169Z",
      "primary_phone": null
    },
    "invitee": {
      "identity_id": "4f835954-ff74-4fdf-9631-3422006af3f0",
      "email": "[email protected]",
      "first_name": null,
      "middle_name": null,
      "last_name": null,
      "birth_date": null,
      "addresses": [
      ],
      "phones": [
      ],
      "administrative_gender": null,
      "gender_identity": null,
      "organization_ids": [
      ],
      "external_id": null,
      "created_at": "2022-05-12T17:05:39.200Z",
      "updated_at": "2022-05-12T17:05:39.200Z",
      "primary_phone": null
    }
  },
  "time": 1652375139
}

Patient Inviter Invite

{
  "event_name": "Patient Inviter Invite",
  "event_type": "patient",
  "patient_identity_id": "4f835954-ff74-4fdf-9631-3422006af3f0",
  "payload": {
    "inviter": {
      "identity_id": "5dbbf0c1-fb6b-40a0-b9bf-82c551ddb2e0",
      "email": "[email protected]",
      "first_name": null,
      "middle_name": null,
      "last_name": null,
      "birth_date": null,
      "addresses": [
      ],
      "phones": [
      ],
      "administrative_gender": null,
      "gender_identity": null,
      "organization_ids": [
      ],
      "external_id": null,
      "created_at": "2022-05-12T17:05:39.169Z",
      "updated_at": "2022-05-12T17:05:39.169Z",
      "primary_phone": null
    },
    "invitee": {
      "identity_id": "4f835954-ff74-4fdf-9631-3422006af3f0",
      "email": "[email protected]",
      "first_name": null,
      "middle_name": null,
      "last_name": null,
      "birth_date": null,
      "addresses": [
      ],
      "phones": [
      ],
      "administrative_gender": null,
      "gender_identity": null,
      "organization_ids": [
      ],
      "external_id": null,
      "created_at": "2022-05-12T17:05:39.200Z",
      "updated_at": "2022-05-12T17:05:39.200Z",
      "primary_phone": null
    }
  },
  "time": 1652375139
}

Patient Create

{
  "event_name": "Patient Create",
  "event_type": "patient",
  "patient_identity_id": "3d5eb787-68af-4d74-96ef-13d3cdbf7306",
  "payload": {
    "identity_id": "3d5eb787-68af-4d74-96ef-13d3cdbf7306",
    "email": "[email protected]",
    "first_name": null,
    "middle_name": null,
    "last_name": null,
    "birth_date": null,
    "addresses": [
    ],
    "phones": [
      {
        "id": "8cf2fe5c-02b3-454d-9e5e-4582d1ba5a10",
        "number": "1-459-680-6465 x97368",
        "active": true,
        "user_id": "a8a7491f-0829-480b-b5d8-e6e83d546cd0",
        "created_at": "2022-05-12T17:05:38.171Z",
        "updated_at": "2022-05-12T17:05:38.171Z",
        "primary": true,
        "label": null
      }
    ],
    "administrative_gender": null,
    "gender_identity": null,
    "organization_ids": [
    ],
    "external_id": null,
    "created_at": "2022-05-12T17:05:38.166Z",
    "updated_at": "2022-05-12T17:05:38.166Z",
    "primary_phone": "1-459-680-6465 x97368",
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375138
}

Patient Update

{
  "event_name": "Patient Update",
  "event_type": "patient",
  "patient_identity_id": "3d5eb787-68af-4d74-96ef-13d3cdbf7306",
  "payload": {
    "identity_id": "3d5eb787-68af-4d74-96ef-13d3cdbf7306",
    "email": "[email protected]",
    "first_name": null,
    "middle_name": null,
    "last_name": null,
    "birth_date": null,
    "addresses": [
    ],
    "phones": [
      {
        "id": "8cf2fe5c-02b3-454d-9e5e-4582d1ba5a10",
        "number": "1-459-680-6465 x97368",
        "active": true,
        "user_id": "a8a7491f-0829-480b-b5d8-e6e83d546cd0",
        "created_at": "2022-05-12T17:05:38.171Z",
        "updated_at": "2022-05-12T17:05:38.171Z",
        "primary": true,
        "label": null
      }
    ],
    "administrative_gender": null,
    "gender_identity": null,
    "organization_ids": [
    ],
    "external_id": null,
    "created_at": "2022-05-12T17:05:38.166Z",
    "updated_at": "2022-05-12T17:05:38.187Z",
    "primary_phone": "1-459-680-6465 x97368",
    "before_update": {
      "identity_id": "3d5eb787-68af-4d74-96ef-13d3cdbf7306",
      "email": "[email protected]",
      "first_name": null,
      "middle_name": null,
      "last_name": null,
      "birth_date": null,
      "addresses": [
      ],
      "phones": [
        {
          "id": "8cf2fe5c-02b3-454d-9e5e-4582d1ba5a10",
          "number": "1-459-680-6465 x97368",
          "active": true,
          "user_id": "a8a7491f-0829-480b-b5d8-e6e83d546cd0",
          "created_at": "2022-05-12T17:05:38.171Z",
          "updated_at": "2022-05-12T17:05:38.171Z",
          "primary": true,
          "label": null
        }
      ],
      "administrative_gender": null,
      "gender_identity": null,
      "organization_ids": [
      ],
      "external_id": null,
      "created_at": null,
      "updated_at": "2022-05-12T17:05:38.166Z",
      "primary_phone": "1-459-680-6465 x97368"
    },
    "topic": "update",
    "version": "1.0"
  },
  "time": 1652375138
}

Patient Medications

Patient Medication Create

{
  "event_name": "Patient Medication Create",
  "event_type": "patient_medication",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "id": "b908800e-8be1-4c75-8827-78602aea9aa1",
    "name": "Earl Grey",
    "external_pharmacy_name": null,
    "external_pharmacy_id": null,
    "external_case_id": "27e16492-e73d-4275-afc3-b7b3c4c03fc3",
    "patient_unique_email": "[email protected]",
    "refills_left": 0,
    "refills_prescribed": 0,
    "over_the_counter": false,
    "next_reorder_date": null,
    "medication_order_ids": [
    ],
    "patient_id": "90e5d020-1d51-4b8d-8d3c-06652a9dca2d",
    "created_at": "2022-05-12T17:05:38.559Z",
    "prescribing_doctor": null,
    "quantity_dispensed": null,
    "external_medication_id": null,
    "days_supply": null,
    "directions": null,
    "compound": null,
    "updated_at": "2022-05-12T17:05:38.559Z",
    "last_order_status": null,
    "status": "created",
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375138
}

Patient Medication Update

{
  "event_name": "Patient Medication Update",
  "event_type": "patient_medication",
  "patient_identity_id": "fe1ac0ef-f086-47a8-8c0b-8566ed57d89f",
  "payload": {
    "id": "b908800e-8be1-4c75-8827-78602aea9aa1",
    "name": "Earl Grey",
    "external_pharmacy_name": null,
    "external_pharmacy_id": null,
    "external_case_id": "27e16492-e73d-4275-afc3-b7b3c4c03fc3",
    "patient_unique_email": "[email protected]",
    "refills_left": 0,
    "refills_prescribed": 0,
    "over_the_counter": false,
    "next_reorder_date": null,
    "medication_order_ids": [
    ],
    "patient_id": "90e5d020-1d51-4b8d-8d3c-06652a9dca2d",
    "created_at": "2022-05-12T17:05:38.559Z",
    "prescribing_doctor": null,
    "quantity_dispensed": null,
    "external_medication_id": null,
    "days_supply": null,
    "directions": null,
    "compound": null,
    "updated_at": "2022-05-12T17:05:38.687Z",
    "last_order_status": null,
    "status": "completed",
    "before_update": {
      "id": "b908800e-8be1-4c75-8827-78602aea9aa1",
      "name": "Earl Grey",
      "external_pharmacy_name": null,
      "external_pharmacy_id": null,
      "external_case_id": "27e16492-e73d-4275-afc3-b7b3c4c03fc3",
      "patient_unique_email": "[email protected]",
      "refills_left": 0,
      "refills_prescribed": 0,
      "over_the_counter": false,
      "next_reorder_date": null,
      "medication_order_ids": [
      ],
      "patient_id": "90e5d020-1d51-4b8d-8d3c-06652a9dca2d",
      "created_at": null,
      "prescribing_doctor": null,
      "quantity_dispensed": null,
      "external_medication_id": null,
      "days_supply": null,
      "directions": null,
      "compound": null,
      "updated_at": "2022-05-12T17:05:38.559Z",
      "last_order_status": null,
      "status": "created"
    },
    "topic": "update",
    "version": "1.0"
  },
  "time": 1652375138
}

Patient Related Persons

Patient Related Person Create

{
  "event_name": "Patient Related Person Create",
  "event_type": "patient_related_person",
  "patient_identity_id": "e4448214-ee26-4155-ba34-b1e5e10134c1",
  "payload": {
    "id": "a883b545-e677-4608-a560-bc767973aaa9",
    "relationship_type": "adoptive mother",
    "patient_id": "5338c2b3-ccc2-42ed-826c-1d572190bf7d",
    "related_person_id": "5bd943e9-f9ef-4b52-b8a0-c9e12879d3ab",
    "related_person_type": "User",
    "created_at": "2022-05-12T17:05:39.106Z",
    "updated_at": "2022-05-12T17:05:39.106Z",
    "patient": {
      "identity_id": "7f73a4a0-12ee-412e-b93a-713b654692c5"
    },
    "related_person": {
      "identity_id": "e4448214-ee26-4155-ba34-b1e5e10134c1"
    },
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375139
}

Submissions

Submission Create

{
  "event_name": "Submission Create",
  "event_type": "submission",
  "patient_identity_id": "ab456a9a-4b88-43d4-a6bd-8274002dd035",
  "payload": {
    "id": "6691489e-4907-4c23-bd55-b158c1ca4047",
    "questionnaire_id": "29350eb0-0be4-4f24-9ef7-a845826a80c2",
    "metadata": {
    },
    "status": "draft",
    "created_at": "2022-05-12T17:05:38.000Z",
    "updated_at": "2022-05-12T17:05:38.000Z",
    "user_id": "202085e3-3f8f-4914-88c7-d545a2bad457",
    "survey_id": "361c5301-074d-4298-b854-cdcef3ac5d9b",
    "survey_name": "Boehm, Mosciski and Romaguera",
    "completed": false,
    "last_response": {
      "id": "02f05a60-3cf7-4e2f-85ed-368f443a0b80",
      "content": "minima",
      "question_content": "Rerum asperiores sit magnam?",
      "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
      "question_id": "a5b367dc-8be7-43ff-a6d6-dc710f7cee60",
      "answer_id": null,
      "created_at": "2022-05-12T17:05:38.066Z",
      "updated_at": "2022-05-12T17:05:38.066Z",
      "status": "active"
    },
    "last_response_question": {
      "id": "a5b367dc-8be7-43ff-a6d6-dc710f7cee60",
      "title": "Rerum asperiores sit magnam?",
      "position": 3,
      "status": "active",
      "questionnaire_id": "361c5301-074d-4298-b854-cdcef3ac5d9b",
      "created_at": "2022-05-12T17:05:38.062Z",
      "updated_at": "2022-05-12T17:05:38.062Z",
      "metadata": {
      },
      "required": false,
      "observation_type_id": null
    },
    "last_response_question_pos": 3,
    "last_response_question_title": "Rerum asperiores sit magnam?",
    "total_questions_responded": 3,
    "responses": [
      {
        "id": "1def1167-df39-4ac1-87c4-c3bf3e977f24",
        "content": "dicta",
        "question_content": "Provident eum iste aut?",
        "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
        "question_id": "7c1aed21-2c82-4f7c-9286-8e5ce9388bca",
        "answer_id": null,
        "created_at": "2022-05-12T17:05:38.025Z",
        "updated_at": "2022-05-12T17:05:38.025Z",
        "status": "active"
      },
      {
        "id": "714df3be-efa7-45d9-953f-ff5132572d3c",
        "content": "sint",
        "question_content": "Quis totam et ex?",
        "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
        "question_id": "02959508-5a70-484e-9a09-99b76ffcbbf1",
        "answer_id": null,
        "created_at": "2022-05-12T17:05:38.046Z",
        "updated_at": "2022-05-12T17:05:38.046Z",
        "status": "active"
      },
      {
        "id": "02f05a60-3cf7-4e2f-85ed-368f443a0b80",
        "content": "minima",
        "question_content": "Rerum asperiores sit magnam?",
        "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
        "question_id": "a5b367dc-8be7-43ff-a6d6-dc710f7cee60",
        "answer_id": null,
        "created_at": "2022-05-12T17:05:38.066Z",
        "updated_at": "2022-05-12T17:05:38.066Z",
        "status": "active"
      }
    ],
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375138
}

Submission Update

{
  "event_name": "Submission Update",
  "event_type": "submission",
  "patient_identity_id": "ab456a9a-4b88-43d4-a6bd-8274002dd035",
  "payload": {
    "id": "6691489e-4907-4c23-bd55-b158c1ca4047",
    "questionnaire_id": "29350eb0-0be4-4f24-9ef7-a845826a80c2",
    "metadata": {
    },
    "status": "completed",
    "created_at": "2022-05-12T17:05:38.000Z",
    "updated_at": "2022-05-12T17:05:38.092Z",
    "user_id": "202085e3-3f8f-4914-88c7-d545a2bad457",
    "survey_id": "361c5301-074d-4298-b854-cdcef3ac5d9b",
    "survey_name": "Boehm, Mosciski and Romaguera",
    "completed": true,
    "last_response": {
      "id": "02f05a60-3cf7-4e2f-85ed-368f443a0b80",
      "content": "minima",
      "question_content": "Rerum asperiores sit magnam?",
      "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
      "question_id": "a5b367dc-8be7-43ff-a6d6-dc710f7cee60",
      "answer_id": null,
      "created_at": "2022-05-12T17:05:38.066Z",
      "updated_at": "2022-05-12T17:05:38.066Z",
      "status": "active"
    },
    "last_response_question": {
      "id": "a5b367dc-8be7-43ff-a6d6-dc710f7cee60",
      "title": "Rerum asperiores sit magnam?",
      "position": 3,
      "status": "active",
      "questionnaire_id": "361c5301-074d-4298-b854-cdcef3ac5d9b",
      "created_at": "2022-05-12T17:05:38.062Z",
      "updated_at": "2022-05-12T17:05:38.062Z",
      "metadata": {
      },
      "required": false,
      "observation_type_id": null
    },
    "last_response_question_pos": 3,
    "last_response_question_title": "Rerum asperiores sit magnam?",
    "total_questions_responded": 3,
    "responses": [
      {
        "id": "1def1167-df39-4ac1-87c4-c3bf3e977f24",
        "content": "dicta",
        "question_content": "Provident eum iste aut?",
        "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
        "question_id": "7c1aed21-2c82-4f7c-9286-8e5ce9388bca",
        "answer_id": null,
        "created_at": "2022-05-12T17:05:38.025Z",
        "updated_at": "2022-05-12T17:05:38.025Z",
        "status": "active"
      },
      {
        "id": "714df3be-efa7-45d9-953f-ff5132572d3c",
        "content": "sint",
        "question_content": "Quis totam et ex?",
        "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
        "question_id": "02959508-5a70-484e-9a09-99b76ffcbbf1",
        "answer_id": null,
        "created_at": "2022-05-12T17:05:38.046Z",
        "updated_at": "2022-05-12T17:05:38.046Z",
        "status": "active"
      },
      {
        "id": "02f05a60-3cf7-4e2f-85ed-368f443a0b80",
        "content": "minima",
        "question_content": "Rerum asperiores sit magnam?",
        "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
        "question_id": "a5b367dc-8be7-43ff-a6d6-dc710f7cee60",
        "answer_id": null,
        "created_at": "2022-05-12T17:05:38.066Z",
        "updated_at": "2022-05-12T17:05:38.066Z",
        "status": "active"
      }
    ],
    "before_update": {
      "id": "6691489e-4907-4c23-bd55-b158c1ca4047",
      "questionnaire_id": "29350eb0-0be4-4f24-9ef7-a845826a80c2",
      "metadata": {
      },
      "status": "draft",
      "created_at": null,
      "updated_at": "2022-05-12T17:05:38.000Z",
      "user_id": "202085e3-3f8f-4914-88c7-d545a2bad457",
      "survey_id": "361c5301-074d-4298-b854-cdcef3ac5d9b",
      "survey_name": "Boehm, Mosciski and Romaguera",
      "completed": false,
      "last_response": {
        "id": "02f05a60-3cf7-4e2f-85ed-368f443a0b80",
        "content": "minima",
        "question_content": "Rerum asperiores sit magnam?",
        "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
        "question_id": "a5b367dc-8be7-43ff-a6d6-dc710f7cee60",
        "answer_id": null,
        "created_at": "2022-05-12T17:05:38.066Z",
        "updated_at": "2022-05-12T17:05:38.066Z",
        "status": "active"
      },
      "last_response_question": {
        "id": "a5b367dc-8be7-43ff-a6d6-dc710f7cee60",
        "title": "Rerum asperiores sit magnam?",
        "position": 3,
        "status": "active",
        "questionnaire_id": "361c5301-074d-4298-b854-cdcef3ac5d9b",
        "created_at": "2022-05-12T17:05:38.062Z",
        "updated_at": "2022-05-12T17:05:38.062Z",
        "metadata": {
        },
        "required": false,
        "observation_type_id": null
      },
      "last_response_question_pos": 3,
      "last_response_question_title": "Rerum asperiores sit magnam?",
      "total_questions_responded": 3,
      "responses": [
        {
          "id": "1def1167-df39-4ac1-87c4-c3bf3e977f24",
          "content": "dicta",
          "question_content": "Provident eum iste aut?",
          "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
          "question_id": "7c1aed21-2c82-4f7c-9286-8e5ce9388bca",
          "answer_id": null,
          "created_at": "2022-05-12T17:05:38.025Z",
          "updated_at": "2022-05-12T17:05:38.025Z",
          "status": "active"
        },
        {
          "id": "714df3be-efa7-45d9-953f-ff5132572d3c",
          "content": "sint",
          "question_content": "Quis totam et ex?",
          "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
          "question_id": "02959508-5a70-484e-9a09-99b76ffcbbf1",
          "answer_id": null,
          "created_at": "2022-05-12T17:05:38.046Z",
          "updated_at": "2022-05-12T17:05:38.046Z",
          "status": "active"
        },
        {
          "id": "02f05a60-3cf7-4e2f-85ed-368f443a0b80",
          "content": "minima",
          "question_content": "Rerum asperiores sit magnam?",
          "submission_id": "6691489e-4907-4c23-bd55-b158c1ca4047",
          "question_id": "a5b367dc-8be7-43ff-a6d6-dc710f7cee60",
          "answer_id": null,
          "created_at": "2022-05-12T17:05:38.066Z",
          "updated_at": "2022-05-12T17:05:38.066Z",
          "status": "active"
        }
      ]
    },
    "topic": "update",
    "version": "1.0"
  },
  "time": 1652375138
}

Tasks

Task Create

{
  "event_name": "Task Create",
  "event_type": "task",
  "patient_identity_id": "6c6417a3-42bc-4c6f-b4f6-3541018f8a77",
  "payload": {
    "id": "f9c4c402-43cb-4099-9616-92e96d43f0a1",
    "name": "Bluebery Solstice",
    "description": null,
    "achievement_status": "in_progress",
    "due_on": null,
    "care_plan_id": "e529dc7a-0cd1-4f27-825b-06f7ece82a5b",
    "tag_list": [
    ],
    "cms_entry_id": null,
    "created_at": "2022-05-12T17:05:39.333Z",
    "updated_at": "2022-05-12T17:05:39.333Z",
    "topic": "create",
    "version": "1.0"
  },
  "time": 1652375139
}

Task Update

{
  "event_name": "Task Update",
  "event_type": "task",
  "patient_identity_id": "6c6417a3-42bc-4c6f-b4f6-3541018f8a77",
  "payload": {
    "id": "f9c4c402-43cb-4099-9616-92e96d43f0a1",
    "name": "Bluebery Solstice",
    "description": null,
    "achievement_status": "cancelled",
    "due_on": null,
    "care_plan_id": "e529dc7a-0cd1-4f27-825b-06f7ece82a5b",
    "tag_list": [
    ],
    "cms_entry_id": null,
    "created_at": "2022-05-12T17:05:39.333Z",
    "updated_at": "2022-05-12T17:05:39.356Z",
    "before_update": {
      "id": "f9c4c402-43cb-4099-9616-92e96d43f0a1",
      "name": "Bluebery Solstice",
      "description": null,
      "achievement_status": "in_progress",
      "due_on": null,
      "care_plan_id": "e529dc7a-0cd1-4f27-825b-06f7ece82a5b",
      "tag_list": [
      ],
      "cms_entry_id": null,
      "created_at": null,
      "updated_at": "2022-05-12T17:05:39.333Z"
    },
    "topic": "update",
    "version": "1.0"
  },
  "time": 1652375139
}


Did this page help you?