Important: This is a draft IG for trial use. Click here to give feedback.

EN NL FR

HdBe-AllergyIntolerance

CBBDescriptionStatus
HdBe-AllergyIntolerance

An allergy or intolerance describes a patient’s tendency towards hypersensitivity to a certain substance, so that an unwanted physiological reaction is expected after exposure to the substance, while most people would not exhibit such a reaction to that amount. The observed physiological changes are usually the result of an immunological reaction. The substances can be categorized as follows:

  • Medicine
  • Medicine category
  • Ingredient/addition
  • Nutrition
  • Environmental factor
  • Animal
  • Plants
  • Chemicals
  • Inhaled allergenic

Purpose

Documenting and communicating allergies and intolerances is an important part of medical registration. It concerns the core of patient safety in general and medication safety in particular. In the execution of research, treatment and care, these patient characteristics constantly have to be taken into account. In principle, allergies and intolerances are also disorders and also could be entered as a problem. Nevertheless, these are usually entered separately. Allergies/Intolerances have a lot in common with warnings (Alert). An important difference is that with allergies and intolerances, a lot of detailed information is recorded on things such as the reactions to the causative substance. Furthermore, not every warning is a problem or medical condition.

Evidence Base

Complete medicinal allergies are insufficient when it comes to reactions to exposure to food products, items (such as bandages and band-aids), plants and animals. For these items, the standard allows the use of free text or the use of SNOMED CT code. However, no validated value set is currently available for this purpose for SNOMED CT.

active

id0..1string
extensionI0..*Extension
CausativeAgent1..1CodeableConceptBinding
AllergyCategory0..1CodeableConceptBinding
AllergyStatus0..1CodeableConceptBinding
StartDateTime0..1dateTime
Criticality0..1CodeableConceptBinding
LastReactionDateTime0..1dateTime
Comment0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
Symptom1..*CodeableConceptBinding
SpecificSubstance0..1CodeableConceptBinding
ReactionDescription0..1string
Severity0..1CodeableConceptBinding
RouteOfExposure0..1CodeableConceptBinding
ReactionTime0..1dateTime

AllergyIntolerance0..*
AllergyIntolerance.CausativeAgentCodeableConcept1..1
AllergyIntolerance.AllergyCategoryCodeableConcept0..1
AllergyIntolerance.AllergyStatusCodeableConcept0..1
AllergyIntolerance.StartDateTimedateTime0..1
AllergyIntolerance.CriticalityCodeableConcept0..1
AllergyIntolerance.LastReactionDateTimedateTime0..1
AllergyIntolerance.Commentstring0..1
AllergyIntolerance.ReactionBackboneElement0..*
AllergyIntolerance.Reaction.SymptomCodeableConcept1..*
AllergyIntolerance.Reaction.SpecificSubstanceCodeableConcept0..1
AllergyIntolerance.Reaction.ReactionDescriptionstring0..1
AllergyIntolerance.Reaction.SeverityCodeableConcept0..1
AllergyIntolerance.Reaction.RouteOfExposureCodeableConcept0..1
AllergyIntolerance.Reaction.ReactionTimedateTime0..1


AllergyIntolerance
DefinitionRoot concept of the AllergyIntolerance information model. This root concept contains all data elements of the AllergyIntolerance information model.
Cardinality0...*
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
AllergyIntolerance.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AllergyIntolerance.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AllergyIntolerance.CausativeAgent
DefinitionSubstance, group of substances or environmental factor to which the patient is allergic or hypersensitive.
Cardinality1...1
TypeCodeableConcept
Binding

Belgian refset for causative agent, no drug

CausativeAgent (required)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
AllergyIntolerance.AllergyCategory
DefinitionIdentifies the allergy category such as medication, food or environment.
Cardinality0...1
TypeCodeableConcept
Binding

AllergyCategory codes

AllergyCategory (required)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
AllergyIntolerance.AllergyStatus
DefinitionStatement on the status of the patient’s hypersensitivity.
Cardinality0...1
TypeCodeableConcept
Binding

AllergyStatus codes

AllergyStatus (required)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
AllergyIntolerance.StartDateTime
DefinitionThe date and time at which the allergy or undesired reaction was determined. This can be an exact date and time, or a rough indication of the date (such as only the year, or the month and the year).
Cardinality0...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
AllergyIntolerance.Criticality
DefinitionCritical extent is defined as “the potential severity of future reactions.” This represents a clinical evaluation of the worst case scenario for a future reaction. It can be based on the severity of past reactions, the dose and manner of exposure which caused reactions in the past, and the life-threatening potential of the type of reaction. Critical extent is a property of the allergy, and not of the reaction itself.
Cardinality0...1
TypeCodeableConcept
Binding

Criticality codes

