Introduction

Heim appointments may include steps that involve collecting data about the Patient such as blood pressure. All such data created during the lifecycle of an appointment is stored within the data object within an appointment. The data object has a variable schema to reflect the variable and optional data that may or may not be present depending on the task steps within the appointment.

Please speak with your account manager or contact your integration lead to discuss how you can take advantage of data to improve your patient and appointment management.

Viewing data

1. View the appointment data object on the appointment detail, task steps page
   1. Open the appointments dashboard: https://app.heim.health/dashboard/appointments
   2. Choose an appointment in the list and click "View"
   3. Click on "Task Steps" in the side menu
   4. If a step is sub-titled "Reading" then it will store that reading in the appointment data object
2. View the data by making an API call:
   1. call to GET Appointment and see the data property within the appointment object
   2. call to GET All Appointments and see the data property within each appointment object in the list of objects

Example data object

Within this appointment object are blood pressure readings taking during the appointment.

{
  "data": {
    "bp": {
      "dia": 78,
      "sys": 112
    }
  },
}

Additional data with varying schema may be present alongside, or instead of, blood pressure.