Docs

Get appointment result

Retrieve the post-visit result for an appointment.

SDK method: patient.appointments.result() in TypeScript and Python. patient is the user-scoped client, client.forUser(userId) or client.for_user(user_id).

GET/appointments/{appointment_id}/result/

Retrieve the post-visit result for an appointment.

The result lists each prescription's display name and pharmacy destination, plus a stable artifact identifier for the clinician-finalized note once it is available. The clinician note is separate from the pre-visit AI SOAP-note artifact. Retrieve it with GET /artifacts/{artifactId}/; the artifact.ready event signals when its content is ready. The result reflects the clinical data recorded when the clinician finalized the note.

A 200 response means the appointment is fulfilled and its result is available. A 202 response means the result is not available yet and the client should retry later with bounded backoff. A 404 response means the appointment is unavailable in the authenticated organization and user scope. A 409 response means the appointment was cancelled or was a no-show, so no result will become available. Both authentication credentials are required.

Authorization

HTTPBearer XDoctronicUserID
AuthorizationBearer <token>

In: header

X-Doctronic-User-ID<token>

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

appointment_id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/appointments/string/result/"
{  "code": "success",  "message": "Request successful",  "data": {    "appointmentId": "string",    "prescriptions": [      {        "displayName": "string",        "pharmacy": {          "ncpdpId": "string",          "name": "string",          "address": {            "line1": "string",            "city": "string",            "state": "string",            "postalCode": "string"          },          "phoneNumber": "string"        }      }    ],    "clinicianNote": "string"  }}