Consultation workflows
A consultation represents a medical question submitted by a user with active access to Abi. Partner systems can create a request, retrieve its current state, add a follow-up, or end the workflow.
What a consultation contains
Section titled “What a consultation contains”Each consultation has an Abi consultation identifier, the associated user identifier, creation time, status, and one or more questions. The consultation can also contain attachments supplied through the approved journey and, once resolved, the answer and relevant professional information.
The reference documents the complete response shape. At a product level, think of the consultation as the durable record connecting a user’s question, the service workflow, and the final response.
Consultation states
Section titled “Consultation states”| State | Meaning |
|---|---|
open |
The request is awaiting acceptance by an Abi healthcare professional. |
claimed |
A healthcare professional has accepted the request. |
resolved |
A response has been provided. |
closed |
The workflow has been closed. |
canceled |
The request was cancelled and is not available to a healthcare professional. |
Recommended lifecycle
Section titled “Recommended lifecycle”- Create a consultation for an existing, authorized user.
- Persist the returned consultation identifier.
- Retrieve the consultation when your product needs current status or response data.
- Add a follow-up only while the consultation state permits it.
- Cancel an unwanted request or close a completed workflow.
Attachments must use secure, reachable URLs and must follow the data-handling requirements agreed with Abi. Do not place credentials or unrestricted patient files in examples or logs.
See the API reference for the current state model, fields, and responses.
