Introduction

The Heim platfom is designed to manage complex care tasks where your Organisation requires control over important actions and messaging. To achieve this you can supply extra information using the flexible metadata object on an Appointment. This data is then available for use across the lifecycle of the Appointment.

Please speak with your account manager, or contact your integration lead to discuss how you can take advantage of metadata to improve the task outcome.

Viewing metadata

You can view the current metadata associated with the Appointment in three ways:

1. View the metadata tab on the appointment detail page in the dashboard
   1. Open the dashboard: https://app.heim.health/dashboard/appointments
   2. Choose an appointment in the list and click "view"
   3. If the appointment has metadata, then a tab will be available called "Metadata" along with the other "Summary" and "Timeline" tabs.
   4. If no metadata exists, then the tab is not displayed
2. View the metadata by making an API call:
   1. call to GET Appointment
   2. call to GET appointments

Example uses

Specifying sample tube type and quantity

If your task includes phlebotomy you can specify the type and quantity of blood sample tubes that you need to support different panels of diagnostic tests. This information is then displayed to the Practitioner who is completing the task.

{
  "tubes": [
    { "type": "SST", "quantity": 2, "top": "yellow" },
    { "type": "EDTA", "quantity": 1, "top": "purple" }
  ]
}

If you are using the standard Heim test request form, you can also add additional information that will be useful to the laboratory for processing, for example:

{
  "tubes": [
    { "type": "SST", "quantity": 2, "top": "yellow" },
    { "type": "EDTA", "quantity": 1, "top": "purple" }
  ],
  "clientReferenceCode": "OIAUSDASDA",
  "panel":"CARDIO1"
}

and the Practitioner can add this additional information to the test request form.

Including tracking information in messages to Patient

If you have already dispatched equipment to a Patient, and you have a tracking number, you could supply this tracking number to us when you create the Appointment, or subsequently via an update to the Appointment. For example, you could provide the following object in the metadata property:

{'tracking_number' : 'RMHSD8WLF'}

And this can be included in and email or SMS messages by including:

Your appointment with Acme is on Thursday 24th Feb at 1:15PM. 
Please contact support if you have not received your ECG monitor.
To track this item click: 
https://www.royalmail.com/portal/rm/track?trackNumber={{appointment.metadata.tracking_number}}