Vaccinations

put/api/Vaccinations/{id}

Path parameters

idstring required

Request body

vaccineTypeIdstring nullable
administeredDatestring date-time nullable
expirationDatestring date-time nullable
vaccineExpirationDatestring date-time nullable

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

lotNumberstring nullable
manufacturerstring nullable
routestring nullable
sitestring nullable
administeredByIdstring nullable

Reassign who physically gave the dose. Null = leave unchanged; to CLEAR back to "not recorded / external", set bool UpdateVaccinationRecordRequest.NoAdministeredBy.

noAdministeredByboolean

True = clear the administering staff member to "not recorded / external". Wins over string? UpdateVaccinationRecordRequest.AdministeredById.

doctorOfRecordIdstring nullable

Reassign the DVM of record. Null = leave unchanged; to CLEAR to "no doctor", set bool UpdateVaccinationRecordRequest.NoDoctorOfRecord.

noDoctorOfRecordboolean

True = clear the doctor of record (dose certifies unsigned). Wins over string? UpdateVaccinationRecordRequest.DoctorOfRecordId.

notesstring nullable

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.27

    • added the new optional request property (media type: application/json)

      new-optional-request-property

    • added the new optional request property (media type: text/json)

      new-optional-request-property

    • added the new optional request property (media type: application/*+json)

      new-optional-request-property

    • added the new optional request property (media type: application/json)

      new-optional-request-property

    • added the new optional request property (media type: text/json)

      new-optional-request-property

    • added the new optional request property (media type: application/*+json)

      new-optional-request-property

    • added the new optional request property (media type: application/json)

      new-optional-request-property

    • added the new optional request property (media type: text/json)

      new-optional-request-property

    • added the new optional request property (media type: application/*+json)

      new-optional-request-property

    • added the optional property to the response with the status (media type: text/plain)

      response-optional-property-added

    • added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/plain)

      response-optional-property-added

    • added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/plain)

      response-optional-property-added

    • added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/plain)

      response-optional-property-added

    • added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/plain)

      response-optional-property-added

    • added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/plain)

      response-optional-property-added

    • added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • added the optional property to the response with the status (media type: text/json)

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog