Note templates and sections

Templates and sections

Notes generated by Nabla Core API follow a template. Each template has a set of sections: a generated note only contains the sections defined by its template.

Which template a note is generated with depends on which API surface is calling:

• on the User API, POST /v1/core/user/generate-note uses the template stored in the user's note settings (set via PATCH /v1/core/user/note-settings); the request body does not carry a template;
• on the Server API, POST /v1/core/server/generate-note takes a note_template_key in the request body.

Built-in templates

The table below is a reference for templates available to most English organizations — this is only a subset of all templates the API may expose for your account. Always query the API to get the full list available to you and the current section outline of each template.

Template	Use case	Sections
GENERIC_MULTIPLE_SECTIONS	Recommended for general medicine.	CHIEF_COMPLAINT, HISTORY_OF_PRESENT_ILLNESS, PAST_MEDICAL_HISTORY, PAST_SURGICAL_HISTORY, PAST_OBSTETRIC_HISTORY, FAMILY_HISTORY, SOCIAL_HISTORY, ALLERGIES, CURRENT_MEDICATIONS, IMMUNIZATIONS, VITALS, PHYSICAL_EXAM, LAB_RESULTS, IMAGING_RESULTS, ASSESSMENT, PLAN, PRESCRIPTION, APPOINTMENTS
GENERIC_MULTIPLE_SECTIONS_AP_MERGED	Like GENERIC_MULTIPLE_SECTIONS with Assessment and Plan merged into a single section.	CHIEF_COMPLAINT, HISTORY_OF_PRESENT_ILLNESS, PAST_MEDICAL_HISTORY, PAST_SURGICAL_HISTORY, PAST_OBSTETRIC_HISTORY, FAMILY_HISTORY, SOCIAL_HISTORY, ALLERGIES, CURRENT_MEDICATIONS, IMMUNIZATIONS, VITALS, PHYSICAL_EXAM, LAB_RESULTS, IMAGING_RESULTS, ASSESSMENT_AND_PLAN, PRESCRIPTION, APPOINTMENTS
GENERIC_SOAP	Standard Subjective, Objective, Assessment, Plan format.	SUBJECTIVE, OBJECTIVE, ASSESSMENT, PLAN
GENERIC_SOAP_AP_MERGED	SOAP format with Assessment and Plan merged.	SUBJECTIVE, OBJECTIVE, ASSESSMENT_AND_PLAN
GENERIC_SOAP_PLUS_EXAM_TESTS_AP_MERGED	SOAP merged format with two additional sections: physical exam and diagnostic tests ordered.	SUBJECTIVE, OBJECTIVE, PHYSICAL_EXAM, DIAGNOSTIC_TESTS_ORDERED, ASSESSMENT_AND_PLAN
GENERIC_APSO_AP_MERGED	APSO format — Assessment and Plan come first, merged.	ASSESSMENT_AND_PLAN, SUBJECTIVE, OBJECTIVE
EMERGENCY_MULTIPLE_SECTIONS	Recommended for emergency medicine.	CHIEF_COMPLAINT, HISTORY_OF_PRESENT_ILLNESS, PAST_MEDICAL_HISTORY, PAST_SURGICAL_HISTORY, PAST_OBSTETRIC_HISTORY, FAMILY_HISTORY, SOCIAL_HISTORY, ALLERGIES, CURRENT_MEDICATIONS, IMMUNIZATIONS, VITALS, PHYSICAL_EXAM, LAB_RESULTS, IMAGING_RESULTS, ASSESSMENT, PLAN, PRESCRIPTION, APPOINTMENTS
EMERGENCY_SOAP	Emergency medicine in SOAP format.	SUBJECTIVE, OBJECTIVE, ASSESSMENT, PLAN
WCC_MULTIPLE_SECTIONS	Well Child Care visits. Includes a WCC-specific section covering behavioural, language, cognitive, and physical development, as well as diet.	CHIEF_COMPLAINT, HISTORY_OF_PRESENT_ILLNESS, WELL_CHILD_CARE, PAST_MEDICAL_HISTORY, PAST_SURGICAL_HISTORY, PAST_OBSTETRIC_HISTORY, FAMILY_HISTORY, SOCIAL_HISTORY, ALLERGIES, CURRENT_MEDICATIONS, IMMUNIZATIONS, VITALS, PHYSICAL_EXAM, LAB_RESULTS, IMAGING_RESULTS, ASSESSMENT, PLAN, PRESCRIPTION, APPOINTMENTS
WCC_SOAP	Well Child Care visits in SOAP format. Includes the same WCC-specific section.	SUBJECTIVE, WELL_CHILD_CARE, OBJECTIVE, ASSESSMENT, PLAN
PSYCHIATRY_MULTIPLE_SECTIONS	Recommended for psychiatry. Includes a MENTAL_HEALTH_EXAM section.	CHIEF_COMPLAINT, HISTORY_OF_PRESENT_ILLNESS, PAST_MEDICAL_HISTORY, PAST_SURGICAL_HISTORY, PAST_OBSTETRIC_HISTORY, FAMILY_HISTORY, SOCIAL_HISTORY, ALLERGIES, CURRENT_MEDICATIONS, VITALS, IMMUNIZATIONS, PHYSICAL_EXAM, LAB_RESULTS, IMAGING_RESULTS, MENTAL_HEALTH_EXAM, ASSESSMENT, PLAN, PRESCRIPTION, APPOINTMENTS
PSYCHIATRY_SOAP	Psychiatry in SOAP format.	SUBJECTIVE, OBJECTIVE, ASSESSMENT, PLAN
PSYCHOLOGY_MULTIPLE_SECTIONS	Recommended for psychology sessions.	CHIEF_COMPLAINT, HISTORY_OF_PRESENT_COMPLAINT, MENTAL_HEALTH_HISTORY, SOCIAL_HISTORY, MENTAL_HEALTH_EXAM, ASSESSMENT, PLAN, APPOINTMENTS
CARDIOLOGY_MULTIPLE_SECTIONS	Recommended for cardiology. Includes a CARDIOVASCULAR_RISK_FACTORS section.	CHIEF_COMPLAINT, HISTORY_OF_PRESENT_ILLNESS, CARDIOVASCULAR_RISK_FACTORS, PAST_MEDICAL_HISTORY, PAST_SURGICAL_HISTORY, PAST_OBSTETRIC_HISTORY, FAMILY_HISTORY, SOCIAL_HISTORY, ALLERGIES, CURRENT_MEDICATIONS, VITALS, IMMUNIZATIONS, PHYSICAL_EXAM, LAB_RESULTS, IMAGING_RESULTS, ASSESSMENT, PLAN, PRESCRIPTION, APPOINTMENTS
DIET_MULTIPLE_SECTIONS	Recommended for nutrition and dietitian consultations.	LIFESTYLE, PAST_MEDICAL_HISTORY, CHIEF_COMPLAINT, VITALS, FOOD_HABITS, OBJECTIVES_AND_ADVICE, APPOINTMENTS

