Allergy (Patient Dossier)
1.2.0 - STU1 Belgium flag

Allergy (Patient Dossier), published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/allergy/ and changes regularly. See the Directory of published versions

Logical Model: Allergy Intolerance Logical Model

Official URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-model-allergyintolerance Version: 1.2.0
Active as of 2025-07-02 Computable Name: BeModelAllergyIntolerance

Allergy / Intolerance information model

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. be-model-allergyintolerance 0..* Element
Elements defined in Ancestors:@id, extension
Allergy Intolerance Logical Model
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... patient 1..1 Reference() The person that has the allergy
... category 0..* code 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
... type 0..1 code The Type - whether it is an allergy or intolerance
Binding: BeVSAllergyIntoleranceType (required)
... status 0..1 BackboneElement The status of the allergy
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... clinicalStatus 1..1 CodeableConcept The status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1 CodeableConcept The verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1 dateTime when the allergy/intolerance was recorded
... recorder 1..1 Reference() Who recorded the allergy
... asserter 0..1 Reference() Who asserted the allergy
... note 0..1 string Additional text note about the allergy or intolerance
... reactions 0..* BackboneElement known past reactions to the allergen
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..1 CodeableConcept How the reaction manifested itself
.... onset 0..1 dateTime Manifestation date
.... note 0..1 string Additional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-allergyintolerancecode
From this IG
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-vs-allergyintolerance-type
From this IG
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
From the FHIR Standard
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. be-model-allergyintolerance 0..* Element
Elements defined in Ancestors:@id, extension
Allergy Intolerance Logical Model
... patient 1..1 Reference() The person that has the allergy
... code 1..1 CodeableConcept The substance that the person is allergic to
Binding: BeAllergyIntoleranceCode (extensible)
... category 0..* code 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
... status 0..1 BackboneElement The status of the allergy
.... clinicalStatus 1..1 CodeableConcept The status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1 CodeableConcept The verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1 dateTime when the allergy/intolerance was recorded
... recorder 1..1 Reference() Who recorded the allergy
... asserter 0..1 Reference() Who asserted the allergy
... note 0..1 string Additional text note about the allergy or intolerance
... reactions 0..* BackboneElement known past reactions to the allergen
.... manifestation 1..1 CodeableConcept How the reaction manifested itself
.... onset 0..1 dateTime Manifestation date
.... note 0..1 string Additional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-allergyintolerancecode
From this IG
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-vs-allergyintolerance-type
From this IG
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
From the FHIR Standard
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
From the FHIR Standard
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. be-model-allergyintolerance 0..* Element
Elements defined in Ancestors:@id, extension
Allergy Intolerance Logical Model
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... patient 1..1 Reference() The person that has the allergy
... category 0..* code 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
... type 0..1 code The Type - whether it is an allergy or intolerance
Binding: BeVSAllergyIntoleranceType (required)
... status 0..1 BackboneElement The status of the allergy
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... clinicalStatus 1..1 CodeableConcept The status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1 CodeableConcept The verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1 dateTime when the allergy/intolerance was recorded
... recorder 1..1 Reference() Who recorded the allergy
... asserter 0..1 Reference() Who asserted the allergy
... note 0..1 string Additional text note about the allergy or intolerance
... reactions 0..* BackboneElement known past reactions to the allergen
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..1 CodeableConcept How the reaction manifested itself
.... onset 0..1 dateTime Manifestation date
.... note 0..1 string Additional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-allergyintolerancecode
From this IG
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-vs-allergyintolerance-type
From this IG
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
From the FHIR Standard
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Element

Summary

Mandatory: 0 element(7 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. be-model-allergyintolerance 0..* Element
Elements defined in Ancestors:@id, extension
Allergy Intolerance Logical Model
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... patient 1..1 Reference() The person that has the allergy
... category 0..* code 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
... type 0..1 code The Type - whether it is an allergy or intolerance
Binding: BeVSAllergyIntoleranceType (required)
... status 0..1 BackboneElement The status of the allergy
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... clinicalStatus 1..1 CodeableConcept The status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1 CodeableConcept The verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1 dateTime when the allergy/intolerance was recorded
... recorder 1..1 Reference() Who recorded the allergy
... asserter 0..1 Reference() Who asserted the allergy
... note 0..1 string Additional text note about the allergy or intolerance
... reactions 0..* BackboneElement known past reactions to the allergen
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..1 CodeableConcept How the reaction manifested itself
.... onset 0..1 dateTime Manifestation date
.... note 0..1 string Additional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-allergyintolerancecode
From this IG
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-vs-allergyintolerance-type
From this IG
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
From the FHIR Standard
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. be-model-allergyintolerance 0..* Element
Elements defined in Ancestors:@id, extension
Allergy Intolerance Logical Model
... patient 1..1 Reference() The person that has the allergy
... code 1..1 CodeableConcept The substance that the person is allergic to
Binding: BeAllergyIntoleranceCode (extensible)
... category 0..* code 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
... status 0..1 BackboneElement The status of the allergy
.... clinicalStatus 1..1 CodeableConcept The status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1 CodeableConcept The verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1 dateTime when the allergy/intolerance was recorded
... recorder 1..1 Reference() Who recorded the allergy
... asserter 0..1 Reference() Who asserted the allergy
... note 0..1 string Additional text note about the allergy or intolerance
... reactions 0..* BackboneElement known past reactions to the allergen
.... manifestation 1..1 CodeableConcept How the reaction manifested itself
.... onset 0..1 dateTime Manifestation date
.... note 0..1 string Additional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-allergyintolerancecode
From this IG
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-vs-allergyintolerance-type
From this IG
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
From the FHIR Standard
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
From the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. be-model-allergyintolerance 0..* Element
Elements defined in Ancestors:@id, extension
Allergy Intolerance Logical Model
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... patient 1..1 Reference() The person that has the allergy
... category 0..* code 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
... type 0..1 code The Type - whether it is an allergy or intolerance
Binding: BeVSAllergyIntoleranceType (required)
... status 0..1 BackboneElement The status of the allergy
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... clinicalStatus 1..1 CodeableConcept The status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1 CodeableConcept The verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1 dateTime when the allergy/intolerance was recorded
... recorder 1..1 Reference() Who recorded the allergy
... asserter 0..1 Reference() Who asserted the allergy
... note 0..1 string Additional text note about the allergy or intolerance
... reactions 0..* BackboneElement known past reactions to the allergen
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..1 CodeableConcept How the reaction manifested itself
.... onset 0..1 dateTime Manifestation date
.... note 0..1 string Additional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-allergyintolerancecode
From this IG
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-vs-allergyintolerance-type
From this IG
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
From the FHIR Standard
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Element

Summary

Mandatory: 0 element(7 nested mandatory elements)

 

Other representations of profile: CSV, Excel