Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
type	S	0..1	CodeableConcept	BeExtAllergyType URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type Binding: BeVSAllergyIntoleranceType (extensible)
Slices for identifier	S	0..*	Identifier	External ids for this item Slice: Unordered, Open by value:system
identifier:allergy		0..1	Identifier	Reference ID of the allergy
system		1..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
value		1..1	string	The value that is unique
clinicalStatus	S	0..1	CodeableConcept	active | inactive | resolved
verificationStatus	S	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
type		0..0
category	S	0..*	code	food | medication | environment | biologic
code	S	1..1	CodeableConcept	Use ATC, CNK or CTI-extended in case of medication allergy Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI
patient	S	1..1	Reference(BePatient)	Who the sensitivity is for
recordedDate	S	1..1	dateTime	Date first version of the resource instance was recorded
recorder	S	1..1	Reference(BePractitioner | BePractitionerRole | BePatient)	Who recorded the sensitivity
asserter	S	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
note	S	0..*	Annotation	Additional text not captured in other fields
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event
manifestation	S	1..1	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: BeRiskManifestation (extensible)
onset	S	0..1	dateTime	Date(/time) when manifestations showed
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: BeExposureRoute (extensible)
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
AllergyIntolerance.code	extensible	BeAllergyIntoleranceCode
AllergyIntolerance.reaction.manifestation	extensible	BeRiskManifestation
AllergyIntolerance.reaction.exposureRoute	extensible	BeExposureRoute

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
type	S	0..1	CodeableConcept	BeExtAllergyType URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type Binding: BeVSAllergyIntoleranceType (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	External ids for this item Slice: Unordered, Open by value:system
identifier:allergy	Σ	0..1	Identifier	Reference ID of the allergy
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
value	Σ	1..1	string	The value that is unique Example General: 123456
clinicalStatus	?!SΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
category	SΣ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
code	SΣ	1..1	CodeableConcept	Use ATC, CNK or CTI-extended in case of medication allergy Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI
patient	SΣ	1..1	Reference(BePatient)	Who the sensitivity is for
recordedDate	S	1..1	dateTime	Date first version of the resource instance was recorded
recorder	S	1..1	Reference(BePractitioner | BePractitionerRole | BePatient)	Who recorded the sensitivity
asserter	SΣ	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
note	S	0..*	Annotation	Additional text not captured in other fields
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
manifestation	S	1..1	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: BeRiskManifestation (extensible)
onset	S	0..1	dateTime	Date(/time) when manifestations showed
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: BeExposureRoute (extensible)
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
AllergyIntolerance.identifier:allergy.use	required	IdentifierUse
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.category	required	AllergyIntoleranceCategory
AllergyIntolerance.code	extensible	BeAllergyIntoleranceCode
AllergyIntolerance.reaction.substance	example	SubstanceCode
AllergyIntolerance.reaction.manifestation	extensible	BeRiskManifestation
AllergyIntolerance.reaction.exposureRoute	extensible	BeExposureRoute

Constraints

Id	Grade	Path(s)	Details	Requirements
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	A resource should have narrative for robust management : text.`div`.exists()
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
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
type	S	0..1	CodeableConcept	BeExtAllergyType URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type Binding: BeVSAllergyIntoleranceType (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	External ids for this item Slice: Unordered, Open by value:system
identifier:allergy	Σ	0..1	Identifier	Reference ID 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
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
clinicalStatus	?!SΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
category	SΣ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	Use ATC, CNK or CTI-extended in case of medication allergy Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI
patient	SΣ	1..1	Reference(BePatient)	Who the sensitivity is for
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
onset[x]		0..1		When allergy or intolerance was identified
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
recordedDate	S	1..1	dateTime	Date first version of the resource instance was recorded
recorder	S	1..1	Reference(BePractitioner | BePractitionerRole | BePatient)	Who recorded the sensitivity
asserter	SΣ	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
note	S	0..*	Annotation	Additional text not captured in other fields
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
manifestation	S	1..1	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: BeRiskManifestation (extensible)
description		0..1	string	Description of the event as a whole
onset	S	0..1	dateTime	Date(/time) when manifestations showed
severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: BeExposureRoute (extensible)
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
AllergyIntolerance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.identifier:allergy.use	required	IdentifierUse
AllergyIntolerance.identifier:allergy.type	extensible	Identifier Type Codes
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.category	required	AllergyIntoleranceCategory
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality
AllergyIntolerance.code	extensible	BeAllergyIntoleranceCode
AllergyIntolerance.reaction.substance	example	SubstanceCode
AllergyIntolerance.reaction.manifestation	extensible	BeRiskManifestation
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRoute	extensible	BeExposureRoute

Constraints

Id	Grade	Path(s)	Details	Requirements
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	A resource should have narrative for robust management : text.`div`.exists()
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()

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

• BePatient (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
• BePractitioner (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
• BePractitionerRole (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)

Extensions

This structure refers to these extensions:

• https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type

Slices

This structure defines the following Slices:

• The element AllergyIntolerance.identifier is sliced based on the value of value:system

Maturity: 1

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
type	S	0..1	CodeableConcept	BeExtAllergyType URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type Binding: BeVSAllergyIntoleranceType (extensible)
Slices for identifier	S	0..*	Identifier	External ids for this item Slice: Unordered, Open by value:system
identifier:allergy		0..1	Identifier	Reference ID of the allergy
system		1..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
value		1..1	string	The value that is unique
clinicalStatus	S	0..1	CodeableConcept	active | inactive | resolved
verificationStatus	S	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
type		0..0
category	S	0..*	code	food | medication | environment | biologic
code	S	1..1	CodeableConcept	Use ATC, CNK or CTI-extended in case of medication allergy Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI
patient	S	1..1	Reference(BePatient)	Who the sensitivity is for
recordedDate	S	1..1	dateTime	Date first version of the resource instance was recorded
recorder	S	1..1	Reference(BePractitioner | BePractitionerRole | BePatient)	Who recorded the sensitivity
asserter	S	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
note	S	0..*	Annotation	Additional text not captured in other fields
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event
manifestation	S	1..1	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: BeRiskManifestation (extensible)
onset	S	0..1	dateTime	Date(/time) when manifestations showed
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: BeExposureRoute (extensible)
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
AllergyIntolerance.code	extensible	BeAllergyIntoleranceCode
AllergyIntolerance.reaction.manifestation	extensible	BeRiskManifestation
AllergyIntolerance.reaction.exposureRoute	extensible	BeExposureRoute

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
type	S	0..1	CodeableConcept	BeExtAllergyType URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type Binding: BeVSAllergyIntoleranceType (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	External ids for this item Slice: Unordered, Open by value:system
identifier:allergy	Σ	0..1	Identifier	Reference ID of the allergy
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
value	Σ	1..1	string	The value that is unique Example General: 123456
clinicalStatus	?!SΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
category	SΣ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
code	SΣ	1..1	CodeableConcept	Use ATC, CNK or CTI-extended in case of medication allergy Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI
patient	SΣ	1..1	Reference(BePatient)	Who the sensitivity is for
recordedDate	S	1..1	dateTime	Date first version of the resource instance was recorded
recorder	S	1..1	Reference(BePractitioner | BePractitionerRole | BePatient)	Who recorded the sensitivity
asserter	SΣ	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
note	S	0..*	Annotation	Additional text not captured in other fields
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
manifestation	S	1..1	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: BeRiskManifestation (extensible)
onset	S	0..1	dateTime	Date(/time) when manifestations showed
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: BeExposureRoute (extensible)
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
AllergyIntolerance.identifier:allergy.use	required	IdentifierUse
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.category	required	AllergyIntoleranceCategory
AllergyIntolerance.code	extensible	BeAllergyIntoleranceCode
AllergyIntolerance.reaction.substance	example	SubstanceCode
AllergyIntolerance.reaction.manifestation	extensible	BeRiskManifestation
AllergyIntolerance.reaction.exposureRoute	extensible	BeExposureRoute

Constraints

Id	Grade	Path(s)	Details	Requirements
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	A resource should have narrative for robust management : text.`div`.exists()
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
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
type	S	0..1	CodeableConcept	BeExtAllergyType URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type Binding: BeVSAllergyIntoleranceType (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	External ids for this item Slice: Unordered, Open by value:system
identifier:allergy	Σ	0..1	Identifier	Reference ID 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
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
clinicalStatus	?!SΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
category	SΣ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	Use ATC, CNK or CTI-extended in case of medication allergy Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI
patient	SΣ	1..1	Reference(BePatient)	Who the sensitivity is for
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
onset[x]		0..1		When allergy or intolerance was identified
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
recordedDate	S	1..1	dateTime	Date first version of the resource instance was recorded
recorder	S	1..1	Reference(BePractitioner | BePractitionerRole | BePatient)	Who recorded the sensitivity
asserter	SΣ	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
note	S	0..*	Annotation	Additional text not captured in other fields
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
manifestation	S	1..1	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: BeRiskManifestation (extensible)
description		0..1	string	Description of the event as a whole
onset	S	0..1	dateTime	Date(/time) when manifestations showed
severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: BeExposureRoute (extensible)
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
AllergyIntolerance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.identifier:allergy.use	required	IdentifierUse
AllergyIntolerance.identifier:allergy.type	extensible	Identifier Type Codes
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.category	required	AllergyIntoleranceCategory
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality
AllergyIntolerance.code	extensible	BeAllergyIntoleranceCode
AllergyIntolerance.reaction.substance	example	SubstanceCode
AllergyIntolerance.reaction.manifestation	extensible	BeRiskManifestation
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRoute	extensible	BeExposureRoute

Constraints

Id	Grade	Path(s)	Details	Requirements
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	A resource should have narrative for robust management : text.`div`.exists()
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()

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

• BePatient (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
• BePractitioner (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
• BePractitionerRole (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)

Extensions

This structure refers to these extensions:

• https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type

Slices

This structure defines the following Slices:

• The element AllergyIntolerance.identifier is sliced based on the value of value:system

Maturity: 1