AllergyIntolerance

Overview

The AllergyIntolerance resource provides information about a patient's risk of harmful or undesirable physiological responses to specific substances. This includes allergies, intolerances, and adverse reactions that are unique to an individual and associated with exposure to substances such as medications, foods, or environmental factors.

Use Cases:

Recording patient allergies and intolerances for clinical decision support
Supporting medication reconciliation and prescribing workflows
Enabling care coordination across healthcare providers
Meeting regulatory requirements for allergy documentation

Relationships:

Patient: References the individual with the allergy or intolerance
Practitioner: May reference the healthcare provider who recorded the allergy
Encounter: May be linked to the clinical encounter when the allergy was identified
Provenance: Tracks the source and history of allergy information

Resource Schema

Key Fields:

Field	Type	Description	Required
id	string	Unique identifier for the resource	Yes
patient	Reference(Patient)	Who the sensitivity is for	Yes
clinicalStatus	CodeableConcept	Clinical status (active, inactive, resolved)	No
verificationStatus	CodeableConcept	Verification status (unconfirmed, confirmed, etc.)	No
type	code	Type of reaction (allergy, intolerance)	No
category	code[]	Category of substance (food, medication, environment, biologic)	No
criticality	code	Criticality of the allergy (low, high, unable-to-assess)	No
code	CodeableConcept	Code that identifies the allergy or intolerance	No
onset[x]	dateTime/Age/Period/Range/string	When allergy or intolerance was identified	No
reaction	BackboneElement[]	Adverse reaction events linked to exposure	No

JSON Example:

{
    "resourceType": "AllergyIntolerance",
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "meta": {
        "lastUpdated": "2022-08-19T13:58:00.000+00:00"
    },
    "clinicalStatus": {
        "coding": [
            {
                "system": "urn:oid:2.16.840.1.113883.4.642.3.1372",
                "code": "active",
                "display": "Active"
            }
        ],
        "text": "Active"
    },
    "verificationStatus": {
        "coding": [
            {
                "system": "urn:oid:2.16.840.1.113883.4.642.3.1370",
                "code": "confirmed",
                "display": "Confirmed"
            }
        ],
        "text": "Confirmed"
    },
    "type": "allergy",
    "category": [
        "food"
    ],
    "code": {
        "coding": [
            {
                "code": "2889",
                "display": "PEANUTS"
            },
            {
                "system": "urn:oid:2.16.840.1.113883.6.96",
                "code": "762952008",
                "display": "Peanut"
            }
        ],
        "text": "PEANUTS"
    },
    "patient": {
        "reference": "Patient/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "type": "Patient"
    },
    "onsetDateTime": "2022-01-01T12:00:00.000-00:00",
    "recordedDate": "2022-08-17T12:00:00+00:00",
    "reaction": [
        {
            "substance": {
                "coding": [
                    {
                        "code": "2889",
                        "display": "PEANUTS"
                    },
                    {
                        "system": "urn:oid:2.16.840.1.113883.6.96",
                        "code": "762952008",
                        "display": "Peanut"
                    }
                ],
                "text": "PEANUTS"
            },
            "manifestation": [
                {
                    "coding": [
                        {
                            "system": "urn:oid:2.16.840.1.113883.6.96",
                            "code": "247472004",
                            "display": "Hives"
                        }
                    ],
                    "text": "Hives"
                }
            ]
        }
    ]
}

Operations

The Certified API AllergyIntolerance resource supports the following operations. However, support varies by the targeted CareRecord or solution.

CareRecord / Solution	Create	Read	Update	Search
GEHRIMED	-	Yes	-	Yes
myAvatar	-	Yes	-	Yes
myEvolv	-	Yes	-	Yes
myUnity	-	Yes	-	Yes
TheraOffice	-	Yes	-	Yes

Read: Retrieves a specific AllergyIntolerance resource by its unique identifier.

Endpoint: GET /AllergyIntolerance/{id}

Search

Search for allergy intolerances using various criteria.

GET Method

Use GET for simple searches with parameters in the query string.

Production
Preview

GET /AllergyIntolerance?parameter=value

GET /AllergyIntolerance?parameter=value

POST Method

Use POST for complex searches with form-encoded parameters.

Production
Preview

POST /AllergyIntolerance/_search

POST /AllergyIntolerance/_search

info

Not all Netsmart solutions support AllergyIntolerance search. See supported operations table above and consult your target solution's documentation for more information.

Search Parameters

Patient-based Search:

Parameter	Type	Required	Description	Example
`patient`	reference	Yes	Who the sensitivity is for	`Yes`
`clinical-status`	token	No	active	`clinical-status=value`
`date`	date	No	Date first version of the resource instance was recorded	`date=value`
`onset`	date	No	Date(/time) when manifestations showed	`onset=value`
`_lastUpdated`	date	No	Only return resources which were last updated as specified by the given range	`_lastUpdated=value`
`_revinclude`	special	No	Include Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"	`_revinclude=value`

ID-based Search:

Parameter	Type	Required	Description	Example
`_id`	string	Yes	The ID of the resource	`_id=value`
`_lastUpdated`	date	No	Only return resources which were last updated as specified by the given range	`_lastUpdated=value`
`_revinclude`	special	No	Include Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"	`_revinclude=value`

Examples

Read Examples:

Production
Preview

Read AllergyIntolerance by ID
curl -X GET https://fhir.netsmartcloud.com/provider/patient-access/v2/{tenant-id}/AllergyIntolerance/456 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Read AllergyIntolerance by ID
curl -X GET https://fhirtest.netsmartcloud.com/provider/patient-access/v2/{tenant}/AllergyIntolerance/456 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Search Examples:

Production
Preview

Search by Patient
curl -X POST https://fhir.netsmartcloud.com/provider/patient-access/v2/{tenant-id}/AllergyIntolerance/_search \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d "patient=Patient/123"

Search by Patient and Clinical Status
curl -X POST https://fhir.netsmartcloud.com/provider/patient-access/v2/{tenant-id}/AllergyIntolerance/_search \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d "patient=Patient/123" \
    -d "clinical-status=active"

Search by Patient
curl -X POST https://fhirtest.netsmartcloud.com/provider/patient-access/v2/{tenant}/AllergyIntolerance/_search \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d "patient=Patient/123"

Search by Patient and Clinical Status
curl -X POST https://fhirtest.netsmartcloud.com/provider/patient-access/v2/{tenant}/AllergyIntolerance/_search \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d "patient=Patient/123" \
    -d "clinical-status=active"

Integration Patterns

Common Workflows:

Retrieve all allergies for a patient during care planning
Filter active allergies for medication safety checks
Include provenance data to track allergy information sources
Cross-reference with medication orders for contraindication checking

Related Resources:

Patient - Individual with the allergy or intolerance
Practitioner - Healthcare provider who recorded the allergy
Encounter - Clinical encounter when allergy was identified
Provenance - Source and history tracking

Error Handling

For detailed error codes and handling procedures, see the Error Handling Guide.

Supported Profiles

This resource supports the following FHIR profiles as defined in the CapabilityStatement:

US Core AllergyIntolerance Profile
Base FHIR R4 AllergyIntolerance Resource

Overview​

Resource Schema​

Operations​

Search​

GET Method​

POST Method​

Search Parameters​

Examples​

Integration Patterns​

Error Handling​

Supported Profiles​