VEvetnio
vetmanager

Create the VetManager visit for a consultation

Creates a visit for the selected owner and animal in VetManager (or adds the animal to an earlier visit) and links the consultation to it. It does not export the note: call the export endpoint next. A new visit charges the practice's basic fee. Safe to retry: when the visit context reports a pending creation with canRetry, resend the same selection to finish it without creating a duplicate.

Errors: 400 for an empty note or a selection VetManager rejects (for example an animal the owner does not own); 401 when the caller must sign in to VetManager again; 403 when the practice is not linked or not allowed to create visits; 409 when the account changed, the consultation is already linked, or another creation is in progress.

post/workspaces/{workspaceId}/consultations/{consultationId}/vetmanager/visit

Request

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

Path parameters

workspaceIdstring required

Identifier of the clinic (workspace), as returned by GET /workspaces. The key's user must be a member of the clinic, or an admin of the organization it belongs to.

Example:furunculotic-loud-chihuahua
consultationIdstring required

Identifier of the consultation (UUID), as returned when it was created or by GET /workspaces/{workspaceId}/consultations. It must belong to the clinic in workspaceId.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

practiceIdinteger required

VetManager practice id, as returned in practice.id by the visit context.

identityKeystring required

Opaque key from the visit context. A request is rejected with 409 when the signed-in VetManager account or practice changed since it was issued.

clinicalNotestring required

The note to write: HTML, plain text, or a structured note serialised as a JSON object. It is converted to plain text and must not be empty.

Example request

{
  "practiceId": 4242,
  "identityKey": "3f1e9c0b7a",
  "clinicalNote": "<p><strong>Anamnes</strong><br>Hälta vänster bak sedan två veckor.</p>",
  "selection": {
    "contactId": 5101,
    "animalId": 8811,
    "assignmentId": 3100001,
    "name": "Hälta"
  }
}

Response

The linked visit.

resonIdinteger required

VetManager visit reason ("reson") id: the record the note is written to.

assignmentIdinteger nullable required

VetManager visit (assignment) id; null for a recovered visit, which cannot take more animals.

practiceIdinteger required

VetManager practice id, as returned in practice.id by the visit context.

contactIdinteger required

VetManager client (owner) id.

animalIdinteger required

VetManager animal id.

clientBlockedboolean required

true when VetManager flags the owner as blocked; show a warning.

returnUrlstring nullable required

Link to the visit in VetManager, when known.

Example response

{
  "resonId": 2535050,
  "assignmentId": 3100001,
  "practiceId": 4242,
  "contactId": 5101,
  "animalId": 8811,
  "returnUrl": "https://vetmanager.se/vet_assignments/3100001/edit"
}

Changes

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