Sign in
Vaccinations

Retract a dose without erasing it — the record stays on the chart, struck through, and stops counting as a valid administration. Prefer this over DELETE whenever the dose was really recorded and is being reversed; DELETE remains for removing a row that should never have existed.

post/api/Vaccinations/{id}/void

Path parameters

idstring required

Request body

reasonstring

Why the dose was retracted. Shown alongside the struck-through record.

Response

OK

idstring
patientIdstring
appointmentIdstring nullable
administeredDatestring date-time
expirationDatestring date-time nullable

Next-due date (when the current dose lapses). Not the vial expiry — see DateTime? VaccinationRecordDto.VaccineExpirationDate.

vaccineExpirationDatestring date-time nullable

Physical vaccine vial/lot expiration date (distinct from the next-due DateTime? VaccinationRecordDto.ExpirationDate).

lotNumberstring nullable
manufacturerstring nullable
routestring nullable
sitestring nullable
notesstring nullable
inventoryTransactionIdstring nullable
hasUnresolvedLotboolean

True when the underlying inventory lot is a temporary placeholder awaiting resolution. Certificate generation is blocked while this is true.

isVoidedboolean

True when the dose was retracted (billing line voided, or a mis-entry corrected). The record stays on the chart for audit but is not a valid dose: it drives no reminders, does not count toward vaccination status or schedule stage, and cannot be certified. Render it struck through.

voidedAtstring date-time nullable
voidReasonstring nullable
createdAtstring date-time
updatedAtstring date-time

Changes

Changed in 1 of the 6 revisions of this API.1