Skip to main content
POST
Create a Smart Template

Authorizations

Authorization
string
header
required

API key passed as a Bearer token

Body

application/json

Request body for registering a medical record configuration — a map of section key to section definition.

configuration
Configuration · object
required

Section map keyed by node name (schema + optional prompt strategy).

name
string | null

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

Maximum string length: 200
Example:

"Cardiology intake"

description
string | null

Optional human-readable description of the template.

Maximum string length: 500
Example:

"Intake template for the cardiology outpatient clinic."

specialty
enum<string> | null

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.

Available options:
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
Example:

"GENERAL_MEDICINE"

Response

Successful Response

Response body for registering a medical record configuration.

id
string
required

Public ID of the medical record configuration.

Example:

"mrc_a1b2c3d4e5f6g7h8"

name
string
required

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

Example:

"Cardiology intake"

hash
string
required

SHA-256 hash of the canonical configuration JSON.

Example:

"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"

createdAt
string<date-time>
required
Example:

"2026-04-20T14:30:00Z"

created
boolean
required

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

Example:

true