Docs

Overview

See what the Doctronic API does, how an integration fits together, and where to start building.

The Doctronic API runs AI clinical consultations inside your product. Your backend creates a record for each patient, streams the consultation turn by turn, reacts to typed safety and workflow events, and retrieves the resulting summaries and SOAP notes.

How an integration works

Every call comes from your backend. One consultation moves through these resources:

  1. Patient → user. Create a Doctronic user for the patient and store its mem_… ID with the patient record in your system. See Users.
  2. User → chat. Create a chat for the consultation. One chat holds one consultation.
  3. Chat → streamed turn. Send each patient message to the chat's stream endpoint. The reply arrives as Server-Sent Events while the assistant writes it.
  4. Turn → typed events. message.* events carry the text to render. Separate events carry state: guardian for safety, conversation.end and skill_code.cta for next steps, and ai_consultation.complete when the consultation is done. Drive product state from these events, not from the assistant's wording.
  5. Completion → consultation documents. ai_consultation.complete lists the IDs of the long summary, short summary, and SOAP note. Fetch each one with GET /artifacts/{artifactId}/.
  6. Optional care. Continue into a Doctronic appointment, save a pharmacy, or store insurance coverage for the same user.
TermMeaning
UserThe Doctronic record for one patient, scoped to your organization
ChatThe API resource for one consultation
guardian eventA stream event that tells your product to run its agreed safety behavior
ArtifactThe API resource for a consultation document: a summary, SOAP note, or clinician note

What you can build

WorkflowAvailabilityStart with
A patient holds a clinical conversation in your productPublic APIConversations
Your workflow passes prior context into the consultationPublic APIPass context
Your product reacts to safety and next-step eventsPublic APISafety
Your records include summaries, SOAP notes, and clinician notesPublic APIConsultation documents
The patient books a scheduled or ASAP Doctronic visit and picks a pharmacyPublic API, enabled per organizationAppointments and pharmacy
Your backend stores the patient's insurance coveragePublic APICoverage
Your system receives appointment and artifact updates asynchronouslyConfigured by DoctronicWebhooks

"Public API" means the operation is in the published OpenAPI 3.1 contract. Doctronic enables credentials, workflows, and production access for each organization; see Get access.

Where to go

On this page