Vaccines

The Vaccine feature allows the user to record, update or view the detail of historical procedures performed on the patient. The Vaccine Changed Subscription feature will allow the user to retrieve changes made to the historical vaccines data. For more information, please refer Changed Data Subscriptions.

VACCINATION

The vaccination section contains a list of checkbox questions with a required list of administered dates.

  • 'DEFAULT' is the Y/N checkbox that says whether the patient had this vaccine. If DEFAULT is Y then ADMINISTERED is a required list of administered dates. Even one administration should be submitted as a list.
  • 'cvx' is the HL7 Table 0292, Vaccine Administered code as maintained by the CDC: http://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=cvx.
  • 'text' is the patient-friendly name of the vaccine.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Add vaccine to patient's chart
POST
/v1/{practiceid}/chart/{patientid}/vaccines

Records a vaccine in the patient's chart in Vaccine section

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
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful or not.
vaccineids string IDs of any vaccines that were created (currently only one can be created at a time)
Example Code
Get list of patient's vaccines
GET
/v1/{practiceid}/chart/{patientid}/vaccines

Retrieves patient's historical vaccines

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
patientid integer patientid
showdeleted boolean Include deleted vaccines in the result
showdeclinedorders boolean If set, include orders that were declined
departmentid integer The athenaNet department id.
showprescribednotadministered boolean Include vaccines that were prescribed but were not administered in the result
showrefused boolean Include refused vaccines in the result
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed
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
vaccines array List of vaccines administered to the patient
vaccinesectionnote string The note associated with the vaccines section in a patient's chart
Example Code
Update patient's vaccine data
PUT
/v1/{practiceid}/chart/{patientid}/vaccines/{vaccineid}

Modifies the vaccine data of the patient

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
vaccineid string vaccineid
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Remove vaccine from patient's chart
DELETE
/v1/{practiceid}/chart/{patientid}/vaccines/{vaccineid}

Delete's a specific vaccine data from patient's chart

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
vaccineid string vaccineid
patientid integer patientid
deleteddate string Date when this vaccine record was deleted from athenaNet (defaults to today)
departmentid integer The athenaNet department id.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Get list of vaccine change events to which you can subscribe
GET
/v1/{practiceid}/chart/healthhistory/vaccine/changed/subscription/events

Retrieves the list of events that can be input for the vaccines changed subscription

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

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code
Subscribe to all/specific change events for vaccines
POST
/v1/{practiceid}/chart/healthhistory/vaccine/changed/subscription

Subscribe for changed Vaccines events

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
Content-Type string Content type of the payload

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for historical vaccine was successful.
Example Code
Get list of vaccine change subscription(s)
GET
/v1/{practiceid}/chart/healthhistory/vaccine/changed/subscription

Retrieves list of events for Vaccines

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

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code
Get list of changes in vaccines based on subscription
GET
/v1/{practiceid}/chart/healthhistory/vaccine/changed

Retrieves list of modified vaccines data of a patient

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
leaveunprocessed boolean For testing purposes, do not mark records as processed
showprocessedenddatetime string See showprocessedstartdatetime
showprocessedstartdatetime string Show already processed changes. This will show changes that you previously retrieved at some point after this datetime mm/dd/yyyy hh24:mi:ss (Eastern). Can be used to refetch data if there was an error, such as a timeout, and records are marked as already retrieved. This is intended to be used with showprocessedenddatetime and for a short period of time only. Also note that all messages will eventually be deleted.
limit integer Number of entries to return (default 1000, max 5000)Please note that this endpoint has a different default than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
administerdate string Date when this vaccine was administered (if administered). Can be in YYYY, MM/YYYY, or MM/DD/YYYY format.
administernote string Note associated with administering the vaccine, if available
administerroute string Route by which this vaccine was administered
administerroutedescription string Description of the route by which this vaccine was administered
administersite string Site where the vaccine was administered
amount number Quantity of the vaccine that was adminsitered
approvedby string The username of the user who approved this vaccine order, if clinical
approveddate string Date when this vaccine order was approved, if clinical
chartsharinggroupid integer ID of the chart sharing group that the vaccine is associated with. This can be used to determine what department a vaccine belongs with.
clinicalorderclasses array The various Clinical Order Classes associated with this Vaccine
contraindicationreason array List of codes indicating why the order was contraindicated (for vaccines only). If this field is not present, the order does not contain a contraindication reason.
cvx integer Vaccine Administered Code
declinedreason array List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen.
declinedreasontext string The user-facing description of the reason the order was not given.
deleteddate string Date when this vaccine was deleted (if deleted)
description string Vaccine description
enteredby string The username of the user who entered the historic vaccine information into the chart
entereddate string Date when the vaccine information was entered into the chart
expirationdate string Date to administer vaccine by
genusname string The name of the vaccine that appears in the UI of the chart
lotnumber string The lot number of the vaccine that was administered. This is an identifier assigned to a batch of medications by the manufacturer.
mvx string Manufacturer code
ndc string The National Drug Code for the administered vaccine.
orderedby string The username of the user who ordered the vaccine
ordereddate string Date the vaccine was ordered
partiallyadministered string Whether this vaccine was partially administered or not.
patientid integer ID of the patient that the vaccine is associated with.
prescribeddate string Date when this vaccine was prescribed (if prescribed)
refuseddate string Date when this vaccine was refused (if refused)
refusednote string Note associated with refusal, if available
refusedreason string Reason for refusal, if available
status string Status of this vaccine (one of: ADMINISTERED, REFUSED, PRESCRIBED but not adminstered yet)
submitdate string Date when this vaccine order was submitted, if clinical
units string Units corresponding to the above quantity
vaccinator string Individual who has administered the vaccine
vaccineid string Athena ID for this vaccine (prefix of H for historical, C for clinical)
vaccineinformationstatements array The Vaccine Information Statements (VIS) that were given to the patient, grouped by Clinical Order Class
vaccinetype string Type of vaccine (either CLINICAL - ordered/administered by the practice, or HISTORICAL - from patient's previous medical history or alternative source)
visgivendate string Date when the Vaccine Information Statement was given to the patient
Example Code
Unsubscribe to all/specific change events for vaccines
DELETE
/v1/{practiceid}/chart/healthhistory/vaccine/changed/subscription

Delete an specific event which is no longer required

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
eventname string By default, you are unsubscribed from all possible events. If you only wish to unsubscribe from an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for historical vaccine was successful.
Example Code