Tross
Demo dataBook a demo
ECLINICALWORKS

Fetch patient immunization

List patient immunizations and injections.

POSThttps://preview.ontross.com/api/integrations/ecw/fetch-patient-immunization
Request Fields
input.patientId
string
required
Patient chart being read or written, from fetch-patients.
Example
"348144"
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
immOrderDetailsCount
integer
How many immunization records eCW returned.
Example
0
immOrderDetails
array
The patient's immunization records, one entry per dose.
immOrderDetails[].givenDate
string
Date the immunization was administered.
Example
"10/06/2026"
immOrderDetails[].encLock
string
Whether the encounter is locked against further edits.
Example
"0"
immOrderDetails[].ImmStatus
integer
Numeric eCW status code, spelled out in immStatusDetails.
Example
1
immOrderDetails[].ImmReasonCode
string
Coded reason the immunization was given or declined.
Example
"00"
immOrderDetails[].givenBy
string
Staff member who administered the immunization.
Example
"Example,Riley"
immOrderDetails[].lotNumber
string
Vaccine lot number for the dose given.
Example
"EX26A104"
immOrderDetails[].ItemId
integer
Catalog item id for the vaccine that was administered.
Example
900501
immOrderDetails[].Name
string
Vaccine name as eCW's immunization catalog spells it.
Example
"Influenza vaccine"
immOrderDetails[].immStatusDetails
string
Readable wording for the numeric ImmStatus code.
Example
"Administered"
immOrderDetails[].ImmOtherReason
string
Free-text reason given when the reason code is Other.
Example
"Patient requested vaccination at a later visit."
immOrderDetails[].encType
integer
Encounter type code, an integer or string depending on operation.
Example
1
immOrderDetails[].ImmunizationId
integer
eCW's own identifier for this immunization record.
Example
9000601
immOrderDetails[].location
string
Location eCW records for this immunization.
Example
"Left deltoid"
immOrderDetails[].Dose
string
Dose amount recorded for this immunization.
Example
"0.5 mL"
immFluScheduleDetails
object
Wrapper holding the flu date-range filters and their status.
immFluScheduleDetails.immFluDateRangeFilter
array
Flu season date-range filters eCW offers for this patient.
immFluScheduleDetails.immFluDateRangeFilter[].name
string
Display label for the available influenza season filter.
Example
"2571 - 9190"
immFluScheduleDetails.immFluDateRangeFilter[].value
integer
Numeric selection value for the influenza season filter.
Example
0
immFluScheduleDetails.immFluDateRangeFilter[].fluYear
array
Flu seasons covered by this date range filter.
immFluScheduleDetails.status
string
Source outcome marker for the influenza filter response.
Example
"success"
showImmRxnBtnInRed
boolean
Whether eCW flags the immunization reaction button red.
Example
false
status
string
Source outcome marker for the immunization history response.
Example
"success"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/fetch-patient-immunization \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"348144"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "348144"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "immOrderDetailsCount": 0,
    "immOrderDetails": [
      {
        "givenDate": "10/06/2026",
        "encLock": "0",
        "ImmStatus": 1,
        "ImmReasonCode": "00",
        "givenBy": "Example,Riley",
        "lotNumber": "EX26A104",
        "ItemId": 900501,
        "Name": "Influenza vaccine",
        "immStatusDetails": "Administered",
        "ImmOtherReason": "Patient requested vaccination at a later visit.",
        "encType": 1,
        "ImmunizationId": 9000601,
        "location": "Left deltoid",
        "Dose": "0.5 mL"
      }
    ],
    "immFluScheduleDetails": {
      "immFluDateRangeFilter": [
        {
          "name": "2571 - 9190",
          "value": 0,
          "fluYear": [
            "6136 - 0711"
          ]
        }
      ],
      "status": "success"
    },
    "showImmRxnBtnInRed": false,
    "status": "success"
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}