Procedure

Represents a clinical procedure performed on a patient, including surgeries, dental work, diagnostics, and therapeutic interventions.

Schema ID: https://vetformat.org/schemas/v1/procedure.schema.json

Fields

Field	Type	Required	Description
resource_type	"Procedure"	Yes	Fixed resource type identifier for this schema.
id	string	Yes	Unique identifier for the procedure record. UUID recommended.
patient_id	string	Yes	Reference to the patient on whom the procedure was performed.
encounter_id	string	No	Reference to the encounter during which the procedure was performed.
name	string	Yes	Human-readable name of the procedure.
code	[ovfcode]	No
status	enum	Yes	Current status of the procedure.
category	enum	No	The high-level category of the procedure.
performed_date	string (date-time)	Yes	Date and time when the procedure was performed or started.
end_date	string (date-time)	No	Date and time when the procedure ended.
practitioner_id	string	No	Reference to the practitioner who performed the procedure. Must match an id in the top-level practitioners array.
anesthesia	[anesthesia]	No
outcome	string	No	Description of the procedure outcome.
complications	string	No	Any complications that occurred during or after the procedure.
notes	string	No	Additional notes about the procedure.
cost	[ovfcost]	No

status values

• planned
• in-progress
• completed
• cancelled

category values

• surgery
• dental
• diagnostic
• therapeutic
• grooming
• other

Sub-objects

anesthesia object

Anesthesia details for the procedure.

Field	Type	Required	Description
type	enum	No	Type of anesthesia administered.
agent	string	No	Name of the anesthetic agent used.

anesthesia.type values

• general
• local
• sedation
• none

Full Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://vetformat.org/schemas/v1/procedure.schema.json",
  "title": "Procedure",
  "description": "Represents a clinical procedure performed on a patient, including surgeries, dental work, diagnostics, and therapeutic interventions.",
  "type": "object",
  "required": [
    "resource_type",
    "id",
    "patient_id",
    "name",
    "status",
    "performed_date"
  ],
  "additionalProperties": false,
  "$defs": {
    "anesthesia": {
      "type": "object",
      "description": "Anesthesia details for the procedure.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "general",
            "local",
            "sedation",
            "none"
          ],
          "description": "Type of anesthesia administered.",
          "examples": [
            "general"
          ]
        },
        "agent": {
          "type": "string",
          "description": "Name of the anesthetic agent used.",
          "examples": [
            "Isoflurane"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "properties": {
    "resource_type": {
      "const": "Procedure",
      "description": "Fixed resource type identifier for this schema.",
      "examples": [
        "Procedure"
      ]
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9._-]+$",
      "description": "Unique identifier for the procedure record. UUID recommended.",
      "examples": [
        "proc-550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "patient_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9._-]+$",
      "description": "Reference to the patient on whom the procedure was performed.",
      "examples": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "encounter_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9._-]+$",
      "description": "Reference to the encounter during which the procedure was performed.",
      "examples": [
        "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      ]
    },
    "name": {
      "type": "string",
      "description": "Human-readable name of the procedure.",
      "examples": [
        "Ovariohysterectomy (Spay)"
      ]
    },
    "code": {
      "$ref": "ovf.schema.json#/$defs/code"
    },
    "status": {
      "type": "string",
      "enum": [
        "planned",
        "in-progress",
        "completed",
        "cancelled"
      ],
      "description": "Current status of the procedure.",
      "examples": [
        "completed"
      ]
    },
    "category": {
      "type": "string",
      "enum": [
        "surgery",
        "dental",
        "diagnostic",
        "therapeutic",
        "grooming",
        "other"
      ],
      "description": "The high-level category of the procedure.",
      "examples": [
        "surgery"
      ]
    },
    "performed_date": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when the procedure was performed or started.",
      "examples": [
        "2025-06-15T09:00:00Z"
      ]
    },
    "end_date": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when the procedure ended.",
      "examples": [
        "2025-06-15T10:30:00Z"
      ]
    },
    "practitioner_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9._-]+$",
      "description": "Reference to the practitioner who performed the procedure. Must match an id in the top-level practitioners array.",
      "examples": [
        "pract-001"
      ]
    },
    "anesthesia": {
      "$ref": "#/$defs/anesthesia"
    },
    "outcome": {
      "type": "string",
      "description": "Description of the procedure outcome.",
      "examples": [
        "Successful. Patient recovered well from anesthesia."
      ]
    },
    "complications": {
      "type": "string",
      "description": "Any complications that occurred during or after the procedure.",
      "examples": [
        "Minor bleeding controlled with cauterization."
      ]
    },
    "notes": {
      "type": "string",
      "description": "Additional notes about the procedure.",
      "examples": [
        "E-collar to be worn for 10 days. Suture removal in 14 days."
      ]
    },
    "cost": {
      "$ref": "ovf.schema.json#/$defs/cost"
    }
  }
}