> ## Documentation Index > Fetch the complete documentation index at: https://docs.telepatia.ai/llms.txt > Use this file to discover all available pages before exploring further. # 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`. ## OpenAPI ````yaml /pt-BR/scribe-api/openapi.json post /v1/medical-record-configurations openapi: 3.1.0 info: title: Scribe Public API description: >- API REST externa para integração com a plataforma Telepatia. Autentique-se com chaves de API, defina o contexto da consulta e busque sessões de scribe. version: 0.1.0 servers: - url: https://scribe-api.telepatia.ai description: Production security: - BearerAuth: [] paths: /v1/medical-record-configurations: post: tags: - Medical Record Configurations summary: Create a Smart Template description: >- Register a Smart Template (medical record configuration). Idempotent on content hash: identical configurations for the same account return the existing id with `created: false`. operationId: >- api_medical_record_configuration_create_v1_medical_record_configurations_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateMedicalRecordConfigurationRequest' example: 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 responses: '200': description: Resposta bem-sucedida content: application/json: schema: $ref: '#/components/schemas/CreateMedicalRecordConfigurationResponse' example: created: true createdAt: '2026-04-20T14:30:00Z' hash: >- 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 id: mrc_a1b2c3d4e5f6g7h8 name: Cardiology intake '400': description: >- Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes. content: application/json: examples: parameter_missing: summary: Missing required field value: error: type: invalid_request_error code: parameter_missing message: name is required. param: name parameter_invalid: summary: Invalid field value value: error: type: invalid_request_error code: parameter_invalid message: >- idCountry must be a valid country name, ISO alpha-2, or ISO alpha-3 code. param: idCountry account_invalid: summary: Invalid account value: error: type: invalid_request_error code: account_invalid message: Account has no valid authId. schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Não autorizado — chave de API ausente ou inválida. content: application/json: examples: authentication_required: summary: Invalid or missing API key value: error: type: authentication_error code: authentication_required message: Invalid API key. schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Conflito — o recurso já existe ou está em estado conflitante. content: application/json: examples: resource_conflict: summary: Resource conflict value: error: type: invalid_request_error code: resource_conflict message: >- consultationInternalId is already in use by a different consultation. param: consultationInternalId schema: $ref: '#/components/schemas/ErrorResponse' '503': description: Serviço indisponível — uma dependência externa está indisponível. content: application/json: examples: service_unavailable: summary: Failed to create medical record configuration value: error: type: api_error code: service_unavailable message: Failed to create medical record configuration. schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: CreateMedicalRecordConfigurationRequest: properties: name: anyOf: - type: string maxLength: 200 - type: 'null' title: Name description: Human-readable display name. Defaults to the public id when omitted. examples: - Cardiology intake description: anyOf: - type: string maxLength: 500 - type: 'null' title: Description description: Optional human-readable description of the template. examples: - Intake template for the cardiology outpatient clinic. specialty: anyOf: - $ref: '#/components/schemas/MedicalSpecialty' - type: 'null' description: >- Medical specialty this template targets (key such as `GENERAL_MEDICINE` or value such as `generalMedicine`). When set by an institutional API key, the template is distributed as a child copy to every account of that specialty in the institution. Optional; omitting it skips distribution. examples: - GENERAL_MEDICINE configuration: additionalProperties: $ref: '#/components/schemas/Section' type: object minProperties: 1 title: Configuration description: Section map keyed by node name (schema + optional prompt strategy). type: object required: - configuration title: CreateMedicalRecordConfigurationRequest description: >- Corpo da requisição para registrar uma configuração de prontuário médico — um mapa de chave de seção para definição de seção. examples: - 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 CreateMedicalRecordConfigurationResponse: properties: id: type: string title: Id description: Public ID of the medical record configuration. examples: - mrc_a1b2c3d4e5f6g7h8 name: type: string title: Name description: >- Resolved display name (defaults to the public id when none was provided). examples: - Cardiology intake hash: type: string title: Hash description: SHA-256 hash of the canonical configuration JSON. examples: - 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 createdAt: type: string format: date-time title: Createdat examples: - '2026-04-20T14:30:00Z' created: type: boolean title: Created description: >- True if a new configuration was created; False if a matching one already existed. examples: - true type: object required: - id - name - hash - createdAt - created title: CreateMedicalRecordConfigurationResponse description: Corpo da resposta ao registrar uma configuração de prontuário médico. examples: - created: true createdAt: '2026-04-20T14:30:00Z' hash: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 id: mrc_a1b2c3d4e5f6g7h8 name: Cardiology intake ErrorResponse: description: Envelope padronizado de resposta de erro. properties: error: $ref: '#/components/schemas/ErrorDetail' required: - error title: ErrorResponse type: object MedicalSpecialty: type: string enum: - 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 title: MedicalSpecialty Section: properties: schema: oneOf: - $ref: '#/components/schemas/StringSchema' - $ref: '#/components/schemas/NumberSchema' - $ref: '#/components/schemas/BooleanSchema' - $ref: '#/components/schemas/ObjectSchema' - $ref: '#/components/schemas/ArraySchema' - $ref: '#/components/schemas/CodeSchema' - $ref: '#/components/schemas/CodeListSchema' - $ref: '#/components/schemas/DerivedSchema' title: Schema systemPrompt: anyOf: - type: string - type: 'null' title: Systemprompt instructionSet: anyOf: - $ref: '#/components/schemas/InstructionSetRef' - type: 'null' join: type: boolean title: Join description: >- When False, the section always runs as its own LangGraph node instead of being batched with peers that share the same prompt strategy. Use this for sections whose per-instance content (e.g. distinct `templateN` bodies) would be lost in a merged LLM call. default: true type: object required: - schema title: Section description: |- A single section in the medical record configuration. Pairs an output schema with optional generation instructions. ErrorDetail: description: >- Detalhe do erro com códigos legíveis por máquina e mensagem legível por humanos. properties: type: description: Broad error category for high-level handling. examples: - invalid_request_error title: Type type: string code: description: Machine-readable error code. Clients should switch on this value. examples: - parameter_invalid title: Code type: string message: description: Human-readable error message ending with a period. examples: - >- idCountry must be a valid country name, ISO alpha-2, or ISO alpha-3 code. title: Message type: string param: anyOf: - type: string - type: 'null' default: null description: The request field that caused the error, if applicable. examples: - idCountry title: Param details: anyOf: - additionalProperties: true type: object - type: 'null' default: null description: Optional structured, machine-readable context for the error. examples: - pendingConsultations: - sessionId: abc123 url: https://... title: Details required: - type - code - message title: ErrorDetail type: object StringSchema: properties: type: type: string const: string title: Type instructions: anyOf: - type: string - type: 'null' title: Instructions label: anyOf: - type: string - type: 'null' title: Label enum: anyOf: - items: anyOf: - type: string - $ref: '#/components/schemas/EnumOption' type: array - type: 'null' title: Enum examples: anyOf: - items: type: string type: array - type: 'null' title: Examples template: anyOf: - type: string - type: 'null' title: Template pattern: anyOf: - type: string - type: 'null' title: Pattern format: anyOf: - type: string - type: 'null' title: Format nullable: type: boolean title: Nullable default: false required: type: boolean title: Required default: true default: anyOf: - type: string - type: 'null' title: Default type: object required: - type title: StringSchema description: Schema for string-valued outputs. NumberSchema: properties: type: type: string enum: - number - integer title: Type instructions: anyOf: - type: string - type: 'null' title: Instructions label: anyOf: - type: string - type: 'null' title: Label minimum: anyOf: - type: number - type: 'null' title: Minimum maximum: anyOf: - type: number - type: 'null' title: Maximum exclusiveMinimum: anyOf: - type: number - type: 'null' title: Exclusiveminimum exclusiveMaximum: anyOf: - type: number - type: 'null' title: Exclusivemaximum enum: anyOf: - items: type: number type: array - type: 'null' title: Enum nullable: type: boolean title: Nullable default: false required: type: boolean title: Required default: true default: anyOf: - type: number - type: 'null' title: Default type: object required: - type title: NumberSchema description: Schema for numeric outputs (number or integer). BooleanSchema: properties: type: type: string const: boolean title: Type instructions: anyOf: - type: string - type: 'null' title: Instructions label: anyOf: - type: string - type: 'null' title: Label nullable: type: boolean title: Nullable default: false required: type: boolean title: Required default: true default: anyOf: - type: boolean - type: 'null' title: Default type: object required: - type title: BooleanSchema description: Schema for boolean outputs. ObjectSchema: properties: type: type: string const: object title: Type instructions: anyOf: - type: string - type: 'null' title: Instructions label: anyOf: - type: string - type: 'null' title: Label properties: additionalProperties: oneOf: - $ref: '#/components/schemas/StringSchema' - $ref: '#/components/schemas/NumberSchema' - $ref: '#/components/schemas/BooleanSchema' - $ref: '#/components/schemas/ObjectSchema' - $ref: '#/components/schemas/ArraySchema' - $ref: '#/components/schemas/CodeSchema' - $ref: '#/components/schemas/CodeListSchema' - $ref: '#/components/schemas/DerivedSchema' type: object title: Properties examples: anyOf: - items: type: string type: array - type: 'null' title: Examples template: anyOf: - type: string - type: 'null' title: Template nullable: type: boolean title: Nullable default: false required: type: boolean title: Required default: true type: object required: - type - properties title: ObjectSchema description: Schema for object outputs with named properties. ArraySchema: properties: type: type: string const: array title: Type instructions: anyOf: - type: string - type: 'null' title: Instructions label: anyOf: - type: string - type: 'null' title: Label items: oneOf: - $ref: '#/components/schemas/StringSchema' - $ref: '#/components/schemas/NumberSchema' - $ref: '#/components/schemas/BooleanSchema' - $ref: '#/components/schemas/ObjectSchema' - $ref: '#/components/schemas/ArraySchema' - $ref: '#/components/schemas/CodeSchema' - $ref: '#/components/schemas/CodeListSchema' - $ref: '#/components/schemas/DerivedSchema' title: Items minItems: anyOf: - type: integer - type: 'null' title: Minitems maxItems: anyOf: - type: integer - type: 'null' title: Maxitems examples: anyOf: - items: type: string type: array - type: 'null' title: Examples template: anyOf: - type: string - type: 'null' title: Template nullable: type: boolean title: Nullable default: false required: type: boolean title: Required default: true type: object required: - type - items title: ArraySchema description: Schema for array outputs with a single item schema. CodeSchema: properties: type: type: string const: code title: Type instructions: anyOf: - type: string - type: 'null' title: Instructions system: type: string title: System source: anyOf: - type: string - items: type: string type: array - type: 'null' title: Source maxOptions: type: integer minimum: 1 title: Maxoptions default: 1 required: type: boolean title: Required default: true type: object required: - type - system title: CodeSchema description: >- A single medical code resolved from generated text (ICD-10, TUSS, ...). The LLM never emits the code directly. After generation, a coding pass reads the text named by ``source`` and writes a natural-language search query; a resolution pass then turns that query into catalog codes via the injected ``CodeResolver``. Output is always ``{"code": str | None, "options": [{"code": str, "score": float}, ...]}`` — ``code`` is the best match (or ``None``) and ``options`` is the ranked list (length ≤ ``max_options``). ``source`` selects which sibling text in the enclosing object to code: ``None`` (default) → all non-code siblings, ``str`` → one sibling, ``list`` → several. Code fields are excluded from the structured-output schema sent to the LLM and only ever appear as properties of an object (they need sibling text). CodeListSchema: properties: type: type: string const: codeList title: Type instructions: anyOf: - type: string - type: 'null' title: Instructions system: type: string title: System source: anyOf: - type: string - items: type: string type: array - type: 'null' title: Source maxItems: anyOf: - type: integer - type: 'null' title: Maxitems maxOptions: type: integer minimum: 1 title: Maxoptions default: 1 required: type: boolean title: Required default: true type: object required: - type - system title: CodeListSchema description: >- A list of medical codes resolved from generated free-text. Like :class:`CodeSchema`, but the coding pass decomposes the source text into multiple search queries and resolution returns a **list** of ``{"code", "options"}`` units, one per resolved condition (unresolved ones are dropped). See :class:`CodeSchema` for ``source`` and ``max_options``. DerivedSchema: properties: type: type: string const: derivedString title: Type derivation: items: $ref: '#/components/schemas/DerivedStringVariant' type: array minItems: 1 title: Derivation label: anyOf: - type: string - type: 'null' title: Label required: type: boolean title: Required default: true type: object required: - type - derivation title: DerivedSchema description: >- A string field computed from sibling values, never generated by the LLM. Each ``derivation`` variant supplies a language-specific template whose ``{placeholder}`` refs interpolate sibling properties of the enclosing object. Derived fields are excluded from every representation handed to the model and filled deterministically post-generation (after defaults, before coding). Missing/null/non-scalar sibling values render as empty strings. Like code fields, a derived field only ever appears as a property of an object (it needs siblings to interpolate). InstructionSetRef: properties: telepatiaPromptId: $ref: '#/components/schemas/TelepatiaPromptId' values: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Values type: object required: - telepatiaPromptId title: InstructionSetRef description: Reference to a prompt template with optional variable substitutions. EnumOption: properties: label: type: string title: Label value: type: string title: Value type: object required: - label - value title: EnumOption description: >- A decoupled enum option: display ``label`` vs stored ``value`` (code). Lets a partner show ``label`` while the generated record stores the stable ``value`` (catalog id, ICD-10, SNOMED), so labels can be renamed/translated without breaking the integration that consumes the code. DerivedStringVariant: properties: language: type: string title: Language template: type: string title: Template type: object required: - language - template title: DerivedStringVariant description: A language-specific template for a derived string field. TelepatiaPromptId: type: string enum: - IDENTIFICATION - CHIEF_COMPLAINT - HISTORY_OF_PRESENT_ILLNESS - REVIEW_OF_SYSTEMS - PAST_MEDICAL_HISTORY - PAST_MEDICAL_GYNECOLOGICAL_HISTORY - VITAL_SIGNS - ANTHROPOMETRIC_MEASURES - PHYSICAL_EXAMINATION - LABORATORY_AND_DIAGNOSTIC_TEST_RESULTS - CURRENT_TREATMENT - ASSESSMENT_PLAN - RECOMMENDATION_WARNING_SIGNS - PROCEDURE - MEDICAL_ORDERS_GENERAL_ORDERS - MEDICAL_ORDERS_INTERCONSULTATIONS - MEDICAL_ORDERS_MEDICATIONS - MEDICAL_ORDERS_DIAGNOSTIC_TESTS - MEDICAL_ORDERS_REFERRALS - MEDICAL_ORDERS_FOLLOW_UPS - MEDICAL_ORDERS_NON_PHARMACOLOGICAL - MEDICAL_ORDERS_WARNING_SIGNS - SUBJECTIVE - OBJECTIVE - DIAGNOSIS - SUMMARY - TEMPLATE - CHIEF_COMPLAINT_TRIAGE - EXTRA_ORAL_EXAMINATION - INTRA_ORAL_EXAMINATION - ODONTOGRAM - HISTORY_OF_PRESENT_ILLNESS_PSYCHOLOGY - PAST_MEDICAL_HISTORY_PSYCHOLOGY - COGNITIVE_BEHAVIORAL_EMOTIONAL_FUNCTIONAL_STATUS - MENTAL_EXAMINATION - MENTAL_EXAM - FUNCTIONAL_COGNITIVE_SPIRITUAL_ASSESSMENT - PSYCHOLOGY_ADJUSTMENT_AREA - PSYCHOLOGY_GENOGRAM - ASSESSMENT_PLAN_PSYCHOLOGY - PAST_MEDICAL_CONDITIONS_CARDIOVASCULAR_RISK - CARDIOVASCULAR_RISK - PAST_MEDICAL_CONDITIONS_PRENATAL_CARE - PRENATAL_CARE_PARTNER - PRENATAL_CARE_GYNECOLOGICAL_HISTORY - PRENATAL_CARE_LABORATORY_AND_DIAGNOSTIC_TEST_RESULTS - INTEGRATED_HEALTH_CARE_ROUTES_AGING - HEALTHY_LIFESTYLE title: TelepatiaPromptId description: Available Telepatia instruction set identifiers. securitySchemes: BearerAuth: type: http scheme: bearer description: Chave de API enviada como token Bearer ````