Update a Dot Phrase

PATCH 
/dot_phrases/:id

Update a Dot Phrase.

Request

Path Parameters

id uuidrequired
The unique identifier of the Dot Phrase.
Example: 23A9981B-9E46-4ADB-BB0B-8E406C624540

application/json

Body

required

titlestring
A user-friendly title for the Dot Phrase. Does not impact the matching logic.
Example: Normal physical exam
triggerstring
The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.
Example: Your physical exam is normal
content_auto_update_enabledboolean
If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.
Example: false
replacementstring
The replacement text for this Dot Phrase. If the Dot Phrase's trigger is detected, this text will be suggested in the note generation's response.
Example: - Heart Examination: Normal, with regular rate and rhythm, no murmurs. - Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi. - Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly.

Responses

200

application/json

Schema

Schema

iduuidrequired

Unique identifier of the Dot Phrase.

titlestringrequired
A user-friendly title for the Dot Phrase. Does not impact the matching logic.
Example: Normal physical exam
triggerstringrequired
The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.
Example: Your physical exam is normal
content_auto_update_enabledbooleanrequired
If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.
Example: false
replacementstringrequired
The replacement text for this Dot Phrase. If the Dot Phrase's trigger is detected, this text will be suggested in the note generation's response.
Example: - Heart Examination: Normal, with regular rate and rhythm, no murmurs. - Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi. - Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "Normal physical exam",
  "trigger": "Your physical exam is normal",
  "content_auto_update_enabled": false,
  "replacement": "- Heart Examination: Normal, with regular rate and rhythm, no murmurs. - Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi. - Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly."
}