Skip to main content

Per-section note customization options

In addition to specifying a template that the generated note will conform to, you can customize each section's content — its style, level of detail, or specific guidelines. All customization options are optional: specify only the ones you care about.

Available options​

  • Style — Whether you prefer bullet-points or paragraph-like formatting. In some cases, for instance if the content of a section is very brief, requesting BULLET_POINTS will still yield a paragraph because bullet points wouldn't make sense.
  • Custom instruction — Free-form guidelines applied to a single section. Keep these clear and concise for best results.
  • Level of detail — Whether you prefer the default content density or a more detailed one. Use DETAILED to ask for richer output.
  • Split by problem — Structures the section content into subsections, one per distinct clinical problem or topic. The subsections live inside the same single string field, so this flag does not change the section's API schema. On A&P-merged templates, structured subsections are exposed as content.type: "SUBSECTIONS" instead. See the Assessment & Plan guide.

Before 2026-08-25, sections used a flat top-level text field instead of content. Starting with 2026-08-25, content is required and text is no longer accepted.

Discovering which options apply to a section​

Not every customization option is available on every section of every template (and availability can also vary by locale). To find out which options a given section supports for a given template, call:

GET /v1/core/user/note-settings/templates/{template_key}

Each section in the response has a supported_customization_options field listing the dimensions you may set for it (STYLE, CUSTOM_INSTRUCTION, LEVEL_OF_DETAIL, SPLIT_BY_PROBLEM). Only send customizations for options listed there — sending an unsupported option returns an error.

The corresponding Server API endpoint is GET /v1/core/server/generate-note/templates/{template_key}?locale={note_locale}.

Example​

Below is a TypeScript snippet demonstrating how to customize sections within the GENERIC_MULTIPLE_SECTIONS_AP_MERGED template on a Server API POST /v1/core/server/generate-note request (on the User API the template and per-section customizations live on /note-settings instead — see the User API note-settings guide):

Before 2026-06-12, the Server API took a note_template enum. Starting with 2026-06-12, that field is note_template_key (a freetext string).

const generateNoteRequestBody = {
  ...otherFields, // transcript, etc.
  note_locale: "ENGLISH_US",
  note_template_key: "GENERIC_MULTIPLE_SECTIONS_AP_MERGED",
  note_sections_customization: [
    // 'History Of Present Illness' is detailed and split by problem.
    {
      section_key: "HISTORY_OF_PRESENT_ILLNESS",
      level_of_detail: "DETAILED",
      split_by_problem: true,
    },
    // 'Vitals' and 'Allergies' are formatted in bullet points, with custom instructions.
    {
      section_key: "VITALS",
      custom_instruction:
        "Include discussion about the patient's diet and nutritional concerns",
      style: "BULLET_POINTS",
    },
    {
      section_key: "ALLERGIES",
      style: "BULLET_POINTS",
    },
  ],
};

When constructing this list:

  • only specify sections that belong to the chosen template — see Templates and sections;
  • only specify customization options that the section supports, as returned by the endpoint above;
  • each section may appear at most once in the list.

For API versions 2024-10-01 through 2026-04-24 (before 2026-06-12), see Note customization through 2026-04-24.