Discovering available templates

Templates vary by locale and evolve over time — new sections can be added, so always query the API for the current outline rather than assuming a fixed shape. What won't change: existing templates are never removed, and section keys are never renamed or deleted.

To list the templates available to a user in a given locale:

GET /v1/core/user/note-settings/templates

The response contains a templates[] array with each template's key, title, and description.

To get the section outline of a specific template:

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

The response contains a sections[] array; each entry has a key, a title, and the customization options it supports.

The matching Server API endpoints are:

GET /v1/core/server/generate-note/templates?locale={note_locale}
GET /v1/core/server/generate-note/templates/{template_key}?locale={note_locale}

On the User API, set the user's preferred template via PATCH /v1/core/user/note-settings (using note_template_key); subsequent calls to POST /v1/core/user/generate-note will use it.

On the Server API, pass the chosen key as note_template_key in the POST /v1/core/server/generate-note request body. When applying per-section customizations, only reference section keys returned by the template's sections[].

Example notes

Here are a couple of clinical notes generated using different templates.

• Using GENERIC_MULTIPLE_SECTIONS template:

{
  "note": {
    "title": "Headache and Back Pain",
    "locale": "ENGLISH_US",
    "template_key": "GENERIC_MULTIPLE_SECTIONS",
    "sections": [
      {
        "key": "CHIEF_COMPLAINT",
        "title": "Chief complaint",
        "text": "Severe headache. Back pain. Broken ankle from last week."
      },
      {
        "key": "HISTORY_OF_PRESENT_ILLNESS",
        "title": "History of present illness",
        "text": "The patient presented today with a strong headache and severe back pain. The back pain is particularly intense and the patient also mentioned a recent ankle fracture that occurred last week. The patient expressed a desire to see a therapist and requested prescriptions for pain management, specifically mentioning Advil, Ibuprofen, or Augmentin. The patient's current weight is 72 kilograms and height is 1.80 meters."
      },
      {
        "key": "VITALS",
        "title": "Vitals",
        "text": "Height: 1.80m. Weight: 72kg."
      },
      {
        "key": "PLAN",
        "title": "Plan",
        "text": "Schedule appointment with a therapist."
      },
      {
        "key": "PRESCRIPTION",
        "title": "Prescription",
        "text": "Ibuprofen 400mg, take every 6-8 hours as needed for pain."
      }
    ]
  }
}

• Using DIET_MULTIPLE_SECTIONS template:

{
  "note": {
    "title": "Weight Management and Lifestyle Plan",
    "locale": "ENGLISH_US",
    "template_key": "DIET_MULTIPLE_SECTIONS",
    "sections": [
      {
        "key": "LIFESTYLE",
        "title": "Lifestyle",
        "text": "Sedentary professional activity, no regular physical activities."
      },
      {
        "key": "PAST_MEDICAL_HISTORY",
        "title": "Medical history",
        "text": "Allergic to peanuts, experiencing regular headaches, family history of diabetes."
      },
      {
        "key": "CHIEF_COMPLAINT",
        "title": "Reason for visit and goals",
        "text": "To improve overall health and manage weight."
      },
      {
        "key": "VITALS",
        "title": "Vitals",
        "text": "Weight is 110 kg, height and BMI not mentioned."
      },
      {
        "key": "OBJECTIVES_AND_ADVICE",
        "title": "Objectives and advice",
        "text": "- Start incorporating physical activity into daily routine.\n- Avoid peanuts and other allergens.\n- Reduce intake of processed and high-fat foods.\n- Increase intake of fiber, vegetables, and lean proteins."
      },
      {
        "key": "APPOINTMENTS",
        "title": "Appointment",
        "text": "Next appointment in 4 weeks."
      }
    ]
  }
}