HL7 Europe Patient Summary
1.0.0-ci-build - ci-build
150
HL7 Europe Patient Summary
1.0.0-ci-build - ci-build
150
HL7 Europe Patient Summary, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.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/eps/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/eps/StructureDefinition/allergyintolerance-obl-eu-eps | Version: 1.0.0-ci-build | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: AllergyIntoleranceOblEuEps | ||
Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0). |
||||
This profile sets the IPS obligations on the EU Core AllergyIntolerance profile.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  AllergyIntolerance |
C | 0..* | AllergyIntoleranceEuCore | 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 | |||||||||||||||
  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 | |||||||||||||||||
 Slices for value[x] |
Content/Rules for all slices | |||||||||||||||||
| value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||
| clinicalStatus |
C | 0..1 | CodeableConcept | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||||
| verificationStatus |
C | 0..1 | CodeableConcept | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||||||||
| type |
0..1 | code | Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| |||||||||||||||
| code |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| |||||||||||||||
 patient |
1..1 | Reference(Patient (EU core)) | Who the allergy or intolerance concerns
| |||||||||||||||
 reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||
| Slices for onset[x] |
0..1 | Date of onset of the allergy or intolerance Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||||||||||||
| onsetDateTime |
dateTime | |||||||||||||||||
| onsetAge |
Age | |||||||||||||||||
| onsetPeriod |
Period | |||||||||||||||||
| onsetRange |
Range | |||||||||||||||||
| onsetString |
string | |||||||||||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date
| |||||||||||||||
 reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||
| 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
| |||||||||||||||
| 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.
| |||||||||||||||
| Documentation for this format | ||||||||||||||||||
| 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 | Allergies & Intolerances - IPS | 📦2.0.1 | International Patient Summary Implementation Guide v2.0 |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.1 | International Patient Summary Implementation Guide v2.0 |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| 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 AllergyIntoleranceEuCore
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntoleranceEuCore | 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 allergy or intolerance content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||
| 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 | |||||||||||||||
| 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 | string | 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 | |||||||||||||||||
| Slices for value[x] |
Content/Rules for all slices | |||||||||||||||||
| value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||
| identifier |
0..* | Identifier | Business identifier for the allergy or intolerance | |||||||||||||||
| clinicalStatus |
C | 0..1 | CodeableConcept | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||||
| verificationStatus |
C | 0..1 | CodeableConcept | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||||||||
| type |
0..1 | code | Type of propensity 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 |
0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | |||||||||||||||
| code |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| |||||||||||||||
| patient |
1..1 | Reference(Patient (EU core)) | Who the allergy or intolerance concerns
| |||||||||||||||
| 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 | 0..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 | Date of onset of the allergy or intolerance Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||||||||||||
| onsetDateTime |
dateTime | |||||||||||||||||
| onsetAge |
Age | |||||||||||||||||
| onsetPeriod |
Period | |||||||||||||||||
| onsetRange |
Range | |||||||||||||||||
| onsetString |
string | |||||||||||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date
| |||||||||||||||
| recordedDate |
0..1 | dateTime | Date when the allergy or intolerance was recorded | |||||||||||||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the allergy or intolerance | |||||||||||||||
| asserter |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who asserts the allergy or intolerance | |||||||||||||||
| lastOccurrence |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||||||||||||
| note |
0..* | Annotation | Additional text not captured in other fields | |||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||
 author[x] |