CriticalExtent (required)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
AllergyIntolerance.LastReactionDateTime
DefinitionEntry of the last time a hypersensitive reaction took place.
Cardinality0...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
AllergyIntolerance.Comment
DefinitionTextual explanation of the hypersensitivity which cannot be entered in any of the other fields.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
AllergyIntolerance.Reaction
DefinitionContainer of the Reaction concept. This container contains all data elements of the Reaction concept.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
AllergyIntolerance.Reaction.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AllergyIntolerance.Reaction.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AllergyIntolerance.Reaction.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AllergyIntolerance.Reaction.Symptom
DefinitionThe content specifications of the reaction that takes place when the patient is exposed to the causative substance.
Cardinality1...*
TypeCodeableConcept
Binding

Symptom codes

Symptom (extensible)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
AllergyIntolerance.Reaction.SpecificSubstance
DefinitionMore specific indication of the substance that caused the reaction. This can be a specific substance from a group of substances to which the patient is allergic or hypersensitive.
Cardinality0...1
TypeCodeableConcept
Binding

Belgian refset for causative agent, no drug

CausativeAgent (required)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
AllergyIntolerance.Reaction.ReactionDescription
DefinitionTextual description of the reaction as a whole.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
AllergyIntolerance.Reaction.Severity
DefinitionThe severity of the reaction as a result of exposure to the causative substance.
Cardinality0...1
TypeCodeableConcept
Binding

Severity codes

CriticalExtent (required)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
AllergyIntolerance.Reaction.RouteOfExposure
DefinitionWay in which the patient came into contact with the causative agent or the way in which the agent was administered.
Cardinality0...1
TypeCodeableConcept
Binding

RouteOfExposure codes

RouteOfExposure (required)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
AllergyIntolerance.Reaction.ReactionTime
DefinitionDate and time at which the reaction took place. This may also be just the date or a partial date, in the event that the exact date is unknown.
Cardinality0...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a

Example instances

AllergyIntolerance
CausativeAgent 419442005 - Ethanol (code by SNOMED CT)
AllergyCategory 418471000 - Propensity to adverse reactions to food (code by SNOMED CT)
AllergyStatus 55561003 - Active (code by SNOMED CT)
StartDateTime 2010
criticality 24484000 - Severe (code by SNOMED CT)
LastReactionDateTime 2019-04-21
Comment Allergic reactions seems to get more severe over time.
reaction ---
reaction.Symptom 126485001 - Urticaria (code by SNOMED CT)
Reaction.SpecificSubstance
Reaction.ReactionDescription
reaction.Severity 24484000 - Severe (code by SNOMED CT)
Reaction.RouteOfExposure 26643006 - Oral route (code by SNOMED CT)
Reaction.ReactionTime 2019-04-21

zib AllergyIntolerance-v3.3 difference

Concept Category Description
Description textual Removed known issues as they contain Dutch context (G-standard).
CausativeAgent terminology Replaced existing Codelists with valueSet CausativeAgent which contains Belgian SNOMED refset with code: 751000172100.
AllergyCategory terminology Added SNOMED CT code for unknown to AllergyCategory valueSet and replaced Other value with SNOMED CT code.
AllergyStatus terminology Replaced AllergyStatus valueSet values with SNOMED CT codes of active and inactive, which are equal to the values in the AllergyIntolerance-v4.0 2021 pre-adopt version.
Reaction.Symptom terminology Added SNOMED CT code for unknown to Symptom valueSet and replaced Other value with SNOMED CT code.
Reaction.Severity terminology Replaced valueSet with CriticalExtent valueSet, which is also used at the criticality element, because the codes in the valueset overlap. Morerover, the reaction can not be registered as a fatal reaction too.
Reaction.SpecificSubstance terminology Replaced existing Codelists with valueSet CausativeAgent which contains Belgian SNOMED refset with code: 751000172100.



Terminology Bindings

PathNameStrengthURL
CausativeAgentCausativeAgentrequiredhttps://fhir.healthdata.be/ValueSet/CausativeAgent
AllergyCategoryAllergyCategoryrequiredhttps://fhir.healthdata.be/ValueSet/AllergyCategory
AllergyStatusAllergyStatusrequiredhttps://fhir.healthdata.be/ValueSet/AllergyStatus
CriticalityCriticalExtentrequiredhttps://fhir.healthdata.be/ValueSet/CriticalExtent
Reaction.SymptomSymptomextensiblehttps://fhir.healthdata.be/ValueSet/Symptom
Reaction.SpecificSubstanceCausativeAgentrequiredhttps://fhir.healthdata.be/ValueSet/CausativeAgent
Reaction.SeverityCriticalExtentrequiredhttps://fhir.healthdata.be/ValueSet/CriticalExtent
Reaction.RouteOfExposureRouteOfExposurerequiredhttps://fhir.healthdata.be/ValueSet/RouteOfExposure