FR Document Core (FHIR), published by Agence du Numérique en Santé (ANS) - 2-10 Rue d'Oradour-sur-Glane, 75015 Paris. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ansforge/interop-IG-fhir-document-core/ and changes regularly. See the Directory of published versions

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

Resource Profile: AllergyIntolerance - FR Allergy and intolerance Document

FRAllergyIntoleranceDocument est un profil utilisé pourdécrire une allergie ou une hypersensibilité non allergique ou une intolérance ou une idiosyncrasie.

Usages:

• Examples for this Profile: AllergyIntolerance/example-allergy-intolerance-data-absent-reason

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance(4.0.1)	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifiant
clinicalStatus	?!SΣC	0..1	CodeableConcept	Statut clinique Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	0..1	CodeableConcept	Certitude Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:type		0..1	(Complex)	Type d'allergie ou d'intolérance URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type"
value[x]		0..1	CodeableConcept	allergy | intolerance - Underlying mechanism (if known) Binding: FRValueSetAllergyInoleranceTypeDocument (0.1.0) (preferred)
criticality	SΣ	0..1	code	Criticité Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	agent allergique Binding: FRValueSetAllergyCodeDocument (0.1.0) (extensible)
patient	SΣ	1..1	Reference(FR Patient INS Document(0.1.0) | FR Patient Document(0.1.0))	Patient concerné par l'allergie ou intolérance
Slices for onset[x]	S	0..1		Date d'identification d'allergie ou d'intolérance Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetPeriod	S	0..1	Period	Dates de début et de fin
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
reaction	S	0..*	BackboneElement	Réaction observée
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
substance	S	0..1	CodeableConcept	Substance responsable de la réaction Binding: FRValueSetAllergySubstanceDocument (0.1.0) (required)
manifestation	S	1..*	CodeableConcept	Symptômes/signes cliniques associés à l’événement Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
onset	S	0..1	dateTime	Dates de début et de fin du problème
severity	S	0..1	code	Sévérité Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
note	S	0..*	Annotation	Commentaire
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.type.​extension:type.value[x]	Base	preferred	ValueSet - FR ValueSet Allergy Intolerance Type Document	📍0.1.0	This IG
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	ValueSet – FR ValueSet Allergy Code Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​substance	Base	required	ValueSet – FR ValueSet Allergy Substance Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​manifestation	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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	AllergyIntolerance.implicitRules, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.type.extension:type.value[x], AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.onset[x], AllergyIntolerance.onset[x]:onsetPeriod, AllergyIntolerance.onset[x]:onsetPeriod.start, AllergyIntolerance.reaction, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.note	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	AllergyIntolerance.modifierExtension, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.reaction.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AllergyIntolerance(4.0.1)	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
identifier		0..*	Identifier	Identifiant
clinicalStatus	S	0..1	CodeableConcept	Statut clinique
verificationStatus	S	0..1	CodeableConcept	Certitude
type	S	0..1	code	allergy | intolerance - Underlying mechanism (if known)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:type		0..1	(Complex)	Type d'allergie ou d'intolérance URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type
extension		0..0		Extension
value[x]		0..1	CodeableConcept	allergy | intolerance - Underlying mechanism (if known) Binding: FRValueSetAllergyInoleranceTypeDocument (0.1.0) (preferred)
criticality	S	0..1	code	Criticité
code	S	1..1	CodeableConcept	agent allergique Binding: FRValueSetAllergyCodeDocument (0.1.0) (extensible)
patient	S	1..1	Reference(FR Patient INS Document(0.1.0) | FR Patient Document(0.1.0))	Patient concerné par l'allergie ou intolérance
Slices for onset[x]	S	0..1	dateTime, Age, Period, Range, string	Date d'identification d'allergie ou d'intolérance Slice: Unordered, Open by type:$this
onset[x]:onsetPeriod	S	0..1	Period	Dates de début et de fin
start		1..1	dateTime	Starting time with inclusive boundary
reaction	S	0..*	BackboneElement	Réaction observée
substance	S	0..1	CodeableConcept	Substance responsable de la réaction Binding: FRValueSetAllergySubstanceDocument (0.1.0) (required)
manifestation	S	1..*	CodeableConcept	Symptômes/signes cliniques associés à l’événement
onset	S	0..1	dateTime	Dates de début et de fin du problème
severity	S	0..1	code	Sévérité
note	S	0..*	Annotation	Commentaire
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.type.​extension:type.value[x]	Base	preferred	ValueSet - FR ValueSet Allergy Intolerance Type Document	📍0.1.0	This IG
AllergyIntolerance.code	Base	extensible	ValueSet – FR ValueSet Allergy Code Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​substance	Base	required	ValueSet – FR ValueSet Allergy Substance Document	📍0.1.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance(4.0.1)	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifiant
clinicalStatus	?!SΣC	0..1	CodeableConcept	Statut clinique Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	0..1	CodeableConcept	Certitude Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:type		0..1	(Complex)	Type d'allergie ou d'intolérance URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type"
value[x]		0..1	CodeableConcept	allergy | intolerance - Underlying mechanism (if known) Binding: FRValueSetAllergyInoleranceTypeDocument (0.1.0) (preferred)
value		0..1	string	Primitive value for code
category	Σ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	0..1	code	Criticité Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	agent allergique Binding: FRValueSetAllergyCodeDocument (0.1.0) (extensible)
patient	SΣ	1..1	Reference(FR Patient INS Document(0.1.0) | FR Patient Document(0.1.0))	Patient concerné par l'allergie ou intolérance
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
Slices for onset[x]	S	0..1		Date d'identification d'allergie ou d'intolérance Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetPeriod	S	0..1	Period	Dates de début et de fin
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
asserter	Σ	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		0..*	Annotation	Additional text not captured in other fields
reaction	S	0..*	BackboneElement	Réaction observée
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
substance	S	0..1	CodeableConcept	Substance responsable de la réaction Binding: FRValueSetAllergySubstanceDocument (0.1.0) (required)
manifestation	S	1..*	CodeableConcept	Symptômes/signes cliniques associés à l’événement Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
description		0..1	string	Description of the event as a whole
onset	S	0..1	dateTime	Dates de début et de fin du problème
severity	S	0..1	code	Sévérité 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: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
note	S	0..*	Annotation	Commentaire
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.type.​extension:type.value[x]	Base	preferred	ValueSet - FR ValueSet Allergy Intolerance Type Document	📍0.1.0	This IG
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	ValueSet – FR ValueSet Allergy Code Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​substance	Base	required	ValueSet – FR ValueSet Allergy Substance Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​manifestation	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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	AllergyIntolerance.meta, AllergyIntolerance.implicitRules, AllergyIntolerance.language, AllergyIntolerance.text, AllergyIntolerance.extension, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.type.extension:type.value[x], AllergyIntolerance.category, AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.onset[x]:onsetPeriod, AllergyIntolerance.onset[x]:onsetPeriod.extension, AllergyIntolerance.onset[x]:onsetPeriod.start, AllergyIntolerance.onset[x]:onsetPeriod.end, AllergyIntolerance.recordedDate, AllergyIntolerance.recorder, AllergyIntolerance.asserter, AllergyIntolerance.lastOccurrence, AllergyIntolerance.note, AllergyIntolerance.reaction, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.description, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.exposureRoute, AllergyIntolerance.reaction.note	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	AllergyIntolerance.extension, AllergyIntolerance.modifierExtension, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.onset[x]:onsetPeriod.extension, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 14 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• FR Patient INS Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-patient-ins-document|0.1.0)
• FR Patient Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-patient-document|0.1.0)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type|0.1.0

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of AllergyIntolerance.onset[x]

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance(4.0.1)	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifiant
clinicalStatus	?!SΣC	0..1	CodeableConcept	Statut clinique Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	0..1	CodeableConcept	Certitude Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:type		0..1	(Complex)	Type d'allergie ou d'intolérance URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type"
value[x]		0..1	CodeableConcept	allergy | intolerance - Underlying mechanism (if known) Binding: FRValueSetAllergyInoleranceTypeDocument (0.1.0) (preferred)
criticality	SΣ	0..1	code	Criticité Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	agent allergique Binding: FRValueSetAllergyCodeDocument (0.1.0) (extensible)
patient	SΣ	1..1	Reference(FR Patient INS Document(0.1.0) | FR Patient Document(0.1.0))	Patient concerné par l'allergie ou intolérance
Slices for onset[x]	S	0..1		Date d'identification d'allergie ou d'intolérance Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetPeriod	S	0..1	Period	Dates de début et de fin
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
reaction	S	0..*	BackboneElement	Réaction observée
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
substance	S	0..1	CodeableConcept	Substance responsable de la réaction Binding: FRValueSetAllergySubstanceDocument (0.1.0) (required)
manifestation	S	1..*	CodeableConcept	Symptômes/signes cliniques associés à l’événement Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
onset	S	0..1	dateTime	Dates de début et de fin du problème
severity	S	0..1	code	Sévérité Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
note	S	0..*	Annotation	Commentaire
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.type.​extension:type.value[x]	Base	preferred	ValueSet - FR ValueSet Allergy Intolerance Type Document	📍0.1.0	This IG
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	ValueSet – FR ValueSet Allergy Code Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​substance	Base	required	ValueSet – FR ValueSet Allergy Substance Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​manifestation	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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	AllergyIntolerance.implicitRules, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.type.extension:type.value[x], AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.onset[x], AllergyIntolerance.onset[x]:onsetPeriod, AllergyIntolerance.onset[x]:onsetPeriod.start, AllergyIntolerance.reaction, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.note	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	AllergyIntolerance.modifierExtension, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.reaction.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AllergyIntolerance(4.0.1)	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
identifier		0..*	Identifier	Identifiant
clinicalStatus	S	0..1	CodeableConcept	Statut clinique
verificationStatus	S	0..1	CodeableConcept	Certitude
type	S	0..1	code	allergy | intolerance - Underlying mechanism (if known)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:type		0..1	(Complex)	Type d'allergie ou d'intolérance URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type
extension		0..0		Extension
value[x]		0..1	CodeableConcept	allergy | intolerance - Underlying mechanism (if known) Binding: FRValueSetAllergyInoleranceTypeDocument (0.1.0) (preferred)
criticality	S	0..1	code	Criticité
code	S	1..1	CodeableConcept	agent allergique Binding: FRValueSetAllergyCodeDocument (0.1.0) (extensible)
patient	S	1..1	Reference(FR Patient INS Document(0.1.0) | FR Patient Document(0.1.0))	Patient concerné par l'allergie ou intolérance
Slices for onset[x]	S	0..1	dateTime, Age, Period, Range, string	Date d'identification d'allergie ou d'intolérance Slice: Unordered, Open by type:$this
onset[x]:onsetPeriod	S	0..1	Period	Dates de début et de fin
start		1..1	dateTime	Starting time with inclusive boundary
reaction	S	0..*	BackboneElement	Réaction observée
substance	S	0..1	CodeableConcept	Substance responsable de la réaction Binding: FRValueSetAllergySubstanceDocument (0.1.0) (required)
manifestation	S	1..*	CodeableConcept	Symptômes/signes cliniques associés à l’événement
onset	S	0..1	dateTime	Dates de début et de fin du problème
severity	S	0..1	code	Sévérité
note	S	0..*	Annotation	Commentaire
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.type.​extension:type.value[x]	Base	preferred	ValueSet - FR ValueSet Allergy Intolerance Type Document	📍0.1.0	This IG
AllergyIntolerance.code	Base	extensible	ValueSet – FR ValueSet Allergy Code Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​substance	Base	required	ValueSet – FR ValueSet Allergy Substance Document	📍0.1.0	This IG

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance(4.0.1)	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifiant
clinicalStatus	?!SΣC	0..1	CodeableConcept	Statut clinique Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	0..1	CodeableConcept	Certitude Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:type		0..1	(Complex)	Type d'allergie ou d'intolérance URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type"
value[x]		0..1	CodeableConcept	allergy | intolerance - Underlying mechanism (if known) Binding: FRValueSetAllergyInoleranceTypeDocument (0.1.0) (preferred)
value		0..1	string	Primitive value for code
category	Σ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	0..1	code	Criticité Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	agent allergique Binding: FRValueSetAllergyCodeDocument (0.1.0) (extensible)
patient	SΣ	1..1	Reference(FR Patient INS Document(0.1.0) | FR Patient Document(0.1.0))	Patient concerné par l'allergie ou intolérance
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
Slices for onset[x]	S	0..1		Date d'identification d'allergie ou d'intolérance Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetPeriod	S	0..1	Period	Dates de début et de fin
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
asserter	Σ	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		0..*	Annotation	Additional text not captured in other fields
reaction	S	0..*	BackboneElement	Réaction observée
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
substance	S	0..1	CodeableConcept	Substance responsable de la réaction Binding: FRValueSetAllergySubstanceDocument (0.1.0) (required)
manifestation	S	1..*	CodeableConcept	Symptômes/signes cliniques associés à l’événement Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
description		0..1	string	Description of the event as a whole
onset	S	0..1	dateTime	Dates de début et de fin du problème
severity	S	0..1	code	Sévérité 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: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
note	S	0..*	Annotation	Commentaire
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.type.​extension:type.value[x]	Base	preferred	ValueSet - FR ValueSet Allergy Intolerance Type Document	📍0.1.0	This IG
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	ValueSet – FR ValueSet Allergy Code Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​substance	Base	required	ValueSet – FR ValueSet Allergy Substance Document	📍0.1.0	This IG
AllergyIntolerance.reaction.​manifestation	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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	AllergyIntolerance.meta, AllergyIntolerance.implicitRules, AllergyIntolerance.language, AllergyIntolerance.text, AllergyIntolerance.extension, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.type.extension:type.value[x], AllergyIntolerance.category, AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.onset[x]:onsetPeriod, AllergyIntolerance.onset[x]:onsetPeriod.extension, AllergyIntolerance.onset[x]:onsetPeriod.start, AllergyIntolerance.onset[x]:onsetPeriod.end, AllergyIntolerance.recordedDate, AllergyIntolerance.recorder, AllergyIntolerance.asserter, AllergyIntolerance.lastOccurrence, AllergyIntolerance.note, AllergyIntolerance.reaction, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.description, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.exposureRoute, AllergyIntolerance.reaction.note	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	AllergyIntolerance.extension, AllergyIntolerance.modifierExtension, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.onset[x]:onsetPeriod.extension, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 14 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• FR Patient INS Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-patient-ins-document|0.1.0)
• FR Patient Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-patient-document|0.1.0)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type|0.1.0

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of AllergyIntolerance.onset[x]

Other representations of profile: CSV, Excel, Schematron