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.
Endpoints
- Primary
- Reference
- Subscription
Get patient's allergies
Input Parameters
Expand all❙ required
Output Parameters
Expand allUpdate patient's allergies
Input Parameters
Expand all❙ required
❙ Request Body
Expand allOutput Parameters
Expand allSearch for available allergies
Input Parameters
Expand all❙ required
Output Parameters
Expand allGet list of allergy reactions
Input Parameters
Expand all❙ required
Output Parameters
Expand allGet list of allergy severities
Input Parameters
Expand all❙ required
Output Parameters
Expand allGet list of allergy change events to which you are subscribed
Input Parameters
Expand all❙ required
Output Parameters
Expand allSubscribe to all/specific change events for allergies
Input Parameters
Expand all❙ required
Output Parameters
Expand allGet list of allergy change subscription(s)
Input Parameters
Expand all❙ required
Output Parameters
Expand allGet list of changes in allergies based on subscribed events
Input Parameters
Expand all❙ required
Output Parameters
Expand allUnsubscribe to all/specific change events for allergies
Input Parameters
Expand all❙ required