Skip to content
SNOW Docs

Create a provider-driven pre-visit session

POST
/v1/sessions/previsit/provider

Sugar alias for POST /v1/sessions with type=pre-consult and ui_type=clinician. Use when clinic staff (front-desk, nurse, doctor) fills the form on a clinic tablet with the patient present.

Identical to /v1/sessions/previsit/patient except the rendered form uses clinician language (less explanatory text, more clinical terminology). Response ui_type is always clinician.

Authorizations

Parameters

Header Parameters

Idempotency-Key

Optional UUID to deduplicate retries. 24h TTL.

string format: uuid

Request Body required

object
patient
object
clinic
object
template_code
string
nullable
appointment_id
string
nullable
language
string
en
expires_in_minutes
integer
default: 120
metadata
object
key
additional properties
any
{
  "patient": {
    "name": "Priya S"
  },
  "clinic": {
    "doctor": "Dr. Padmavathi",
    "display_name": "Sunrise Clinic"
  }
}

Responses

201

Session created (ui_type=clinician)

object
id
string format: uuid
session_id
string format: uuid
token

Opaque public token used in patient-facing URLs

string
type

Server-side aliases: emergency-summary → emergency, pre-anc-visit → pre-consult.

string
Allowed values: pre-consult clinical-note discharge referral transfer medication lab-requisition history international emergency emergency-summary pre-anc-visit pre-visit-clinic care-plan radiology
specialty
string
nullable 
obstetrics
session_url
string format: uri 
https://previsit.summary.to/obstetrics/bRJIY1oc8BgtMCucjWfPJk3P
expires_at
string format: date-time
created_at
string format: date-time
ui_type

Hint for which UI mode the link is intended for

string
Allowed values: patient clinician

400

Validation error

object
error
required
string
Invalid link
code
integer
1003

401

Invalid API key

object
error
required
string
Invalid link
code
integer
1003

409

Idempotency-Key body mismatch

object
error
required
string
Invalid link
code
integer
1003

429

Rate limit / quota exceeded

object
error
required
string
Invalid link
code
integer
1003