Sign in

v1

latestSwagger 2.02026-08-061791731.4 MB
Immunizations

{{baseUrl}}/persons/:personId/chart/immunizations/series-completions/:seriesId

Gets a patient's immunization series completion information for the provided person Id and series completion Id.

get/persons/{personId}/chart/immunizations/series-completions/{seriesId}

Path parameters

personIdstring required

(Required) (Required) The id of the person whose immunization series completion information is being retrieved

seriesIdstring required

(Required) (Required) The id of the series completion record whose details are being retrieved

Headers

Acceptstring required

Response

OK

idstring required
personIdstring required
enterpriseIdstring required
practiceIdstring required
seriesNamestring required
isCompletestring required
commentstring required

Example response

{
  "id": "<string>",
  "personId": "<string>",
  "enterpriseId": "<string>",
  "practiceId": "<string>",
  "seriesName": "<string>",
  "isComplete": "<string>",
  "comment": "<string>",
  "_links": [
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    },
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    }
  ]
}