Consultation flows
A consultation flow is the path from "doctor starts" to "HIS receives data".
Tiep supports three common flows.
Flow 1: Tiep UI with a dynamic form
Use this when the HIS knows exactly what form should be used for this visit.
The form is sent when creating the token. This is called a dynamic form because it belongs to that session or exact schema.
Flow 2: Tiep UI with catalogued forms
Use this when the facility already has a library of forms.
Catalogued forms are filtered by doctor specialty. For example, an orthopedic doctor sees orthopedic forms.
Flow 3: Direct API
Use this when your own app handles recording and review.
curl -X POST "https://api.tiep.ai/v1/facilities/12/generate" \
-H "X-API-Key: $FACILITY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"doctor": {
"id": "doctor-123",
"name": "Dr. Anna Smith",
"specialties": ["ORTHOPEDICS"]
},
"form": {
"title": "Short visit",
"type": "object",
"properties": {
"reason": {
"title": "Reason",
"type": "string",
"description": "Why the patient came today"
}
}
},
"transcript": {
"sentences": [
{ "text": "Patient comes in with shoulder pain after tennis." }
]
}
}'
The response is the generated payload. No doctor needs to open Tiep UI.
Session status
If you create a session, you can poll it.
| Status | Meaning |
|---|---|
in_progress | The visit exists but the report is not generated yet. |
pending | The doctor paused the visit for later. |
report_generated | Tiep generated the report, but it is not saved yet. |
report_saved | The doctor saved the report. The payload is available. |