International Patient Summary Implementation Guide
2.0.0 - STU 2
International Patient Summary Implementation Guide
2.0.0 - STU 2
This page is part of the International Patient Summary Implementation Guide (v2.0.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: AllergyIntoleranceUvIps | ||
This profile represents the constraints applied to the AllergyIntolerance resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an allergy or intolerance is represented in the patient summary as an instance of an AllergyIntolerance resource constrained by this profile.
It documents the relevant allergies or intolerances for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.
This profile constrains the representation of a record of an allergy or intolerance of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.
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..* | AllergyIntolerance | 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 |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
   extension:abatement |
0..1 | dateTime, Age, Period, Range, string | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
 clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||
| verificationStatus |
?!Σ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 |
SOΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| ||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | 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 |
SOΣ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
| ||||||||||||
 reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
 Slices for onset[x] |
SO | 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 |
SO | 0..1 | dateTime | When allergy or intolerance was identified
| ||||||||||||
 reaction |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
| ||||||||||||
| severity |
SO | 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 | ||||||||||||||||
| 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.0 | This IG |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG |
| 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 AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:abatement |
0..1 | dateTime, Age, Period, Range, string | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||||||||
| clinicalStatus |
SO | 0..1 | CodeableConceptIPS | active | inactive | resolved
| ||||||||||||
 verificationStatus |
0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error | |||||||||||||
| type |
SO | 0..1 | code | allergy | intolerance - Underlying mechanism (if known)
| ||||||||||||
| code |
SO | 1..1 | CodeableConceptIPS | 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 |
SO | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
| ||||||||||||
| reference |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
| Slices for onset[x] |
SO | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this
| ||||||||||||
| onset[x]:onsetDateTime |
SO | 0..1 | dateTime | When allergy or intolerance was identified
| ||||||||||||
| reaction |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
| ||||||||||||
| severity |
SO | 0..1 | code | mild | moderate | severe (of event as a whole)
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.code | Base | preferred | Allergies & Intolerances - IPS | 📦2.0.0 | This IG |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 | ||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| 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 | dateTime, Age, Period, Range, string | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||
| verificationStatus |
?!Σ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 |
SOΣ | 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 |
Σ | 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 |
SOΣ | 1..1 | CodeableConceptIPS | 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 |
SOΣ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
| ||||||||||||
| 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 |
SOΣ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] |
SO | 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 |
SO | 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(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 |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| substance |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
| ||||||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||||||
| severity |
SO | 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 | ||||||||||||||||
| 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.0 | This IG |
| AllergyIntolerance.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | example | Substance Code | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG |
| 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 AllergyIntolerance
Summary
Mandatory: 2 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntolerance | 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 |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:abatement |
0..1 | dateTime, Age, Period, Range, string | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||
| verificationStatus |
?!Σ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 |
SOΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| ||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | 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 |
SOΣ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
| ||||||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
| Slices for onset[x] |
SO | 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 |
SO | 0..1 | dateTime | When allergy or intolerance was identified
| ||||||||||||
| reaction |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
| ||||||||||||
| severity |
SO | 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 | ||||||||||||||||
| 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.0 | This IG |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG |
| 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 AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:abatement |
0..1 | dateTime, Age, Period, Range, string | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||||||||
| clinicalStatus |
SO | 0..1 | CodeableConceptIPS | active | inactive | resolved
| ||||||||||||
| verificationStatus |
0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error | |||||||||||||
| type |
SO | 0..1 | code | allergy | intolerance - Underlying mechanism (if known)
| ||||||||||||
| code |
SO | 1..1 | CodeableConceptIPS | 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 |
SO | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
| ||||||||||||
| reference |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
| Slices for onset[x] |
SO | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this
| ||||||||||||
| onset[x]:onsetDateTime |
SO | 0..1 | dateTime | When allergy or intolerance was identified
| ||||||||||||
| reaction |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
| ||||||||||||
| severity |
SO | 0..1 | code | mild | moderate | severe (of event as a whole)
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.code | Base | preferred | Allergies & Intolerances - IPS | 📦2.0.0 | This IG |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 | ||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| 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 | dateTime, Age, Period, Range, string | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||
| verificationStatus |
?!Σ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 |
SOΣ | 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 |
Σ | 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 |
SOΣ | 1..1 | CodeableConceptIPS | 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 |
SOΣ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
| ||||||||||||
| 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 |
SOΣ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] |
SO | 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 |
SO | 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(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 |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| substance |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
| ||||||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||||||
| severity |
SO | 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 | ||||||||||||||||
| 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.0 | This IG |
| AllergyIntolerance.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | example | Substance Code | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG |
| 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 AllergyIntolerance
Summary
Mandatory: 2 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1. Generated 2025-10-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change