v1

latestSwagger 2.02026-08-061791731.4 MB

Immunizations

{{baseUrl}}/persons/:personId/chart/immunizations/exclusions

Gets a list of excluded vaccines for the specified person id after performing additional OData query operations.

get/persons/{personId}/chart/immunizations/exclusions

Path parameters

personIdstring required

(Required) (Required) The id of the person whose excluded 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>",
      "cvxCode": "<string>",
      "name": "<string>",
      "reasons": [
        "<string>",
        "<string>"
      ],
      "startDate": "<string>",
      "endDate": "<string>",
      "comment": "<string>",
      "createdBy": "<string>",
      "createTimestamp": "<string>",
      "modifiedBy": "<string>",
      "modifyTimestamp": "<string>",
      "practiceName": "<string>",
      "excludedBy": "<string>",
      "isDeleted": "<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>",
      "cvxCode": "<string>",
      "name": "<string>",
      "reasons": [
        "<string>",
        "<string>"
      ],
      "startDate": "<string>",
      "endDate": "<string>",
      "comment": "<string>",
      "createdBy": "<string>",
      "createTimestamp": "<string>",
      "modifiedBy": "<string>",
      "modifyTimestamp": "<string>",
      "practiceName": "<string>",
      "excludedBy": "<string>",
      "isDeleted": "<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>"
}