Tags

Create a new tag

Create a tag in the EMR. A created tag can be applied to a patient via the Patient Tags endpoint.

post/tags

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/tags
  • Auth: HTTP basic

Request body

namestring required

Name of the tag. The name must be unique.

categorystring required

Category for the tag.

descriptionstring required

Description for the tag.

displays_on_dashboolean nullable required

Display the tag under the associated patient photo block when the patient chart or encounter note is opened.

note_displays_on_dashboardboolean nullable required

Display the full text of any associated tag note in addition to showing the existence of the tag on the dashboard. This behavior is dependent on displays_on_dash being true as well.

displays_on_calendarboolean nullable required

Display in the scheduler interface when scheduling an appointment for a tagged patient.

colorstring nullable required

A valid six-digit hex code that defines the color for the tag.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.