Sign in

v1

latestSwagger 2.02026-08-061791731.4 MB
Immunizations

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

Gets immunization order details for the specified person and order.

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

Path parameters

personIdstring required

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

orderIdstring required

(Required) (Required) The id of the immunization order being retrieved

Headers

Acceptstring required

Response

OK

idstring required
enterpriseIdstring required
practiceIdstring required
encounterIdstring required
personIdstring required
personNamestring required
userFriendlyOrderNumberstring required
generatedBystring required
locationIdstring required
locationNamestring required
orderingProviderIdstring required
orderingProviderNamestring required
supervisorProviderIdstring required
statusstring required
vaccineDescriptionstring required
createTimestampstring required
createTimestampTimezonestring required
modifyTimestampstring required
modifyTimestampTimezonestring required
registryIdstring required
interfaceMessagestring required
hasDocumentsstring required
hasTrackingCommentsstring required
immunizationsDescriptionstring required
orderCommentstring required
isVerbalOrderstring required
allergiesReviewedstring[] required
cancelReasonstring required
signOffDatestring required
signOffDateTimezonestring required
signOffUserIdstring required
signOffUserNamestring required
privacyLevelstring required
encounterTimestampstring required
encounterTimestampTimezonestring required
isDeletedstring required

Example response

{
  "id": "<string>",
  "enterpriseId": "<string>",
  "practiceId": "<string>",
  "encounterId": "<string>",
  "personId": "<string>",
  "personName": "<string>",
  "userFriendlyOrderNumber": "<string>",
  "generatedBy": "<string>",
  "locationId": "<string>",
  "locationName": "<string>",
  "orderingProviderId": "<string>",
  "orderingProviderName": "<string>",
  "supervisorProviderId": "<string>",
  "status": "<string>",
  "vaccineDescription": "<string>",
  "createTimestamp": "<string>",
  "createTimestampTimezone": "<string>",
  "modifyTimestamp": "<string>",
  "modifyTimestampTimezone": "<string>",
  "registryId": "<string>",
  "interfaceMessage": "<string>",
  "hasDocuments": "<string>",
  "hasTrackingComments": "<string>",
  "immunizationsDescription": "<string>",
  "orderComment": "<string>",
  "isVerbalOrder": "<string>",
  "allergiesReviewed": [
    "<string>",
    "<string>"
  ],
  "cancelReason": "<string>",
  "signOffDate": "<string>",
  "signOffDateTimezone": "<string>",
  "signOffUserId": "<string>",
  "signOffUserName": "<string>",
  "privacyLevel": "<string>",
  "encounterTimestamp": "<string>",
  "encounterTimestampTimezone": "<string>",
  "isDeleted": "<string>",
  "_links": [
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    },
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    }
  ]
}