FHIR DSTU2 - Chart - Immunizations

These FHIR Immunizations (Charts) endpoints are a partial implementation of the FHIR DSTU2 specification. We will consider expanding these and adding additional FHIR endpoints, as well as future versions, based on usage and requests from API users.

Note-1: that these endpoints do not follow the same naming conventions as many of the other APIs offered.

Note-2: If you are accessing a practice without Communicator Brands and are using one of the endpoints that require BRANDID in the path, you can use any positive integer for BRANDID.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Find immunizations for a given patient.
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization

List of Immunization resources from the results of the search

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
departmentid integer departmentid
explanation boolean Switch to enable explanation.
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).
date string Filter results within a specific time period or date. Prefix: eq - specific, le - inclusive less, lt - exclusive less, ge - inclusive greater, gt - exclusive greater, separate start and end date with space. Example: ge2015-06-1 le2015-06-22
THIRDPARTYUSERNAME string User name of the patient in the third party application.
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all
date string Vaccination administration date
expirationdate string Vaccine expiration date
explanation object Explanation why immunization was not given
id string Logical id of this artifact
patient object Who was immunized
reported string Indicates a self-reported record
resourcetype string The type of resource
status string in-progress | on-hold | completed | entered-in-error | stopped
vaccinecode object Vaccine product administered
wasnotgiven string Flag for whether immunization was given
Example Code
Get a specific immunization by ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization/ClinicalVaccine-{immunizationid}

Immunization resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
departmentid integer departmentid
immunizationid integer immunizationid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
date string Vaccination administration date
expirationdate string Vaccine expiration date
id string Logical id of this artifact
patient object Who was immunized
reported string Indicates a self-reported record
resourcetype string The type of resource
status string in-progress | on-hold | completed | entered-in-error | stopped
vaccinecode object Vaccine product administered
wasnotgiven string Flag for whether immunization was given
Example Code
Get a specific immunization by ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization/HistoricalVaccine-{immunizationid}

Immunization resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
departmentid integer departmentid
immunizationid integer immunizationid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
date string Vaccination administration date
expirationdate string Vaccine expiration date
id string Logical id of this artifact
patient object Who was immunized
reported string Indicates a self-reported record
resourcetype string The type of resource
status string in-progress | on-hold | completed | entered-in-error | stopped
vaccinecode object Vaccine product administered
wasnotgiven string Flag for whether immunization was given
Example Code
Find immunizations for a given patient.
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization

List of Immunization resources from the results of the search

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).
date string Filter results within a specific time period.
THIRDPARTYUSERNAME string User name of the patient in the third party application.
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all
date string Vaccination administration date
expirationdate string Vaccine expiration date
explanation object Explanation why immunization was not given
id string Logical id of this artifact
patient object Who was immunized
reported string Indicates a self-reported record
resourcetype string The type of resource
status string in-progress | on-hold | completed | entered-in-error | stopped
vaccinecode object Vaccine product administered
wasnotgiven string Flag for whether immunization was given
Example Code
Get a specific immunization by ID
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization/ClinicalVaccine-{immunizationid}

Immunization resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
brandid integer brandid
immunizationid integer immunizationid
chartsharinggroupid integer chartsharinggroupid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
date string Vaccination administration date
expirationdate string Vaccine expiration date
id string Logical id of this artifact
patient object Who was immunized
reported string Indicates a self-reported record
resourcetype string The type of resource
status string in-progress | on-hold | completed | entered-in-error | stopped
vaccinecode object Vaccine product administered
wasnotgiven string Flag for whether immunization was given
Example Code
Get a specific immunization by ID
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization/HistoricalVaccine-{immunizationid}

Immunization resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
brandid integer brandid
immunizationid integer immunizationid
chartsharinggroupid integer chartsharinggroupid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
date string Vaccination administration date
expirationdate string Vaccine expiration date
id string Logical id of this artifact
patient object Who was immunized
reported string Indicates a self-reported record
resourcetype string The type of resource
status string in-progress | on-hold | completed | entered-in-error | stopped
vaccinecode object Vaccine product administered
wasnotgiven string Flag for whether immunization was given
Example Code