HEheidihealth
Heidi API

Get Template

Changed on

Return a single consult-note or document template.

get/api/v2/ml-scribe/open-api/templates/{template_id}

Request

  • Base URL
    https://au.api.heidihealth.com
  • Auth
    HTTP bearer

Path parameters

template_idstring required
Example:5eb7cf5a86d9755df3a6c593

Response

Successful Response

is_privateboolean
team_idstring nullable
template_author_group'Heidi' | 'Community' | 'Team' | 'User'
template_visibility'Community' | 'Team' | 'User' | 'Heidi' | 'Organization'
source_template_idstring nullable
template_gallery_sharing_preference_show_nameboolean
template_gallery_sharing_preference_show_clinicboolean
template_gallery_sharing_preference_show_profile_pictureboolean
shared_team_idsstring[] nullable

An array of team_ids that the template is shared with

kinde_user_idstring required
created_timestring date-time nullable
updated_timestring date-time nullable
deleted_atstring date-time nullable
template_gallery_url_pathstring nullable
is_structured_templateboolean
global_last_usedstring date-time nullable

Last time the template was used by any user (global usage timestamp)

global_usageinteger

Total number of times the template has been used across all users (global usage counter)

last_modified_ia_feedback_loopstring date-time nullable
namestring required
structure_templatestring
descriptionstring nullable
tone_templatestring nullable
template_category'CONSULT_NOTE_TEMPLATE' | 'DOCUMENT_TEMPLATE' | 'FORM_TEMPLATE' | 'ASSESSMENT_TEMPLATE' | 'LETTER_TEMPLATE'
template_htmlstring nullable
template_jsonstring nullable
sectional_note_ehr_provider'Epic Systems' | 'Other' | 'Heidi'
s3_object_keystring nullable
version_control_idstring nullable
original_v1_structure_templatestring nullable
list_order_priorityinteger nullable
should_deduct_quotaboolean
organization_idstring nullable

The organization_id the template belongs to

idstring required
usageinteger
is_favoriteboolean
added_to_favorite_atstring date-time nullable
is_pinnedboolean
added_to_pinned_atstring date-time nullable
last_usedstring date-time nullable
is_editableboolean
is_publishableboolean
author_namestring
review_status'PENDING' | 'APPROVED' | 'REJECTED' | 'UNNECESSARY'

Example response

{
  "team_id": "5eb7cf5a86d9755df3a6c593",
  "shared_team_ids": [
    "5eb7cf5a86d9755df3a6c593"
  ],
  "version_control_id": "5eb7cf5a86d9755df3a6c593",
  "organization_id": "5eb7cf5a86d9755df3a6c593",
  "id": "5eb7cf5a86d9755df3a6c593"
}

Changes