Medical Record Configurations

Create a Smart Template

Register a Smart Template (medical record configuration). Idempotent on content hash: identical configurations for the same account return the existing id with created: false.

post/v1/medical-record-configurations

Request

Base URL
https://scribe-api.telepatia.ai
Auth
HTTP bearer

Request body

namestring nullable

Human-readable display name. Defaults to the public id when omitted.

descriptionstring nullable

Optional human-readable description of the template.

specialty'acupuncture' | 'alternativeMedicine' | 'ayurvedicMedicine' | 'chiropractic' | 'herbalMedicine' | 'homeopathy' | 'naturopathy' | 'traditionalChineseMedicine' | 'cosmeticDentistry' | 'dentistry' | 'developmentalBehavioralPediatrics' | 'endodontics' | 'forensicDentistry' | 'maxillofacialProsthodontics' | 'oralMaxillofacialSurgery' | 'oralMedicine' | 'oralPathology' | 'oralSurgery' | 'orthodontics' | 'pediatricDentistry' | 'periodontics' | 'prosthodontics' | 'addictionPsychiatry' | 'adolescentMedicine' | 'aerospaceMedicine' | 'allergyImmunology' | 'andrology' | 'anesthesiology' | 'anesthesiologyCriticalCare' | 'bariatricSurgery' | 'breastRadiology' | 'breastSurgery' | 'cardiacSurgery' | 'cardiovascularSurgery' | 'cardiology' | 'cardiovascularDisease' | 'cardiovascularRiskProgram' | 'childAbusePediatrics' | 'childAdolescentPsychiatry' | 'childNeurology' | 'childWelfareSocialWork' | 'clinicalNeurophysiology' | 'clinicalSocialWork' | 'colorectalSurgery' | 'communityMedicine' | 'communitySocialWork' | 'consultationLiaisonPsychiatry' | 'cosmeticDermatology' | 'craniofacialTrauma' | 'dermatology' | 'dermoscopy' | 'diabetes' | 'diagnosticRadiology' | 'electrophysiology' | 'emergencyCriticalCare' | 'emergencyMedicine' | 'emergencyPsychiatry' | 'endocrineSurgery' | 'endocrinology' | 'epilepsy' | 'facialPlasticSurgery' | 'familyMedicine' | 'familySocialWork' | 'footAnkleSurgery' | 'forensicPsychiatry' | 'forensicSocialWork' | 'gastroenterology' | 'generalMedicine' | 'generalMedicinePsychiatry' | 'generalSurgery' | 'geriatricMedicine' | 'geriatricPsychiatry' | 'geriatricSocialWork' | 'ginecology' | 'gynecologicOncology' | 'gynecologicSurgery' | 'gynecology' | 'handSurgery' | 'headNeckSurgery' | 'headacheMedicine' | 'heartFailureTransplantCardiology' | 'hematology' | 'hepatobiliarySurgery' | 'hipKneeSurgery' | 'hospitalist' | 'infectiousDisease' | 'internalCriticalCare' | 'internalMedicine' | 'interventionalCardiology' | 'interventionalRadiology' | 'maternalFetalMedicine' | 'medicalSocialWork' | 'militarySocialWork' | 'minimallyInvasiveGynecologicSurgery' | 'mohsSurgery' | 'musculoskeletalRadiology' | 'neonatology' | 'nephrology' | 'neurocriticalCare' | 'neuroimmunology' | 'neurology' | 'neuromuscularMedicine' | 'neuroradiology' | 'neurorehabilitation' | 'neurosurgery' | 'neurotology' | 'nuclearMedicine' | 'obstetrics' | 'obstetricsGynecology' | 'occupationalMedicine' | 'occupationalSocialWork' | 'oculoplasticSurgery' | 'oncology' | 'oncologySocialWork' | 'ophthalmology' | 'orthopedicHandSurgery' | 'orthopedicSportsMedicine' | 'orthopedicTrauma' | 'orthopedics' | 'otolaryngology' | 'painMedicine' | 'palliativeMedicine' | 'palliativeSocialWork' | 'pediatricAllergyImmunology' | 'pediatricAnesthesiology' | 'pediatricCardiology' | 'pediatricCriticalCare' | 'pediatricDermatology' | 'pediatricEmergencyMedicine' | 'pediatricEndocrinology' | 'pediatricENT' | 'pediatricGastroenterology' | 'pediatricHematologyOncology' | 'pediatricInfectiousDisease' | 'pediatricNephrology' | 'pediatricNeurology' | 'pediatricCardiacSurgery' | 'pediatricOncology' | 'pediatricOphthalmology' | 'pediatricOrthopedics' | 'pediatricPalliativeCare' | 'pediatricPulmonology' | 'pediatricRadiology' | 'pediatricRheumatology' | 'pediatricSocialWork' | 'pediatricSurgery' | 'pediatricTrauma' | 'pediatricUrology' | 'pediatrics' | 'perinatalPsychiatry' | 'physicalMedicineRehab' | 'plasticSurgery' | 'prenatalCareProgram' | 'preventiveMedicine' | 'psychiatricSocialWork' | 'psychiatry' | 'psychosomaticMedicine' | 'publicHealth' | 'pulmonaryDisease' | 'pulmonology' | 'radiationOncologist' | 'radiationOncology' | 'reproductiveEndocrinology' | 'retinaSurgery' | 'rheumatology' | 'riasProgram' | 'manager' | 'schoolSocialWork' | 'shoulderElbowSurgery' | 'sleepMedicine' | 'socialWork' | 'spinalCordInjury' | 'spinalTrauma' | 'spineSurgery' | 'sportsMedicine' | 'substanceAbuseSocialWork' | 'surgicalOncology' | 'telemedicine' | 'thoracicSurgery' | 'transplantHepatology' | 'transplantSurgery' | 'traumaSurgery' | 'traumatology' | 'triage' | 'unknown' | 'urgentCare' | 'urologicOncology' | 'urology' | 'vascularSurgery' | 'nursing' | 'clinicalNutrition' | 'eatingDisorderNutrition' | 'gastroenterologicNutrition' | 'geriatricNutrition' | 'nutrition' | 'oncologyNutrition' | 'pediatricNutrition' | 'renalNutrition' | 'sportsNutrition' | 'clinicalPsychology' | 'counselingPsychology' | 'developmentalPsychology' | 'forensicPsychology' | 'geropsychology' | 'healthPsychology' | 'industrialOrganizationalPsychology' | 'militaryPsychology' | 'neuropsychology' | 'positivePsychology' | 'psychology' | 'rehabilitationPsychology' | 'schoolPsychology' | 'sportsPsychology' | 'occupationalTherapy' | 'physicalTherapy' | 'respiratoryTherapy' | 'speechTherapy' | 'therapy' | 'other'

