Sign in
Clinical

Retrieve an existing patient vaccine records

get/api/patient_vaccine_records/{id}

Path parameters

idstring required

Query parameters

cvx_codestring
patientinteger
sincestring
doctorinteger

Response

OK

lot_numberstring

Lot/batch number of the vaccine dose

sitestring
ordering_doctorinteger
idinteger
next_dose_datestring

Date for next dose of vaccine

cpt_codestring

Vaccine cpt code

completion_status'CP' | 'RE' | 'NA' | 'PA'

Vaccination status, can be CP(Complete), RE(Refused), NA(Not administered), PA(Partially administered)

administered_atinteger

ID of /api/offices where the administration happened

commentsstring
funding_eligibility'V01' | 'V02' | 'V03' | 'V04' | 'V05' | 'V07'

The funding program that should pay for a given immunization

unitsstring
entered_bystring

ID of user who created the record

patientinteger required
administration_startstring

Datetime when the administration starts

record_source'00' | '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08'
updated_atstring
consent_forminteger

Consent form related with vaccine record

manufacturerstring

Manufacturer of the vaccine

administered_bystring

ID of /api/users who performs the administration

namestring required
visstring

Related vaccine information statement

created_atstring
observed_immunity'398102009' | '409498004' | '397428000' | '18624000' | '91428005' | '271511000' | '240532009' | '6142004' | '52947006' | '14189004' | '23511006' | '36989005' | '27836007' | '16814004' | '14168008' | '36653000' | '76902006' | '66071002' | '4834000' | '111852003' | '38907003' | '40468003' | '16541001'
amountnumber

Amount of vaccine administered

vaccine_inventoryinteger

ID of /api/vaccine_inventories the vaccine is from

routestring
cvx_codestring required

Vaccine cvx code

Changes

No recorded changes to this endpoint across all 2 revisions of this API.