CLclinicos
Vaccinations

Suggest the schedule stage and next-due date for a dose being administered — which dose of the series this is, and when the next one is due (generalizes the rabies 1-vs-3-year rule).

Changed on
get/api/Vaccinations/next-dose

Request

Query parameters

patientIdstring
vaccineTypeIdstring
administeredDatestring date-time

Response

OK

vaccineTypeIdstring
hasScheduleboolean

False when the type has no explicit schedule and isn't rabies — plain single-duration behavior.

stageLabelstring nullable
isSeriesRestartboolean

True when prior doses exist but lapsed beyond the grace window, so the series restarts.

isSeriesCompleteboolean

True when this dose is the last of a non-repeating schedule: nothing further is due, so there is no suggested interval, duration, or next-due date (and no reminders).

isRabiesboolean
suggestedNextDueDatestring date-time nullable

Server-computed next-due date from the given administration date (the FE default). Null when bool NextDoseSuggestionDto.IsSeriesComplete — nothing further is due.

Changes

  • 85ee96c0bb96Revision changes
    • info

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

    • info

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

    • info

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

  • a905bde4e796Revision changes
    • info

      endpoint added