Female Genital Mutilation (FGM)

User stories


Add FGM Risk Indicator

As a Healthcare Worker:

  • I can add the patient’s FGM risk indicator

So that:

  • Other healthcare workers know if the patient has any family history of FGM

Use Case Flows

Actors

  • Healthcare worker

Frequency of Use

  • Real-time

Triggers

  • Healthcare worker decides that the patient is at risk of FGM. Decision made to add FGM risk indicator.

Pre-conditions

  • Patient has a verified NHS number

Post-conditions

  • FGM risk indicator added to FGM-IS for the patient

Main Course

  • The healthcare worker decides the patient is at risk of FGM
  • The healthcare worker adds the risk indicator to FGM-IS

Alternative Course

  • Patient already as an FGM risk indicator on FGM-IS and addition is rejected
  • Patient is over 18 and addition of FGM risk indicator is rejected by FGM-IS

Exception

  • System exception e.g. network access, RBAC failure, API error

View FGM Risk Indicator

As a Healthcare Worker:

  • I can view the patient’s FGM Indicator

So that:

  • I know if the patient has any Family history of FGM

Use Case Flows

Actors

  • Healthcare worker

Frequency of Use

  • Real-time

Triggers

  • Patient attends health setting and meets criteria for system to trigger FGM status query i.e. under 18 with female genitalia

Pre-conditions

  • Patient has a verified NHS number

Post-conditions

  • Healthcare worker is made aware of any risk of FGM

Main Course

  • The patient presents at the care setting
  • The healthcare worker is made aware of the patient being at risk of FGM

Alternative Course

  • Patient’s NHS number is not on FGM-IS. Nothing is presented to the health or social care

Exception

  • System exception e.g. network access, RBAC failure, API error

Delete FGM Risk Indicator

As a Healthcare Worker:

  • I can delete the patient’s FGM risk indicator if it is no longer required

So that:

  • The patient's FGM risk indicator is correct

Use Case Flows

Actors

  • Healthcare worker

Frequency of Use

  • Real-time

Triggers

  • Healthcare worker decides that the patient is no longer at risk of FGM. Decision made to deleted FGM risk indicator

Pre-conditions

  • Patient has a verified NHS number

Post-conditions

  • FGM risk indicator removed from FGM-IS for the patient

Main Course

  • The healthcare worker decides the patient should not have an FGM risk indicator recorded
  • The healthcare worker removes the risk indicator from FGM-IS

Alternative Course

N/A

Exception

  • System exception e.g. network access, RBAC failure, API error

FHIR Assets for Sprint 1

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="draft" />
    <date value="2023-08-18" />
    <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": "draft",
    "date": "2023-08-18",
    "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

Note:There is currently no example that uses this extension. An example will be added in a future release.

Extension Specific Guidance

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

England FGM Removal Reason

Description

A set of codes that define the reason a FGM Flag was removed.

HTML View

This code system https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason defines the following codes:

CodeDisplay
0Added in error - this child does not have a family history of FGM
2No longer required - this child has had FGM

Table View

CodeSystem.id[0]England-FGMRemovalReason
CodeSystem.url[0]https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason
CodeSystem.version[0]1.0.0
CodeSystem.name[0]EnglandFGMRemovalReason
CodeSystem.title[0]England FGM Removal Reason
CodeSystem.status[0]draft
CodeSystem.date[0]2023-08-18
CodeSystem.publisher[0]NHS England
CodeSystem.contact[0].name[0]NHS England
CodeSystem.contact[0].telecom[0].system[0]email
CodeSystem.contact[0].telecom[0].value[0]interoperabilityteam@nhs.net
CodeSystem.contact[0].telecom[0].use[0]work
CodeSystem.contact[0].telecom[0].rank[0]1
CodeSystem.description[0]A set of codes that define the reason a FGM Flag was removed.
CodeSystem.copyright[0]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.
CodeSystem.caseSensitive[0]True
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]0
CodeSystem.concept[0].display[0]Added in error - this child does not have a family history of FGM
CodeSystem.concept[1].code[0]2
CodeSystem.concept[1].display[0]No longer required - this child has had FGM

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="England-FGMRemovalReason" />
    <url value="https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason" />
    <version value="1.0.0" />
    <name value="EnglandFGMRemovalReason" />
    <title value="England FGM Removal Reason" />
    <status value="draft" />
    <date value="2023-08-18" />
    <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="A set of codes that define the reason a FGM Flag was removed." />
    <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." />
    <caseSensitive value="true" />
    <content value="complete" />
    <concept>
        <code value="0" />
        <display value="Added in error - this child does not have a family history of FGM" />
    </concept>
    <concept>
        <code value="2" />
        <display value="No longer required - this child has had FGM" />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "England-FGMRemovalReason",
    "url": "https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason",
    "version": "1.0.0",
    "name": "EnglandFGMRemovalReason",
    "title": "England FGM Removal Reason",
    "status": "draft",
    "date": "2023-08-18",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "A set of codes that define the reason a FGM Flag was removed.",
    "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.",
    "caseSensitive": true,
    "content": "complete",
    "concept":  [
        {
            "code": "0",
            "display": "Added in error - this child does not have a family history of FGM"
        },
        {
            "code": "2",
            "display": "No longer required - this child has had FGM"
        }
    ]
}


