UK Core Implementation Guide STU3 Sequence

Please note:

This version of the UK Core is for C&TA Sprint 7 Review.
This version is not suitable for implementation. Other versions are available on the UK Core Version History Guide
Please follow the guidance on the Contact Us page if you need any assistance.
A summary of changes is available on the STU3 Sequence Change Log

StructureDefinition Extension-UKCore-AllergyIntoleranceEnd

Canonical_URL	Description	Profile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd	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.	This extension extends the AllergyIntolerance resource to support the exchange of information describing the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.

Context of Use

AllergyIntolerance.clinicalStatus

Tree View

Extension	I		Extension	Element Id Extension Short description 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. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
extension	I	0..*	Extension	Element Id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
endDate	I	0..1	Extension	Element Id Extension.extension:endDate Short description The date the allergy or intolerance was recorded as no longer valid Alternate names extensions, user content Definition The date the allergy or intolerance was recorded as no longer valid. Comments 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. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	Element Id Extension.extension:endDate.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value endDate Mappings rim:N/A
value[x]		1..1		Element Id Extension.extension:endDate.value[x] Short description The date the allergy was recorded as no longer valid Definition The date the allergy was recorded as no longer valid. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueDateTime			dateTime	Data Type dateTime
reasonEnded	I	0..1	Extension	Element Id Extension.extension:reasonEnded Short description The reason why the allergy or intolerance has been resolved Alternate names extensions, user content Definition The reason why the allergy or intolerance has been resolved. Comments 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. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	Element Id Extension.extension:reasonEnded.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value reasonEnded Mappings rim:N/A
value[x]		1..1		Element Id Extension.extension:reasonEnded.value[x] Short description The reason why the allergy or intolerance has been resolved Definition The reason why the allergy or intolerance has been resolved. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueString			string	Data Type string
url		1..1	System.StringFixed Value	Element Id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A

Table View

Extension		..1
Extension.extension		0..
Extension.extension		0..1
Extension.extension.url		..
Extension.extension.value[x]	dateTime	1..
Extension.extension		0..1
Extension.extension.url		..
Extension.extension.value[x]	string	1..
Extension.url		..
Extension.value[x]		..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-AllergyIntoleranceEnd" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd" />
    <version value="2.2.0" />
    <name value="ExtensionUKCoreAllergyIntoleranceEnd" />
    <title value="Extension UK Core Allergy Intolerance End" />
    <status value="active" />
    <date value="2022-08-26" />
    <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="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." />
    <purpose value="This extension extends the AllergyIntolerance resource to support the exchange of information describing the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); 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 &quot;AS IS&quot; 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&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; 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" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="AllergyIntolerance.clinicalStatus" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <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." />
            <max value="1" />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Extension.extension:endDate">
            <path value="Extension.extension" />
            <sliceName value="endDate" />
            <short value="The date the allergy or intolerance was recorded as no longer valid" />
            <definition value="The date the allergy or intolerance was recorded as no longer valid." />
            <min value="0" />
            <max value="1" />
        </element>
        <element id="Extension.extension:endDate.url">
            <path value="Extension.extension.url" />
            <fixedUri value="endDate" />
        </element>
        <element id="Extension.extension:endDate.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="The date the allergy was recorded as no longer valid" />
            <definition value="The date the allergy was recorded as no longer valid." />
            <min value="1" />
            <type>
                <code value="dateTime" />
            </type>
        </element>
        <element id="Extension.extension:reasonEnded">
            <path value="Extension.extension" />
            <sliceName value="reasonEnded" />
            <short value="The reason why the allergy or intolerance has been resolved" />
            <definition value="The reason why the allergy or intolerance has been resolved." />
            <min value="0" />
            <max value="1" />
        </element>
        <element id="Extension.extension:reasonEnded.url">
            <path value="Extension.extension.url" />
            <fixedUri value="reasonEnded" />
        </element>
        <element id="Extension.extension:reasonEnded.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="The reason why the allergy or intolerance has been resolved" />
            <definition value="The reason why the allergy or intolerance has been resolved." />
            <min value="1" />
            <type>
                <code value="string" />
            </type>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-AllergyIntoleranceEnd",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd",
    "version": "2.2.0",
    "name": "ExtensionUKCoreAllergyIntoleranceEnd",
    "title": "Extension UK Core Allergy Intolerance End",
    "status": "active",
    "date": "2022-08-26",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "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.",
    "purpose": "This extension extends the AllergyIntolerance resource to support the exchange of information describing the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.",
    "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",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "AllergyIntolerance.clinicalStatus"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "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.",
                "max": "1"
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Extension.extension:endDate",
                "path": "Extension.extension",
                "sliceName": "endDate",
                "short": "The date the allergy or intolerance was recorded as no longer valid",
                "definition": "The date the allergy or intolerance was recorded as no longer valid.",
                "min": 0,
                "max": "1"
            },
            {
                "id": "Extension.extension:endDate.url",
                "path": "Extension.extension.url",
                "fixedUri": "endDate"
            },
            {
                "id": "Extension.extension:endDate.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "The date the allergy was recorded as no longer valid",
                "definition": "The date the allergy was recorded as no longer valid.",
                "min": 1,
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ]
            },
            {
                "id": "Extension.extension:reasonEnded",
                "path": "Extension.extension",
                "sliceName": "reasonEnded",
                "short": "The reason why the allergy or intolerance has been resolved",
                "definition": "The reason why the allergy or intolerance has been resolved.",
                "min": 0,
                "max": "1"
            },
            {
                "id": "Extension.extension:reasonEnded.url",
                "path": "Extension.extension.url",
                "fixedUri": "reasonEnded"
            },
            {
                "id": "Extension.extension:reasonEnded.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "The reason why the allergy or intolerance has been resolved",
                "definition": "The reason why the allergy or intolerance has been resolved.",
                "min": 1,
                "type":  [
                    {
                        "code": "string"
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}

Examples

Allergy Intolerance End- An example to illustrate the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.
Example UKCore-Extension-AllergyIntolEnd

Extension Specific Guidance

An optional extension to record the date and reason when the allergy was no longer clinically active.
If the AllergyIntolerance.clinicalStatus is active then this extension SHALL be omitted.
If the AllergyIntolerance.clinicalStatus is inactive or resolved then the date and reason when the allergy was identified as no longer active SHOULD be populated.