StructureDefinition Extension-England-FlagRemovalReason

Canonical_URLDescriptionProfile_Purpose
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-FlagRemovalReason

An extension used to allow the removal of a Flag and to indicate the reason why the Flag needs removal or has been removed.

The extension extends the Flag resource to support the NHS England requirements for removal of Flags with a stated reason.

Context of Use: Flag

Tree View

url1..1System.StringFixed Value
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean

Table View

Extension..
Extension.url..
Extension.value[x]Coding1..
Extension.value[x].system1..
Extension.value[x].code1..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-England-FlagRemovalReason" />
    <url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-FlagRemovalReason" />
    <version value="1.0.0" />
    <name value="ExtensionEnglandFlagRemovalReason" />
    <title value="Extension England Flag Removal Reason" />
    <status value="active" />
    <date value="2023-11-09" />
    <publisher value="NHS England" />
    <contact>
        <name value="NHS England" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="An extension used to allow the removal of a Flag and to indicate the reason why the Flag needs removal or has been removed." />
    <purpose value="The extension extends the Flag resource to support the NHS England requirements for removal of Flags with a stated reason." />
    <copyright value="Copyright &#169; 2023+ NHS England 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="Flag" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-FlagRemovalReason" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <min value="1" />
            <type>
                <code value="Coding" />
            </type>
            <binding>
                <strength value="required" />
                <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-FlagRemovalReason" />
            </binding>
        </element>
        <element id="Extension.value[x].system">
            <path value="Extension.value[x].system" />
            <min value="1" />
        </element>
        <element id="Extension.value[x].code">
            <path value="Extension.value[x].code" />
            <min value="1" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-England-FlagRemovalReason",
    "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-FlagRemovalReason",
    "version": "1.0.0",
    "name": "ExtensionEnglandFlagRemovalReason",
    "title": "Extension England Flag Removal Reason",
    "status": "active",
    "date": "2023-11-09",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "An extension used to allow the removal of a Flag and to indicate the reason why the Flag needs removal or has been removed.",
    "purpose": "The extension extends the Flag resource to support the NHS England requirements for removal of Flags with a stated reason.",
    "copyright": "Copyright © 2023+ NHS England 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": "Flag"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-FlagRemovalReason"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "Coding"
                    }
                ],
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-FlagRemovalReason"
                }
            },
            {
                "id": "Extension.value[x].system",
                "path": "Extension.value[x].system",
                "min": 1
            },
            {
                "id": "Extension.value[x].code",
                "path": "Extension.value[x].code",
                "min": 1
            }
        ]
    }
}

Examples

Various Examples to illustrate the outcome of an attempted system operation on flag status, error or warning codes in response to a request.

Examples-Female-Genital-Mutilation (FGM)

Extension Specific Guidance

There is a binding within this extension to ValueSet-England-FlagRemovalReason.