v1

latestSwagger 2.02026-08-061791731.4 MB
Immunizations
{{baseUrl}}/persons/:personId/chart/immunizations

Gets a list of ordered vaccines for the specified person id after performing additional OData query operations.
get/persons/{personId}/chart/immunizations
Path parameters

personIdstring required
(Required) (Required) The id of the person whose ordered vaccines are being retrieved
Query parameters

$topstring required
(Required)
$filterstring required
(Required)
$orderbystring required
(Required)
$skipstring required
(Required)
$inlinecountstring required
(Required)
$countstring required
(Required)
Headers

Acceptstring required
Response

NextPageLinkstring required
Countstring required
Example response

{
  "Items": [
    {
      "id": "<string>",
      "personId": "<string>",
      "enterpriseId": "<string>",
      "practiceId": "<string>",
      "orderId": "<string>",
      "orderStatus": "<string>",
      "cvxCode": "<string>",
      "description": "<string>",
      "recordSourceCode": "<string>",
      "recordSourceName": "<string>",
      "administerCptCode": "<string>",
      "isDeleted": "<string>",
      "cptCode": "<string>",
      "sequenceNumber": "<string>",
      "status": "<string>",
      "comment": "<string>",
      "brandName": "<string>",
      "siteCode": "<string>",
      "site": "<string>",
      "sideCode": "<string>",
      "side": "<string>",
      "routeCode": "<string>",
      "route": "<string>",
      "unitsCode": "<string>",
      "units": "<string>",
      "lotNumber": "<string>",
      "expirationDate": "<string>",
      "dose": "<string>",
      "mvxCode": "<string>",
      "manufacturerNumber": "<string>",
      "manufacturerName": "<string>",
      "notAdministeredReason": "<string>",
      "notAdministeredCode": "<string>",
      "purchaseType": "<string>",
      "strength": "<string>",
      "administeredYear": "<string>",
      "administeredMonth": "<string>",
      "administeredDay": "<string>",
      "administeredDate": "<string>",
      "administeredTimestamp": "<string>",
      "administeredByUserId": "<string>",
      "administeredByName": "<string>",
      "auditId": "<string>",
      "chargeId": "<string>",
      "adminChargeId": "<string>",
      "isException": "<string>",
      "isCounselled": "<string>",
      "counselledCode": "<string>",
      "counselledUnit": "<string>",
      "counselChargeId": "<string>",
      "consentFrom": "<string>",
      "consentGivenTo": "<string>",
      "ndcId": "<string>",
      "isError": "<string>",
      "snomedImmunity": "<string>",
      "isVfc": "<string>",
      "vfcCode": "<string>",
      "vfcDate": "<string>",
      "vfcDateTimezone": "<string>",
      "fundingSourceCode": "<string>",
      "simCode": "<string>",
      "signOffUserId": "<string>",
      "signOffName": "<string>",
      "signOffDate": "<string>",
      "signOffDateTimezone": "<string>",
      "signoffComment": "<string>",
      "displayName": "<string>",
      "hideOnChart": "<string>",
      "createdBy": "<string>",
      "createTimestamp": "<string>",
      "createTimestampTimezone": "<string>",
      "modifiedByUserId": "<string>",
      "modifiedByName": "<string>",
      "modifyTimestamp": "<string>",
      "modifyTimestampTimezone": "<string>",
      "overrideInvalidDose": "<string>",
      "billingUnits": "<string>",
      "vaccineInventoryId": "<string>",
      "isReported": "<string>",
      "wasNotGiven": "<string>",
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ]
    },
    {
      "id": "<string>",
      "personId": "<string>",
      "enterpriseId": "<string>",
      "practiceId": "<string>",
      "orderId": "<string>",
      "orderStatus": "<string>",
      "cvxCode": "<string>",
      "description": "<string>",
      "recordSourceCode": "<string>",
      "recordSourceName": "<string>",
      "administerCptCode": "<string>",
      "isDeleted": "<string>",
      "cptCode": "<string>",
      "sequenceNumber": "<string>",
      "status": "<string>",
      "comment": "<string>",
      "brandName": "<string>",
      "siteCode": "<string>",
      "site": "<string>",
      "sideCode": "<string>",
      "side": "<string>",
      "routeCode": "<string>",
      "route": "<string>",
      "unitsCode": "<string>",
      "units": "<string>",
      "lotNumber": "<string>",
      "expirationDate": "<string>",
      "dose": "<string>",
      "mvxCode": "<string>",
      "manufacturerNumber": "<string>",
      "manufacturerName": "<string>",
      "notAdministeredReason": "<string>",
      "notAdministeredCode": "<string>",
      "purchaseType": "<string>",
      "strength": "<string>",
      "administeredYear": "<string>",
      "administeredMonth": "<string>",
      "administeredDay": "<string>",
      "administeredDate": "<string>",
      "administeredTimestamp": "<string>",
      "administeredByUserId": "<string>",
      "administeredByName": "<string>",
      "auditId": "<string>",
      "chargeId": "<string>",
      "adminChargeId": "<string>",
      "isException": "<string>",
      "isCounselled": "<string>",
      "counselledCode": "<string>",
      "counselledUnit": "<string>",
      "counselChargeId": "<string>",
      "consentFrom": "<string>",
      "consentGivenTo": "<string>",
      "ndcId": "<string>",
      "isError": "<string>",
      "snomedImmunity": "<string>",
      "isVfc": "<string>",
      "vfcCode": "<string>",
      "vfcDate": "<string>",
      "vfcDateTimezone": "<string>",
      "fundingSourceCode": "<string>",
      "simCode": "<string>",
      "signOffUserId": "<string>",
      "signOffName": "<string>",
      "signOffDate": "<string>",
      "signOffDateTimezone": "<string>",
      "signoffComment": "<string>",
      "displayName": "<string>",
      "hideOnChart": "<string>",
      "createdBy": "<string>",
      "createTimestamp": "<string>",
      "createTimestampTimezone": "<string>",
      "modifiedByUserId": "<string>",
      "modifiedByName": "<string>",
      "modifyTimestamp": "<string>",
      "modifyTimestampTimezone": "<string>",
      "overrideInvalidDose": "<string>",
      "billingUnits": "<string>",
      "vaccineInventoryId": "<string>",
      "isReported": "<string>",
      "wasNotGiven": "<string>",
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ]
    }
  ],
  "NextPageLink": "<string>",
  "Count": "<string>"
}