# Update vaccination

Partially updates an existing Vaccination. Only provided fields will be updated.

Endpoint: PATCH /site/{siteId}/ahds/v1/vaccination/{vaccinationId}
Version: 1.0
Security: bearer

## Security:

  - `bearer` (unknown)
    http bearer JWT

## Path parameters:

  - `siteId` (number, required)
    Site identifier

  - `vaccinationId` (string, required)
    Vaccination unique identifier (UUID)

## Request fields (application/json):

  - `administeredAt` (string)
    Date and time when the vaccination was administered.
    Example: 2025-01-01T00:00:00.000Z

  - `animalId` (string)
    Identifier of the animal that received the vaccination.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `batchId` (string)
    Identifier or lot number of the vaccine batch used.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `consultId` (string)
    Identifier of the consultation/visit during which the vaccination was administered.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `description` (string)
    Free-text description of the vaccination or product.
    Example: Example description

  - `extensions` (object)
    Practice- or vendor-specific extensions.

  - `isActive` (boolean)
    Whether this vaccination record is currently active.
    Example: true

  - `nextAdministrationDate` (string)
    Planned date for the next administration/booster.
    Example: 2025-01-01

  - `notes` (string)
    Clinical notes related to this vaccination.
    Example: Example description

  - `productId` (string)
    Identifier of the vaccine product used.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `quantity` (number)
    Quantity of vaccine administered, expressed in product units.
    Example: 1.23

  - `salesResourceId` (string)
    Identifier linking this vaccination to a sales or billing resource.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `vetId` (string)
    Identifier of the veterinarian who administered or is responsible for the vaccination.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `doseUnit` (string)
    Unit of measure for the vaccine dose (e.g., mL, dose, IU).
    Example: example

  - `route` (object)
    Route of administration for the vaccine.

  - `route.code` (string, required)
    Code value
    Example: 12345

  - `route.system` (string, required)
    Code system URI
    Example: http://example.com/codesystem

  - `route.display` (string)
    Human-readable display
    Example: Example Display Name

  - `site` (string)
    Anatomical site of vaccine administration (e.g., right forelimb, left hindlimb).
    Example: example

  - `manufacturer` (string)
    Name of the vaccine manufacturer as recorded at administration time.
    Example: Example Name

  - `expiryDate` (string)
    Expiry date of the vaccine batch used at the time of administration.
    Example: 2025-01-01

  - `indication` (object)
    Clinical indication or reason for vaccination (e.g., core vaccine, travel requirement, outbreak control).

  - `status` (object)
    Clinical status of the vaccination event (e.g., completed, not-done, entered-in-error).

  - `herdGroupId` (string)
    Identifier of the herd, group, or lot of animals associated with this vaccination event, when applicable.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `isBooster` (boolean)
    Indicates whether this vaccination is a booster dose in a series.
    Example: true

  - `seriesNumber` (number)
    Position of this dose within a vaccination series (e.g., 1 for first dose, 2 for second dose).
    Example: 1.23

## Response 200:

  - `200` (unknown)
    Vaccination updated successfully

## Response 200 fields (application/json):

  - `administeredAt` (string, required)
    Date and time when the vaccination was administered.
    Example: 2025-01-01T00:00:00.000Z

  - `animalId` (string, required)
    Identifier of the animal that received the vaccination.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `batchId` (string, required)
    Identifier or lot number of the vaccine batch used.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `consultId` (string, required)
    Identifier of the consultation/visit during which the vaccination was administered.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `createdAt` (string, required)
    Timestamp when the vaccination record was created.
    Example: 2025-01-01T00:00:00.000Z

  - `description` (string, required)
    Free-text description of the vaccination or product.
    Example: Example description

  - `extensions` (object, required)
    Practice- or vendor-specific extensions.

  - `isActive` (boolean, required)
    Whether this vaccination record is currently active.
    Example: true

  - `nextAdministrationDate` (string, required)
    Planned date for the next administration/booster.
    Example: 2025-01-01T00:00:00Z

  - `notes` (string, required)
    Clinical notes related to this vaccination.
    Example: Example description

  - `productId` (string, required)
    Identifier of the vaccine product used.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `quantity` (number, required)
    Quantity of vaccine administered, expressed in product units.
    Example: 1.23

  - `salesResourceId` (string, required)
    Identifier linking this vaccination to a sales or billing resource.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `updatedAt` (string, required)
    Timestamp when the vaccination record was last updated.
    Example: 2025-01-01T00:00:00.000Z

  - `vaccinationId` (string, required)
    Canonical identifier for this vaccination record.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `vetId` (string, required)
    Identifier of the veterinarian who administered or is responsible for the vaccination.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `doseUnit` (string, required)
    Unit of measure for the vaccine dose (e.g., mL, dose, IU).
    Example: example

  - `route` (object, required)
    Route of administration for the vaccine.

  - `route.code` (string, required)
    Code value
    Example: 12345

  - `route.system` (string, required)
    Code system URI
    Example: http://example.com/codesystem

  - `route.display` (string)
    Human-readable display
    Example: Example Display Name

  - `site` (string, required)
    Anatomical site of vaccine administration (e.g., right forelimb, left hindlimb).
    Example: example

  - `manufacturer` (string, required)
    Name of the vaccine manufacturer as recorded at administration time.
    Example: Example Name

  - `expiryDate` (string, required)
    Expiry date of the vaccine batch used at the time of administration.
    Example: 2025-01-01T00:00:00Z

  - `indication` (object, required)
    Clinical indication or reason for vaccination (e.g., core vaccine, travel requirement, outbreak control).

  - `status` (object, required)
    Clinical status of the vaccination event (e.g., completed, not-done, entered-in-error).

  - `herdGroupId` (string, required)
    Identifier of the herd, group, or lot of animals associated with this vaccination event, when applicable.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `isBooster` (boolean, required)
    Indicates whether this vaccination is a booster dose in a series.
    Example: true

  - `seriesNumber` (number, required)
    Position of this dose within a vaccination series (e.g., 1 for first dose, 2 for second dose).
    Example: 1.23

## Response 400:

  - `400` (unknown)
    Invalid request body

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 404:

  - `404` (unknown)
    Vaccination not found

