Allergy (Patient Dossier)
1.1.0 - STU1
This page is part of the HL7 Belgium FHIR Implementation Guide - Allergy profiles (v1.1.0: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2023-02-06 |
Definitions for the be-model-allergyintolerance logical model.
Guidance on how to interpret the contents of this table can be found here.
1. be-model-allergyintolerance | |
Definition | Allergy / Intolerance information model |
Control | 0..? |
2. be-model-allergyintolerance.patient | |
Definition | The person that has the allergy |
Control | 1..1 |
Type | Reference |
3. 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 |
Control | 1..1 |
Binding | The codes SHALL be taken from BeAllergyIntoleranceCode; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
4. 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 |
Control | 0..* |
Type | code |
5. 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' |
Control | 0..1 |
Binding | The codes SHALL be taken from BeVSAllergyIntoleranceType |
Type | code |
6. be-model-allergyintolerance.status | |
Definition | The status of the allergy |
Control | 0..1 |
Type | BackboneElement |
7. be-model-allergyintolerance.status.clinicalStatus | |
Definition | The status of the allergy - if it is active or resolved |
Control | 1..1 |
Binding | The codes SHALL be taken from AllergyIntoleranceClinicalStatusCodes |
Type | CodeableConcept |
8. be-model-allergyintolerance.status.verificationStatus | |
Definition | The verification status of the allergy - if it is confirmed or suspected or refuted |
Control | 1..1 |
Binding | The codes SHALL be taken from AllergyIntoleranceVerificationStatusCodes |
Type | CodeableConcept |
9. be-model-allergyintolerance.recordedDate | |
Definition | when the allergy/intolerance was recorded |
Control | 1..1 |
Type | dateTime |
10. be-model-allergyintolerance.recorder | |
Definition | Who recorded the allergy |
Control | 1..1 |
Type | Reference |
11. 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. |
Control | 0..1 |
Type | Reference |
12. be-model-allergyintolerance.note | |
Definition | Additional text note about the allergy or intolerance |
Control | 0..1 |
Type | string |
13. be-model-allergyintolerance.reactions | |
Definition | known past reactions to the allergen |
Control | 0..* |
Type | BackboneElement |
14. be-model-allergyintolerance.reactions.manifestation | |
Definition | How the reaction manifested itself, e.g. rash, breathing difficulty... |
Control | 1..1 |
Type | CodeableConcept |
15. 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 |
Control | 0..1 |
Type | dateTime |
16. be-model-allergyintolerance.reactions.note | |
Definition | Additional text note about the allergic reaction |
Control | 0..1 |
Type | string |
Guidance on how to interpret the contents of this table can be found here.
1. be-model-allergyintolerance | |
Definition | Allergy / Intolerance information model Base definition for all elements in a resource. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Invariants | Defined on this element 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 |
Control | 1..1 |
Type | Reference |
3. 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 |
Control | 1..1 |
Binding | The codes SHALL be taken from BeAllergyIntoleranceCode; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
4. 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 |
Control | 0..* |
Type | code |
5. 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' |
Control | 0..1 |
Binding | The codes SHALL be taken from BeVSAllergyIntoleranceType |
Type | code |
6. be-model-allergyintolerance.status | |
Definition | The status of the allergy |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, user content, modifiers |
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 | Defined on this element 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()) |
8. be-model-allergyintolerance.status.clinicalStatus | |
Definition | The status of the allergy - if it is active or resolved |
Control | 1..1 |
Binding | The codes SHALL be taken from AllergyIntoleranceClinicalStatusCodes |
Type | CodeableConcept |
9. be-model-allergyintolerance.status.verificationStatus | |
Definition | The verification status of the allergy - if it is confirmed or suspected or refuted |
Control | 1..1 |
Binding | The codes SHALL be taken from AllergyIntoleranceVerificationStatusCodes |
Type | CodeableConcept |
10. be-model-allergyintolerance.recordedDate | |
Definition | when the allergy/intolerance was recorded |
Control | 1..1 |
Type | dateTime |
11. be-model-allergyintolerance.recorder | |
Definition | Who recorded the allergy |
Control | 1..1 |
Type | Reference |
12. 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. |
Control | 0..1 |
Type | Reference |
13. be-model-allergyintolerance.note | |
Definition | Additional text note about the allergy or intolerance |
Control | 0..1 |
Type | string |
14. be-model-allergyintolerance.reactions | |
Definition | known past reactions to the allergen |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, user content, modifiers |
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 | Defined on this element 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()) |
16. be-model-allergyintolerance.reactions.manifestation | |
Definition | How the reaction manifested itself, e.g. rash, breathing difficulty... |
Control | 1..1 |
Type | CodeableConcept |
17. 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 |
Control | 0..1 |
Type | dateTime |
18. be-model-allergyintolerance.reactions.note | |
Definition | Additional text note about the allergic reaction |
Control | 0..1 |
Type | string |
Guidance on how to interpret the contents of this table can be found here.
1. be-model-allergyintolerance | |
Definition | Allergy / Intolerance information model |
Control | 0..* This element is affected by the following invariants: ele-1 |
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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
3. 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. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, 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. |
Invariants | Defined on this element 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()) |
Slicing | This 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:
|
4. be-model-allergyintolerance.patient | |
Definition | The person that has the allergy |
Control | 1..1 |
Type | Reference |
5. 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 |
Control | 1..1 |
Binding | The codes SHALL be taken from BeAllergyIntoleranceCode; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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 |
Control | 0..* |
Type | code |
7. 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' |
Control | 0..1 |
Binding | The codes SHALL be taken from BeVSAllergyIntoleranceType |
Type | code |
8. be-model-allergyintolerance.status | |
Definition | The status of the allergy |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
10. 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. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, 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. |
Invariants | Defined on this element 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()) |
Slicing | This 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:
|
11. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, user content, modifiers |
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 | Defined on this element 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()) |
12. be-model-allergyintolerance.status.clinicalStatus | |
Definition | The status of the allergy - if it is active or resolved |
Control | 1..1 |
Binding | The codes SHALL be taken from AllergyIntoleranceClinicalStatusCodes |
Type | CodeableConcept |
13. be-model-allergyintolerance.status.verificationStatus | |
Definition | The verification status of the allergy - if it is confirmed or suspected or refuted |
Control | 1..1 |
Binding | The codes SHALL be taken from AllergyIntoleranceVerificationStatusCodes |
Type | CodeableConcept |
14. be-model-allergyintolerance.recordedDate | |
Definition | when the allergy/intolerance was recorded |
Control | 1..1 |
Type | dateTime |
15. be-model-allergyintolerance.recorder | |
Definition | Who recorded the allergy |
Control | 1..1 |
Type | Reference |
16. 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. |
Control | 0..1 |
Type | Reference |
17. be-model-allergyintolerance.note | |
Definition | Additional text note about the allergy or intolerance |
Control | 0..1 |
Type | string |
18. be-model-allergyintolerance.reactions | |
Definition | known past reactions to the allergen |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
20. 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. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, 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. |
Invariants | Defined on this element 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()) |
Slicing | This 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:
|
21. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
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 Names | extensions, user content, modifiers |
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 | Defined on this element 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()) |
22. be-model-allergyintolerance.reactions.manifestation | |
Definition | How the reaction manifested itself, e.g. rash, breathing difficulty... |
Control | 1..1 |
Type | CodeableConcept |
23. 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 |
Control | 0..1 |
Type | dateTime |
24. be-model-allergyintolerance.reactions.note | |
Definition | Additional text note about the allergic reaction |
Control | 0..1 |
Type | string |