AllergyIntolerance
Overview
The AllergyIntolerance resource documents risks of harmful or undesirable physiological responses unique to an individual when exposed to specific substances. This resource is essential for clinical decision support and medication safety workflows.
Important: Always validate AllergyIntolerance resource support and available operations by retrieving the current CapabilityStatement from /metadata before implementing integrations.
Resource Schema
The AllergyIntolerance resource follows the HL7 FHIR R4 AllergyIntolerance specification.
Key elements include:
patient- Reference to the patient with the allergycode- Substance that causes the allergyclinicalStatus- Active, inactive, or resolved statusverificationStatus- Confirmed, unconfirmed, or entered-in-errortype- Allergy or intolerancecategory- Food, medication, environment, or biologiccriticality- Low, high, or unable-to-assessreaction- Adverse reaction details
Example AllergyIntolerance Resource
{
"resourceType": "AllergyIntolerance",
"id": "12345",
"clinicalStatus": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}]
},
"verificationStatus": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}]
},
"type": "allergy",
"category": ["medication"],
"criticality": "high",
"code": {
"coding": [{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "7980",
"display": "Penicillin"
}]
},
"patient": {
"reference": "Patient/12345"
},
"recordedDate": "2024-01-15",
"reaction": [{
"substance": {
"coding": [{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "7980",
"display": "Penicillin"
}]
},
"manifestation": [{
"coding": [{
"system": "http://snomed.info/sct",
"code": "247472004",
"display": "Hives"
}]
}],
"severity": "moderate"
}]
}
Supported Profiles
This API supports the following FHIR profiles:
Operations
The General Purpose FHIR R4 AllergyIntolerance resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.
| CareRecord / Solution | Create | Read | Update | Search |
|---|---|---|---|---|
| GEHRIMED | - | Yes | - | Yes |
| myAvatar | Yes | Yes | Yes | Yes |
| myEvolv | - | Yes | - | Yes |
| myUnity | - | Yes | - | Yes |
| Referral Manager | - | - | - | - |
Search
Not all Netsmart solutions support AllergyIntolerance search. See supported operations table above and consult your target solution's documentation for more information.
This resource supports a combination of standard and custom search parameters in addition to the common parameters.
Standard Parameters
| Name | Type | Description |
|---|---|---|
| patient | reference | REQUIRED Who the sensitivity is for |
| onset | dateRange | Date(/time) when manifestations showed |
| date | dateRange | Date first version of the resource instance was recorded |
Custom Parameters
| Name | Type | Description |
|---|---|---|
| end | date | Deprecated. Use date parameter with le prefix instead. |
| start | date | Deprecated. Use date parameter with ge prefix instead. |
Search Examples
The POST method is recommended as it keeps health information out of the URL.
- Production
- Preview
curl -X POST https://fhir.netsmartcloud.com/v4/AllergyIntolerance/_search \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json" \
-H "Content-Type: application/x-form-urlencoded" \
-d "patient=Patient/123" \
curl -X POST https://fhirtest.netsmartcloud.com/v4/AllergyIntolerance/_search \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json" \
-H "Content-Type: application/x-form-urlencoded" \
-d "patient=Patient/123" \
Error Handling
For information about error responses when working with AllergyIntolerance resources, see Common Errors.
Common AllergyIntolerance-related errors include:
- Missing required patient reference
- Invalid allergy codes or terminology
- Unsupported clinical or verification status values
- Invalid reaction manifestation codes
Integration Patterns
Clinical Decision Support
AllergyIntolerance resources are critical for medication safety:
# Check patient allergies before prescribing
curl -X GET "https://fhir.netsmartcloud.com/v4/AllergyIntolerance?patient=12345&clinicalStatus=active" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/fhir+json"
Medication Reconciliation
Include allergies when retrieving patient medication information:
# Get patient medications with allergy check
curl -X GET "https://fhir.netsmartcloud.com/v4/MedicationRequest?patient=12345&_include=MedicationRequest:patient&_revinclude=AllergyIntolerance:patient" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/fhir+json"
Relationships to Other Resources
The AllergyIntolerance resource connects to several other resources:
- Patient - The individual with the allergy or intolerance
- MedicationRequest - Prescriptions that must consider allergies
- Encounter - Clinical encounters where allergies are documented
- Practitioner - Healthcare providers documenting allergies
- Organization - Healthcare organizations managing allergy data
Support
For questions about AllergyIntolerance resource implementation or clinical decision support integration, contact Netsmart support through your designated support channels.