Left: | IPA-AllergyIntolerance (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance) |
Right: | AllergyIntolerance Profile (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-allergyintolerance) |
Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance' vs 'http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-allergyintolerance' |
Information | StructureDefinition.name | Values for name differ: 'IPAAllergyIntolerance' vs 'AllergyIntoleranceProfile' |
Information | StructureDefinition.title | Values for title differ: 'IPA-AllergyIntolerance' vs 'AllergyIntolerance Profile' |
Information | StructureDefinition.status | Values for status differ: 'active' vs 'draft' |
Information | StructureDefinition.date | Values for date differ: '2022-08-02' vs '2024-11-24' |
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Patient Care' vs 'HL7 Canada - FHIR Implementation Work Group' |
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#CA' |
Information | StructureDefinition.short | Values for short differ: 'Allergy or Intolerance (generally: Risk of adverse reaction to a substance)' vs 'AllergyIntolerance Profile' |
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 AllergyIntolerance Profile is based upon the core FHIR AllergyIntolerance Resource' |
Warning | AllergyIntolerance.clinicalStatus | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | AllergyIntolerance.verificationStatus | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.comment | Values for comment differ: 'This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to [search](http://hl7.org/fhir/R4/search.html) for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.' vs 'Some implementers may utilize value sets where category is readily distinguishable while others may not, and those that do not use those value sets should consider making category MS in their profiles' |
Information | AllergyIntolerance.code | Element minimum cardinalities differ: '1' vs '0' |
Warning | AllergyIntolerance.reaction.manifestation | Elements differ in definition for mustSupport: 'false' vs 'true' |
Information | StructureDefinition.comment | Values for comment differ: 'Coding of the route of exposure with a terminology should be used wherever possible.' vs 'The binding strength of this element is [Preferred](https://www.hl7.org/fhir/terminologies.html#strength), meaning that codes are encouraged to draw from the RouteOfAdministration value set for interoperability purposes but are not required to do so to be considered conformant.' |
Information | AllergyIntolerance.reaction.exposureRoute | Example/preferred bindings differ at AllergyIntolerance.reaction.exposureRoute using binding from AllergyIntoleranceProfile |
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 | 2022-08-02 | 2024-11-24 |
|
description | Minimum expectations for an AllergyIntolerance resource when accessed via a International Patient Access API | Proposed constraints and extensions on the AllergyIntolerance Resource |
|
experimental | false |
| |
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |
| |
jurisdiction[1] | urn:iso:std:iso:3166#CA |
| |
kind | resource | ||
name | IPAAllergyIntolerance | AllergyIntoleranceProfile |
|
publisher | HL7 International / Patient Care | HL7 Canada - FHIR Implementation Work Group |
|
purpose | |||
status | active | draft |
|
title | IPA-AllergyIntolerance | AllergyIntolerance Profile |
|
type | AllergyIntolerance | ||
url | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance | http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-allergyintolerance |
|
version | 1.1.0 |
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) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | C | 0..* | AllergyIntolerance | AllergyIntolerance Profile ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error ca-baseline-allergy: AllergyIntolerance.verificationStatus SHALL be present if AllergyIntolerance.code represents NullFlavor concept ca-baseline-allergy-notasked: if AllergyIntolerance.code is a NullFlavor value, then AllergyIntolerance.clinicalStatus, AllergyIntolerance.type, AllergyIntolerance.category, AllergyIntolerance.criticality SHALL NOT be present ca-baseline-allergy-noallergy: if AllergyIntolerance.code is '716186003' No known allergy, then AllergyIntolerance.verificationStatus SHALL be one of the following: confirmed | refuted | entered-in-error | |||||||||
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.
| 0..1 | code | Language of the resource content Binding: ?? (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 | ?!SOΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: ?? (required): The clinical status of the allergy or intolerance.
| ?!ΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: ?? (required): The clinical status of the allergy or intolerance. |
| ||||||||
verificationStatus | ?!SOΣ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.
| ?!Σ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 | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk. | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk. | |||||||||
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 | CodeableConcept | Code that identifies the allergy or intolerance Binding: ?? (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
| SΣ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: ?? (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
| ||||||||
id | 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 |
| |||||||||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system |
| ||||||||||||
text | Σ | 0..1 | string | Plain text representation of the concept |
| ||||||||||||
patient | SOΣ | 1..1 | Reference(IPA-Patient) | Who the sensitivity is for
| SΣ | 1..1 | Reference(Patient Profile) | Who the sensitivity is for | |||||||||
encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | 0..1 | Reference(Encounter Profile) | 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 Slice: Unordered, Open by type:$this | |||||||||||
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 Profile (General) | PractitionerRole Profile (General) | Patient Profile) | Who recorded the sensitivity | |||||||||||
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | Σ | 0..1 | Reference(Patient Profile | Practitioner Profile (General) | PractitionerRole Profile (General)) | 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 | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | 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). | |||||||||||
id | 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 |
| |||||||||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system |
| ||||||||||||
text | Σ | 0..1 | string | Plain text representation of the concept |
| ||||||||||||
manifestation | 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. | 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. |
| |||||||||
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: ?? (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: ?? (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: ?? (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: ?? (preferred): 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 |