Sign in

v1

latestSwagger 2.02026-08-061791731.4 MB
Immunizations

{{baseUrl}}/persons/:personId/chart/immunizations/group-status

Gets a list of vaccine group status for the specified person id.

get/persons/{personId}/chart/immunizations/group-status

Path parameters

personIdstring required

(Required) (Required) The id of the person whose vaccine group statuses are being retrieved

Headers

Acceptstring required

Response

OK

groupNamestring required
personIdstring required
isStatusProcessedSuccessfullystring required
isRuleFoundstring required
referenceDatestring required
personDateOfBirthstring required
cdcStartMonthstring required
cdcEndMonthstring required
nextDueDatestring required
statusstring required
statusCalculationCodestring required
doseSequenceStatusCalulatedForstring required
groupMinimumAgeInDaysstring required
groupMaximumAgeInDaysstring required
doseMinimumAgeInDaysstring required
doseMaximumAgeInDaysstring required
cvxToAdministerstring required
vaccineToAdministerstring required
totalDosesstring required
statusCalculationMessagestring required
nextDueDateCalculationMessagestring required

Example response

{
  "groupName": "<string>",
  "personId": "<string>",
  "isStatusProcessedSuccessfully": "<string>",
  "isRuleFound": "<string>",
  "referenceDate": "<string>",
  "personDateOfBirth": "<string>",
  "cdcStartMonth": "<string>",
  "cdcEndMonth": "<string>",
  "nextDueDate": "<string>",
  "status": "<string>",
  "statusCalculationCode": "<string>",
  "doseSequenceStatusCalulatedFor": "<string>",
  "groupMinimumAgeInDays": "<string>",
  "groupMaximumAgeInDays": "<string>",
  "doseMinimumAgeInDays": "<string>",
  "doseMaximumAgeInDays": "<string>",
  "cvxToAdminister": "<string>",
  "vaccineToAdminister": "<string>",
  "totalDoses": "<string>",
  "statusCalculationMessage": "<string>",
  "nextDueDateCalculationMessage": "<string>",
  "_links": [
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    },
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    }
  ]
}