Immunizations

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

Gets immunization orders for the specified person after performing additional OData operations.

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

Request

Base URL
https://nativeapi.nextgen.com/nge/prod/nge-api/api
Auth
none declared. Required headers: Accept
TypeScript
https://skmtc.dev/nextgen/apis/enterprise-api-uscdi-routes/docs/persons/:personId/chart/immunizations/orders/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

personIdstring required

(Required) (Required) The id of the person whose immunization order is being retrieved

Query parameters

$topstring required

$filterstring required

$orderbystring required

$skipstring required

$inlinecountstring required

$countstring required

Headers

Acceptstring required

Response

NextPageLinkstring required

Countstring required

Example response

{
  "Items": [
    {
      "id": "<string>",
      "enterpriseId": "<string>",
      "practiceId": "<string>",
      "encounterId": "<string>",
      "personId": "<string>",
      "userFriendlyOrderNumber": "<string>",
      "orderingProviderId": "<string>",
      "orderingProviderName": "<string>",
      "supervisorProviderId": "<string>",
      "status": "<string>",
      "vaccineDescription": "<string>",
      "createTimestamp": "<string>",
      "createTimestampTimezone": "<string>",
      "modifyTimestamp": "<string>",
      "modifyTimestampTimezone": "<string>",
      "isDeleted": "<string>",
      "hasDocuments": "<string>",
      "hasTrackingComments": "<string>",
      "immunizationsDescription": "<string>",
      "isVerbalOrder": "<string>",
      "encounterTimestamp": "<string>",
      "encounterTimestampTimezone": "<string>",
      "locationId": "<string>",
      "locationName": "<string>",
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ]
    },
    {
      "id": "<string>",
      "enterpriseId": "<string>",
      "practiceId": "<string>",
      "encounterId": "<string>",
      "personId": "<string>",
      "userFriendlyOrderNumber": "<string>",
      "orderingProviderId": "<string>",
      "orderingProviderName": "<string>",
      "supervisorProviderId": "<string>",
      "status": "<string>",
      "vaccineDescription": "<string>",
      "createTimestamp": "<string>",
      "createTimestampTimezone": "<string>",
      "modifyTimestamp": "<string>",
      "modifyTimestampTimezone": "<string>",
      "isDeleted": "<string>",
      "hasDocuments": "<string>",
      "hasTrackingComments": "<string>",
      "immunizationsDescription": "<string>",
      "isVerbalOrder": "<string>",
      "encounterTimestamp": "<string>",
      "encounterTimestampTimezone": "<string>",
      "locationId": "<string>",
      "locationName": "<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>"
}

Changes

No recorded changes to this operation across all 1 revision of this API.