v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB

Immunizations

Retrieve Immunization

Retrieve a single immunization

get/api/2.0/immunizations/{id}/

idinteger required

administered_datestring date-time required

administering_physicianinteger nullable required

allowed_sharingboolean nullable

Whether this immunization should be sent to Immunization Registry (true/false/null)

created_datestring date-time nullable

deleted_datestring date-time nullable

descriptionstring nullable

dose_in_seriesinteger nullable

expiration_datestring date nullable

idinteger

lot_numberstring nullable

manufacturer_codestring nullable

manufacturer_namestring nullable

methodstring nullable

ndcstring nullable

Should be 10-11 digits, 2 dashes.

notesstring nullable

ordering_physicianinteger nullable required

patientinteger required

patient_consentboolean nullable

practiceinteger nullable

priority_populationstring nullable

For Immunization Registry Integrations (less than 9 symbols).

qtystring nullable required

qty_unitsstring nullable

reasonstring nullable

service_location_idinteger nullable

sitestring nullable

visstring nullable

vis_given_datestring date nullable