Sign in

191e69116448

latestSwagger 2.02026-08-061791731.4 MB
Immunizations

{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines

Gets vaccines for the given person id and order id.

get/persons/{personId}/chart/immunizations/orders/{orderId}/vaccines

Path parameters

personIdstring required

(Required) (Required) The id of the person who the order belongs to

orderIdstring required

(Required) (Required) The id of the order whose vaccines are being retrieved

Headers

Acceptstring required

Response

OK

idstring required
personIdstring required
enterpriseIdstring required
practiceIdstring required
orderIdstring required
cvxCodestring required
descriptionstring required
cptCodestring required
sequenceNumberstring required
statusstring required
lotNumberstring required
administeredYearstring required
administeredMonthstring required
administeredDaystring required
administeredDatestring required
administeredTimestampstring required
administeredByUserIdstring required
administeredByNamestring required
isVfcstring required
vfcCodestring required
fundingSourceCodestring required

Example response

{
  "id": "<string>",
  "personId": "<string>",
  "enterpriseId": "<string>",
  "practiceId": "<string>",
  "orderId": "<string>",
  "cvxCode": "<string>",
  "description": "<string>",
  "cptCode": "<string>",
  "sequenceNumber": "<string>",
  "status": "<string>",
  "lotNumber": "<string>",
  "administeredYear": "<string>",
  "administeredMonth": "<string>",
  "administeredDay": "<string>",
  "administeredDate": "<string>",
  "administeredTimestamp": "<string>",
  "administeredByUserId": "<string>",
  "administeredByName": "<string>",
  "isVfc": "<string>",
  "vfcCode": "<string>",
  "fundingSourceCode": "<string>",
  "_links": [
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    },
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    }
  ]
}