Creates a new Vaccination record. Vaccination resource in the Animal Health Data Store
Date and time when the vaccination was administered.
Identifier of the animal that received the vaccination.
Identifier or lot number of the vaccine batch used.
Identifier of the consultation/visit during which the vaccination was administered.
Identifier of the vaccine product used.
Identifier linking this vaccination to a sales or billing resource.
Canonical identifier for this vaccination record.
Identifier of the veterinarian who administered or is responsible for the vaccination.
Anatomical site of vaccine administration (e.g., right forelimb, left hindlimb).
Name of the vaccine manufacturer as recorded at administration time.
Expiry date of the vaccine batch used at the time of administration.
Clinical indication or reason for vaccination (e.g., core vaccine, travel requirement, outbreak control).
Clinical status of the vaccination event (e.g., completed, not-done, entered-in-error).
Identifier of the herd, group, or lot of animals associated with this vaccination event, when applicable.
- Mock serverhttps://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/vaccination
- Local Developmenthttp://localhost:8083/site/{siteId}/ahds/v1/vaccination
curl -i -X POST \
'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/vaccination' \
-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",
"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-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
}'Vaccination created successfully
Date and time when the vaccination was administered.
Identifier of the animal that received the vaccination.
Identifier or lot number of the vaccine batch used.
Identifier of the consultation/visit during which the vaccination was administered.
Timestamp when the vaccination record was created.
Free-text description of the vaccination or product.
Planned date for the next administration/booster.
Identifier of the vaccine product used.
Identifier linking this vaccination to a sales or billing resource.
Timestamp when the vaccination record was last updated.
Canonical identifier for this vaccination record.
Identifier of the veterinarian who administered or is responsible for the vaccination.
Anatomical site of vaccine administration (e.g., right forelimb, left hindlimb).
Name of the vaccine manufacturer as recorded at administration time.
Expiry date of the vaccine batch used at the time of administration.
Clinical indication or reason for vaccination (e.g., core vaccine, travel requirement, outbreak control).
Clinical status of the vaccination event (e.g., completed, not-done, entered-in-error).
Identifier of the herd, group, or lot of animals associated with this vaccination event, when applicable.
Indicates whether this vaccination is a booster dose in a series.
{ "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 }