vettigo

Export clinical note to Vettigo

Adds the supplied clinical note as a new, dated note in a Vettigo animal's medical record, authored by the caller's Vettigo user and department. The animal is taken from the consultation: a consultation started from Vettigo for an animal, else the Vettigo animal synced to the consultation's patient, else the animal of the Vettigo appointment the consultation was started from.

The note text is taken from the request, not from the consultation's stored note. Not idempotent: every call adds another note.

Errors: 400 when the consultation is not linked to Vettigo, the note is empty or the request is invalid (all reported as Invalid Vettigo request); 401 when the caller has no linked Vettigo account or Vettigo rejects Vetnio's credentials; 404 when the consultation does not exist; 429 on Vettigo rate limiting; 500 for other Vettigo failures.

post/workspaces/{workspaceId}/consultations/{consultationId}/vettigo/export

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/consultations/{consultationId}/vettigo/export
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the Vetnio workspace (clinic). The caller must be a member. The Vettigo clinic used is the one the caller last launched Vetnio from, not something configured on the workspace.

Example:furunculotic-loud-chihuahua
consultationIdstring required

Vetnio consultation (UUID) whose Vettigo animal or appointment receives the note.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

clinicalNotestring required

The note to write. Either HTML or plain text, or a JSON object serialised as a string (a structured note), which is written as one Field name: block per key with the key turned into a readable label. HTML is converted to plain text and characters Vettigo cannot store are replaced. Must not be empty after conversion.

Example request

{
  "clinicalNote": "<p><strong>Anamnesis</strong><br>Limping on the left hind leg for 2 weeks.</p><p><strong>Plan</strong><br>Meloxicam 0.1 mg/kg PO SID for 5 days.</p>"
}

Response

Export result, including the Vettigo animalID when resolved.

status'ok' required

Always ok; failures are returned as errors.

httpStatusnumber required

Always 200. Kept for older clients.

animalIDnumber nullable required

Vettigo animal id whose medical record received the note. null when the animal was resolved through the consultation's Vettigo appointment instead.

Example response

{
  "status": "ok",
  "httpStatus": 200,
  "animalID": 482913
}

Changes

No recorded changes to this operation across all 1 revision of this API.