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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: Allergy Intolerance Logical Model

Allergy / Intolerance information model

Usage:

• This Logical Model Profile 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.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Element

Name	Flags	Card.	Type	Description & Constraints
be-model-allergyintolerance		0..*	Element	Elements defined in Ancestors: @id, extension Allergy Intolerance Logical Model Instances of this logical model are not marked to be the target of a Reference
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
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
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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
be-model-allergyintolerance.code	extensible	BeAllergyIntoleranceCode
be-model-allergyintolerance.type	required	BeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes

Name	Flags	Card.	Type	Description & Constraints
be-model-allergyintolerance		0..*	Element	Elements defined in Ancestors: @id, extension Allergy Intolerance Logical Model Instances of this logical model are not marked to be the target of a Reference
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
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
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
be-model-allergyintolerance.code	extensible	BeAllergyIntoleranceCode
be-model-allergyintolerance.type	required	BeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
be-model-allergyintolerance		0..*	Element	Elements defined in Ancestors: @id, extension Allergy Intolerance Logical Model Instances of this logical model are not marked to be the target of a Reference
@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
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
be-model-allergyintolerance.code	extensible	BeAllergyIntoleranceCode
be-model-allergyintolerance.type	required	BeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must 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)

Differential View

This structure is derived from Element

Name	Flags	Card.	Type	Description & Constraints
be-model-allergyintolerance		0..*	Element	Elements defined in Ancestors: @id, extension Allergy Intolerance Logical Model Instances of this logical model are not marked to be the target of a Reference
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
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
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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
be-model-allergyintolerance.code	extensible	BeAllergyIntoleranceCode
be-model-allergyintolerance.type	required	BeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
be-model-allergyintolerance		0..*	Element	Elements defined in Ancestors: @id, extension Allergy Intolerance Logical Model Instances of this logical model are not marked to be the target of a Reference
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
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
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
be-model-allergyintolerance.code	extensible	BeAllergyIntoleranceCode
be-model-allergyintolerance.type	required	BeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
be-model-allergyintolerance		0..*	Element	Elements defined in Ancestors: @id, extension Allergy Intolerance Logical Model Instances of this logical model are not marked to be the target of a Reference
@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
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
be-model-allergyintolerance.code	extensible	BeAllergyIntoleranceCode
be-model-allergyintolerance.type	required	BeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must 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