Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) iehr-1: If the original code could not be translated it must be present
abatement	S	0..1	dateTime	Extension URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
clinicalStatus	S	0..1	CodeableConcept	active | inactive | resolved
verificationStatus	S	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
type	S	0..1	code	allergy | intolerance - Underlying mechanism (if known)
criticality	S	0..1	code	low | high | unable-to-assess
code	S	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: CombinedAllergy - IEHR (required)
patient	S	1..1	Reference(Patient-IEHR)	Who the sensitivity is for
encounter		0..1	Reference(Encounter-IEHR)	Encounter when the allergy or intolerance was asserted
onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
recorder		0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Who recorded the sensitivity
asserter	S	0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Source of the information about the allergy
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
Slices for manifestation	S	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Slice: Unordered, Open by pattern:$this
manifestation:reactionICD10	S	0..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ICD10 ValueSet-IEHR (required)
onset	S	0..1	dateTime	Date(/time) when manifestations showed
severity	S	0..1	code	mild | moderate | severe (of event as a whole)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.code	required	CombinedAllergyIEHR http://interopehrate.eu/fhir/ValueSet/CombinedAllergy-IEHR from this IG
AllergyIntolerance.reaction.manifestation:reactionICD10	required	ICD10ValueSetIEHR http://interopehrate.eu/fhir/ValueSet/ICD10ValueSet-IEHR from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
iehr-1	error	AllergyIntolerance	If the original code could not be translated it must be present : (code.coding.exists(code = 'OTH') and code.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not()

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error iehr-1: If the original code could not be translated it must be present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
abatement	S	0..1	dateTime	Extension URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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.
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
criticality	SΣ	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	Code that identifies the allergy or intolerance Binding: CombinedAllergy - IEHR (required)
patient	SΣ	1..1	Reference(Patient-IEHR)	Who the sensitivity is for
encounter		0..1	Reference(Encounter-IEHR)	Encounter when the allergy or intolerance was asserted
Slices for onset[x]		0..1		When allergy or intolerance was identified Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
recorder		0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Who recorded the sensitivity
asserter	SΣ	0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Source of the information about the allergy
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for manifestation	S	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Slice: Unordered, Open by pattern:$this Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
manifestation:reactionICD10	S	0..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ICD10 ValueSet-IEHR (required)
onset	S	0..1	dateTime	Date(/time) when manifestations showed
severity	S	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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	required	CombinedAllergyIEHR http://interopehrate.eu/fhir/ValueSet/CombinedAllergy-IEHR from this IG
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
AllergyIntolerance.reaction.manifestation:reactionICD10	required	ICD10ValueSetIEHR http://interopehrate.eu/fhir/ValueSet/ICD10ValueSet-IEHR from this IG
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard

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()
iehr-1	error	AllergyIntolerance	If the original code could not be translated it must be present : (code.coding.exists(code = 'OTH') and code.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not()

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error iehr-1: If the original code could not be translated it must be present
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
abatement	S	0..1	dateTime	Extension URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
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.
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
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	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	Code that identifies the allergy or intolerance Binding: CombinedAllergy - IEHR (required)
patient	SΣ	1..1	Reference(Patient-IEHR)	Who the sensitivity is for
encounter		0..1	Reference(Encounter-IEHR)	Encounter when the allergy or intolerance was asserted
Slices for onset[x]		0..1		When allergy or intolerance was identified Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
recorder		0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Who recorded the sensitivity
asserter	SΣ	0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	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	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).
Slices for manifestation	S	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Slice: Unordered, Open by pattern:$this Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
manifestation:reactionICD10	S	0..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ICD10 ValueSet-IEHR (required)
description		0..1	string	Description of the event as a whole
onset	S	0..1	dateTime	Date(/time) when manifestations showed
severity	S	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: 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		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	required	CombinedAllergyIEHR http://interopehrate.eu/fhir/ValueSet/CombinedAllergy-IEHR from this IG
AllergyIntolerance.reaction.substance	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
AllergyIntolerance.reaction.manifestation:reactionICD10	required	ICD10ValueSetIEHR http://interopehrate.eu/fhir/ValueSet/ICD10ValueSet-IEHR from this IG
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard

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()
iehr-1	error	AllergyIntolerance	If the original code could not be translated it must be present : (code.coding.exists(code = 'OTH') and code.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not()

Summary

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

Structures

This structure refers to these other structures:

• Patient-IEHR (http://interopehrate.eu/fhir/StructureDefinition/Patient-IEHR)
• Encounter-IEHR (http://interopehrate.eu/fhir/StructureDefinition/Encounter-IEHR)
• Practitioner (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Practitioner-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of AllergyIntolerance.reaction.manifestation

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) iehr-1: If the original code could not be translated it must be present
abatement	S	0..1	dateTime	Extension URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
clinicalStatus	S	0..1	CodeableConcept	active | inactive | resolved
verificationStatus	S	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
type	S	0..1	code	allergy | intolerance - Underlying mechanism (if known)
criticality	S	0..1	code	low | high | unable-to-assess
code	S	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: CombinedAllergy - IEHR (required)
patient	S	1..1	Reference(Patient-IEHR)	Who the sensitivity is for
encounter		0..1	Reference(Encounter-IEHR)	Encounter when the allergy or intolerance was asserted
onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
recorder		0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Who recorded the sensitivity
asserter	S	0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Source of the information about the allergy
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
Slices for manifestation	S	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Slice: Unordered, Open by pattern:$this
manifestation:reactionICD10	S	0..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ICD10 ValueSet-IEHR (required)
onset	S	0..1	dateTime	Date(/time) when manifestations showed
severity	S	0..1	code	mild | moderate | severe (of event as a whole)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.code	required	CombinedAllergyIEHR http://interopehrate.eu/fhir/ValueSet/CombinedAllergy-IEHR from this IG
AllergyIntolerance.reaction.manifestation:reactionICD10	required	ICD10ValueSetIEHR http://interopehrate.eu/fhir/ValueSet/ICD10ValueSet-IEHR from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
iehr-1	error	AllergyIntolerance	If the original code could not be translated it must be present : (code.coding.exists(code = 'OTH') and code.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not()

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error iehr-1: If the original code could not be translated it must be present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
abatement	S	0..1	dateTime	Extension URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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.
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
criticality	SΣ	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	Code that identifies the allergy or intolerance Binding: CombinedAllergy - IEHR (required)
patient	SΣ	1..1	Reference(Patient-IEHR)	Who the sensitivity is for
encounter		0..1	Reference(Encounter-IEHR)	Encounter when the allergy or intolerance was asserted
Slices for onset[x]		0..1		When allergy or intolerance was identified Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
recorder		0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Who recorded the sensitivity
asserter	SΣ	0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Source of the information about the allergy
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for manifestation	S	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Slice: Unordered, Open by pattern:$this Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
manifestation:reactionICD10	S	0..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ICD10 ValueSet-IEHR (required)
onset	S	0..1	dateTime	Date(/time) when manifestations showed
severity	S	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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	required	CombinedAllergyIEHR http://interopehrate.eu/fhir/ValueSet/CombinedAllergy-IEHR from this IG
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
AllergyIntolerance.reaction.manifestation:reactionICD10	required	ICD10ValueSetIEHR http://interopehrate.eu/fhir/ValueSet/ICD10ValueSet-IEHR from this IG
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard

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()
iehr-1	error	AllergyIntolerance	If the original code could not be translated it must be present : (code.coding.exists(code = 'OTH') and code.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not()

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error iehr-1: If the original code could not be translated it must be present
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
abatement	S	0..1	dateTime	Extension URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
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.
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
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	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	Code that identifies the allergy or intolerance Binding: CombinedAllergy - IEHR (required)
patient	SΣ	1..1	Reference(Patient-IEHR)	Who the sensitivity is for
encounter		0..1	Reference(Encounter-IEHR)	Encounter when the allergy or intolerance was asserted
Slices for onset[x]		0..1		When allergy or intolerance was identified Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
recorder		0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	Who recorded the sensitivity
asserter	SΣ	0..1	Reference(Patient-IEHR | Practitioner (IPS) | RelatedPerson)	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	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).
Slices for manifestation	S	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Slice: Unordered, Open by pattern:$this Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
manifestation:reactionICD10	S	0..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ICD10 ValueSet-IEHR (required)
description		0..1	string	Description of the event as a whole
onset	S	0..1	dateTime	Date(/time) when manifestations showed
severity	S	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: 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		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	required	CombinedAllergyIEHR http://interopehrate.eu/fhir/ValueSet/CombinedAllergy-IEHR from this IG
AllergyIntolerance.reaction.substance	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
AllergyIntolerance.reaction.manifestation:reactionICD10	required	ICD10ValueSetIEHR http://interopehrate.eu/fhir/ValueSet/ICD10ValueSet-IEHR from this IG
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard

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()
iehr-1	error	AllergyIntolerance	If the original code could not be translated it must be present : (code.coding.exists(code = 'OTH') and code.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not()

Summary

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

Structures

This structure refers to these other structures:

• Patient-IEHR (http://interopehrate.eu/fhir/StructureDefinition/Patient-IEHR)
• Encounter-IEHR (http://interopehrate.eu/fhir/StructureDefinition/Encounter-IEHR)
• Practitioner (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Practitioner-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of AllergyIntolerance.reaction.manifestation