Skip to content

Replace vaccination

Request

Fully replaces an existing Vaccination. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

vaccinationIdstringrequired

Vaccination unique identifier (UUID)

Bodyapplication/jsonrequired
administeredAtstringrequired

Date and time when the vaccination was administered.

Example:"2025-01-01T00:00:00.000Z"
animalIdstringrequired

Identifier of the animal that received the vaccination.

Example:"123e4567-e89b-12d3-a456-426614174000"
batchIdstringrequired

Identifier or lot number of the vaccine batch used.

Example:"123e4567-e89b-12d3-a456-426614174000"
consultIdstringrequired

Identifier of the consultation/visit during which the vaccination was administered.

Example:"123e4567-e89b-12d3-a456-426614174000"
descriptionstringrequired

Free-text description of the vaccination or product.

Example:"Example description"
extensionsobjectrequired

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

Example:true
nextAdministrationDatestringrequired

Planned date for the next administration/booster.

Example:"2025-01-01"
notesstringrequired

Clinical notes related to this vaccination.

Example:"Example description"
productIdstringrequired

Identifier of the vaccine product used.

Example:"123e4567-e89b-12d3-a456-426614174000"
quantitynumberrequired

Quantity of vaccine administered, expressed in product units.

Example:1.23
salesResourceIdstringrequired

Identifier linking this vaccination to a sales or billing resource.

Example:"123e4567-e89b-12d3-a456-426614174000"
vetIdstringrequired

Identifier of the veterinarian who administered or is responsible for the vaccination.

Example:"123e4567-e89b-12d3-a456-426614174000"
doseUnitstringrequired

Unit of measure for the vaccine dose (e.g., mL, dose, IU).

Example:"example"
routeobject(CodeableConceptDto)required

Route of administration for the vaccine.

sitestringrequired

Anatomical site of vaccine administration (e.g., right forelimb, left hindlimb).

Example:"example"
manufacturerstringrequired

Name of the vaccine manufacturer as recorded at administration time.

Example:"Example Name"
expiryDatestringrequired

Expiry date of the vaccine batch used at the time of administration.

Example:"2025-01-01"
indicationobject(CodeableConceptDto)required

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

statusobject(CodeableConceptDto)required

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

herdGroupIdstringrequired

Identifier of the herd, group, or lot of animals associated with this vaccination event, when applicable.

Example:"123e4567-e89b-12d3-a456-426614174000"
isBoosterbooleanrequired

Indicates whether this vaccination is a booster dose in a series.

Example:true
seriesNumbernumberrequired

Position of this dose within a vaccination series (e.g., 1 for first dose, 2 for second dose).

Example:1.23
curl -i -X PUT \
  'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/vaccination/{vaccinationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "administeredAt": "2025-01-01T00:00:00.000Z",
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "batchId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Example description",
    "extensions": {},
    "isActive": true,
    "nextAdministrationDate": "2025-01-01",
    "notes": "Example description",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 1.23,
    "salesResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000",
    "doseUnit": "example",
    "route": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "site": "example",
    "manufacturer": "Example Name",
    "expiryDate": "2025-01-01",
    "indication": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "status": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "isBooster": true,
    "seriesNumber": 1.23
  }'

Responses

Vaccination replaced successfully

Bodyapplication/json
administeredAtstring, (date-time)required

Date and time when the vaccination was administered.

Example:"2025-01-01T00:00:00.000Z"
animalIdstringrequired

Identifier of the animal that received the vaccination.

Example:"123e4567-e89b-12d3-a456-426614174000"
batchIdstringrequired

Identifier or lot number of the vaccine batch used.

Example:"123e4567-e89b-12d3-a456-426614174000"
consultIdstringrequired

Identifier of the consultation/visit during which the vaccination was administered.

Example:"123e4567-e89b-12d3-a456-426614174000"
createdAtstring, (date-time)required

Timestamp when the vaccination record was created.

Example:"2025-01-01T00:00:00.000Z"
descriptionstringrequired

Free-text description of the vaccination or product.

Example:"Example description"
extensionsobjectrequired

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

Example:true
nextAdministrationDatestring, (date-time)required

Planned date for the next administration/booster.

Example:"2025-01-01T00:00:00Z"
notesstringrequired

Clinical notes related to this vaccination.

Example:"Example description"
productIdstringrequired

Identifier of the vaccine product used.

Example:"123e4567-e89b-12d3-a456-426614174000"
quantitynumberrequired

Quantity of vaccine administered, expressed in product units.

Example:1.23
salesResourceIdstringrequired

Identifier linking this vaccination to a sales or billing resource.

Example:"123e4567-e89b-12d3-a456-426614174000"
updatedAtstring, (date-time)required

Timestamp when the vaccination record was last updated.

Example:"2025-01-01T00:00:00.000Z"
vaccinationIdstringrequired

Canonical identifier for this vaccination record.

Example:"123e4567-e89b-12d3-a456-426614174000"
vetIdstringrequired

Identifier of the veterinarian who administered or is responsible for the vaccination.

Example:"123e4567-e89b-12d3-a456-426614174000"
doseUnitstringrequired

Unit of measure for the vaccine dose (e.g., mL, dose, IU).

Example:"example"
routeobject(CodeableConceptDto)required

Route of administration for the vaccine.

sitestringrequired

Anatomical site of vaccine administration (e.g., right forelimb, left hindlimb).

Example:"example"
manufacturerstringrequired

Name of the vaccine manufacturer as recorded at administration time.

Example:"Example Name"
expiryDatestring, (date-time)required

Expiry date of the vaccine batch used at the time of administration.

Example:"2025-01-01T00:00:00Z"
indicationobject(CodeableConceptDto)required

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

statusobject(CodeableConceptDto)required

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

herdGroupIdstringrequired

Identifier of the herd, group, or lot of animals associated with this vaccination event, when applicable.

Example:"123e4567-e89b-12d3-a456-426614174000"
isBoosterbooleanrequired

Indicates whether this vaccination is a booster dose in a series.

Example:true
seriesNumbernumberrequired

Position of this dose within a vaccination series (e.g., 1 for first dose, 2 for second dose).

Example:1.23
Response
{ "administeredAt": "2025-01-01T00:00:00.000Z", "animalId": "123e4567-e89b-12d3-a456-426614174000", "batchId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "description": "Example description", "extensions": {}, "isActive": true, "nextAdministrationDate": "2025-01-01T00:00:00Z", "notes": "Example description", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": 1.23, "salesResourceId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "vaccinationId": "123e4567-e89b-12d3-a456-426614174000", "vetId": "123e4567-e89b-12d3-a456-426614174000", "doseUnit": "example", "route": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "site": "example", "manufacturer": "Example Name", "expiryDate": "2025-01-01T00:00:00Z", "indication": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "status": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "herdGroupId": "123e4567-e89b-12d3-a456-426614174000", "isBooster": true, "seriesNumber": 1.23 }