Immunization-GET

Description

Retrieves detailed information on patient immunizations, enabling healthcare developers to access and display real-time data regarding vaccination records for streamlined tracking and analysis within clinical workflows.

Use Cases

Retrieve Immunization Record: Obtain patient vaccination details
Access Vaccine History: Retrieve vaccination records
Query Immunization Dates: Obtain specific vaccination dates
Review Vaccine Types: Access information on vaccine types
Examine Dose Details: Retrieve details on vaccine doses

Request Sample

Athena

Elation

Canvas

cURL

JavaScript

Java

Python

Source Specific Details

EHR	APIs	mandatory filters	optional filters
Athena	`${url}/v1/${practiceId}/chart/${patientId}/vaccines?departmentid=${departmentId}`	patient departmentId	_count _offset include third-party-user-name patient-facing-call
Elation	`${url}/histories` `${url}/immunizations`	patient	_count _offset
Canvas	`${url}/Immunization`	patient encounter visitType

Filters

FilterName	Description	Default Value
_count	Pagination params
_offset	Pagination params. Athena: Starting point of entries; 0-indexed
asserter	Source of the information about the allergy
category	food \| medication \| environment \| biologic
clinical-status	active \| inactive \| resolved
code	Multiple Resources: * [Immunization](Immunization.html): Code that identifies the allergy or intolerance * [Condition](condition.html): Code for the condition * [DeviceRequest](devicerequest.html): Code for what is being requested/ordered * [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result * [FamilyMemberHistory](familymemberhistory.html): A search by a condition code * [List](list.html): What the purpose of this list is * [Medication](medication.html): Returns medications for a specific code * [MedicationAdministration](medicationadministration.html): Return administrations of this medication code * [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code * [MedicationStatement](medicationstatement.html): Return statements of this medication code * [Observation](observation.html): The code of the observation type * [Procedure](procedure.html): A code to identify a procedure * [ServiceRequest](servicerequest.html): What is being requested/ordered
criticality	low \| high \| unable-to-assess
date	Vaccination (non)-Administration Date
departmentId	Identifier for the department
encounter	Encounter created as part of
identifier	Business identifier
include	List of fields which needed to be shown in result
last-date	Date(/time) of last known occurrence of a reaction
manifestation	Clinical symptoms/signs associated with the Event
onset	Date(/time) when manifestations showed
patient	Patient reference for any fhir resource
patient-facing-call	When 'true' is passed source will collect relevant data and store in their database.	false
practitioner	Practitioner reference for the any fhir resource
primary-source	primary source
quorum	sets sync/async mode	true
recorder	Who recorded the sensitivity
route	How the subject was exposed to the substance
severity	mild \| moderate \| severe (of event as a whole)
third-party-user-name	User name of the patient in the third party application.
type	Multiple Resources: * [Immunization](Immunization.html): allergy \| intolerance - Underlying mechanism (if known) * [Composition](composition.html): Kind of composition (LOINC if possible) * [DocumentManifest](documentmanifest.html): Kind of document set * [DocumentReference](documentreference.html): Kind of document (LOINC if possible) * [Encounter](encounter.html): Specific type of encounter * [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
verification-status	unconfirmed \| confirmed \| refuted \| entered-in-error

Immunization Export-POST

Immunization ID-DELETE