Skip to content

Commit

Permalink
fgm use cases
Browse files Browse the repository at this point in the history
  • Loading branch information
marcusfearnett-nhsdigital committed Jun 12, 2024
1 parent 3e2cc89 commit f842472
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 40 deletions.
21 changes: 2 additions & 19 deletions input/pagecontent/add-fgm-flag-record.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,39 +76,22 @@ Then a freetext note may be added to the flag

### Workflow

A practitioner performs an examination and determines that a condition and/or an adjustment should be recorded. If the patient does not consent, no details are recorded. If the patient consents, then the adjustment is recorded, and optionally the condition as well.

<div style="text-align: left;">
<img style="max-width: 70%" alt="Add Patient Flag record workflow BPMN diagram." src="add-pf-record-workflow.svg"/>
<img style="max-width: 70%" alt="Add FGM Flag record workflow BPMN diagram." src="add-fgm-record-workflow.svg"/>
</div>

### System Interactions

The practioner decides to record a condition with the patients consent. This could be done with individual calls to the required endpoints, or can be done in a single transaction Bundle. A transaction Bundle can help with data integrity requirements and also help to reduce required http calls.
The practioner decides to record a

<div style="text-align: left;">
{%include add-fgm-record-sequence.svg%}
</div>

### Examples

* [Patient example](Patient-PatientExample1.html)

The following set of examples constitute the individual associated resources with the intial addition of a flag for Reasonable Adjustment. This includes the Consent resource where the patient has agreed to share information. Also a patient Flag resource, the adjustment Flag resource and the associated Condition resource. All resources have contained provenances.

A transaction Bundle is also given that allows these resources (plus the patient) to be entered in an atomic traction. It uses PUTs, where in the case of an intial update, it may be done as a [conditional update](https://www.hl7.org/fhir/http.html#cond-update)

* [Consent](Consent-RAConsentExample1.html)
* [Patient flag](Flag-RAPatientFlagExample1.html)
* [Reasonable Adjustment flag 1](Flag-RAFlagExample1.html)
* [Condition 1](Condition-RAConditionExample1.html)
* [Transaction Bundle 1](Bundle-AddRARecordTransactionExample1.html)

The following set of examples are for the same patient, and constitute an addition flag and condition. The transaction Bundle here illustates an idempotent update by simply adding the new resources to the first transaction Bundle.

* [Reasonable Adjustment flag 2](Flag-RAFlagExample2.html)
* [Condition 2](Condition-RAConditionExample2.html)
* [Transaction Bundle 2](Bundle-AddRARecordTransactionExample2.html)

### Relevant Documentation

Expand Down
16 changes: 15 additions & 1 deletion input/pagecontent/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,21 @@ Share female genital mutilation (FGM) information for children under 18 with rel
<a name="fgm-key-purposes"></a>
Key purposes of the Female Genital Mutilation - Information Sharing include:

* Share female genital mutilation (FGM) information for children under 18 with relevant NHS and scocial care professionals
Authorised healthcare workers can:

* query to determine if a patient has a FGM family history indicator
* create a FGM family history indicator for a patient
** must be gender ‘female’, ‘unknown’ or indeterminate’ according to PDS
** must be under the age of 18 according to PDS
** must not already have a FGM family history indicator on FGM-IS
** must have a verified NHS number
* delete a FGM family history indicator for a patient

The FGM FLag record contains:

* an indicator that a child with female genitalia has a family history of FGM
* the date that the FGM assessment was carried out



### Dependencies
Expand Down
17 changes: 1 addition & 16 deletions input/pagecontent/remove-fgm-flag-record.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,34 +30,19 @@ A patient may revoke consent to share information about Reasonable Adjustment re
</p>

<div>
<img style="max-width: 70%" alt="Remove Patient Flag record workflow BPMN diagram." src="remove-pf-record-workflow.svg"/>
<img style="max-width: 70%" alt="Remove FGM Flag record workflow BPMN diagram." src="remove-fgm-record-workflow.svg"/>
</div>

### System Interactions

In the following sequence diagram, a patient revokes consent. The Consent resource is updated to reflect the patient dissent, and all adjustment records are deleted.

<div style="text-align: left;">

{%include remove-fgm-record-sequence.svg%}

</div>

The following resource types will be deleted from the record if consent is not granted i.e.

* [Patient Flag](StructureDefinition-PatientFlag.html)
* [Programme Flag](StructureDefinition-ProgrammeFlag.html)
* [Condition Flag](StructureDefinition-FlagCondition.html)

#### Example

Multiple resources can be deleted using a transaction bundle. This [example delete transaction Bundle](Bundle-RemoveRARecordExample.html) demonstates deleting the following resources

* [Patient Flag](Flag-RAPatientFlagExample1.html) example.
* [Programme Flag](Flag-RAFlagExample1.html) example.
* [Condition Flag](Condition-RAConditionExample1.html) example.

### Relevant Documentation

* [Bundle](https://hl7.org/fhir/r4/bundle.html)
* [Transaction](https://hl7.org/fhir/r4/http.html#transaction)
6 changes: 2 additions & 4 deletions input/pagecontent/retrieve-fgm-flag-record.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ For high level requirements, see [Key purposes of the FGM Flag](index.html#fgm-k

### Usecase

A Patient Flag Record may be retrieved if it exists. It will be possible to determine that a adjustment flags exist by searching for a [Patient Flag](StructureDefinition-PatientFlag.html) with:
An FGM Flag Record may be retrieved if it exists. It will be possible to determine that an flags exist by searching for a [Patient Flag](StructureDefinition-PatientFlag.html) with:

- [Programme Flags](StructureDefinition-ProgrammeFlag.html)
- [Programme Flags](StructureDefinition-ProgrammeFlag.html) with a category of [NRAF](CodeSystem-PatientFlagCategory.html#PatientFlagCategory-NRAF)
- or the code [NRAF](CodeSystem-PatientFlagCategory.html#PatientFlagCategory-NRAF),
-

<div style="text-align: left;">

Expand Down

0 comments on commit f842472

Please sign in to comment.