Skip to content

Commit

Permalink
IOPS-2494(Guidance for Remove Reasonable Adjustment Record) Review (#21)
Browse files Browse the repository at this point in the history
* Create remove-record-usecase.plantuml

* Update remove-reasonable-adjustment-record.md

* Add files via upload

* Delete input/images/remove-record-workflow.svg

* Add files via upload

* Update remove-reasonable-adjustment-record.md

* Delete input/images/remove-record-workflow.bpmn

* Delete input/images/remove-record-workflow.svg

* Add files via upload

* Update remove-record-usecase.plantuml

* Delete input/images/remove-record-workflow.bpmn

* Delete input/images/remove-record-workflow.svg

* Add files via upload

* Update remove-reasonable-adjustment-record.md

* Update 0012-RemoveRARecordExample.fsh

* Update 0012-RemoveRARecordExample.fsh

* Update remove-reasonable-adjustment-record.md

* Update 0012-RemoveRARecordExample.fsh

* Create remove-record-sequence.plantuml

* Delete input/images/remove-record-workflow.bpmn

* Delete input/images/remove-record-workflow.svg

* Add files via upload

* Update remove-reasonable-adjustment-record.md

* Update remove-reasonable-adjustment-record.md

* Update remove-record-usecase.plantuml

* Update remove-record-usecase.plantuml

* Update remove-reasonable-adjustment-record.md

* Update remove-reasonable-adjustment-record.md

* Update remove-reasonable-adjustment-record.md

* Update remove-reasonable-adjustment-record.md

* Update remove-reasonable-adjustment-record.md

* Update remove-reasonable-adjustment-record.md

* Update _updatePublisher.sh

* minor format fixes

* spelling fix

* fix alt text on bpmn diagrams

---------

Co-authored-by: Declan Kieran <[email protected]>
  • Loading branch information
vickyjaiswal0308 and declankieran-nhsd authored Mar 22, 2024
1 parent 8f1cb9e commit 72a067b
Show file tree
Hide file tree
Showing 10 changed files with 214 additions and 23 deletions.
2 changes: 1 addition & 1 deletion _updatePublisher.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ while [ "$#" -gt 0 ]; do
done

echo "Checking internet connection"
curl -sSf tx.fhir.org > /dev/null
curl -sSf raw.githubusercontent.com > /dev/null

if [ $? -ne 0 ] ; then
echo "Offline (or the terminology server is down), unable to update. Exiting"
Expand Down
4 changes: 2 additions & 2 deletions input/fsh/examples/0012-RemoveRARecordExample.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ InstanceOf: Bundle
Title: "RA Example of deleting an RA record with a Transaction"
Usage: #example
* type = #transaction
* entry[0].request.method = #DELETE
* entry[=].request.url = "Flag/fba99f70-fe1d-42e2-b77a-916e44b53c19"
* entry[+].request.method = #DELETE
* entry[=].request.url = "Flag/RAPatientFlagExample1"
* entry[+].request.method = #DELETE
* entry[=].request.url = "Consent/RAConsentExample1"
* entry[+].request.method = #DELETE
Expand Down
30 changes: 30 additions & 0 deletions input/images-source/remove-record-sequence.plantuml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
@startuml

skinparam actorStyle hollow

actor "Practitioner" as pra
actor "Patient" as pat
participant "FHIR API" as api
entity "Consent" as con
entity "Patient Flag" as pfg
entity "Adjustment Flag" as adj
entity "Condition" as cod

pra -> pat : Request consent
pra <-- pat : Deny/revoke consent

pra -> api : Record consent was not given
api -> con : Update resource
con -> con : Validate
api <-- con : return
alt Validation failed
api -> api : rollback
pra <-- api : OperationOutcome
else Validation passed
api -> pfg : Delete adjustment patient flag
api -> adj : Delete adjustment flag(s)
api -> cod : Delete condition flag(s)
pra <-- api : OperationOutcome
end

@enduml
21 changes: 21 additions & 0 deletions input/images-source/remove-record-usecase.plantuml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
@startuml

skinparam actorStyle awesome

actor Practitioner as pra
package Consenter {
actor "Patient Advocate" as pad
actor Patient as pat
}

usecase "Consent to share information" as CON
usecase "Remove Reasonable Adjustment record" as RET

pat -- CON
pad -- CON
pra -- CON
pra -- RET
CON <.. RET : include


@enduml
99 changes: 99 additions & 0 deletions input/images/remove-record-workflow.bpmn
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_149wjti" targetNamespace="http://bpmn.io/schema/bpmn" exporter="bpmn-js (https://demo.bpmn.io)" exporterVersion="17.0.2">
<bpmn:collaboration id="Collaboration_0q56fut">
<bpmn:participant id="Participant_18xshys" name="Consent to Treatment" processRef="Process_0q168hd" />
</bpmn:collaboration>
<bpmn:process id="Process_0q168hd">
<bpmn:laneSet id="LaneSet_1s0cwuu">
<bpmn:lane id="Lane_1qewygr" name="API">
<bpmn:flowNodeRef>Event_0o7dt0z</bpmn:flowNodeRef>
<bpmn:flowNodeRef>Activity_1kgwaxm</bpmn:flowNodeRef>
</bpmn:lane>
<bpmn:lane id="Lane_0s229l6" name="Patient">
<bpmn:flowNodeRef>Activity_1s5y9xm</bpmn:flowNodeRef>
</bpmn:lane>
<bpmn:lane id="Lane_0jp784q" name="Practitioner">
<bpmn:flowNodeRef>Event_03tz7z4</bpmn:flowNodeRef>
<bpmn:flowNodeRef>Activity_00yhqnr</bpmn:flowNodeRef>
</bpmn:lane>
</bpmn:laneSet>
<bpmn:startEvent id="Event_03tz7z4">
<bpmn:outgoing>Flow_0ws129z</bpmn:outgoing>
</bpmn:startEvent>
<bpmn:sequenceFlow id="Flow_0ws129z" sourceRef="Event_03tz7z4" targetRef="Activity_00yhqnr" />
<bpmn:task id="Activity_00yhqnr" name="Request consent">
<bpmn:incoming>Flow_0ws129z</bpmn:incoming>
<bpmn:outgoing>Flow_1y1ffd0</bpmn:outgoing>
</bpmn:task>
<bpmn:sequenceFlow id="Flow_1y1ffd0" sourceRef="Activity_00yhqnr" targetRef="Activity_1s5y9xm" />
<bpmn:task id="Activity_1s5y9xm" name="Deny/revoke consent">
<bpmn:incoming>Flow_1y1ffd0</bpmn:incoming>
<bpmn:outgoing>Flow_1l3qp01</bpmn:outgoing>
</bpmn:task>
<bpmn:sequenceFlow id="Flow_1l3qp01" sourceRef="Activity_1s5y9xm" targetRef="Activity_1kgwaxm" />
<bpmn:subProcess id="Activity_1kgwaxm" name="Update consent/remove all records">
<bpmn:incoming>Flow_1l3qp01</bpmn:incoming>
<bpmn:outgoing>Flow_0a0e2sc</bpmn:outgoing>
</bpmn:subProcess>
<bpmn:sequenceFlow id="Flow_0a0e2sc" sourceRef="Activity_1kgwaxm" targetRef="Event_0o7dt0z" />
<bpmn:endEvent id="Event_0o7dt0z">
<bpmn:incoming>Flow_0a0e2sc</bpmn:incoming>
</bpmn:endEvent>
</bpmn:process>
<bpmndi:BPMNDiagram id="BPMNDiagram_1">
<bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Collaboration_0q56fut">
<bpmndi:BPMNShape id="Participant_18xshys_di" bpmnElement="Participant_18xshys" isHorizontal="true">
<dc:Bounds x="160" y="62" width="600" height="748" />
<bpmndi:BPMNLabel />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="Lane_0jp784q_di" bpmnElement="Lane_0jp784q" isHorizontal="true">
<dc:Bounds x="190" y="62" width="570" height="250" />
<bpmndi:BPMNLabel />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="Lane_0s229l6_di" bpmnElement="Lane_0s229l6" isHorizontal="true">
<dc:Bounds x="190" y="312" width="570" height="258" />
<bpmndi:BPMNLabel />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="Lane_1qewygr_di" bpmnElement="Lane_1qewygr" isHorizontal="true">
<dc:Bounds x="190" y="570" width="570" height="240" />
<bpmndi:BPMNLabel />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="Event_03tz7z4_di" bpmnElement="Event_03tz7z4">
<dc:Bounds x="262" y="172" width="36" height="36" />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="Activity_1su78ja_di" bpmnElement="Activity_00yhqnr">
<dc:Bounds x="420" y="150" width="100" height="80" />
<bpmndi:BPMNLabel />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="Activity_1au192q_di" bpmnElement="Activity_1s5y9xm">
<dc:Bounds x="420" y="390" width="100" height="80" />
<bpmndi:BPMNLabel />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="Event_0o7dt0z_di" bpmnElement="Event_0o7dt0z">
<dc:Bounds x="642" y="672" width="36" height="36" />
</bpmndi:BPMNShape>
<bpmndi:BPMNShape id="Activity_1cld9ri_di" bpmnElement="Activity_1kgwaxm">
<dc:Bounds x="420" y="650" width="100" height="80" />
</bpmndi:BPMNShape>
<bpmndi:BPMNEdge id="Flow_0ws129z_di" bpmnElement="Flow_0ws129z">
<di:waypoint x="298" y="190" />
<di:waypoint x="420" y="190" />
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge id="Flow_1y1ffd0_di" bpmnElement="Flow_1y1ffd0">
<di:waypoint x="470" y="230" />
<di:waypoint x="470" y="390" />
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge id="Flow_1l3qp01_di" bpmnElement="Flow_1l3qp01">
<di:waypoint x="470" y="470" />
<di:waypoint x="470" y="650" />
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge id="Flow_0a0e2sc_di" bpmnElement="Flow_0a0e2sc">
<di:waypoint x="520" y="690" />
<di:waypoint x="642" y="690" />
</bpmndi:BPMNEdge>
</bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
<bpmndi:BPMNDiagram id="BPMNDiagram_1vcjc0h">
<bpmndi:BPMNPlane id="BPMNPlane_1tv2ji1" bpmnElement="Activity_1kgwaxm" />
</bpmndi:BPMNDiagram>
</bpmn:definitions>
4 changes: 4 additions & 0 deletions input/images/remove-record-workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion input/pagecontent/add-reasonable-adjustment-record.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Then a freetext note may be added to the flag
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%" src="add-record-workflow.svg"/>
<img style="max-width: 70%" alt="Add record workflow BPMN diagram." src="add-record-workflow.svg"/>
</div>

### System Interactions
Expand Down
Loading

0 comments on commit 72a067b

Please sign in to comment.