AllergyIntolerance

These FHIR AllergyIntolerance 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: these endpoints do not follow the same naming conventions as many of the other APIs offered.

Note: 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

Endpoints

Find allergy intolerances for a given patient.

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/AllergyIntolerance
Returns the full list of AllergyIntolerance resources. Date filtering does not apply.
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
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).
status string Status of allergy intolerances to retrieve
_lastupdated string Last updated filter
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
criticality string CRITL | CRITH | CRITU
id string Logical id of this artifact
onset string Effective date of the allergy
patient object Who the sensitivity is for
reaction array Adverse Reaction Events linked to exposure to substance
recordeddate string When recorded
resourcetype string The type of resource
status string active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
substance object Substance, (or class) considered to be responsible for risk
text object Text summary of the resource, for human interpretation
Example Code

Get allergy intolerance details

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/AllergyIntolerance/{allergyintoleranceid}
AllergyIntolerance 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
allergyintoleranceid integer allergyintoleranceid
departmentid integer departmentid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
criticality string CRITL | CRITH | CRITU
id string Logical id of this artifact
patient object Who the sensitivity is for
reaction array Adverse Reaction Events linked to exposure to substance
recordeddate string When recorded
resourcetype string The type of resource
status string active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
substance object Substance, (or class) considered to be responsible for risk
text object Text summary of the resource, for human interpretation
Example Code

Find allergy intolerances for a given patient.

GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/AllergyIntolerance
Returns the full list of AllergyIntolerance resources. Date filtering does not apply.
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).
status string Status of allergy intolerances to retrieve
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
criticality string CRITL | CRITH | CRITU
id string Logical id of this artifact
onset string Effective date of the allergy
patient object Who the sensitivity is for
reaction array Adverse Reaction Events linked to exposure to substance
recordeddate string When recorded
resourcetype string The type of resource
status string active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
substance object Substance, (or class) considered to be responsible for risk
text object Text summary of the resource, for human interpretation
Example Code

Get allergy intolerance details

GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/AllergyIntolerance/{allergyintoleranceid}
AllergyIntolerance 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
allergyintoleranceid integer allergyintoleranceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
criticality string CRITL | CRITH | CRITU
id string Logical id of this artifact
patient object Who the sensitivity is for
reaction array Adverse Reaction Events linked to exposure to substance
recordeddate string When recorded
resourcetype string The type of resource
status string active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
substance object Substance, (or class) considered to be responsible for risk
text object Text summary of the resource, for human interpretation
Example Code