Canonical_URL | Current_Version | Last_Updated | Description |
---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance | 2.5.0 | 2023-12-12 | This profile defines the UK constraints and extensions on the International FHIR resource AllergyIntolerance. |
Profile_Purpose |
---|
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. |
AllergyIntolerance | I | AllergyIntolerance | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
evidence | I | 0..* | Extension(Reference(DiagnosticReport)) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
clinicalStatus | S Σ ?! I | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
allergyIntoleranceEnd | I | 0..1 | Extension(Complex) |
coding | Σ | 0..* | Coding |
text | Σ | 0..1 | string |
verificationStatus | S Σ ?! I | 0..1 | CodeableConceptBinding |
type | Σ | 0..1 | codeBinding |
category | Σ | 0..* | codeBinding |
criticality | Σ | 0..1 | codeBinding |
code | S Σ | 1..1 | CodeableConceptBinding |
patient | S Σ I | 1..1 | Reference(Patient) |
encounter | I | 0..1 | Reference(Encounter) |
onset[x] | 0..1 | ||
onsetDateTime | dateTime | ||
onsetAge | Age | ||
onsetPeriod | Period | ||
onsetRange | Range | ||
onsetString | string | ||
recordedDate | 0..1 | dateTime | |
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) |
asserter | Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
lastOccurrence | 0..1 | dateTime | |
note | 0..* | Annotation | |
reaction | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
substance | 0..1 | CodeableConceptBinding | |
manifestation | 1..* | CodeableConceptBinding | |
description | 0..1 | string | |
onset | 0..1 | dateTime | |
severity | S | 0..1 | codeBinding |
exposureRoute | 0..1 | CodeableConceptBinding | |
note | 0..* | Annotation |
AllergyIntolerance | I | AllergyIntolerance | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
evidence | I | 0..* | Extension(Reference(DiagnosticReport)) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
clinicalStatus | S Σ ?! I | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
allergyIntoleranceEnd | I | 0..1 | Extension(Complex) |
coding | Σ | 0..* | Coding |
text | Σ | 0..1 | string |
verificationStatus | S Σ ?! I | 0..1 | CodeableConceptBinding |
type | Σ | 0..1 | codeBinding |
category | Σ | 0..* | codeBinding |
criticality | Σ | 0..1 | codeBinding |
code | S Σ | 1..1 | CodeableConceptBinding |
patient | S Σ I | 1..1 | Reference(Patient) |
encounter | I | 0..1 | Reference(Encounter) |
onset[x] | 0..1 | ||
onsetDateTime | dateTime | ||
onsetAge | Age | ||
onsetPeriod | Period | ||
onsetRange | Range | ||
onsetString | string | ||
recordedDate | 0..1 | dateTime | |
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) |
asserter | Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
lastOccurrence | 0..1 | dateTime | |
note | 0..* | Annotation | |
reaction | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
substance | 0..1 | CodeableConceptBinding | |
manifestation | 1..* | CodeableConceptBinding | |
description | 0..1 | string | |
onset | 0..1 | dateTime | |
severity | S | 0..1 | codeBinding |
exposureRoute | 0..1 | CodeableConceptBinding | |
note | 0..* | Annotation |
AllergyIntolerance | I | AllergyIntolerance | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
evidence | I | 0..* | Extension(Reference(DiagnosticReport)) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
clinicalStatus | S Σ ?! I | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
allergyIntoleranceEnd | I | 0..1 | Extension(Complex) |
coding | Σ | 0..* | Coding |
text | Σ | 0..1 | string |
verificationStatus | S Σ ?! I | 0..1 | CodeableConceptBinding |
type | Σ | 0..1 | codeBinding |
category | Σ | 0..* | codeBinding |
criticality | Σ | 0..1 | codeBinding |
code | S Σ | 1..1 | CodeableConceptBinding |
patient | S Σ I | 1..1 | Reference(Patient) |
encounter | I | 0..1 | Reference(Encounter) |
onset[x] | 0..1 | ||
onsetDateTime | dateTime | ||
onsetAge | Age | ||
onsetPeriod | Period | ||
onsetRange | Range | ||
onsetString | string | ||
recordedDate | 0..1 | dateTime | |
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) |
asserter | Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
lastOccurrence | 0..1 | dateTime | |
note | 0..* | Annotation | |
reaction | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
substance | 0..1 | CodeableConceptBinding | |
manifestation | 1..* | CodeableConceptBinding | |
description | 0..1 | string | |
onset | 0..1 | dateTime | |
severity | S | 0..1 | codeBinding |
exposureRoute | 0..1 | CodeableConceptBinding | |
note | 0..* | Annotation |
AllergyIntolerance | 0..* | |
AllergyIntolerance.id | string | 0..1 |
AllergyIntolerance.meta | Meta | 0..1 |
AllergyIntolerance.implicitRules | uri | 0..1 |
AllergyIntolerance.language | code | 0..1 |
AllergyIntolerance.text | Narrative | 0..1 |
AllergyIntolerance.contained | Resource | 0..* |
AllergyIntolerance.extension | Extension | 0..* |
AllergyIntolerance.extension | Extension | 0..* |
AllergyIntolerance.modifierExtension | Extension | 0..* |
AllergyIntolerance.identifier | Identifier | 0..* |
AllergyIntolerance.clinicalStatus | CodeableConcept | 0..1 |
AllergyIntolerance.clinicalStatus.id | string | 0..1 |
AllergyIntolerance.clinicalStatus.extension | Extension | 0..* |
AllergyIntolerance.clinicalStatus.extension | Extension | 0..1 |
AllergyIntolerance.clinicalStatus.coding | Coding | 0..* |
AllergyIntolerance.clinicalStatus.text | string | 0..1 |
AllergyIntolerance.verificationStatus | CodeableConcept | 0..1 |
AllergyIntolerance.type | code | 0..1 |
AllergyIntolerance.category | code | 0..* |
AllergyIntolerance.criticality | code | 0..1 |
AllergyIntolerance.code | CodeableConcept | 1..1 |
AllergyIntolerance.patient | Reference(Patient) | 1..1 |
AllergyIntolerance.encounter | Reference(Encounter) | 0..1 |
AllergyIntolerance.onset[x] | dateTime, Age, Period, Range, string | 0..1 |
AllergyIntolerance.recordedDate | dateTime | 0..1 |
AllergyIntolerance.recorder | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | 0..1 |
AllergyIntolerance.asserter | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | 0..1 |
AllergyIntolerance.lastOccurrence | dateTime | 0..1 |
AllergyIntolerance.note | Annotation | 0..* |
AllergyIntolerance.reaction | BackboneElement | 0..* |
AllergyIntolerance.reaction.id | string | 0..1 |
AllergyIntolerance.reaction.extension | Extension | 0..* |
AllergyIntolerance.reaction.modifierExtension | Extension | 0..* |
AllergyIntolerance.reaction.substance | CodeableConcept | 0..1 |
AllergyIntolerance.reaction.manifestation | CodeableConcept | 1..* |
AllergyIntolerance.reaction.description | string | 0..1 |
AllergyIntolerance.reaction.onset | dateTime | 0..1 |
AllergyIntolerance.reaction.severity | code | 0..1 |
AllergyIntolerance.reaction.exposureRoute | CodeableConcept | 0..1 |
AllergyIntolerance.reaction.note | Annotation | 0..* |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-AllergyIntolerance" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" /> <version value="2.5.0" /> <name value="UKCoreAllergyIntolerance" /> <title value="UK Core AllergyIntolerance" /> <status value="active" /> <date value="2023-12-12" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [AllergyIntolerance](https://hl7.org/fhir/R4/AllergyIntolerance.html)." /> <purpose value="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. \n\nWhere 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. \n\nSubstances 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. \n\nThis 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](https://hl7.org/fhir/R4/consent.html) resource." /> <copyright value="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." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="AllergyIntolerance" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" /> <derivation value="constraint" /> <snapshot> <element id="AllergyIntolerance"> <path value="AllergyIntolerance" /> <short value="Allergy or Intolerance (generally: Risk of adverse reaction to a substance)" /> <definition value="Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance." /> <comment value="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." /> <alias value="Allergy" /> <alias value="Intolerance" /> <alias value="Adverse Reaction" /> <min value="0" /> <max value="*" /> <base> <path value="AllergyIntolerance" /> <min value="0" /> <max value="*" /> </base> <constraint> <key value="dom-2" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" /> <expression value="contained.contained.empty()" /> <xpath value="not(parent::f:contained and f:contained)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-4" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" /> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-3" /> <severity value="error" /> <human value="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" /> <expression value="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()" /> <xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"> <valueBoolean value="true" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation"> <valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." /> </extension> <key value="dom-6" /> <severity value="warning" /> <human value="A resource should have narrative for robust management" /> <expression value="text.`div`.exists()" /> <xpath value="exists(f:text/h:div)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-5" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a security label" /> <expression value="contained.meta.security.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:security))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="ait-1" /> <severity value="error" /> <human value="AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error." /> <expression value="verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()" /> <xpath value="f:verificationStatus/f:coding/f:code/@value='entered-in-error' or exists(f:clinicalStatus)" /> <source value="http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" /> </constraint> <constraint> <key value="ait-2" /> <severity value="error" /> <human value="AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error" /> <expression value="verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()" /> <xpath value="not(f:verificationStatus/f:coding/f:code/@value='entered-in-error') or not(exists(f:clinicalStatus))" /> <source value="http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" /> </constraint> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="Observation[classCode=OBS, moodCode=EVN]" /> </mapping> </element> <element id="AllergyIntolerance.id"> <path value="AllergyIntolerance.id" /> <short value="Logical id of this artifact" /> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isSummary value="true" /> </element> <element id="AllergyIntolerance.meta"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.meta" /> <short value="Metadata about the resource" /> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.meta" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Meta" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="AllergyIntolerance.implicitRules"> <path value="AllergyIntolerance.implicitRules" /> <short value="A set of rules under which this content was created" /> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." /> <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.implicitRules" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="AllergyIntolerance.language"> <path value="AllergyIntolerance.language" /> <short value="Language of the resource content" /> <definition value="The base language in which the resource is written." /> <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.language" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="preferred" /> <description value="A human language." /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="AllergyIntolerance.text"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.text" /> <short value="Text summary of the resource, for human interpretation" /> <definition value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." /> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later." /> <alias value="narrative" /> <alias value="html" /> <alias value="xhtml" /> <alias value="display" /> <min value="0" /> <max value="1" /> <base> <path value="DomainResource.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Narrative" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act.text?" /> </mapping> </element> <element id="AllergyIntolerance.contained"> <path value="AllergyIntolerance.contained" /> <short value="Contained, inline Resources" /> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." /> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels." /> <alias value="inline resources" /> <alias value="anonymous resources" /> <alias value="contained resources" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.contained" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Resource" /> </type> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="AllergyIntolerance.extension"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="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." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="AllergyIntolerance.extension:evidence"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.extension" /> <sliceName value="evidence" /> <short value="A reference to results of investigations that confirmed the certainty of the diagnosis." /> <definition value="A reference to results of investigations that confirmed the certainty of the diagnosis." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="AllergyIntolerance.modifierExtension"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.modifierExtension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Extensions that cannot be ignored" /> <definition value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="AllergyIntolerance.identifier"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.identifier" /> <short value="External ids for this item" /> <definition value="Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server." /> <comment value="This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number." /> <requirements value="Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers." /> <min value="0" /> <max value="*" /> <base> <path value="AllergyIntolerance.identifier" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CX / EI (occasionally, more often EI maps to a resource id or a URL)" /> </mapping> <mapping> <identity value="rim" /> <map value="II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" /> </mapping> <mapping> <identity value="servd" /> <map value="Identifier" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.identifier" /> </mapping> <mapping> <identity value="v2" /> <map value="IAM-7" /> </mapping> <mapping> <identity value="rim" /> <map value="id" /> </mapping> </element> <element id="AllergyIntolerance.clinicalStatus"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.clinicalStatus" /> <short value="active | inactive | resolved" /> <definition value="The clinical status of the allergy or intolerance." /> <comment value="Refer to [discussion](extensibility.html#Special-Case) if clincalStatus is missing data.\nThe data type is CodeableConcept because clinicalStatus 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." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.clinicalStatus" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <condition value="ait-1" /> <condition value="ait-2" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="true" /> <isModifierReason value="This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active." /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AllergyIntoleranceClinicalStatus" /> </extension> <strength value="required" /> <description value="The clinical status of the allergy or intolerance." /> <valueSet value="http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.status" /> </mapping> <mapping> <identity value="rim" /> <map value="Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value" /> </mapping> </element> <element id="AllergyIntolerance.clinicalStatus.id"> <path value="AllergyIntolerance.clinicalStatus.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="AllergyIntolerance.clinicalStatus.extension"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.clinicalStatus.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="AllergyIntolerance.clinicalStatus.extension:allergyIntoleranceEnd"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.clinicalStatus.extension" /> <sliceName value="allergyIntoleranceEnd" /> <short value="Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid." /> <definition value="Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="1" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="AllergyIntolerance.clinicalStatus.coding"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.clinicalStatus.coding" /> <short value="Code defined by a terminology system" /> <definition value="A reference to a code defined by a terminology system." /> <comment value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true." /> <requirements value="Allows for alternative encodings within a code system, and translations to other code systems." /> <min value="0" /> <max value="*" /> <base> <path value="CodeableConcept.coding" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Coding" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" /> </mapping> <mapping> <identity value="rim" /> <map value="CV" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding rdfs:subClassOf dt:CDCoding" /> </mapping> <mapping> <identity value="v2" /> <map value="C*E.1-8, C*E.10-22" /> </mapping> <mapping> <identity value="rim" /> <map value="union(., ./translation)" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" /> </mapping> </element> <element id="AllergyIntolerance.clinicalStatus.text"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true" /> </extension> <path value="AllergyIntolerance.clinicalStatus.text" /> <short value="Plain text representation of the concept" /> <definition value="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user." /> <comment value="Very often the text is the same as a displayName of one of the codings." /> <requirements value="The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source." /> <min value="0" /> <max value="1" /> <base> <path value="CodeableConcept.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="C*E.9. But note many systems use C*E.2 for this" /> </mapping> <mapping> <identity value="rim" /> <map value="./originalText[mediaType/code="text/plain"]/data" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" /> </mapping> </element> <element id="AllergyIntolerance.verificationStatus"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.verificationStatus" /> <short value="unconfirmed | confirmed | refuted | entered-in-error" /> <definition value="Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product)." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.verificationStatus" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <condition value="ait-1" /> <condition value="ait-2" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="true" /> <isModifierReason value="This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid." /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AllergyIntoleranceVerificationStatus" /> </extension> <strength value="required" /> <description value="Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance." /> <valueSet value="http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.status" /> </mapping> <mapping> <identity value="rim" /> <map value="Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value" /> </mapping> </element> <element id="AllergyIntolerance.type"> <path value="AllergyIntolerance.type" /> <short value="allergy | intolerance - Underlying mechanism (if known)" /> <definition value="Identification of the underlying physiological mechanism for the reaction risk." /> <comment value="Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource." /> <alias value="Category" /> <alias value="Class" /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.type" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AllergyIntoleranceType" /> </extension> <strength value="required" /> <description value="Identification of the underlying physiological mechanism for a Reaction Risk." /> <valueSet value="http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.class" /> </mapping> <mapping> <identity value="v2" /> <map value="IAM-9" /> </mapping> <mapping> <identity value="rim" /> <map value="code" /> </mapping> </element> <element id="AllergyIntolerance.category"> <path value="AllergyIntolerance.category" /> <short value="food | medication | environment | biologic" /> <definition value="Category of the identified substance." /> <comment value="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](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." /> <alias value="Category" /> <alias value="Type" /> <alias value="Reaction Type" /> <alias value="Class" /> <min value="0" /> <max value="*" /> <base> <path value="AllergyIntolerance.category" /> <min value="0" /> <max value="*" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AllergyIntoleranceCategory" /> </extension> <strength value="required" /> <description value="Category of an identified substance associated with allergies or intolerances." /> <valueSet value="http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.class" /> </mapping> <mapping> <identity value="v2" /> <map value="AL1-2" /> </mapping> <mapping> <identity value="rim" /> <map value="value < IntoleranceValue (Agent)" /> </mapping> </element> <element id="AllergyIntolerance.criticality"> <path value="AllergyIntolerance.criticality" /> <short value="low | high | unable-to-assess" /> <definition value="Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance." /> <comment value="The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent." /> <alias value="Severity" /> <alias value="Seriousness" /> <alias value="Contra-indication" /> <alias value="Risk" /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.criticality" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AllergyIntoleranceCriticality" /> </extension> <strength value="required" /> <description value="Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance." /> <valueSet value="http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.grade" /> </mapping> <mapping> <identity value="v2" /> <map value="AL1-4" /> </mapping> <mapping> <identity value="rim" /> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" /> </mapping> </element> <element id="AllergyIntolerance.code"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.code" /> <short value="Code that identifies the allergy or intolerance" /> <definition value="Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance." /> <comment value="It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.\n\nWhen a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship.\n\nThe 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted." /> <alias value="Code" /> <min value="1" /> <max value="1" /> <base> <path value="AllergyIntolerance.code" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AllergyIntoleranceCode" /> </extension> <strength value="preferred" /> <description value="Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.what[x]" /> </mapping> <mapping> <identity value="v2" /> <map value="AL1-3 / IAM-3" /> </mapping> <mapping> <identity value="rim" /> <map value="substance/product:\n\n.participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\n\nnegated/excluded substance/product:\n\n.participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\n\npositive or negated/excluded condition/situation:\n\nObservation.code=ASSERTION; Observation.value" /> </mapping> </element> <element id="AllergyIntolerance.patient"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.patient" /> <short value="Who the sensitivity is for" /> <definition value="The patient who has the allergy or intolerance." /> <comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." /> <alias value="Patient" /> <min value="1" /> <max value="1" /> <base> <path value="AllergyIntolerance.patient" /> <min value="1" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Reference" /> </constraint> <mustSupport value="true" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.subject[x]" /> </mapping> <mapping> <identity value="v2" /> <map value="(PID-3)" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=SBJ].role[classCode=PAT]" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.subject" /> </mapping> </element> <element id="AllergyIntolerance.encounter"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.encounter" /> <short value="Encounter when the allergy or intolerance was asserted" /> <definition value="The encounter when the allergy or intolerance was asserted." /> <comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.encounter" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Reference" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.context" /> </mapping> <mapping> <identity value="rim" /> <map value=".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" /> </mapping> </element> <element id="AllergyIntolerance.onset[x]"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.onset[x]" /> <short value="When allergy or intolerance was identified" /> <definition value="Estimated or actual date, date-time, or age when allergy or intolerance was identified." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.onset[x]" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <type> <code value="Age" /> </type> <type> <code value="Period" /> </type> <type> <code value="Range" /> </type> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.init" /> </mapping> <mapping> <identity value="rim" /> <map value="effectiveTime.low" /> </mapping> </element> <element id="AllergyIntolerance.recordedDate"> <path value="AllergyIntolerance.recordedDate" /> <short value="Date first version of the resource instance was recorded" /> <definition value="The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.recordedDate" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.recorded" /> </mapping> <mapping> <identity value="v2" /> <map value="IAM-13" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=AUT].time" /> </mapping> </element> <element id="AllergyIntolerance.recorder"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.recorder" /> <short value="Who recorded the sensitivity" /> <definition value="Individual who recorded the record and takes responsibility for its content." /> <comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." /> <alias value="Author" /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.recorder" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Reference" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.author" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=AUT].role" /> </mapping> </element> <element id="AllergyIntolerance.asserter"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.asserter" /> <short value="Source of the information about the allergy" /> <definition value="The source of the information about the allergy that is recorded." /> <comment value="The recorder takes responsibility for the content, but can reference the source from where they got it." /> <alias value="Source" /> <alias value="Informant" /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.asserter" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Reference" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.source" /> </mapping> <mapping> <identity value="v2" /> <map value="IAM-14 (if patient) / IAM-18 (if practitioner)" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=INF].role" /> </mapping> </element> <element id="AllergyIntolerance.lastOccurrence"> <path value="AllergyIntolerance.lastOccurrence" /> <short value="Date(/time) of last known occurrence of a reaction" /> <definition value="Represents the date and/or time of the last known occurrence of a reaction event." /> <comment value="This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.lastOccurrence" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime" /> </mapping> </element> <element id="AllergyIntolerance.note"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.note" /> <short value="Additional text not captured in other fields" /> <definition value="Additional narrative about the propensity for the Adverse Reaction, not captured in other fields." /> <comment value="For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes." /> <min value="0" /> <max value="*" /> <base> <path value="AllergyIntolerance.note" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Annotation" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act" /> </mapping> <mapping> <identity value="rim" /> <map value="subjectOf.observationEvent[code="annotation"].value" /> </mapping> </element> <element id="AllergyIntolerance.reaction"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.reaction" /> <short value="Adverse Reaction Events linked to exposure to substance" /> <definition value="Details about each adverse reaction event linked to exposure to the identified substance." /> <min value="0" /> <max value="*" /> <base> <path value="AllergyIntolerance.reaction" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]" /> </mapping> </element> <element id="AllergyIntolerance.reaction.id"> <path value="AllergyIntolerance.reaction.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="AllergyIntolerance.reaction.extension"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.reaction.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="AllergyIntolerance.reaction.modifierExtension"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.reaction.modifierExtension" /> <short value="Extensions that cannot be ignored even if unrecognized" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="AllergyIntolerance.reaction.substance"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.reaction.substance" /> <short value="Specific substance or pharmaceutical product considered to be responsible for event" /> <definition value="Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance." /> <comment value="Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.reaction.substance" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubstanceCode" /> </extension> <strength value="preferred" /> <description value="Codes defining the type of the substance (including pharmaceutical products)." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="rim" /> <map value="outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]" /> </mapping> </element> <element id="AllergyIntolerance.reaction.manifestation"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.reaction.manifestation" /> <short value="Clinical symptoms/signs associated with the Event" /> <definition value="Clinical symptoms and/or signs that are observed or associated with the adverse reaction event." /> <comment value="Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10." /> <alias value="Symptoms" /> <alias value="Signs" /> <min value="1" /> <max value="*" /> <base> <path value="AllergyIntolerance.reaction.manifestation" /> <min value="1" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Manifestation" /> </extension> <strength value="preferred" /> <description value="Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestation" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="v2" /> <map value="AL1-5" /> </mapping> <mapping> <identity value="rim" /> <map value="code" /> </mapping> </element> <element id="AllergyIntolerance.reaction.description"> <path value="AllergyIntolerance.reaction.description" /> <short value="Description of the event as a whole" /> <definition value="Text description about the reaction as a whole, including details of the manifestation if required." /> <comment value="Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives." /> <alias value="Narrative" /> <alias value="Text" /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.reaction.description" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="text" /> </mapping> </element> <element id="AllergyIntolerance.reaction.onset"> <path value="AllergyIntolerance.reaction.onset" /> <short value="Date(/time) when manifestations showed" /> <definition value="Record of the date and/or time of the onset of the Reaction." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.reaction.onset" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="AL1-6" /> </mapping> <mapping> <identity value="rim" /> <map value="effectiveTime.low" /> </mapping> </element> <element id="AllergyIntolerance.reaction.severity"> <path value="AllergyIntolerance.reaction.severity" /> <short value="mild | moderate | severe (of event as a whole)" /> <definition value="Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations." /> <comment value="It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.reaction.severity" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AllergyIntoleranceSeverity" /> </extension> <strength value="required" /> <description value="Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations." /> <valueSet value="http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" /> </mapping> </element> <element id="AllergyIntolerance.reaction.exposureRoute"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.reaction.exposureRoute" /> <short value="How the subject was exposed to the substance" /> <definition value="Identification of the route by which the subject was exposed to the substance." /> <comment value="Coding of the route of exposure with a terminology should be used wherever possible." /> <min value="0" /> <max value="1" /> <base> <path value="AllergyIntolerance.reaction.exposureRoute" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="RouteOfAdministration" /> </extension> <strength value="preferred" /> <description value="A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="rim" /> <map value="outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode" /> </mapping> </element> <element id="AllergyIntolerance.reaction.note"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="AllergyIntolerance.reaction.note" /> <short value="Text about event not captured in other fields" /> <definition value="Additional text about the adverse reaction event not captured in other fields." /> <comment value="Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased." /> <min value="0" /> <max value="*" /> <base> <path value="AllergyIntolerance.reaction.note" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Annotation" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act" /> </mapping> <mapping> <identity value="rim" /> <map value="subjectOf.observationEvent[code="annotation"].value" /> </mapping> </element> </snapshot> <differential> <element id="AllergyIntolerance.extension:evidence"> <path value="AllergyIntolerance.extension" /> <sliceName value="evidence" /> <short value="A reference to results of investigations that confirmed the certainty of the diagnosis." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence" /> </type> </element> <element id="AllergyIntolerance.clinicalStatus"> <path value="AllergyIntolerance.clinicalStatus" /> <mustSupport value="true" /> </element> <element id="AllergyIntolerance.clinicalStatus.extension:allergyIntoleranceEnd"> <path value="AllergyIntolerance.clinicalStatus.extension" /> <sliceName value="allergyIntoleranceEnd" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd" /> </type> <isModifier value="false" /> </element> <element id="AllergyIntolerance.verificationStatus"> <path value="AllergyIntolerance.verificationStatus" /> <mustSupport value="true" /> </element> <element id="AllergyIntolerance.code"> <path value="AllergyIntolerance.code" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode" /> </binding> </element> <element id="AllergyIntolerance.patient"> <path value="AllergyIntolerance.patient" /> <mustSupport value="true" /> </element> <element id="AllergyIntolerance.reaction"> <path value="AllergyIntolerance.reaction" /> <mustSupport value="true" /> </element> <element id="AllergyIntolerance.reaction.substance"> <path value="AllergyIntolerance.reaction.substance" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance" /> </binding> </element> <element id="AllergyIntolerance.reaction.manifestation"> <path value="AllergyIntolerance.reaction.manifestation" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestation" /> </binding> </element> <element id="AllergyIntolerance.reaction.severity"> <path value="AllergyIntolerance.reaction.severity" /> <mustSupport value="true" /> </element> <element id="AllergyIntolerance.reaction.exposureRoute"> <path value="AllergyIntolerance.reaction.exposureRoute" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute" /> </binding> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "UKCore-AllergyIntolerance", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance", "version": "2.5.0", "name": "UKCoreAllergyIntolerance", "title": "UK Core AllergyIntolerance", "status": "active", "date": "2023-12-12", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [AllergyIntolerance](https://hl7.org/fhir/R4/AllergyIntolerance.html).", "purpose": "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. \n\nWhere 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. \n\nSubstances 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. \n\nThis 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](https://hl7.org/fhir/R4/consent.html) resource.", "copyright": "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.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "AllergyIntolerance", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance", "derivation": "constraint", "snapshot": { "element": [ { "id": "AllergyIntolerance", "path": "AllergyIntolerance", "short": "Allergy or Intolerance (generally: Risk of adverse reaction to a substance)", "definition": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.", "comment": "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.", "alias": [ "Allergy", "Intolerance", "Adverse Reaction" ], "min": 0, "max": "*", "base": { "path": "AllergyIntolerance", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "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", "expression": "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()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "ait-1", "severity": "error", "human": "AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.", "expression": "verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()", "xpath": "f:verificationStatus/f:coding/f:code/@value='entered-in-error' or exists(f:clinicalStatus)", "source": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" }, { "key": "ait-2", "severity": "error", "human": "AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error", "expression": "verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()", "xpath": "not(f:verificationStatus/f:coding/f:code/@value='entered-in-error') or not(exists(f:clinicalStatus))", "source": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" } ] }, { "id": "AllergyIntolerance.id", "path": "AllergyIntolerance.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isSummary": true }, { "id": "AllergyIntolerance.meta", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AllergyIntolerance.implicitRules", "path": "AllergyIntolerance.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "AllergyIntolerance.language", "path": "AllergyIntolerance.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "AllergyIntolerance.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "AllergyIntolerance.contained", "path": "AllergyIntolerance.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AllergyIntolerance.extension", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AllergyIntolerance.extension:evidence", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.extension", "sliceName": "evidence", "short": "A reference to results of investigations that confirmed the certainty of the diagnosis.", "definition": "A reference to results of investigations that confirmed the certainty of the diagnosis.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AllergyIntolerance.modifierExtension", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AllergyIntolerance.identifier", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.identifier", "short": "External ids for this item", "definition": "Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", "comment": "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.", "requirements": "Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "*", "base": { "path": "AllergyIntolerance.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "IAM-7" }, { "identity": "rim", "map": "id" } ] }, { "id": "AllergyIntolerance.clinicalStatus", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.clinicalStatus", "short": "active | inactive | resolved", "definition": "The clinical status of the allergy or intolerance.", "comment": "Refer to [discussion](extensibility.html#Special-Case) if clincalStatus is missing data.\nThe data type is CodeableConcept because clinicalStatus 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.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.clinicalStatus", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1", "ait-1", "ait-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceClinicalStatus" } ], "strength": "required", "description": "The clinical status of the allergy or intolerance.", "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"clinicalStatus\", moodCode=EVN].value" } ] }, { "id": "AllergyIntolerance.clinicalStatus.id", "path": "AllergyIntolerance.clinicalStatus.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "AllergyIntolerance.clinicalStatus.extension", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.clinicalStatus.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AllergyIntolerance.clinicalStatus.extension:allergyIntoleranceEnd", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.clinicalStatus.extension", "sliceName": "allergyIntoleranceEnd", "short": "Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.", "definition": "Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AllergyIntolerance.clinicalStatus.coding", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.clinicalStatus.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id": "AllergyIntolerance.clinicalStatus.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "AllergyIntolerance.clinicalStatus.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id": "AllergyIntolerance.verificationStatus", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.verificationStatus", "short": "unconfirmed | confirmed | refuted | entered-in-error", "definition": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).", "comment": "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.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.verificationStatus", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1", "ait-1", "ait-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceVerificationStatus" } ], "strength": "required", "description": "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.", "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"verificationStatus\", moodCode=EVN].value" } ] }, { "id": "AllergyIntolerance.type", "path": "AllergyIntolerance.type", "short": "allergy | intolerance - Underlying mechanism (if known)", "definition": "Identification of the underlying physiological mechanism for the reaction risk.", "comment": "Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term \"allergy\" is used rather generically and may overlap with the use of \"intolerance\" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.", "alias": [ "Category", "Class" ], "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.type", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceType" } ], "strength": "required", "description": "Identification of the underlying physiological mechanism for a Reaction Risk.", "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "IAM-9" }, { "identity": "rim", "map": "code" } ] }, { "id": "AllergyIntolerance.category", "path": "AllergyIntolerance.category", "short": "food | medication | environment | biologic", "definition": "Category of the identified substance.", "comment": "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](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.", "alias": [ "Category", "Type", "Reaction Type", "Class" ], "min": 0, "max": "*", "base": { "path": "AllergyIntolerance.category", "min": 0, "max": "*" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceCategory" } ], "strength": "required", "description": "Category of an identified substance associated with allergies or intolerances.", "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "AL1-2" }, { "identity": "rim", "map": "value < IntoleranceValue (Agent)" } ] }, { "id": "AllergyIntolerance.criticality", "path": "AllergyIntolerance.criticality", "short": "low | high | unable-to-assess", "definition": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.", "comment": "The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term \"severity\" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.", "alias": [ "Severity", "Seriousness", "Contra-indication", "Risk" ], "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.criticality", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceCriticality" } ], "strength": "required", "description": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.", "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "FiveWs.grade" }, { "identity": "v2", "map": "AL1-4" }, { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" } ] }, { "id": "AllergyIntolerance.code", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.code", "short": "Code that identifies the allergy or intolerance", "definition": "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., \"Latex\"), an allergy or intolerance condition (e.g., \"Latex allergy\"), or a negated/excluded code for a specific substance or class (e.g., \"No latex allergy\") or a general or categorical negated statement (e.g., \"No known allergy\", \"No known drug allergies\"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.", "comment": "It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.\n\nWhen a substance or product code is specified for the 'code' element, the \"default\" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the \"Causative agent\" relationship.\n\nThe 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make \"no known allergy\" (or \"no risk of adverse reaction\") statements regarding any coded substance/product (including cases when a pre-coordinated \"no allergy to x\" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.", "alias": [ "Code" ], "min": 1, "max": "1", "base": { "path": "AllergyIntolerance.code", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceCode" } ], "strength": "preferred", "description": "Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "v2", "map": "AL1-3 / IAM-3" }, { "identity": "rim", "map": "substance/product:\n\n.participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\n\nnegated/excluded substance/product:\n\n.participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\n\npositive or negated/excluded condition/situation:\n\nObservation.code=ASSERTION; Observation.value" } ] }, { "id": "AllergyIntolerance.patient", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.patient", "short": "Who the sensitivity is for", "definition": "The patient who has the allergy or intolerance.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "alias": [ "Patient" ], "min": 1, "max": "1", "base": { "path": "AllergyIntolerance.patient", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "v2", "map": "(PID-3)" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role[classCode=PAT]" }, { "identity": "w5", "map": "FiveWs.subject" } ] }, { "id": "AllergyIntolerance.encounter", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.encounter", "short": "Encounter when the allergy or intolerance was asserted", "definition": "The encounter when the allergy or intolerance was asserted.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.encounter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" } ] }, { "id": "AllergyIntolerance.onset[x]", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.onset[x]", "short": "When allergy or intolerance was identified", "definition": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.onset[x]", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" }, { "code": "Age" }, { "code": "Period" }, { "code": "Range" }, { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "FiveWs.init" }, { "identity": "rim", "map": "effectiveTime.low" } ] }, { "id": "AllergyIntolerance.recordedDate", "path": "AllergyIntolerance.recordedDate", "short": "Date first version of the resource instance was recorded", "definition": "The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.recordedDate", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "v2", "map": "IAM-13" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" } ] }, { "id": "AllergyIntolerance.recorder", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.recorder", "short": "Who recorded the sensitivity", "definition": "Individual who recorded the record and takes responsibility for its content.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "alias": [ "Author" ], "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.recorder", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ] }, { "id": "AllergyIntolerance.asserter", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.asserter", "short": "Source of the information about the allergy", "definition": "The source of the information about the allergy that is recorded.", "comment": "The recorder takes responsibility for the content, but can reference the source from where they got it.", "alias": [ "Source", "Informant" ], "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.asserter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "w5", "map": "FiveWs.source" }, { "identity": "v2", "map": "IAM-14 (if patient) / IAM-18 (if practitioner)" }, { "identity": "rim", "map": ".participation[typeCode=INF].role" } ] }, { "id": "AllergyIntolerance.lastOccurrence", "path": "AllergyIntolerance.lastOccurrence", "short": "Date(/time) of last known occurrence of a reaction", "definition": "Represents the date and/or time of the last known occurrence of a reaction event.", "comment": "This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.lastOccurrence", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime" } ] }, { "id": "AllergyIntolerance.note", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.note", "short": "Additional text not captured in other fields", "definition": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.", "comment": "For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.", "min": 0, "max": "*", "base": { "path": "AllergyIntolerance.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act" }, { "identity": "rim", "map": "subjectOf.observationEvent[code=\"annotation\"].value" } ] }, { "id": "AllergyIntolerance.reaction", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.reaction", "short": "Adverse Reaction Events linked to exposure to substance", "definition": "Details about each adverse reaction event linked to exposure to the identified substance.", "min": 0, "max": "*", "base": { "path": "AllergyIntolerance.reaction", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]" } ] }, { "id": "AllergyIntolerance.reaction.id", "path": "AllergyIntolerance.reaction.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "AllergyIntolerance.reaction.extension", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.reaction.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AllergyIntolerance.reaction.modifierExtension", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.reaction.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AllergyIntolerance.reaction.substance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.reaction.substance", "short": "Specific substance or pharmaceutical product considered to be responsible for event", "definition": "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.", "comment": "Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, \"penicillins\"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, \"amoxycillin\"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.reaction.substance", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubstanceCode" } ], "strength": "preferred", "description": "Codes defining the type of the substance (including pharmaceutical products).", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]" } ] }, { "id": "AllergyIntolerance.reaction.manifestation", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.reaction.manifestation", "short": "Clinical symptoms/signs associated with the Event", "definition": "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.", "comment": "Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.", "alias": [ "Symptoms", "Signs" ], "min": 1, "max": "*", "base": { "path": "AllergyIntolerance.reaction.manifestation", "min": 1, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Manifestation" } ], "strength": "preferred", "description": "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestation" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "AL1-5" }, { "identity": "rim", "map": "code" } ] }, { "id": "AllergyIntolerance.reaction.description", "path": "AllergyIntolerance.reaction.description", "short": "Description of the event as a whole", "definition": "Text description about the reaction as a whole, including details of the manifestation if required.", "comment": "Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.", "alias": [ "Narrative", "Text" ], "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.reaction.description", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "text" } ] }, { "id": "AllergyIntolerance.reaction.onset", "path": "AllergyIntolerance.reaction.onset", "short": "Date(/time) when manifestations showed", "definition": "Record of the date and/or time of the onset of the Reaction.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.reaction.onset", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "AL1-6" }, { "identity": "rim", "map": "effectiveTime.low" } ] }, { "id": "AllergyIntolerance.reaction.severity", "path": "AllergyIntolerance.reaction.severity", "short": "mild | moderate | severe (of event as a whole)", "definition": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.", "comment": "It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.reaction.severity", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceSeverity" } ], "strength": "required", "description": "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.", "valueSet": "http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" } ] }, { "id": "AllergyIntolerance.reaction.exposureRoute", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.reaction.exposureRoute", "short": "How the subject was exposed to the substance", "definition": "Identification of the route by which the subject was exposed to the substance.", "comment": "Coding of the route of exposure with a terminology should be used wherever possible.", "min": 0, "max": "1", "base": { "path": "AllergyIntolerance.reaction.exposureRoute", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RouteOfAdministration" } ], "strength": "preferred", "description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode" } ] }, { "id": "AllergyIntolerance.reaction.note", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "AllergyIntolerance.reaction.note", "short": "Text about event not captured in other fields", "definition": "Additional text about the adverse reaction event not captured in other fields.", "comment": "Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.", "min": 0, "max": "*", "base": { "path": "AllergyIntolerance.reaction.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act" }, { "identity": "rim", "map": "subjectOf.observationEvent[code=\"annotation\"].value" } ] } ] }, "differential": { "element": [ { "id": "AllergyIntolerance.extension:evidence", "path": "AllergyIntolerance.extension", "sliceName": "evidence", "short": "A reference to results of investigations that confirmed the certainty of the diagnosis.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence" ] } ] }, { "id": "AllergyIntolerance.clinicalStatus", "path": "AllergyIntolerance.clinicalStatus", "mustSupport": true }, { "id": "AllergyIntolerance.clinicalStatus.extension:allergyIntoleranceEnd", "path": "AllergyIntolerance.clinicalStatus.extension", "sliceName": "allergyIntoleranceEnd", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd" ] } ], "isModifier": false }, { "id": "AllergyIntolerance.verificationStatus", "path": "AllergyIntolerance.verificationStatus", "mustSupport": true }, { "id": "AllergyIntolerance.code", "path": "AllergyIntolerance.code", "min": 1, "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode" } }, { "id": "AllergyIntolerance.patient", "path": "AllergyIntolerance.patient", "mustSupport": true }, { "id": "AllergyIntolerance.reaction", "path": "AllergyIntolerance.reaction", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.substance", "path": "AllergyIntolerance.reaction.substance", "binding": { "strength": "preferred", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance" } }, { "id": "AllergyIntolerance.reaction.manifestation", "path": "AllergyIntolerance.reaction.manifestation", "binding": { "strength": "preferred", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestation" } }, { "id": "AllergyIntolerance.reaction.severity", "path": "AllergyIntolerance.reaction.severity", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.exposureRoute", "path": "AllergyIntolerance.reaction.exposureRoute", "binding": { "strength": "preferred", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute" } } ] } }
The following are feasible use cases for the UK Core AllergyIntolerance profile:
The query against a clinical system or shared record to return recorded allergies as AllergyIntolerance
resources.
Returned results could be ordered by AllergyIntolerance.recordedDate
and/or AllergyIntolerance.lastOccurrence
.
Returned results MAY include multiple instances of the same allergy, as per the causative agent (AllergyIntolerance.code
), but with different AllergyIntolerance.clinicalStatus
values. The newer of such records either by AllergyIntolerance.recordedDate
or AllergyIntolerance.lastOccurrence
SHOULD be deemed the latest or current record of the allergy.
For when systems need to exchange allergy information within a point-to-point message. The AllergyIntolerance
resources can be included within a FHIR Message (within the Bundle), or within a FHIR Document alongside other structured resources and text-based data.
Allergy information SHOULD NOT be duplicated between systems (and, in England, this aligns with the NHS Data Strategy). When exchanging allergies data between systems be mindful of whether the receiving system plans to persist the data. If persisted, processes SHALL be put in place to ensure the data is updated if/when the source record is updated.
When allergy records are migrated between systems, the AllergyIntolerance
resource could be used as a data migration standard.
Where migrated data is not coded, uses retired / invalidated codes, or coded with a terminology which cannot be mapped to SNOMED CT, then refer to the guidance on using degraded drug / non-drug allergy codes.
The following elements are identified as MustSupport, and it is expected that consumers and suppliers SHALL support these as per the MustSupport Guidance.
Element | Reason |
---|---|
AllergyIntolerance.clinicalStatus |
Defines whether the allergy or intolerance is active, inactive or resolved. |
AllergyIntolerance.verificationStatus |
Defines the assertion of the allergy or intolerance. |
AllergyIntolerance.code |
This code identifies the allergy or intolerance |
AllergyIntolerance.patient |
Links the allergy to the patient |
AllergyIntolerance.reaction |
Details about each adverse reaction event |
AllergyIntolerance.reaction.severity |
Clinical assessment of the severity of the reaction event as a whole |
More information about the extensions can be found using the links below.
Extension | Context | Link | Comment |
---|---|---|---|
allergyIntoleranceEnd | AllergyIntolerance.clinicalStatus | Extension UKCore-AllergyIntoleranceEnd | For the date when the allergy or intolerance clinicalStatus is updated to inactive or resolved . |
evidence | AllergyIntolerance | Extension UKCore-Evidence | To reference a DiagnosticReport resource for investigations that confirm the certainty of the allergy or intolerance diagnosis. |
More information about the bindings to UK Core ValueSets can be found below.
Context | Strength | Link |
---|---|---|
AllergyIntolerance.code | Preferred | ValueSet UKCore-AllergyCode |
AllergyIntolerance.reaction.exposureRoute | Preferred | ValueSet UKCore-SubstanceOrProductAdministrationRoute |
AllergyIntolerance.reaction.manifestation | Preferred | ValueSet UKCore-AllergyManifestation |
AllergyIntolerance.reaction.substance | Preferred | ValueSet UKCore-AllergySubstance |
verificationStatus
An optional value from a required terminology binding containing the values;
unconfirmed
confirmed
refuted
entered-in-error
.Note: The use of entered-in-error
dictates the population of the AllergyIntolerance.clinicalStatus
element.
code
Identifies the causative agent for the allergy or intolerance.
When recording an allergy to a medication substance, the provider system SHOULD use a dm+d concept class or alternatively, when the allergy is not recorded against a medication substance, the relevant set of SNOMED CT. These can be found within the ValueSet UKCore-AllergyCode.
AllergyIntolerance.id[0] | UKCore-AllergyIntolerance-Sn-NonDrugAllergy-Example |
AllergyIntolerance.clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
AllergyIntolerance.clinicalStatus[0].coding[0].code[0] | active |
AllergyIntolerance.clinicalStatus[0].coding[0].display[0] | Active |
AllergyIntolerance.verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
AllergyIntolerance.verificationStatus[0].coding[0].code[0] | confirmed |
AllergyIntolerance.verificationStatus[0].coding[0].display[0] | Confirmed |
AllergyIntolerance.code[0].coding[0].system[0] | http://snomed.info/sct |
AllergyIntolerance.code[0].coding[0].code[0] | 196471000000108 |
AllergyIntolerance.code[0].coding[0].display[0] | Transfer-degraded non-drug allergy (record artifact) |
AllergyIntolerance.code[0].text[0] | Latex |
AllergyIntolerance.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
AllergyIntolerance |
id : UKCore-AllergyIntolerance-Sn-NonDrugAllergy-Example |
clinicalStatus |
coding |
system : http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
code : active |
display : Active |
verificationStatus |
coding |
system : http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
code : confirmed |
display : Confirmed |
code |
coding |
system : http://snomed.info/sct |
code : 196471000000108 |
display : Transfer-degraded non-drug allergy (record artifact) |
text : Latex |
patient |
reference : Patient/UKCore-Patient-RichardSmith-Example |
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <id value="UKCore-AllergyIntolerance-Sn-NonDrugAllergy-Example" /> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <!-- **************Snippet start************** --> <code> <coding> <system value="http://snomed.info/sct" /> <code value="196471000000108" /> <display value="Transfer-degraded non-drug allergy (record artifact)" /> </coding> <text value="Latex" /> </code> <!-- **************Snippet end************** --> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> </AllergyIntolerance>
{ "resourceType": "AllergyIntolerance", "id": "UKCore-AllergyIntolerance-Sn-NonDrugAllergy-Example", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "196471000000108", "display": "Transfer-degraded non-drug allergy (record artifact)" } ], "text": "Latex" }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } }
AllergyIntolerance.id[0] | UKCore-AllergyIntolerance-Sn-DrugAllergy-Example |
AllergyIntolerance.clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
AllergyIntolerance.clinicalStatus[0].coding[0].code[0] | active |
AllergyIntolerance.clinicalStatus[0].coding[0].display[0] | Active |
AllergyIntolerance.verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
AllergyIntolerance.verificationStatus[0].coding[0].code[0] | confirmed |
AllergyIntolerance.verificationStatus[0].coding[0].display[0] | Confirmed |
AllergyIntolerance.code[0].coding[0].system[0] | http://snomed.info/sct |
AllergyIntolerance.code[0].coding[0].code[0] | 196461000000101 |
AllergyIntolerance.code[0].coding[0].display[0] | Transfer-degraded drug allergy (record artifact) |
AllergyIntolerance.code[0].text[0] | 9339101000001105 | Septrin |
AllergyIntolerance.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
AllergyIntolerance |
id : UKCore-AllergyIntolerance-Sn-DrugAllergy-Example |
clinicalStatus |
coding |
system : http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
code : active |
display : Active |
verificationStatus |
coding |
system : http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
code : confirmed |
display : Confirmed |
code |
coding |
system : http://snomed.info/sct |
code : 196461000000101 |
display : Transfer-degraded drug allergy (record artifact) |
text : 9339101000001105 | Septrin |
patient |
reference : Patient/UKCore-Patient-RichardSmith-Example |
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <id value="UKCore-AllergyIntolerance-Sn-DrugAllergy-Example" /> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <!-- **************Snippet start************** --> <code> <coding> <system value="http://snomed.info/sct" /> <code value="196461000000101" /> <display value="Transfer-degraded drug allergy (record artifact)" /> </coding> <text value="9339101000001105 | Septrin" /> </code> <!-- **************Snippet end************** --> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> </AllergyIntolerance>
{ "resourceType": "AllergyIntolerance", "id": "UKCore-AllergyIntolerance-Sn-DrugAllergy-Example", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "196461000000101", "display": "Transfer-degraded drug allergy (record artifact)" } ], "text": "9339101000001105 | Septrin" }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } }
Note: “Septrin” is a long discontinued brand name of an antibiotic.
AllergyIntolerance.id[0] | UKCore-AllergyIntolerance-Sn-DrugAllergyToEggProtein-Example |
AllergyIntolerance.clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
AllergyIntolerance.clinicalStatus[0].coding[0].code[0] | active |
AllergyIntolerance.clinicalStatus[0].coding[0].display[0] | Active |
AllergyIntolerance.verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
AllergyIntolerance.verificationStatus[0].coding[0].code[0] | confirmed |
AllergyIntolerance.verificationStatus[0].coding[0].display[0] | Confirmed |
AllergyIntolerance.code[0].coding[0].system[0] | http://snomed.info/sct |
AllergyIntolerance.code[0].coding[0].code[0] | 196461000000101 |
AllergyIntolerance.code[0].coding[0].display[0] | Transfer-degraded drug allergy (record artifact) |
AllergyIntolerance.code[0].text[0] | 213020009 | Allergy to egg protein |
AllergyIntolerance.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
AllergyIntolerance |
id : UKCore-AllergyIntolerance-Sn-DrugAllergyToEggProtein-Example |
clinicalStatus |
coding |
system : http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
code : active |
display : Active |
verificationStatus |
coding |
system : http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
code : confirmed |
display : Confirmed |
code |
coding |
system : http://snomed.info/sct |
code : 196461000000101 |
display : Transfer-degraded drug allergy (record artifact) |
text : 213020009 | Allergy to egg protein |
patient |
reference : Patient/UKCore-Patient-RichardSmith-Example |
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <id value="UKCore-AllergyIntolerance-Sn-DrugAllergyToEggProtein-Example" /> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <!-- **************Snippet start************** --> <code> <coding> <system value="http://snomed.info/sct" /> <code value="196461000000101" /> <display value="Transfer-degraded drug allergy (record artifact)" /> </coding> <text value="213020009 | Allergy to egg protein" /> </code> <!-- **************Snippet end************** --> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> </AllergyIntolerance>
{ "resourceType": "AllergyIntolerance", "id": "UKCore-AllergyIntolerance-Sn-DrugAllergyToEggProtein-Example", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "196461000000101", "display": "Transfer-degraded drug allergy (record artifact)" } ], "text": "213020009 | Allergy to egg protein" }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } }
There can be an explicit assertion of ‘No Known Allergies’ using the SNOMED CT 'No known allergy' hierarchy 716186003 | No known allergy. The parent concept, or any child concept MAY be used.
AllergyIntolerance.code
usage for 'No known drug allergy':AllergyIntolerance.id[0] | UKCore-AllergyIntolerance-Sn-NegHandlNoKnownAllergies-Example |
AllergyIntolerance.clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
AllergyIntolerance.clinicalStatus[0].coding[0].code[0] | active |
AllergyIntolerance.clinicalStatus[0].coding[0].display[0] | Active |
AllergyIntolerance.verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
AllergyIntolerance.verificationStatus[0].coding[0].code[0] | confirmed |
AllergyIntolerance.verificationStatus[0].coding[0].display[0] | Confirmed |
AllergyIntolerance.code[0].coding[0].system[0] | http://snomed.info/sct |
AllergyIntolerance.code[0].coding[0].code[0] | 409137002 |
AllergyIntolerance.code[0].coding[0].display[0] | No known drug allergy (situation) |
AllergyIntolerance.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
AllergyIntolerance |
id : UKCore-AllergyIntolerance-Sn-NegHandlNoKnownAllergies-Example |
clinicalStatus |
coding |
system : http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
code : active |
display : Active |
verificationStatus |
coding |
system : http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
code : confirmed |
display : Confirmed |
code |
coding |
system : http://snomed.info/sct |
code : 409137002 |
display : No known drug allergy (situation) |
patient |
reference : Patient/UKCore-Patient-RichardSmith-Example |
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <id value="UKCore-AllergyIntolerance-Sn-NegHandlNoKnownAllergies-Example" /> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <!-- **************Snippet start************** --> <code> <coding> <system value="http://snomed.info/sct" /> <code value="409137002" /> <display value="No known drug allergy (situation)" /> </coding> </code> <!-- **************Snippet end************** --> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> </AllergyIntolerance>
{ "resourceType": "AllergyIntolerance", "id": "UKCore-AllergyIntolerance-Sn-NegHandlNoKnownAllergies-Example", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "409137002", "display": "No known drug allergy (situation)" } ] }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } }
If other AllergyIntolerance
resources exist in the patient record with a AllergyIntolerance.clinicalStatus
of active
then the system SHALL ignore the 'No Known Allergies' resource instance. The existence of recorded and active allergies takes precedence over instances of 'No Known Allergies' records.
The representation of the causative agent as text is supported within the FHIR standard but this SHOULD only be used as a last resort if a suitable coded term does not exist within the SNOMED CT terminology or if using a degraded allergy code is not appropriate.
nullFlavor
The UK Core recommendation is that the nullFlavor
is not used for the causative agent, even though it is permitted within the FHIR standard.
onset[x]
Record of the date and/or time of the onset of the reaction caused by the allergy or intolerance which can be recorded in one of five ways;
onsetDateTime
onsetAge
onsetPeriod
onsetRange
onsetString
.Provider systems are recommended to support at least AllergyIntolerance.onsetDateTime
and AllergyIntolerance.onsetAge
where this date is available.
It is recommended not to record the onset using an AllergyIntolerance.onsetPeriod
or AllergyIntolerance.onsetRange
as these data types are complex and less useful. If the exact onset date is not known, but was between two known dates, e.g. 2018 and 2019, then use the lower/older date as the AllergyIntolerance.onsetDateTime
instead of using an AllergyIntolerance.onsetPeriod
.
It is recommended not to record the onset using an AllergyIntolerance.onsetString
as this data will not be machine processable.
Consumer systems SHALL be able to handle any of the AllergyIntolerance.onset
data types.
recordedDate
The date the first version of the resource instance was recorded.
The recordedDate represents when this particular AllergyIntolerance
record was created in the system, which is often a system-generated date.
If the instance of the resource is updated via an operation like a RESTful PATCH
or PUT
then the AllergyIntolerance.recordedDate
is not updated and remains the date the resource instance was recorded.
recorder
A reference to the individual who recorded the record and takes responsibility for its content.
The resource being referenced SHOULD conform to one of the following:
asserter
A reference to the source of the information about the allergy.
The resource being referenced SHOULD conform to one of the following:
Provider systems SHOULD provide at least the following minimum data within the referenced resource.
Practitioner
PractitionerRole
Patient
RelatedPerson
Where a human asserter is not captured or cannot be confirmed, i.e. the asserter is not a Practitioner
, Patient
or RelatedPerson
, the provider systems SHOULD reference a PractitionerRole.organisation
and/or PractitionerRole.healthcareService
within a PractitionerRole
resource, using the associated ODS code, as per the following example, asserted by "MILTON KEYNES UNIVERSITY HOSPITAL NHS FOUNDATION TRUST".
PractitionerRole.organisation
for ODS code usage:PractitionerRole.id[0] | UKCore-PractitionerRole-Sn-Organization-Code-Example |
PractitionerRole.identifier[0].system[0] | https://fhir.nhs.uk/Id/sds-role-profile-id |
PractitionerRole.identifier[0].value[0] | 100334993514 |
PractitionerRole.organization[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
PractitionerRole.organization[0].identifier[0].value[0] | RD8 |
PractitionerRole.organization[0].display[0] | MILTON KEYNES UNIVERSITY HOSPITAL NHS FOUNDATION TRUST |
PractitionerRole |
id : UKCore-PractitionerRole-Sn-Organization-Code-Example |
identifier |
system : https://fhir.nhs.uk/Id/sds-role-profile-id |
value : 100334993514 |
organization |
identifier |
system : https://fhir.nhs.uk/Id/ods-organization-code |
value : RD8 |
display : MILTON KEYNES UNIVERSITY HOSPITAL NHS FOUNDATION TRUST |
<PractitionerRole xmlns="http://hl7.org/fhir"> <id value="UKCore-PractitionerRole-Sn-Organization-Code-Example" /> <!-- **************snippet start************** --> <identifier> <system value="https://fhir.nhs.uk/Id/sds-role-profile-id" /> <value value="100334993514" /> </identifier> <organization> <identifier> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="RD8" /> </identifier> <display value="MILTON KEYNES UNIVERSITY HOSPITAL NHS FOUNDATION TRUST" /> </organization> <!-- **************snippet end************** --> </PractitionerRole>
{ "resourceType": "PractitionerRole", "id": "UKCore-PractitionerRole-Sn-Organization-Code-Example", "identifier": [ { "system": "https://fhir.nhs.uk/Id/sds-role-profile-id", "value": "100334993514" } ], "organization": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RD8" }, "display": "MILTON KEYNES UNIVERSITY HOSPITAL NHS FOUNDATION TRUST" } }
lastOccurrence
Represents the date and/or time of the last known occurrence of a reaction event.
note
An optional element for when the clinical user wishes to provide supporting textual information for the allergy record that cannot be conveyed within other elements of the resource.
Where a provider system only has the capability to record a note at one level it SHOULD populate the AllergyIntolerance.note
elements with any notes data captured within the system, irrespective of the data level that the system uses to capture that data.
Where a provider system has the capability to record a note at both the AllergyIntolerance
and at the AllergyIntolerance.reaction
level it SHOULD populate both with the relevant notes applicable to each level.
Consumer systems SHALL be able to handle both multiple AllergyIntolerance.note
and multiple AllergyIntolerance.reaction.note
elements.
reaction
Details about each adverse reaction event linked to exposure to the identified substance.
The AllergyIntolerance.reaction
is optional, but where a AllergyIntolerance.reaction.severity
is available in the provider system it SHALL be included to convey severity even if no other reaction details are explicitly available. If this is the case the AllergyIntolerance.reaction.manifestation
SHALL be coded as the nullFlavor NI
.
reaction.substance
An element to record the specific substance or pharmaceutical product considered to be responsible for event using the ValueSet UKCore-AllergySubstance
reaction.manifestation
A mandatory element if a AllergyIntolerance.reaction
is recorded for the clinical symptoms and/or signs that are observed or associated with the adverse reaction event.
Use nullFlavor NI
for the case when a AllergyIntolerance.reaction.severity
needs to be shared but where a AllergyIntolerance.reaction.manifestation
is not known.
reaction.severity
An optional value from a required terminology binding containing the values;
mild
moderate
severe
Where a severity
is available in the provider system it SHALL be included to convey severity even if no other reaction details are explicitly available.
Where the severity is not known, this element SHOULD be omitted.
Use of this element when populated as severe
MAY be used to express life threatening allergies, used in conjunction with the AllergyIntolerance.criticality
element.
An omitted AllergyIntolerance.reaction.severity
will either mean severity data is not available within the provider system or the severity is not known by the provider system.
reaction.exposureRoute
An optional element to identify the route by which the patient was exposed to the substance.
If this data is available the binding SHOULD be to the ValueSet UKCore-SubstanceOrProductAdministrationRoute.
Consumer systems are recommended not to include this coded information within automated clinical decision support. This is because it could either mean two quite different things;
OR
reaction.note
An optional element for when the clinical user wishes to provide supporting textual information for the reaction that cannot be conveyed within other elements of the backbone element.
See the related guidance above for AllergyIntolerance.note
.