Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
| Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance | Version: 2.5.0 | |||
| Active as of 2023-12-12 | Computable Name: UKCoreAllergyIntolerance | |||
Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
||||
This profile defines the UK constraints and extensions on the International FHIR resource AllergyIntolerance.
This profile allows a record of a clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance.
Where a propensity is identified, to record information or evidence about a reaction event that is characterised by any harmful or undesirable physiological response that is specific to the individual and triggered by exposure of an individual to the identified substance or class of substance.
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.
This resource is used to record physical conditions. It SHALL NOT be used to record preferences for or against types of treatment, for example on religious grounds. For such use cases consider the use of the FHIR Consent resource.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   evidence |
0..* | Reference(DiagnosticReport) | A reference to a DiagnosticReport resource for investigations that confirm the certainty of the allergy or intolerance diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence | |
 clinicalStatus |
S | 0..1 | CodeableConcept | Defines whether the allergy or intolerance is active, inactive or resolved. |
  Slices for extension |
Content/Rules for all slices | |||
 allergyIntoleranceEnd |
0..1 | (Complex) | The date when the allergy or intolerance clinicalStatus is updated to inactive or resolved. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd | |
 verificationStatus |
S | 0..1 | CodeableConcept | Defines the assertion of the allergy or intolerance. |
| code |
S | 1..1 | CodeableConcept | This code identifies the allergy or intolerance. Binding: UK Core Allergy Code (preferred) |
| patient |
S | 1..1 | Reference(Patient) | Links the allergy or intolerance to the patient. |
| reaction |
S | 0..* | BackboneElement | Details about each adverse reaction event. |
| substance |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: UK Core Allergy Substance (preferred) | |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred) | |
| severity |
S | 0..1 | code | A clinical assessment of the severity of the reaction event as a whole. |
 exposureRoute |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: UK Core Substance Or Product Administration Route (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCodefrom this IG | |
| AllergyIntolerance.reaction.substance | preferred | UKCoreAllergySubstancehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstancefrom this IG | |
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestationfrom this IG | |
| AllergyIntolerance.reaction.exposureRoute | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoutefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| evidence |
0..* | Reference(DiagnosticReport) | A reference to a DiagnosticReport resource for investigations that confirm the certainty of the allergy or intolerance diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | Defines whether the allergy or intolerance is active, inactive or resolved. Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| Slices for extension |
Content/Rules for all slices | |||
| allergyIntoleranceEnd |
0..1 | (Complex) | The date when the allergy or intolerance clinicalStatus is updated to inactive or resolved. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd | |
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | Defines the assertion of the allergy or intolerance. Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| code |
SΣ | 1..1 | CodeableConcept | This code identifies the allergy or intolerance. Binding: UK Core Allergy Code (preferred) |
 patient |
SΣ | 1..1 | Reference(Patient) | Links the allergy or intolerance to the patient. |
| reaction |
S | 0..* | BackboneElement | Details about each adverse reaction event. |
| modifierExtension |
?!Σ | 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: UK Core Allergy Substance (preferred) | |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred) | |
| severity |
S | 0..1 | code | A clinical assessment of the severity of the reaction 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: UK Core Substance Or Product Administration Route (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | |
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCodefrom this IG | |
| AllergyIntolerance.reaction.substance | preferred | UKCoreAllergySubstancehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstancefrom this IG | |
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestationfrom this IG | |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | |
| AllergyIntolerance.reaction.exposureRoute | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoutefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| evidence |
0..* | Reference(DiagnosticReport) | A reference to a DiagnosticReport resource for investigations that confirm the certainty of the allergy or intolerance diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | Defines whether the allergy or intolerance is active, inactive or resolved. Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
| 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 | |||||
| allergyIntoleranceEnd |
0..1 | (Complex) | The date when the allergy or intolerance clinicalStatus is updated to inactive or resolved. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | Defines the assertion of the allergy or intolerance. Binding: AllergyIntoleranceVerificationStatusCodes (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: 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. | ||||
| 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. | ||||
| code |
SΣ | 1..1 | CodeableConcept | This code identifies the allergy or intolerance. Binding: UK Core Allergy Code (preferred) | ||||
| patient |
SΣ | 1..1 | Reference(Patient) | Links the allergy or intolerance to the patient. | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||
 onset[x] |
0..1 | When allergy or intolerance was identified | ||||||
| onsetDateTime |
dateTime | |||||||
| onsetAge |
Age | |||||||
| onsetPeriod |
Period | |||||||
| onsetRange |
Range | |||||||
| onsetString |
string | |||||||
| recordedDate |
0..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder |
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 | ||||
| lastOccurrence |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
| note |
0..* | Annotation | Additional text not captured in other fields | |||||
| reaction |
S | 0..* | BackboneElement | Details about each adverse reaction event. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 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: UK Core Allergy Substance (preferred) | |||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred) | |||||
| description |
0..1 | string | Description of the event as a whole | |||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||
| severity |
S | 0..1 | code | A clinical assessment of the severity of the reaction 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: UK Core Substance Or Product Administration Route (preferred) | |||||
| note |
0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCodefrom this IG | ||||
| AllergyIntolerance.reaction.substance | preferred | UKCoreAllergySubstancehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstancefrom this IG | ||||
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestationfrom this IG | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.reaction.exposureRoute | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoutefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from AllergyIntolerance
Differential View
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| evidence |
0..* | Reference(DiagnosticReport) | A reference to a DiagnosticReport resource for investigations that confirm the certainty of the allergy or intolerance diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence | |
| clinicalStatus |
S | 0..1 | CodeableConcept | Defines whether the allergy or intolerance is active, inactive or resolved. |
| Slices for extension |
Content/Rules for all slices | |||
| allergyIntoleranceEnd |
0..1 | (Complex) | The date when the allergy or intolerance clinicalStatus is updated to inactive or resolved. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd | |
| verificationStatus |
S | 0..1 | CodeableConcept | Defines the assertion of the allergy or intolerance. |
| code |
S | 1..1 | CodeableConcept | This code identifies the allergy or intolerance. Binding: UK Core Allergy Code (preferred) |
| patient |
S | 1..1 | Reference(Patient) | Links the allergy or intolerance to the patient. |
| reaction |
S | 0..* | BackboneElement | Details about each adverse reaction event. |
| substance |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: UK Core Allergy Substance (preferred) | |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred) | |
| severity |
S | 0..1 | code | A clinical assessment of the severity of the reaction event as a whole. |
| exposureRoute |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: UK Core Substance Or Product Administration Route (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCodefrom this IG | |
| AllergyIntolerance.reaction.substance | preferred | UKCoreAllergySubstancehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstancefrom this IG | |
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestationfrom this IG | |
| AllergyIntolerance.reaction.exposureRoute | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoutefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| evidence |
0..* | Reference(DiagnosticReport) | A reference to a DiagnosticReport resource for investigations that confirm the certainty of the allergy or intolerance diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | Defines whether the allergy or intolerance is active, inactive or resolved. Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| Slices for extension |
Content/Rules for all slices | |||
| allergyIntoleranceEnd |
0..1 | (Complex) | The date when the allergy or intolerance clinicalStatus is updated to inactive or resolved. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd | |
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | Defines the assertion of the allergy or intolerance. Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| code |
SΣ | 1..1 | CodeableConcept | This code identifies the allergy or intolerance. Binding: UK Core Allergy Code (preferred) |
| patient |
SΣ | 1..1 | Reference(Patient) | Links the allergy or intolerance to the patient. |
| reaction |
S | 0..* | BackboneElement | Details about each adverse reaction event. |
| modifierExtension |
?!Σ | 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: UK Core Allergy Substance (preferred) | |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred) | |
| severity |
S | 0..1 | code | A clinical assessment of the severity of the reaction 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: UK Core Substance Or Product Administration Route (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | |
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCodefrom this IG | |
| AllergyIntolerance.reaction.substance | preferred | UKCoreAllergySubstancehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstancefrom this IG | |
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestationfrom this IG | |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | |
| AllergyIntolerance.reaction.exposureRoute | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoutefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| evidence |
0..* | Reference(DiagnosticReport) | A reference to a DiagnosticReport resource for investigations that confirm the certainty of the allergy or intolerance diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | Defines whether the allergy or intolerance is active, inactive or resolved. Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
| 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 | |||||
| allergyIntoleranceEnd |
0..1 | (Complex) | The date when the allergy or intolerance clinicalStatus is updated to inactive or resolved. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | Defines the assertion of the allergy or intolerance. Binding: AllergyIntoleranceVerificationStatusCodes (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: 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. | ||||
| 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. | ||||
| code |
SΣ | 1..1 | CodeableConcept | This code identifies the allergy or intolerance. Binding: UK Core Allergy Code (preferred) | ||||
| patient |
SΣ | 1..1 | Reference(Patient) | Links the allergy or intolerance to the patient. | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||
| onset[x] |
0..1 | When allergy or intolerance was identified | ||||||
| onsetDateTime |
dateTime | |||||||
| onsetAge |
Age | |||||||
| onsetPeriod |
Period | |||||||
| onsetRange |
Range | |||||||
| onsetString |
string | |||||||
| recordedDate |
0..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder |
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 | ||||
| lastOccurrence |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
| note |
0..* | Annotation | Additional text not captured in other fields | |||||
| reaction |
S | 0..* | BackboneElement | Details about each adverse reaction event. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 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: UK Core Allergy Substance (preferred) | |||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred) | |||||
| description |
0..1 | string | Description of the event as a whole | |||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||
| severity |
S | 0..1 | code | A clinical assessment of the severity of the reaction 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: UK Core Substance Or Product Administration Route (preferred) | |||||
| note |
0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCodefrom this IG | ||||
| AllergyIntolerance.reaction.substance | preferred | UKCoreAllergySubstancehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstancefrom this IG | ||||
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestationfrom this IG | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.reaction.exposureRoute | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoutefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from AllergyIntolerance
Other representations of profile: CSV, Excel, Schematron