England Flag Removal Reason

HTML View

ValueSet 'EnglandFlagRemovalReason'

Version1.0.0
Published byNHS England
StatusDraft (since 2023-08-18)

This ValueSet defines the set of codes that can be used to indicate the reason a Flag was removed.

Contact Information

NHS England

Email: interoperabilityteam@nhs.net

This value set includes codes from the following code systems:

Expansion

This expansion was generated on 2023-08-02T12:00:00+00:00

CodeSystemDisplay
0https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReasonAdded in error - this child does not have a family history of FGM
2https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReasonNo longer required - this child has had FGM

Table View

ValueSet.id[0]England-FlagRemovalReason
ValueSet.url[0]https://fhir.nhs.uk/England/ValueSet/England-FlagRemovalReason
ValueSet.version[0]1.0.0
ValueSet.name[0]EnglandFlagRemovalReason
ValueSet.title[0]England Flag Removal Reason
ValueSet.status[0]draft
ValueSet.date[0]2023-08-18
ValueSet.publisher[0]NHS England
ValueSet.contact[0].name[0]NHS England
ValueSet.contact[0].telecom[0].system[0]email
ValueSet.contact[0].telecom[0].value[0]interoperabilityteam@nhs.net
ValueSet.contact[0].telecom[0].use[0]work
ValueSet.contact[0].telecom[0].rank[0]1
ValueSet.description[0]This ValueSet defines the set of codes that can be used to indicate the reason a Flag was removed.
ValueSet.copyright[0]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.
ValueSet.compose[0].include[0].system[0]https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason
ValueSet.compose[0].include[0].version[0]1.0.0
ValueSet.expansion[0].timestamp[0]2023-08-02T12:00:00+00:00
ValueSet.expansion[0].contains[0].system[0]https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason
ValueSet.expansion[0].contains[0].code[0]0
ValueSet.expansion[0].contains[0].display[0]Added in error - this child does not have a family history of FGM
ValueSet.expansion[0].contains[1].system[0]https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason
ValueSet.expansion[0].contains[1].code[0]2
ValueSet.expansion[0].contains[1].display[0]No longer required - this child has had FGM

XML View

<ValueSet xmlns="http://hl7.org/fhir">
    <id value="England-FlagRemovalReason" />
    <url value="https://fhir.nhs.uk/England/ValueSet/England-FlagRemovalReason" />
    <version value="1.0.0" />
    <name value="EnglandFlagRemovalReason" />
    <title value="England Flag Removal Reason" />
    <status value="draft" />
    <date value="2023-08-18" />
    <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="This ValueSet defines the set of codes that can be used to indicate the reason a Flag was removed." />
    <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." />
    <compose>
        <include>
            <system value="https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason" />
            <version value="1.0.0" />
        </include>
    </compose>
    <expansion>
        <timestamp value="2023-08-02T12:00:00+00:00" />
        <contains>
            <system value="https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason" />
            <code value="0" />
            <display value="Added in error - this child does not have a family history of FGM" />
        </contains>
        <contains>
            <system value="https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason" />
            <code value="2" />
            <display value="No longer required - this child has had FGM" />
        </contains>
    </expansion>
</ValueSet>

JSON View

{
    "resourceType": "ValueSet",
    "id": "England-FlagRemovalReason",
    "url": "https://fhir.nhs.uk/England/ValueSet/England-FlagRemovalReason",
    "version": "1.0.0",
    "name": "EnglandFlagRemovalReason",
    "title": "England Flag Removal Reason",
    "status": "draft",
    "date": "2023-08-18",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This ValueSet defines the set of codes that can be used to indicate the reason a Flag was removed.",
    "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.",
    "compose": {
        "include":  [
            {
                "system": "https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason",
                "version": "1.0.0"
            }
        ]
    },
    "expansion": {
        "timestamp": "2023-08-02T12:00:00+00:00",
        "contains":  [
            {
                "system": "https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason",
                "code": "0",
                "display": "Added in error - this child does not have a family history of FGM"
            },
            {
                "system": "https://fhir.nhs.uk/England/CodeSystem/England-FGMRemovalReason",
                "code": "2",
                "display": "No longer required - this child has had FGM"
            }
        ]
    }
}