Allergy

Allergy feature allows the user record, update and retrieve a the list of patient allergies and adverse reactions. Allergy Reference feature allows the user to view detailed information of an allergy, allergy reaction and severity based on the search parameter. Allergy Severity Reference feature allows the user to view detailed information of an allergy, allergy reaction and severity. The Allergy Changed Subscription feature will allow the user to retrieve changes made in the patient's allergy section (generally new or updated and deleted - unless the “Delete (added in error)” checkbox is marked when removing an allergy which will not display any changes). The user will need to subscribe. For more information about subscriptions, please refer Changed Data Subscriptions.

ALLERGY
The allergy section, unlike previous sections, contains all of the patient’s allergies. 

•  'allergyid' is the global athenaNet ID for this allergy. This is the same ID across all practices. You can get a list of allergies to add using our allergy API. 
• 'name' is the patient-friendly name for this allergy. 
• 'onsetdate' is the date the allergy was first noticed or reported. 
• 'allergyreactionid' is a list of reactions this patient has to this allergen. 
• 'severityid' is a list of reaction severities. If you specify reactions, you must also specify their severities. If the severity is not known, then the value 'none' must be used, which is a special value not currently in the fielddata specification. The allergyreactionid and severityid lists must have the same number of elements, as they are mapped to each other in order.

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

Endpoints

Get patient's allergies
GET
/v1/{practiceid}/chart/{patientid}/allergies

Retrieves list of allergens, allergy reactions, severity documented in the patient 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
patientid integer patientid
showinactive boolean Include deactivated allergies
departmentid integer The athenaNet department id.
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
allergies array
lastmodifiedby string The username of the user who last modified the note, nkda, or allergies.
lastmodifieddatetime string The date and time the note, nkda, or allergies were last updated.
lastupdated string Deprecated, use LASTMODIFIEDDATETIME instead. The last date any of the allergies in the returned list were updated. Does not include nkda or note information, and is date precision.
nkda string Whether the patient has no known drug allergies. This is an explicit statement separate from a patient with no documented allergies so far.
notelastmodifiedby string The username of the user who last modified the note.
notelastmodifieddatetime string The date and time the note was last updated.
sectionnote string A section-wide note
Example Code
Update patient's allergies
PUT
/v1/{practiceid}/chart/{patientid}/allergies

Modifies list of allergies documented in the patient 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
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.
THIRDPARTYUSERNAME string User name of the patient in the third party application.
allergies array A complex JSON object containing an update to the list of patient allergies. Any new allergies will be added, and any existing ones (based on allergenid) will be updated. If any existing ones are skipped, they will NOT be deleted. As such, this section can be empty if, for example, you just want to update NKDA status or the section note.
departmentid integer The ID of the department for this patient. A patient may have multiple charts, and the department determines which chart to use.
nkda boolean Whether the patient has no known drug allergies. This is an explicit statement separate from a patient with no documented allergies so far. Note that while a patient can have this checked and have allergies, that is not recommended.
sectionnote string A section-wide note. Passing an empty string will remove any existing note.

Output Parameters

Expand all
errormessage string If the update operation failed, this will contain any error messages.
success string Whether the update operation was successful.
Example Code
Search for available allergies
GET
/v1/{practiceid}/reference/allergies

Retrieves a list of allergies matching the search criteria

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
searchvalue string A term to search for. Must be at least 2 characters

Output Parameters

Expand all
allergenid integer The athena ID of the allergen
allergenname string The name of the allergen
allergy string DEPRECATED. Use allergenname instead. The name of the allergen.
allergyid integer DEPRECATED. Use allergenid instead. The athena ID of the allergen.
Example Code
Get list of allergy reactions
GET
/v1/{practiceid}/reference/allergies/reactions

Retrieves a list of valid allergy reaction

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
reactionid integer Athena ID for this reaction
reactionname string Name of the reaction
snomedcode integer SNOMED code for this reaction
Example Code
Get list of allergy severities
GET
/v1/{practiceid}/reference/allergies/severities

Retrieves a list of valid allergy severities

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
severity string Severity level name
snomedcode string SNOMED code for this severity level
Example Code
Get list of allergy change events to which you are subscribed
GET
/v1/{practiceid}/chart/healthhistory/allergies/changed/subscription/events

Retrieve list of all events that can be input for this 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 allergies
POST
/v1/{practiceid}/chart/healthhistory/allergies/changed/subscription

Subscribes for changed allergy 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

❙ Request Body

Expand all
eventname string By default, you are subscribed to all possible events. If you only wish to subscribe to an individual event, pass the event name with this argument.

Output Parameters

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

Retrieves list of events applicable for allergies

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 allergies based on subscribed events
GET
/v1/{practiceid}/chart/healthhistory/allergies/changed

Retrieves list of records of modified patient allergy data

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 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
allergenid integer Athena ID for this allergen.
allergenname string The name of the allergen.
deactivatedate string Date of allergy deactivation. Set to deactivate the allergy.
note string Note about this allergy.
onsetdate string Date of allergy onset.
patientid string The Patient ID associated with the allergy.
reactions array List of documented reactions.
Example Code
Unsubscribe to all/specific change events for allergies
DELETE
/v1/{practiceid}/chart/healthhistory/allergies/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 allergies was successful.
Example Code