Sign in

v1

latestSwagger 2.02026-08-061791731.4 MB
Immunizations

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

Gets patient interactions for a vaccine with the given CVX and CPT codes.

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

Path parameters

personIdstring required

(Required) (Required) The id of the person whose interactions are being retrieved

Query parameters

cvxCodestring required

(Required) The cvx code of the vaccine for which interaction are being retrieved

cptCodestring required

(Required) The cpt code of the vaccine for which interaction are being retrieved

Headers

Acceptstring required

Response

OK

personIdstring required
isRequiredstring required
acknowledgedstring required
severityLevelstring required
descriptionstring required
entityNamestring required
eventTypestring required
sourceIdstring required
causestring required
warningDetailstring required
warningTypestring required
warningstring required
causeTextstring required
overrideTextstring required
durAuditKeystring required
isSuppressedstring required
isRecordedElseWherestring required
practiceIdstring required
displaystring required

Example response

{
  "personId": "<string>",
  "isRequired": "<string>",
  "acknowledged": "<string>",
  "severityLevel": "<string>",
  "description": "<string>",
  "entityName": "<string>",
  "eventType": "<string>",
  "sourceId": "<string>",
  "cause": "<string>",
  "warningDetail": "<string>",
  "warningType": "<string>",
  "warning": "<string>",
  "causeText": "<string>",
  "overrideText": "<string>",
  "durAuditKey": "<string>",
  "isSuppressed": "<string>",
  "isRecordedElseWhere": "<string>",
  "practiceId": "<string>",
  "display": "<string>",
  "_links": [
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    },
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    }
  ]
}