| Left: | US Core AllergyIntolerance Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance) |
| Right: | US Core AllergyIntolerance Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance) |
| Error | StructureDefinition.version | Values for version differ: '3.1.1' vs '6.0.0-ballot' |
| Information | StructureDefinition.title | Values for title differ: 'US Core AllergyIntolerance Profile' vs 'US Core AllergyIntolerance Profile' |
| Information | StructureDefinition.date | Values for date differ: '2020-06-29' vs '2022-04-20' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 US Realm Steering Committee' vs 'HL7 International - Cross-Group Projects' |
| Warning | AllergyIntolerance | Elements differ in definition: 'The US Core Allergies Profile is based upon the core FHIR AllergyIntolerance Resource and created to meet the 2015 Edition Common Clinical Data Set 'Medical allergies' requirements.' vs '\-' |
| Warning | AllergyIntolerance | Elements differ in comments: 'Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.' vs '\-' |
| 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 | 2020-06-29 | 2022-04-20 |
|
| description | Defines constraints and extensions on the AllergyIntolerance resource for the minimal set of data to query and retrieve allergy information. | To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the AllergyIntolerance resource to record, search, and fetch allergies/adverse reactions associated with a patient pm2. It identifies the mandatory core elements, extensions, vocabularies and value sets which **SHALL** be present in the AllergyIntolerance resource when using this profile. It provides the floor for standards development for specific use cases. |
|
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
 jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | USCoreAllergyIntolerance | ||
| publisher | HL7 US Realm Steering Committee | HL7 International - Cross-Group Projects |
|
| purpose | |||
| status | active | ||
| title | US Core AllergyIntolerance Profile | US Core AllergyIntolerance Profile |
|
| type | AllergyIntolerance | ||
| url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance | ||
| version | 3.1.1 | 6.0.0-ballot |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L 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 | string | 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: CommonLanguages (preferred): A human 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
 extension | 0..* | Extension | Additional content defined by implementations | 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 | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | |||||||||
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) | |||||||||
| type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | Σ | 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. | Σ | 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. | Σ | 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 | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: USCoreAllergySubstance (extensible) | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible) | |||||||||
| patient | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the sensitivity is for | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the sensitivity is for | |||||||||
| 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] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified | |||||||||||
| 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 | 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: SubstanceCode (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: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |||||||||||
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (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 | 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. | 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. | 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 | 0..* | Annotation | Text about event not captured in other fields | |||||||||||
| Documentation for this format | |||||||||||||||||