FHIR AllergyIntolerance Resource (R4)

AllergyIntolerance records a patient's propensity to an adverse reaction to a substance: drug allergies, food intolerances and so on. Element table, search parameters, example JSON and FHIRPath for FHIR R4.

  • FHIR AllergyIntolerance Resource (R4) — part of the free FHIR Toolbox library.
  • Runs entirely in your browser: your FHIR data is never uploaded to a server.

Overview

AllergyIntolerance records a patient's propensity to an adverse reaction to a substance: drug allergies, food intolerances and so on. It carries the substance (code), clinicalStatus, verification, criticality and any observed reactions.

Elements

ElementTypeCardinalityDescription
AllergyIntolerance.identifierIdentifier0..*External ids for this item
AllergyIntolerance.clinicalStatusCodeableConcept0..1active | inactive | resolved
AllergyIntolerance.verificationStatusCodeableConcept0..1unconfirmed | confirmed | refuted | entered-in-error
AllergyIntolerance.typecode0..1allergy | intolerance - Underlying mechanism (if known)
AllergyIntolerance.categorycode0..*food | medication | environment | biologic
AllergyIntolerance.criticalitycode0..1low | high | unable-to-assess
AllergyIntolerance.codeCodeableConcept0..1Code that identifies the allergy or intolerance
AllergyIntolerance.patientReference1..1Who the sensitivity is for
AllergyIntolerance.encounterReference0..1Encounter when the allergy or intolerance was asserted
AllergyIntolerance.onset[x]dateTime | Age | Period | Range | string0..1When allergy or intolerance was identified
AllergyIntolerance.recordedDatedateTime0..1Date first version of the resource instance was recorded
AllergyIntolerance.recorderReference0..1Who recorded the sensitivity
AllergyIntolerance.asserterReference0..1Source of the information about the allergy
AllergyIntolerance.lastOccurrencedateTime0..1Date(/time) of last known occurrence of a reaction
AllergyIntolerance.noteAnnotation0..*Additional text not captured in other fields
AllergyIntolerance.reactionBackboneElement0..*Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.idString0..1Unique id for inter-element referencing
AllergyIntolerance.reaction.extensionExtension0..*Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtensionExtension0..*Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substanceCodeableConcept0..1Specific substance or pharmaceutical product considered to be responsible for event
AllergyIntolerance.reaction.manifestationCodeableConcept1..*Clinical symptoms/signs associated with the Event
AllergyIntolerance.reaction.descriptionstring0..1Description of the event as a whole
AllergyIntolerance.reaction.onsetdateTime0..1Date(/time) when manifestations showed
AllergyIntolerance.reaction.severitycode0..1mild | moderate | severe (of event as a whole)
AllergyIntolerance.reaction.exposureRouteCodeableConcept0..1How the subject was exposed to the substance
AllergyIntolerance.reaction.noteAnnotation0..*Text about event not captured in other fields

Example JSON (R4)

{
  "resourceType": "AllergyIntolerance",
  "id": "example",
  "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 G"
      }
    ]
  },
  "patient": {
    "reference": "Patient/example"
  },
  "reaction": [
    {
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "39579001",
              "display": "Anaphylaxis"
            }
          ]
        }
      ],
      "severity": "severe"
    }
  ]
}

FHIRPath

  • AllergyIntolerance.code.coding.display — The substance
  • AllergyIntolerance.criticality — Potential seriousness
  • AllergyIntolerance.reaction.severity — Severity of each reaction

Common validation errors

  • Using R4's type code against R5, where type is a CodeableConcept, and reaction.manifestation is CodeableReference.
  • Sending category as a string. It is an array of codes (food | medication | environment | biologic).
  • Recording “no known allergies” as an AllergyIntolerance with a made-up substance. Use the dedicated “no known allergy” code.

FHIR Toolbox is a free, privacy-first collection of HL7 FHIR utilities by Omindra Labs. Every tool performs zero-server processing — your health data never leaves your device.