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

Left: | AllergyIntolerance (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips)
Right: | US Core AllergyIntolerance Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance)

### Messages

Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips' vs 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance'
Error | StructureDefinition.version | Values for version differ: '2.0.0' vs '9.0.0'
Information | StructureDefinition.name | Values for name differ: 'AllergyIntoleranceUvIps' vs 'USCoreAllergyIntolerance'
Information | StructureDefinition.title | Values for title differ: 'AllergyIntolerance (IPS)' vs 'US Core AllergyIntolerance Profile'
Information | StructureDefinition.date | Values for date differ: '2024-06-19T10:50:07-05:00' vs '2023-10-17'
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Patient Care' vs 'HL7 International / Cross-Group Projects'
Information | StructureDefinition.jurisdiction | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
Information | StructureDefinition.jurisdiction | Added the item 'urn:iso:std:iso:3166#US'
Information | StructureDefinition.short | Values for short differ: 'Extension' vs 'Additional content defined by implementations'
Information | StructureDefinition.definition | Values for definition differ: 'An Extension' vs 'May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.'
Information | StructureDefinition.comment | Values for comment differ: 'In the scope of the IPS the entered-in-error concept is not allowed.' vs 'The data type is CodeableConcept because verificationStatus 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.verificationStatus | Elements differ in definition for mustSupport: 'false' vs 'true'
Warning | AllergyIntolerance.type | Elements differ in definition for mustSupport: 'true' vs 'false'
Warning | AllergyIntolerance.onset[x] | Elements differ in definition for mustSupport: 'true' vs 'false'
Information | StructureDefinition.short | Values for short differ: 'Who recorded the sensitivity' vs '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who recorded the sensitivity'
Warning | AllergyIntolerance.reaction.severity | Elements differ in definition for mustSupport: 'true' vs 'false'

### Metadata

Name | Value | Comments
--- | --- | ---
abstract | false |
baseDefinition | http://hl7.org/fhir/StructureDefinition/AllergyIntolerance |
copyright |  |
date | 2024-06-19T10:50:07-05:00 | 2023-10-17 | Values Differ
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 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. | The US Core AllergyIntolerance Profile inherits from the FHIR [AllergyIntolerance](https://hl7.org/fhir/R4/allergyintolerance.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the AllergyIntolerance resource to record, search, and fetch allergies/adverse reactions associated with a patient. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. | Values Differ
experimental |  | false | Added the item 'false'
fhirVersion | 4.0.1 |
jurisdiction |  |
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |  | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
jurisdiction[1] |  | urn:iso:std:iso:3166#US | Added the item 'urn:iso:std:iso:3166#US'
kind | resource |
name | AllergyIntoleranceUvIps | USCoreAllergyIntolerance | Values Differ
publisher | HL7 International / Patient Care | HL7 International / Cross-Group Projects | Values Differ
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. |  | Removed the item '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 | AllergyIntolerance (IPS) | US Core AllergyIntolerance Profile | Values Differ
type | AllergyIntolerance |
url | http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips | http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance | Values Differ
version | 2.0.0 | 9.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 | Additional content defined by implementations |
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 | ?!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)
| ?!S Σ C | 0..1 | CodeableConcept | active | inactive | resolved Binding: ?? (required) |
verificationStatus | ?!Σ 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. | ?!S Σ C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: ?? (required) | Elements differ in definition for mustSupport: 'false' vs 'true'
type | 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)
| Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk. | Elements differ in definition for mustSupport: 'true' vs 'false'
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 | 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)
| S Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: ?? (extensible) |
patient | 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)
| S Σ | 1..1 | Reference(US Core Patient Profile) | Who the sensitivity is for |
id |  | 0..1 | string | Unique id for inter-element referencing |  |  |  |  | Removed this element
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |  |  |  |  | Removed this element
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
|  |  |  |  | Removed this element
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). |  |  |  |  | Removed this element
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |  |  |  |  | Removed this element
display | Σ | 0..1 | string | Text alternative for the resource |  |  |  |  | Removed this element
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 |
Slices for onset[x] | 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)
|  | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified | Elements differ in definition for mustSupport: 'true' vs 'false'
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(US Core Practitioner Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | 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)
| S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
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 | 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)
| S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ?? (extensible) |
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 | 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)
|  | 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. | Elements differ in definition for mustSupport: 'true' vs 'false'
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