0..1 | Individual responsible for the annotation | ||||||||||||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||||||||||||
| authorString |
string | |||||||||||||||||
| time |
0..1 | dateTime | When the annotation was made | |||||||||||||||
| text |
1..1 | markdown | Additional information about the allergy or intolerance | |||||||||||||||
| 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: eHDSI Allergen No Drug  (example) | |||||||||||||||
| 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
| |||||||||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||||||||
| onset |
0..1 | dateTime | Reaction onset | |||||||||||||||
| 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 | ||||||||||||||||||
| 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 | Allergies & Intolerances - IPS | 📦2.0.1 | International Patient Summary Implementation Guide v2.0 |
| AllergyIntolerance.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | example |
eHDSI Allergen No Drug
|
⏿0.2.0 | tx.hl7europe.eu |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.1 | 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. |
| 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 AllergyIntoleranceEuCore
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntoleranceEuCore | 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 | |||||||||||||||
| 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 | |||||||||||||||||
| Slices for value[x] |
Content/Rules for all slices | |||||||||||||||||
| value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||
| clinicalStatus |
C | 0..1 | CodeableConcept | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||||
| verificationStatus |
C | 0..1 | CodeableConcept | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||||||||
| type |
0..1 | code | Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| |||||||||||||||
| code |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| |||||||||||||||
| patient |
1..1 | Reference(Patient (EU core)) | Who the allergy or intolerance concerns
| |||||||||||||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||
| Slices for onset[x] |
0..1 | Date of onset of the allergy or intolerance Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||||||||||||
| onsetDateTime |
dateTime | |||||||||||||||||
| onsetAge |
Age | |||||||||||||||||
| onsetPeriod |
Period | |||||||||||||||||
| onsetRange |
Range | |||||||||||||||||
| onsetString |
string | |||||||||||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date
| |||||||||||||||
| reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||
| 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
| |||||||||||||||
| 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.
| |||||||||||||||
| Documentation for this format | ||||||||||||||||||
| 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 | Allergies & Intolerances - IPS | 📦2.0.1 | International Patient Summary Implementation Guide v2.0 |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.1 | International Patient Summary Implementation Guide v2.0 |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| 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 AllergyIntoleranceEuCore
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
0..* | AllergyIntoleranceEuCore | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |||||||||
 clinicalStatus |
0..1 | CodeableConcept | Current allergy or Intolerance status
| |||||||||
| type |
0..1 | code | Type of propensity
| |||||||||
| code |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance
| |||||||||
| patient |
1..1 | Reference(Patient (EU core)) | Who the allergy or intolerance concerns
| |||||||||
| reference |
0..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||
| onset[x] |
0..1 | dateTime, Age, Period, Range, string | Date of onset of the allergy or intolerance
| |||||||||
| Slices for onset[x] |
Content/Rules for all slices | |||||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date
| |||||||||
| reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event
| |||||||||
| severity |
0..1 | code | Reaction severity
| |||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntoleranceEuCore | 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 allergy or intolerance content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||
| 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 | |||||||||||||||
| 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 | string | 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 | |||||||||||||||||
| Slices for value[x] |
Content/Rules for all slices | |||||||||||||||||
| value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||
| identifier |
0..* | Identifier | Business identifier for the allergy or intolerance | |||||||||||||||
| clinicalStatus |
C | 0..1 | CodeableConcept | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||||
| verificationStatus |
C | 0..1 | CodeableConcept | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||||||||
| type |
0..1 | code | Type of propensity 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 |
0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | |||||||||||||||
| code |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| |||||||||||||||
| patient |
1..1 | Reference(Patient (EU core)) | Who the allergy or intolerance concerns
| |||||||||||||||
| 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 | 0..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 | Date of onset of the allergy or intolerance Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||||||||||||
| onsetDateTime |
dateTime | |||||||||||||||||
| onsetAge |
Age | |||||||||||||||||
| onsetPeriod |
Period | |||||||||||||||||
| onsetRange |
Range | |||||||||||||||||
| onsetString |
string | |||||||||||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date
| |||||||||||||||
| recordedDate |
0..1 | dateTime | Date when the allergy or intolerance was recorded | |||||||||||||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the allergy or intolerance | |||||||||||||||
| asserter |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who asserts the allergy or intolerance | |||||||||||||||
| lastOccurrence |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||||||||||||
| note |
0..* | Annotation | Additional text not captured in other fields | |||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||
| author[x] |
0..1 | Individual responsible for the annotation | ||||||||||||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||||||||||||
| authorString |
string | |||||||||||||||||
| time |
0..1 | dateTime | When the annotation was made | |||||||||||||||
| text |
1..1 | markdown | Additional information about the allergy or intolerance | |||||||||||||||
| 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: eHDSI Allergen No Drug (example) | |||||||||||||||
| 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
| |||||||||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||||||||
| onset |
0..1 | dateTime | Reaction onset | |||||||||||||||
| 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 | ||||||||||||||||||
| 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 | Allergies & Intolerances - IPS | 📦2.0.1 | International Patient Summary Implementation Guide v2.0 |
| AllergyIntolerance.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | example |
eHDSI Allergen No Drug
|
⏿0.2.0 | tx.hl7europe.eu |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.1 | 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. |
| 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 AllergyIntoleranceEuCore
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Europe. Package hl7.fhir.eu.eps#1.0.0-ci-build based on FHIR 4.0.1. Generated 2026-10-16
