Allergy (Patient Dossier)
1.2.0 - STU1 Belgium flag

This page is part of the HL7 Belgium FHIR Implementation Guide - Allergy profiles (v1.2.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: BeModelAllergyIntolerance - Detailed Descriptions

Active as of 2023-12-18

Definitions for the be-model-allergyintolerance logical model.

Guidance on how to interpret the contents of this table can be found here

0. be-model-allergyintolerance
Definition

Allergy / Intolerance information model

ShortAllergy Intolerance Logical Model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. be-model-allergyintolerance.patient
Definition

The person that has the allergy

ShortThe person that has the allergy
Control1..1
TypeReference
4. be-model-allergyintolerance.code
Definition

The substance - from a lst of substances - that the person is allergic to. It is possible to use free text but for the products indicated, a code must be used

ShortThe substance that the person is allergic to
Control1..1
BindingUnless not suitable, these codes SHALL be taken from BeAllergyIntoleranceCode
TypeCodeableConcept
6. be-model-allergyintolerance.category
Definition

The category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent

ShortThe category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent
Control0..*
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. be-model-allergyintolerance.type
Definition

the type of risk (allergy, intolerance...). When it is not possible to distinguish between a real allergy, a non-allergic hypersensitivity or an intolerance you can use the 'Intolerance' type, but code the VerificationStatus as 'Unconfirmed'

ShortThe Type - whether it is an allergy or intolerance
Control0..1
BindingThe codes SHALL be taken from BeVSAllergyIntoleranceType
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. be-model-allergyintolerance.status
Definition

The status of the allergy

ShortThe status of the allergy
Control0..1
TypeBackboneElement
12. be-model-allergyintolerance.status.clinicalStatus
Definition

The status of the allergy - if it is active or resolved

ShortThe status of the allergy - if it is active or resolved
Control1..1
BindingThe codes SHALL be taken from AllergyIntoleranceClinicalStatusCodes
TypeCodeableConcept
14. be-model-allergyintolerance.status.verificationStatus
Definition

The verification status of the allergy - if it is confirmed or suspected or refuted

ShortThe verification status of the allergy - if it is confirmed or suspected or refuted
Control1..1
BindingThe codes SHALL be taken from AllergyIntoleranceVerificationStatusCodes
TypeCodeableConcept
16. be-model-allergyintolerance.recordedDate
Definition

when the allergy/intolerance was recorded

Shortwhen the allergy/intolerance was recorded
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. be-model-allergyintolerance.recorder
Definition

Who recorded the allergy

ShortWho recorded the allergy
Control1..1
TypeReference
20. be-model-allergyintolerance.asserter
Definition

Is the person at the source of the information (eg the patient, the general practitioner, a family member, the healthcare professional who registers the information himself, ...). He is represented as much as possible by a unique identification number, namely the national register number (INSZ) or the BIS number. However, when it comes to a parent or family member, only the role (e.g. father, mother, neighbor, caregiver, friend, etc.) is coded to meet the requirements of the GDPR.

ShortWho asserted the allergy
Control0..1
TypeReference
22. be-model-allergyintolerance.note
Definition

Additional text note about the allergy or intolerance

ShortAdditional text note about the allergy or intolerance
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. be-model-allergyintolerance.reactions
Definition

known past reactions to the allergen

Shortknown past reactions to the allergen
Control0..*
TypeBackboneElement
26. be-model-allergyintolerance.reactions.manifestation
Definition

How the reaction manifested itself, e.g. rash, breathing difficulty...

ShortHow the reaction manifested itself
Control1..1
TypeCodeableConcept
28. be-model-allergyintolerance.reactions.onset
Definition

For each manifestation it is possible to specify an actual date or approximate date (age, period, interval, ...) of each suspected manifestation of the risk

ShortManifestation date
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. be-model-allergyintolerance.reactions.note
Definition

Additional text note about the allergic reaction

ShortAdditional text note about the allergic reaction
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. be-model-allergyintolerance
Definition

Allergy / Intolerance information model


Base definition for all elements in a resource.

ShortAllergy Intolerance Logical ModelBase for all elements
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. be-model-allergyintolerance.patient
Definition

The person that has the allergy

ShortThe person that has the allergy
Control1..1
TypeReference
4. be-model-allergyintolerance.code
Definition

The substance - from a lst of substances - that the person is allergic to. It is possible to use free text but for the products indicated, a code must be used

ShortThe substance that the person is allergic to
Control1..1
BindingUnless not suitable, these codes SHALL be taken from BeAllergyIntoleranceCode
TypeCodeableConcept
6. be-model-allergyintolerance.category
Definition

The category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent

ShortThe category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent
Control0..*
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. be-model-allergyintolerance.type
Definition

the type of risk (allergy, intolerance...). When it is not possible to distinguish between a real allergy, a non-allergic hypersensitivity or an intolerance you can use the 'Intolerance' type, but code the VerificationStatus as 'Unconfirmed'

ShortThe Type - whether it is an allergy or intolerance
Control0..1
BindingThe codes SHALL be taken from BeVSAllergyIntoleranceType
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. be-model-allergyintolerance.status
Definition

The status of the allergy

ShortThe status of the allergy
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. be-model-allergyintolerance.status.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
14. be-model-allergyintolerance.status.clinicalStatus
Definition

The status of the allergy - if it is active or resolved

ShortThe status of the allergy - if it is active or resolved
Control1..1
BindingThe codes SHALL be taken from AllergyIntoleranceClinicalStatusCodes
TypeCodeableConcept
16. be-model-allergyintolerance.status.verificationStatus
Definition

The verification status of the allergy - if it is confirmed or suspected or refuted

ShortThe verification status of the allergy - if it is confirmed or suspected or refuted
Control1..1
BindingThe codes SHALL be taken from AllergyIntoleranceVerificationStatusCodes
TypeCodeableConcept
18. be-model-allergyintolerance.recordedDate
Definition

when the allergy/intolerance was recorded

Shortwhen the allergy/intolerance was recorded
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. be-model-allergyintolerance.recorder
Definition

Who recorded the allergy

ShortWho recorded the allergy
Control1..1
TypeReference
22. be-model-allergyintolerance.asserter
Definition

Is the person at the source of the information (eg the patient, the general practitioner, a family member, the healthcare professional who registers the information himself, ...). He is represented as much as possible by a unique identification number, namely the national register number (INSZ) or the BIS number. However, when it comes to a parent or family member, only the role (e.g. father, mother, neighbor, caregiver, friend, etc.) is coded to meet the requirements of the GDPR.

ShortWho asserted the allergy
Control0..1
TypeReference
24. be-model-allergyintolerance.note
Definition

Additional text note about the allergy or intolerance

ShortAdditional text note about the allergy or intolerance
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. be-model-allergyintolerance.reactions
Definition

known past reactions to the allergen

Shortknown past reactions to the allergen
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. be-model-allergyintolerance.reactions.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
30. be-model-allergyintolerance.reactions.manifestation
Definition

How the reaction manifested itself, e.g. rash, breathing difficulty...

ShortHow the reaction manifested itself
Control1..1
TypeCodeableConcept
32. be-model-allergyintolerance.reactions.onset
Definition

For each manifestation it is possible to specify an actual date or approximate date (age, period, interval, ...) of each suspected manifestation of the risk

ShortManifestation date
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. be-model-allergyintolerance.reactions.note
Definition

Additional text note about the allergic reaction

ShortAdditional text note about the allergic reaction
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. be-model-allergyintolerance
Definition

Allergy / Intolerance information model

ShortAllergy Intolerance Logical Model
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. be-model-allergyintolerance.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. be-model-allergyintolerance.extension
Definition

May 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on be-model-allergyintolerance.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. be-model-allergyintolerance.patient
Definition

The person that has the allergy

ShortThe person that has the allergy
Control1..1
TypeReference
8. be-model-allergyintolerance.code
Definition

The substance - from a lst of substances - that the person is allergic to. It is possible to use free text but for the products indicated, a code must be used

ShortThe substance that the person is allergic to
Control1..1
BindingUnless not suitable, these codes SHALL be taken from BeAllergyIntoleranceCode
TypeCodeableConcept
10. be-model-allergyintolerance.category
Definition

The category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent

ShortThe category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent
Control0..*
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. be-model-allergyintolerance.type
Definition

the type of risk (allergy, intolerance...). When it is not possible to distinguish between a real allergy, a non-allergic hypersensitivity or an intolerance you can use the 'Intolerance' type, but code the VerificationStatus as 'Unconfirmed'

ShortThe Type - whether it is an allergy or intolerance
Control0..1
BindingThe codes SHALL be taken from BeVSAllergyIntoleranceType
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. be-model-allergyintolerance.status
Definition

The status of the allergy

ShortThe status of the allergy
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. be-model-allergyintolerance.status.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
18. be-model-allergyintolerance.status.extension
Definition

May 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on be-model-allergyintolerance.status.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
20. be-model-allergyintolerance.status.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
22. be-model-allergyintolerance.status.clinicalStatus
Definition

The status of the allergy - if it is active or resolved

ShortThe status of the allergy - if it is active or resolved
Control1..1
BindingThe codes SHALL be taken from AllergyIntoleranceClinicalStatusCodes
TypeCodeableConcept
24. be-model-allergyintolerance.status.verificationStatus
Definition

The verification status of the allergy - if it is confirmed or suspected or refuted

ShortThe verification status of the allergy - if it is confirmed or suspected or refuted
Control1..1
BindingThe codes SHALL be taken from AllergyIntoleranceVerificationStatusCodes
TypeCodeableConcept
26. be-model-allergyintolerance.recordedDate
Definition

when the allergy/intolerance was recorded

Shortwhen the allergy/intolerance was recorded
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. be-model-allergyintolerance.recorder
Definition

Who recorded the allergy

ShortWho recorded the allergy
Control1..1
TypeReference
30. be-model-allergyintolerance.asserter
Definition

Is the person at the source of the information (eg the patient, the general practitioner, a family member, the healthcare professional who registers the information himself, ...). He is represented as much as possible by a unique identification number, namely the national register number (INSZ) or the BIS number. However, when it comes to a parent or family member, only the role (e.g. father, mother, neighbor, caregiver, friend, etc.) is coded to meet the requirements of the GDPR.

ShortWho asserted the allergy
Control0..1
TypeReference
32. be-model-allergyintolerance.note
Definition

Additional text note about the allergy or intolerance

ShortAdditional text note about the allergy or intolerance
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. be-model-allergyintolerance.reactions
Definition

known past reactions to the allergen

Shortknown past reactions to the allergen
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. be-model-allergyintolerance.reactions.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
38. be-model-allergyintolerance.reactions.extension
Definition

May 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on be-model-allergyintolerance.reactions.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. be-model-allergyintolerance.reactions.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
42. be-model-allergyintolerance.reactions.manifestation
Definition

How the reaction manifested itself, e.g. rash, breathing difficulty...

ShortHow the reaction manifested itself
Control1..1
TypeCodeableConcept
44. be-model-allergyintolerance.reactions.onset
Definition

For each manifestation it is possible to specify an actual date or approximate date (age, period, interval, ...) of each suspected manifestation of the risk

ShortManifestation date
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. be-model-allergyintolerance.reactions.note
Definition

Additional text note about the allergic reaction

ShortAdditional text note about the allergic reaction
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension