Get a consultation artifact
Retrieve a consultation artifact: a long summary, short summary, AI SOAP note, or clinician-finalized note.
SDK method: patient.artifacts.retrieve() in TypeScript and Python. patient is the user-scoped client, client.forUser(userId) or client.for_user(user_id).
/artifacts/{artifactId}/Retrieve a consultation artifact: a long summary, short summary, AI SOAP note, or clinician-finalized note.
AI artifact identifiers are delivered in the ai_consultation.complete stream event. The clinician note identifier is returned by GET /appointments/{appointment_id}/result/ after the visit is finalized.
A 200 response contains Markdown in data.content.body. A 202 response means generation is still in progress and the client should retry later with bounded backoff. A 404 response means the artifact is unavailable in the authenticated organization and user scope. A 500 response means generation failed.
Authorization
HTTPBearer XDoctronicUserID In: header
Doctronic user ID returned as data.id by POST /users/. This value identifies the user in your organization scope; it is not an API token.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/artifacts/string/"{ "code": "success", "message": "Request successful", "data": { "artifactType": "soap_note", "artifactId": "string", "content": { "chatId": "string", "createdAt": "2019-08-24T14:15:22Z", "body": "string" } }}