workflow'defaultOutpatient' | 'inpatient' | 'emergencyRoom' | 'reportDictation' | 'historySummary'

Product discriminator for a template. Absent means an ordinary Scribe template.

defaultOutpatient, inpatient, and emergencyRoom also denote a Scribe template; each names the clinical care setting the template is written for. reportDictation and historySummary denote a non-Scribe product.

configurationobject required

Section map keyed by node key (schema + optional prompt strategy). A key is a stable identifier that matches ^[A-Za-z0-9_]+$ (ASCII letters, digits, underscore). Put display text in the section schema.label.

Example request

{
  "configuration": {
    "chiefComplaint": {
      "instructionSet": {
        "telepatiaPromptId": "CHIEF_COMPLAINT"
      },
      "schema": {
        "instructions": "Patient's chief complaint.",
        "type": "string"
      }
    },
    "vitals": {
      "instructionSet": {
        "telepatiaPromptId": "VITAL_SIGNS"
      },
      "schema": {
        "instructions": "Vital signs.",
        "properties": {
          "heartRate": {
            "instructions": "Heart rate in bpm.",
            "type": "integer"
          }
        },
        "type": "object"
      }
    }
  },
  "name": "Cardiology intake"
}

Response

Successful Response

idstring required

Public ID of the medical record configuration.

namestring required

Resolved display name (defaults to the public id when none was provided).

hashstring required

SHA-256 hash of the canonical configuration JSON.

createdAtstring date-time required

createdboolean required

True if a new configuration was created; False if a matching one already existed.

exampleobject

Shape of the final payload this template produces, keyed by section name. Leaf values are typed placeholders (<string>, <number>, <a | b> for enums, <YYYY-MM-DD> for dates); object sections nest, free-text sections are a single string.

Example response

{
  "created": true,
  "createdAt": "2026-04-20T14:30:00Z",
  "example": {
    "historyOfPresentIllness": "<string>",
    "reviewOfSystems": [
      "<string>"
    ],
    "visitDate": "<YYYY-MM-DD>",
    "vitalSigns": {
      "bloodPressure": "<string>",
      "heartRate": "<number>",
      "severity": "<mild | moderate | severe>"
    }
  },
  "hash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "id": "mrc_a1b2c3d4e5f6g7h8",
  "name": "Cardiology intake"
}

Changes

No recorded changes to this operation across all 1 revision of this API.