## Profile Comparison between http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips vs http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips

Left: | Allergy Intolerance (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips)
Right: | AllergyIntolerance (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips)

### Messages

Error | StructureDefinition.version | Values for version differ: '2.0.0-ballot' vs '2.0.0'
Information | StructureDefinition.title | Values for title differ: 'Allergy Intolerance (IPS)' vs 'AllergyIntolerance (IPS)'
Information | StructureDefinition.short | Values for short differ: 'Concept - reference to a terminology or just text' vs 'active | inactive | resolved'
Information | StructureDefinition.definition | Values for definition differ: 'A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.' vs 'The clinical status of the allergy or intolerance.'
Information | StructureDefinition.comment | Values for comment differ: 'Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.' vs 'Refer to [discussion](http://hl7.org/fhir/R4/extensibility.html#Special-Case) if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.'
Warning | AllergyIntolerance.clinicalStatus | Elements differ in definition for mustSupport: 'false' vs 'true'
Information | StructureDefinition.short | Values for short differ: 'Concept - reference to a terminology or just text' vs 'unconfirmed | confirmed | refuted | entered-in-error'
Information | StructureDefinition.definition | Values for definition differ: 'A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.' vs 'Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).'
Information | StructureDefinition.short | Values for short differ: 'Concept - reference to a terminology or just text' vs 'Code that identifies the allergy or intolerance'
Information | StructureDefinition.definition | Values for definition differ: 'A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.' vs 'Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., 'Latex'), an allergy or intolerance condition (e.g., 'Latex allergy'), or a negated/excluded code for a specific substance or class (e.g., 'No latex allergy') or a general or categorical negated statement (e.g., 'No known allergy', 'No known drug allergies'). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.'
Information | StructureDefinition.comment | Values for comment differ: 'Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.' vs 'It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text. When a substance or product code is specified for the 'code' element, the 'default' semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the 'Causative agent' relationship. The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make 'no known allergy' (or 'no risk of adverse reaction') statements regarding any coded substance/product (including cases when a pre-coordinated 'no allergy to x' concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.'
Information | AllergyIntolerance.code | Example/preferred bindings differ at AllergyIntolerance.code using binding from AllergyIntoleranceUvIps
Information | StructureDefinition.short | Values for short differ: 'Concept - reference to a terminology or just text' vs 'Clinical symptoms/signs associated with the Event'
Information | StructureDefinition.definition | Values for definition differ: 'A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.' vs 'Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.'
Information | StructureDefinition.comment | Values for comment differ: 'Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.' vs 'Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.'

### Metadata

Name | Value | Comments
--- | --- | ---
abstract | false |
baseDefinition | http://hl7.org/fhir/StructureDefinition/AllergyIntolerance |
copyright |  |
date | 2024-06-19T10:50:07-05:00 |
description | 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 (conditions) 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 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. | Values Differ
experimental |  |
fhirVersion | 4.0.1 |
jurisdiction |  |
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |
kind | resource |
name | AllergyIntoleranceUvIps |
publisher | HL7 International / Patient Care |
purpose | 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. |
status | active |
title | Allergy Intolerance (IPS) | AllergyIntolerance (IPS) | Values Differ
type | AllergyIntolerance |
url | http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips |
version | 2.0.0-ballot | 2.0.0 | Values Differ

### Structure

Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language |  | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
|  | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements |  | 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 |  | 0..* | Resource | Contained, inline Resources |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External ids for this item | Σ | 0..* | Identifier | External ids for this item |
clinicalStatus |  | 0..1 | ?? | Concept - reference to a terminology or just text Binding: ?? (required): The clinical status of the allergy or intolerance. | ?!SO Σ C | 0..1 | ?? | active | inactive | resolved Binding: ?? (required): The clinical status of the allergy or intolerance.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
| Elements differ in definition for mustSupport: 'false' vs 'true'
verificationStatus |  | 0..1 | ?? | Concept - reference to a terminology or just text Binding: ?? (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ?!Σ C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: ?? (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
type | S Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk. | SO Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
category | Σ | 0..* | code | food | medication | environment | biologic Binding: ?? (required): Category of an identified substance associated with allergies or intolerances. | Σ | 0..* | code | food | medication | environment | biologic Binding: ?? (required): Category of an identified substance associated with allergies or intolerances. |
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: ?? (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | Σ | 0..1 | code | low | high | unable-to-assess Binding: ?? (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
code | S | 1..1 | ?? | Concept - reference to a terminology or just text Binding: ?? (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additional Bindings | Purpose
?? | candidate
| SO Σ | 1..1 | ?? | Code that identifies the allergy or intolerance Binding: ?? (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additional Bindings | Purpose
?? | candidate
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
| Example/preferred bindings differ at AllergyIntolerance.code using binding from AllergyIntoleranceUvIps
patient | S Σ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for | SO Σ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
reference | S Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 0..1 | string | Text alternative for the resource | Σ | 0..1 | string | Text alternative for the resource |
encounter |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted |
onset[x] | S | 0..1 | dateTime S, Age, Period, Range, string | When allergy or intolerance was identified | SO | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
recordedDate |  | 0..1 | dateTime | Date first version of the resource instance was recorded |  | 0..1 | dateTime | Date first version of the resource instance was recorded |
recorder |  | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |  | 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 | Σ | 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 |  | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
note |  | 0..* | Annotation | Additional text not captured in other fields |  | 0..* | Annotation | Additional text not captured in other fields |
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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: ?? (example): Codes defining the type of the substance (including pharmaceutical products). |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: ?? (example): Codes defining the type of the substance (including pharmaceutical products). |
manifestation | S | 1..* | ?? | Concept - reference to a terminology or just text Binding: ?? (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT. | SO | 1..* | ?? | Clinical symptoms/signs associated with the Event Binding: ?? (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
description |  | 0..1 | string | Description of the event as a whole |  | 0..1 | string | Description of the event as a whole |
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed |  | 0..1 | dateTime | Date(/time) when manifestations showed |
severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: ?? (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | SO | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: ?? (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
exposureRoute |  | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: ?? (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |  | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: ?? (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 |  | 0..* | Annotation | Text about event not captured in other fields |
Documentation for this format