TEtelepatia
Medical Record Configurations

Get a Smart Template by ID

Get a Smart Template by its public identifier.

get/v1/medical-record-configurations/{configuration_id}

Request

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

Path parameters

configuration_idstring required

Response

Successful Response

idstring required

Stable public identifier.

namestring required

Display name (defaults to the public id when none was set).

descriptionstring nullable

Optional human-readable description of the template.

hashstring required

Content hash used to detect configuration changes.

createdAtstring required

ISO-8601 timestamp when the configuration was created.

configurationobject required

Section configurations keyed by section name (e.g., 'chiefComplaint', 'vitals').

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.

specialtiesstring[]

Medical specialty values this configuration applies to.

status'active' | 'inactive' | 'deleted' required

Public lifecycle status exposed on list/detail responses.

workflowstring nullable

Product this template belongs to. Null for an ordinary Scribe template.

Example response

{
  "id": "mrc_a1b2c3d4e5f6g7h8",
  "name": "Cardiology intake",
  "description": "Intake template for the cardiology outpatient clinic.",
  "example": {
    "historyOfPresentIllness": "<string>",
    "reviewOfSystems": [
      "<string>"
    ],
    "visitDate": "<YYYY-MM-DD>",
    "vitalSigns": {
      "bloodPressure": "<string>",
      "heartRate": "<number>",
      "severity": "<mild | moderate | severe>"
    }
  },
  "specialties": [
    "cardiology"
  ],
  "workflow": "reportDictation"
}

Changes

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