Field Recipes

You already know your EMR screen as a set of form fields — a text box, a number, a dropdown, a checkbox. A Smart Template is the same screen expressed as JSON: each field becomes a property in a section’s OutputSchema. This page gives you the JSON for every field type, then walks you through assembling a full template.

Every field needs instructions — that’s the prompt the model uses to fill the slot. Write it as if briefing a scribe: “the patient’s main complaint, in their own words”.

Field cookbook

Text

A free-text input or textarea.

<input type="text" name="chiefComplaint" />

{
  "type": "string",
  "instructions": "Chief complaint in the patient's own words",
  "maxLength": 500
}

Number

A numeric input. Use integer for whole numbers, number for decimals; bound with minimum / maximum.

<input type="number" name="weightKg" min="0" max="500" />

{
  "type": "number",
  "instructions": "Body weight in kilograms",
  "minimum": 0,
  "maximum": 500
}

A <select> or a group of radio buttons — pick exactly one option. Use { label, value } so you store a stable code and can rename or translate the label freely. Generation returns the value.

<select name="visitType">
  <option value="FIRST_VISIT">First visit</option>
  <option value="FOLLOW_UP">Follow-up</option>
</select>

{
  "type": "string",
  "instructions": "Type of visit",
  "enum": [
    { "label": "First visit", "value": "FIRST_VISIT" },
    { "label": "Follow-up",   "value": "FOLLOW_UP" }
  ]
}

Multi-select (checkbox group)

A group of checkboxes where several options can be selected at once — an array whose items carry the enum.

<input type="checkbox" name="symptoms" value="FEVER" /> Fever
<input type="checkbox" name="symptoms" value="COUGH" /> Cough

{
  "type": "array",
  "instructions": "All symptoms the patient reports",
  "items": {
    "type": "string",
    "enum": [
      { "label": "Fever", "value": "FEVER" },
      { "label": "Cough", "value": "COUGH" }
    ]
  }
}

Yes / No (checkbox)

A single checkbox is a boolean.

<input type="checkbox" name="followUpNeeded" /> Follow-up needed

{
  "type": "boolean",
  "instructions": "Whether a follow-up appointment is needed"
}

Date and time

A date or time input — a string with a format. The value is returned as ISO 8601.

<input type="date" name="visitDate" />

{
  "type": "string",
  "instructions": "Date of the visit",
  "format": "date"
}

Optional field

By default every field is required: true (the model always produces a value). Set required: false to let it return null when the encounter doesn’t mention it.

{
  "type": "string",
  "instructions": "Secondary diagnosis, if any",
  "required": false
}

Default value

Pair required: false with default to guarantee a fallback. For an enum, the default must be one of the values.

{
  "type": "string",
  "instructions": "Triage priority",
  "enum": [
    { "label": "Routine", "value": "ROUTINE" },
    { "label": "Urgent",  "value": "URGENT" }
  ],
  "required": false,
  "default": "ROUTINE"
}

Not supported

There is no conditional logic in a Smart Template — no “show field B only if field A is X”. Keywords like anyOf, if/then/else, pattern, and minItems are silently dropped. Model optionality with required: false + default; put branching in the RPA layer. Full list: OutputSchema → Not supported.

Build a template, field by field

List the fields on your screen

Write down each form field and its kind (text, number, choice, checkbox, date).

Pick the JSON for each

Use the cookbook above to turn each field into an OutputSchema.

Group them into a section

A section is an object whose properties are your fields — one section per part of the record.

{
  "type": "object",
  "instructions": "Consultation summary",
  "properties": {
    "chiefComplaint": { "type": "string", "instructions": "Main complaint" },
    "followUpNeeded": { "type": "boolean", "instructions": "Follow-up needed" }
  }
}

Attach a prompt strategy

Give the section a curated telepatiaPromptId, or your own systemPrompt. See Sections.

Create it, then reference it

POST /v1/medical-record-configurations (idempotent — identical content returns the same id), then pass medicalRecordConfigurationId on set-consultation-context.

Full recipe: a prescription template

A complete template covering every field type — text, number, single choice, multi-select, boolean, and an optional date with a default:

curl -X POST https://scribe-api.telepatia.ai/v1/medical-record-configurations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Prescription",
    "configuration": {
      "prescription": {
        "systemPrompt": "Extract the prescription details from the consultation.",
        "schema": {
          "type": "object",
          "instructions": "Prescription issued during the visit",
          "properties": {
            "patientName": {
              "type": "string",
              "instructions": "Full name of the patient",
              "maxLength": 200
            },
            "itemCount": {
              "type": "integer",
              "instructions": "Number of medications prescribed",
              "minimum": 0,
              "maximum": 50
            },
            "visitType": {
              "type": "string",
              "instructions": "Type of visit",
              "enum": [
                { "label": "First visit", "value": "FIRST_VISIT" },
                { "label": "Follow-up",   "value": "FOLLOW_UP" }
              ]
            },
            "medications": {
              "type": "array",
              "instructions": "Medications prescribed, with dose",
              "items": {
                "type": "object",
                "instructions": "One medication entry",
                "properties": {
                  "name": { "type": "string", "instructions": "Generic or brand name" },
                  "dose": { "type": "string", "instructions": "Dose with unit, e.g. 500 mg" }
                }
              }
            },
            "followUpNeeded": {
              "type": "boolean",
              "instructions": "Whether a follow-up is needed"
            },
            "visitDate": {
              "type": "string",
              "instructions": "Date of the visit",
              "format": "date",
              "required": false,
              "default": "1970-01-01"
            }
          }
        }
      }
    }
  }'

Getting Started

Consultations

Scribe Sessions

Clinical Decision Support

Webhooks

Smart Templates

Session Templates

Accounts

Patients

Reference

Field cookbook

Text

Number

Multi-select (checkbox group)

Yes / No (checkbox)

Date and time

Optional field

Default value

Not supported

Build a template, field by field

Full recipe: a prescription template

Next steps

OutputSchema reference

Sections

​Field cookbook

​Text

​Number

​Single choice (dropdown / radio)

​Multi-select (checkbox group)

​Yes / No (checkbox)

​Date and time

​Optional field

​Default value

​Not supported

​Build a template, field by field

​Full recipe: a prescription template

​Next steps

OutputSchema reference

Sections

Field cookbook

Text

Number

Single choice (dropdown / radio)

Multi-select (checkbox group)

Yes / No (checkbox)

Date and time

Optional field

Default value

Not supported

Build a template, field by field

Full recipe: a prescription template

Next steps