Form schema for the patient-facing intake form

GET

/v1/intake-sessions/{token}/info

Production
Local development

Public endpoint. Returns the form schema (sections + questions) for the patient to render at previsit.summary.to/intake/<token>. Schema is resolved from the catalog template chain (tenant default → SNOW catalog by specialty → general fallback).

Status codes are meaningful:

200 — form is renderable (status pending)
404 — token doesn’t exist
410 — token expired
409 — already submitted

Parameters

Path Parameters

token

required

string

Responses

200

object

status

Always pending when /info returns 200; expired/submitted return 410/409

string

Allowed values: pending

specialty

string

nullable

expires_at

string format: date-time

template

object

code

string

anc_first_visit

version

integer

name

string

source

string

Allowed values: tenant_visit_type tenant_specialty catalog_specialty catalog_general

form_schema

object

sections

Array<object>

object

title

string

questions

Array<object>

object

string

type

string

Allowed values: text number yes_no scale date choice multi_choice

label

string

required

boolean

options

Array<string>

nullable

doctor_name

string

nullable

clinic_name

string

nullable

logo_url

string format: uri

nullable

404

Invalid link

object

error

required

string

Invalid link

code

integer

409

Already submitted

object

error

required

string

Invalid link

code

integer

410

Expired

object

error

required

string

Invalid link

code

integer