Skip to main content
🎉 API version '2024-10-01' just released with many new features. If you are still on an older version, check the migration guide.

Per-section note customization options

This feature is currently Only available in English.

In addition to specifying a template that the generated note will conform to, you can also customize each section's content such as style (paragraph vs bullet points) or level of detail (concise or detailed). All those customization options are optional: you can specify only the ones that you are interested in.

Following are the currently supported per-section customization options.

Customization optionDescriptionAvailability
StyleWhether you prefer bullet points formatting or a paragraph-like one.
In some cases, for instance if the content of the section is very brief, requesting a "bullet points" style will still yield a paragraph because bullet points won't make sense.		Style (paragraph or bullet points) is supported for all sections of all templates.
Level of DetailWhether you prefer the default section level of detail or rich and more detailed one. Use 'detailed' to get more details in the note section content.Applies for:
  • section SUBJECTIVE
    in templates GENERIC_SOAP, EMERGENCY_SOAP and WCC_SOAP;
  • section HISTORY_OF_PRESENT_ILLNESS
    in templates GENERIC_MULTIPLE_SECTIONS, GENERIC_MULTIPLE_SECTIONS_AP_MERGED, CARDIOLOGY_MULTIPLE_SECTIONS, WCC_MULTIPLE_SECTIONS and EMERGENCY_MULTIPLE_SECTIONS.

Please note that templates DIET, PSYCHOLOGY_MULTIPLE_SECTIONS, and PSYCHIATRY_MULTIPLE_SECTIONS are not supported for level of detail customization at this time.
Split by ProblemFor structuring the section content according to distinct clinical problems or topics addressed during the consultation.

This format aims to enhance the clarity and organization of the clinical note, making it easier to read and understand the different issues discussed during the consultation.

When this flag is enabled, the section text is organized into subsections, each corresponding to a specific problem or topic.

The subsections are separated using a human-readable formatting with-in the same single string-typed field, so this flag does not change the section's API schema.

Example customization code​

Following is a Typescript code snippet demonstrating how to customize the sections within the GENERIC_MULTIPLE_SECTIONS_AP_MERGED template.

const generateNoteRequestBody = {
  ...otherFields, // transcript, etc.
  note_locale: "ENGLISH_US",
  note_template: "GENERIC_MULTIPLE_SECTIONS_AP_MERGED", // to generate a note following the GENERAL_MEDICINE_AP_MERGED template
  note_sections_customization: [
    // in which 'History Of Present Illness' section is detailed and split by problem.
    {
      section_key: "HISTORY_OF_PRESENT_ILLNESS",
      level_of_detail: "DETAILED",
      split_by_problem: true,
    },
    // Also, 'Vitals' and 'Allergies' are formatted in bullet points.
    {
      section_key: "VITALS",
      style: "BULLET_POINTS",
    },
    {
      section_key: "ALLERGIES",
      style: "BULLET_POINTS",
    },
  ],
};

You should:

  • only specify sections that apply for the given template (check the Templates and sections);
  • only specify customization options that are supported for the given section and template (check the compatibility table below);
  • also, there should be at most one customization options object per section in the list.

Customization options compatibility matrix​

As mentioned above, some customization options are only available for specific templates and specific sections. Following is the exhaustive matrix of availability.

SectionCustomization options
StyleLevel of DetailSplit by Problem
CHIEF_COMPLAINT✅--
HISTORY_OF_PRESENT_ILLNESS✅✅✅
PAST_MEDICAL_HISTORY✅--
PAST_SURGICAL_HISTORY✅--
PAST_OBSTETRIC_HISTORY✅--
FAMILY_HISTORY✅--
SOCIAL_HISTORY✅--
ALLERGIES✅--
CURRENT_MEDICATIONS✅--
IMMUNIZATIONS✅--
VITALS✅--
LAB_RESULTS✅--
IMAGING_RESULTS✅--
PHYSICAL_EXAM✅--
ASSESSMENT✅--
PLAN✅--
PRESCRIPTION✅--
APPOINTMENTS✅--