HL7 Europe Hospital Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/hdr/ and changes regularly. See the Directory of published versions

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

Resource Profile: Allergy Intolerance: obligations

This profile defines obligations for the AllergyIntolerance resource for the purpose of this project.

This profile constrains the AllergyIntolerance resource for the purpose of project.

Usages:

• This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntoleranceEuHdr	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) Constraints: ait-1, ait-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text	O	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 Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
Slices for extension				Content/Rules for all slices
extension:abatement		0..1	(Complex)	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
Slices for value[x]		1..1		Value of extension Slice: Unordered, Open by type:$this
valueDateTime			dateTime
valueAge			Age
valuePeriod			Period
valueRange			Range
valueString			string
value[x]:valueDateTime		0..1	dateTime	End date
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
clinicalStatus	?!ΣC	0..1	CodeableConceptIPS(2.0.0)	Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	0..1	CodeableConceptIPS(2.0.0)	Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	OΣ	0..1	code	Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
code	OΣ	1..1	CodeableConceptIPS(2.0.0)	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose Allergens Value Set candidate WHO ATC - IPS candidate Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
patient	OΣ	1..1	Reference(Patient (EU core))	Who the sensitivity is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
Slices for onset[x]		0..1		When allergy or intolerance was identified Slice: Unordered, Closed by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetDateTime	O	0..1	dateTime	Onset date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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.code	Base	preferred	Allergy Intolerance - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1

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	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from AllergyIntoleranceEuHdr

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AllergyIntoleranceEuHdr	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0)
text	O	0..1	Narrative	Text summary of the resource, for human interpretation Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
type	O	0..1	code	Type of propensity Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
code	O	1..1	CodeableConceptIPS(2.0.0)	Code that identifies the allergy or intolerance Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
patient	O	1..1	Reference(Patient (EU core))	Who the sensitivity is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
Slices for onset[x]				Content/Rules for all slices
onset[x]:onsetDateTime	O	0..1	dateTime	Onset date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntoleranceEuHdr	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) 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	O	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 Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:abatement		0..1	(Complex)	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
Slices for value[x]		1..1		Value of extension Slice: Unordered, Open by type:$this
valueDateTime			dateTime
valueAge			Age
valuePeriod			Period
valueRange			Range
valueString			string
value[x]:valueDateTime		0..1	dateTime	End date
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!ΣC	0..1	CodeableConceptIPS(2.0.0)	Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	0..1	CodeableConceptIPS(2.0.0)	Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	OΣ	0..1	code	Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
category	Σ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	Σ	0..1	code	Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	OΣ	1..1	CodeableConceptIPS(2.0.0)	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose Allergens Value Set candidate WHO ATC - IPS candidate Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
patient	OΣ	1..1	Reference(Patient (EU core))	Who the sensitivity is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
Slices for onset[x]		0..1		When allergy or intolerance was identified Slice: Unordered, Closed by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetDateTime	O	0..1	dateTime	Onset date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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		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: Allergens Value Set (preferred)
manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Type of allergy or intolerance reaction expected to be used in MyHealth@EU Additional Bindings Purpose eHDSI Reaction Allergy candidate
description		0..1	string	Description of the event as a whole
onset		0..1	dateTime	Date(/time) when manifestations showed
severity		0..1	code	Reaction severity 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	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.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	preferred	Allergy Intolerance - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1
AllergyIntolerance.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​substance	Base	preferred	Allergens Value Set	📦0.1.0-ci-build	This IG
AllergyIntolerance.reaction.​manifestation	Base	preferred	Allergy Reaction - IPS	📦2.0.0	International Patient Summary Implementation Guide v2.0
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	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from AllergyIntoleranceEuHdr

Summary

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntoleranceEuHdr	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) Constraints: ait-1, ait-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text	O	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 Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
Slices for extension				Content/Rules for all slices
extension:abatement		0..1	(Complex)	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
Slices for value[x]		1..1		Value of extension Slice: Unordered, Open by type:$this
valueDateTime			dateTime
valueAge			Age
valuePeriod			Period
valueRange			Range
valueString			string
value[x]:valueDateTime		0..1	dateTime	End date
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
clinicalStatus	?!ΣC	0..1	CodeableConceptIPS(2.0.0)	Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	0..1	CodeableConceptIPS(2.0.0)	Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	OΣ	0..1	code	Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
code	OΣ	1..1	CodeableConceptIPS(2.0.0)	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose Allergens Value Set candidate WHO ATC - IPS candidate Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
patient	OΣ	1..1	Reference(Patient (EU core))	Who the sensitivity is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
Slices for onset[x]		0..1		When allergy or intolerance was identified Slice: Unordered, Closed by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetDateTime	O	0..1	dateTime	Onset date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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.code	Base	preferred	Allergy Intolerance - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1

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	**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()

Differential View

This structure is derived from AllergyIntoleranceEuHdr

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AllergyIntoleranceEuHdr	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0)
text	O	0..1	Narrative	Text summary of the resource, for human interpretation Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
type	O	0..1	code	Type of propensity Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
code	O	1..1	CodeableConceptIPS(2.0.0)	Code that identifies the allergy or intolerance Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
patient	O	1..1	Reference(Patient (EU core))	Who the sensitivity is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
Slices for onset[x]				Content/Rules for all slices
onset[x]:onsetDateTime	O	0..1	dateTime	Onset date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntoleranceEuHdr	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) 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	O	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 Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:abatement		0..1	(Complex)	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
Slices for value[x]		1..1		Value of extension Slice: Unordered, Open by type:$this
valueDateTime			dateTime
valueAge			Age
valuePeriod			Period
valueRange			Range
valueString			string
value[x]:valueDateTime		0..1	dateTime	End date
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!ΣC	0..1	CodeableConceptIPS(2.0.0)	Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	0..1	CodeableConceptIPS(2.0.0)	Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	OΣ	0..1	code	Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
category	Σ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	Σ	0..1	code	Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	OΣ	1..1	CodeableConceptIPS(2.0.0)	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose Allergens Value Set candidate WHO ATC - IPS candidate Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
patient	OΣ	1..1	Reference(Patient (EU core))	Who the sensitivity is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
Slices for onset[x]		0..1		When allergy or intolerance was identified Slice: Unordered, Closed by type:$this
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
onset[x]:onsetDateTime	O	0..1	dateTime	Onset date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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		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: Allergens Value Set (preferred)
manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Type of allergy or intolerance reaction expected to be used in MyHealth@EU Additional Bindings Purpose eHDSI Reaction Allergy candidate
description		0..1	string	Description of the event as a whole
onset		0..1	dateTime	Date(/time) when manifestations showed
severity		0..1	code	Reaction severity 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	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.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	preferred	Allergy Intolerance - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1
AllergyIntolerance.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​substance	Base	preferred	Allergens Value Set	📦0.1.0-ci-build	This IG
AllergyIntolerance.reaction.​manifestation	Base	preferred	Allergy Reaction - IPS	📦2.0.0	International Patient Summary Implementation Guide v2.0
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	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from AllergyIntoleranceEuHdr

Summary

Maturity: 0

Other representations of profile: CSV, Excel, Schematron