| Left: | US Core AllergyIntolerance Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance) |
| Right: | De-Identified UDS Plus AllergyIntolerance (http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-allergyintolerance) |
| Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance' vs 'http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-allergyintolerance' |
| Error | StructureDefinition.version | Values for version differ: '9.0.0-ballot' vs '0.1.0' |
| Information | StructureDefinition.name | Values for name differ: 'USCoreAllergyIntolerance' vs 'UDSPlusAllergyIntolerance' |
| Information | StructureDefinition.title | Values for title differ: 'US Core AllergyIntolerance Profile' vs 'De-Identified UDS Plus AllergyIntolerance' |
| Information | StructureDefinition.date | Values for date differ: '2023-10-17' vs '2026-03-16T10:49:09+00:00' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Cross-Group Projects' vs 'HL7 International / Cross Group Projects' |
| Information | StructureDefinition.short | Values for short differ: 'Allergy or Intolerance (generally: Risk of adverse reaction to a substance)' vs 'De-Identified UDS Plus AllergyIntolerance' |
| Information | StructureDefinition.definition | Values for definition differ: 'Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.' vs 'The UDS+ profile is based on the AllergyIntolerance resource and establishes the core elements, extensions, vocabularies and value sets for representing AllergyIntolerance for UDS+ program.' |
| Information | StructureDefinition.short | Values for short differ: 'Logical id of this artifact' vs 'The de-identified AllergyIntolerance identifier created by the health center to send data to UDS+ Data Receiver' |
| Information | StructureDefinition.definition | Values for definition differ: 'The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.' vs 'De-dentified AllergyIntolerance resource identifier.' |
| Warning | AllergyIntolerance.id | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Information | StructureDefinition.short | Values for short differ: 'Text summary of the resource, for human interpretation' vs 'Cannot include any text in the resource as part of the de-identified data.' |
| Information | AllergyIntolerance.text | Element maximum cardinalities differ: '1' vs '0' |
| Information | StructureDefinition.short | Values for short differ: 'Contained, inline Resources' vs 'Cannot include any contained resources in the resource as part of the de-identified data.' |
| Information | AllergyIntolerance.contained | Element maximum cardinalities differ: '2147483647' vs '0' |
| Warning | AllergyIntolerance.type | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Warning | AllergyIntolerance.category | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Warning | AllergyIntolerance.criticality | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Warning | AllergyIntolerance.onset[x] | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Warning | AllergyIntolerance.recordedDate | Elements differ in definition for mustSupport: 'false' vs 'true' |
| 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: 'false' vs 'true' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/AllergyIntolerance | ||
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
| |
date | 2023-10-17 | 2026-03-16T10:49:09+00:00 |
|
description | 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. | The UDS+ profile is based on the AllergyIntolerance resource and establishes the core elements, extensions, vocabularies and value sets for representing Allergies and Intolerances for UDS+ program. |
|
experimental | false | ||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | USCoreAllergyIntolerance | UDSPlusAllergyIntolerance |
|
publisher | HL7 International / Cross-Group Projects | HL7 International / Cross Group Projects |
|
purpose | |||
status | active | ||
title | US Core AllergyIntolerance Profile | De-Identified UDS Plus AllergyIntolerance |
|
type | AllergyIntolerance | ||
url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance | http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-allergyintolerance |
|
version | 9.0.0-ballot | 0.1.0 |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | C | 0..* | AllergyIntolerance | De-Identified UDS Plus AllergyIntolerance | |||||||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | SΣ | 0..1 | id | The de-identified AllergyIntolerance identifier created by the health center to send data to UDS+ Data Receiver |
| ||||||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() | ?!Σ | 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 | |||||||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
![]() ![]() | 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..0 | Cannot include any text in the resource as part of the de-identified data. This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
| |||||||||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | 0..0 | Cannot include any contained resources in the resource as part of the de-identified data. |
| |||||||||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() | Σ | 0..* | Identifier | External ids for this item | Σ | 0..* | Identifier | External ids for this item | |||||||||
![]() ![]() | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: ?? (required) | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: ?? (required): The clinical status of the allergy or intolerance. | |||||||||
![]() ![]() | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: ?? (required) | ?!SΣ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. | |||||||||
![]() ![]() | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk. | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
| ||||||||
![]() ![]() | Σ | 0..* | code | food | medication | environment | biologic Binding: ?? (required): Category of an identified substance associated with allergies or intolerances. | SΣ | 0..* | code | food | medication | environment | biologic Binding: ?? (required): Category of an identified substance associated with allergies or intolerances. |
| ||||||||
![]() ![]() | Σ | 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. | SΣ | 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. |
| ||||||||
![]() ![]() | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: ?? (extensible) | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: ?? (extensible): The set of codes indicating the allergy or intolerance | |||||||||
![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the sensitivity is for | SΣ | 1..1 | Reference(De-Identified UDS Plus Patient) | Who the sensitivity is for | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
![]() ![]() ![]() | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| ||||||||||||
![]() ![]() ![]() | Σ | 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 | Identifier | Logical reference, when literal reference is not known |
| ||||||||||||
![]() ![]() ![]() | Σ | 0..0 | Text alternative for the resource |
| |||||||||||||
![]() ![]() | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||||||||
![]() ![]() | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified | S | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified |
| |||||||||
![]() ![]() | 0..1 | dateTime | Date first version of the resource instance was recorded | S | 0..1 | dateTime | Date first version of the resource instance was recorded |
| |||||||||
![]() ![]() | 0..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who recorded the sensitivity | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |||||||||||
![]() ![]() | Σ | 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 | |||||||||
![]() ![]() | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||||||||
![]() ![]() | 0..* | Annotation | Additional text not captured in other fields | 0..* | Annotation | Additional text not captured in other fields | |||||||||||
![]() ![]() | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | 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). | |||||||||||
![]() ![]() ![]() | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ?? (extensible) | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ?? (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. | |||||||||
![]() ![]() ![]() | 0..1 | string | Description of the event as a whole | 0..1 | string | Description of the event as a whole | |||||||||||
![]() ![]() ![]() | 0..1 | dateTime | Date(/time) when manifestations showed | 0..1 | dateTime | Date(/time) when manifestations showed | |||||||||||
![]() ![]() ![]() | 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. | 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. |
| |||||||||
![]() ![]() ![]() | 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. | |||||||||||
![]() ![]() ![]() | 0..* | Annotation | Text about event not captured in other fields | 0..* | Annotation | Text about event not captured in other fields | |||||||||||
Documentation for this format | |||||||||||||||||