VEvetnio
consultations
patients

Link a patient to a consultation

Sets the consultation's patient. A consultation has at most one patient, so this replaces any patient already linked; the consultation then appears in that patient's history. Only the patient link changes (the owner, title and notes are untouched). Repeating the call with the same patient is harmless. Returns 404 when the consultation or the patient does not exist in the workspace and 403 when the consultation is archived. There is no unlink endpoint in the REST API.

post/workspaces/{workspaceId}/consultations/{consultationId}/patient

Request

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

Path parameters

workspaceIdstring required

Identifier of the workspace (clinic) that owns the patients and clients. The caller must be a member of it; patients and clients are shared by all members of the workspace.

Example:furunculotic-loud-chihuahua
consultationIdstring required

Consultation (UUID) to link the patient to. Must be in the workspace and not archived.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

patientIdstring required

Patient (UUID) in the same workspace to link to the consultation.

Example request

{
  "patientId": "f2a3b4c5-d6e7-4890-fabc-012345678901"
}

Response

Confirmation that the patient is now linked to the consultation.

successboolean required

Always true; failures are returned as errors.

Example response

{
  "success": true
}

Changes

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