diff --git a/input/images-source/add-ra-record-usecase.plantuml b/input/images-source/add-ra-record-usecase.plantuml index b1804ed..f9d9e08 100644 --- a/input/images-source/add-ra-record-usecase.plantuml +++ b/input/images-source/add-ra-record-usecase.plantuml @@ -10,7 +10,7 @@ usecase "Add Reasonable Adjustment record" as add } -package Consenter { +package "Patient or Proxy" { actor Patient as pat actor "Patient Advocate" as pad } diff --git a/input/images-source/data-model.plantuml b/input/images-source/data-model.plantuml deleted file mode 100644 index 927bf01..0000000 --- a/input/images-source/data-model.plantuml +++ /dev/null @@ -1,53 +0,0 @@ -@startuml - -skinparam linetype ortho - -entity "Patient" as pat { - *NHS Number : number <> -} -package "Patient Flags API" { - -entity "Consent" as con { - *patient : Patient - *category : CodeableConcept - *contained : Provenance (Contained) -} - -entity "Condition" as cod { - *patient : Patient - *code : CodeableConcept - *category : CodeableConcept - *contained : Provenance (Contained) -} - -entity "Patient Flag" as pfg { - *patient : Patient - *code : CodeableConcept - *category : CodeableConcept - *contained : Provenance (Contained) -} - -entity "Programme Flag" as prfg { - *patient : Patient - *code : CodeableConcept - *category : CodeableConcept - *contained : Provenance (Contained) -} - -entity "Provenance" as prov { - *recorded : Date - *agent : Agent (backbone) -} -} - -pat ||..|| con : provides -pat ||--o{ cod : has -pat ||--o| pfg : "has" -pat ||--o{ prfg : has -con ||--|| prov : contains -cod ||--|| prov : contains -pfg ||--|| prov : contains -prfg ||--|| prov : contains -pfg ||--o{ prfg : details - -@enduml diff --git a/input/images-source/remove-ra-record-usecase.plantuml b/input/images-source/remove-ra-record-usecase.plantuml index 48556cd..2703af1 100644 --- a/input/images-source/remove-ra-record-usecase.plantuml +++ b/input/images-source/remove-ra-record-usecase.plantuml @@ -10,7 +10,7 @@ usecase "Remove Reasonable Adjustment record" as add } -package Consenter { +package "Patient or Proxy" { actor Patient as pat actor "Patient Advocate" as pad } diff --git a/input/images-source/retrieve-ra-record-usecase.plantuml b/input/images-source/retrieve-ra-record-usecase.plantuml index 78b042e..7738c73 100644 --- a/input/images-source/retrieve-ra-record-usecase.plantuml +++ b/input/images-source/retrieve-ra-record-usecase.plantuml @@ -10,7 +10,7 @@ usecase "Retrieve Reasonable Adjustment record" as add } -package Consenter { +package "Patient or Proxy" { actor Patient as pat actor "Patient Advocate" as pad } diff --git a/input/pagecontent/add-patient-flag-record.md b/input/pagecontent/add-patient-flag-record.md index 1bd6fb7..7bd9194 100644 --- a/input/pagecontent/add-patient-flag-record.md +++ b/input/pagecontent/add-patient-flag-record.md @@ -12,7 +12,9 @@ For high level requirements, see [Key purposes of the Patient Flag](index.html#p ### 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 patient flag information. + +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.
{%include add-pf-record-sequence.svg%} @@ -26,7 +28,6 @@ The following set of examples constitute the individual associated resources wit 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) diff --git a/input/pagecontent/add-reasonable-adjustment-condition.md b/input/pagecontent/add-reasonable-adjustment-condition.md index 1bd6fb7..d370f8e 100644 --- a/input/pagecontent/add-reasonable-adjustment-condition.md +++ b/input/pagecontent/add-reasonable-adjustment-condition.md @@ -1,6 +1,6 @@ ### Overview -For high level requirements, see [Key purposes of the Patient Flag](index.html#pf-key-purposes) +For high level requirements, see [Key purposes of the Reasonable Adjustment Flag](index.html#ra-key-purposes) ### Usecase @@ -12,7 +12,9 @@ For high level requirements, see [Key purposes of the Patient Flag](index.html#p ### 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 condition information on a reasonable adjustment record as supporting detail e.g. Blind or low vision - both eyes. This typically after a patient consultation and SHALL be 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.
{%include add-pf-record-sequence.svg%} @@ -26,7 +28,6 @@ The following set of examples constitute the individual associated resources wit 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) diff --git a/input/pagecontent/add-reasonable-adjustment-record.md b/input/pagecontent/add-reasonable-adjustment-record.md index 8e4327b..f80ac52 100644 --- a/input/pagecontent/add-reasonable-adjustment-record.md +++ b/input/pagecontent/add-reasonable-adjustment-record.md @@ -1,7 +1,5 @@ ### Overview -Patient consent must be obtained before recording any adjustment or impairment. See [Consent to Share Information](consent-to-share-information.html) for details of requirements around consent. - For high level requirements, see [Key purposes of the Reasonable Adjustment Flag](index.html#ra-key-purposes) ### Usecase diff --git a/input/pagecontent/add-reasonable-adjustment.md b/input/pagecontent/add-reasonable-adjustment.md index 1bd6fb7..4e95226 100644 --- a/input/pagecontent/add-reasonable-adjustment.md +++ b/input/pagecontent/add-reasonable-adjustment.md @@ -1,6 +1,6 @@ ### Overview -For high level requirements, see [Key purposes of the Patient Flag](index.html#pf-key-purposes) +For high level requirements, see [Key purposes of the Reasonable Adjustment Flag](index.html#ra-key-purposes) ### Usecase @@ -12,7 +12,9 @@ For high level requirements, see [Key purposes of the Patient Flag](index.html#p ### 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 reasonable adjustment record information for a single reasonable adjustment e.g. provision of large print. This typically after a patient consultation and 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.
{%include add-pf-record-sequence.svg%} @@ -26,7 +28,6 @@ The following set of examples constitute the individual associated resources wit 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) diff --git a/input/pagecontent/additional-examples.md b/input/pagecontent/additional-examples.md deleted file mode 100644 index 9e55ee1..0000000 --- a/input/pagecontent/additional-examples.md +++ /dev/null @@ -1,19 +0,0 @@ -### Overview - -Basic examples for CPIS and FGM to demo use of same profiles. - -### CPIS - -* [Consent](Consent-CPISConsentExample1.html) -* [Patient flag](Flag-CPISPatientFlagExample1.html) -* [CPIS flag](Flag-CPISFlagExample1.html) -* [Condition](Condition-CPISConditionExample1.html) -* [Transaction Bundle](Bundle-AddCPISRecordTransactionExample1.html) - -### FGM - -* [Consent](Consent-FGMConsentExample1.html) -* [Patient flag](Flag-FGMPatientFlagExample1.html) -* [FGM flag](Flag-FGMFlagExample1.html) -* [Condition](Condition-FGMConditionExample1.html) -* [Transaction Bundle](Bundle-AddFGMRecordTransactionExample1.html) \ No newline at end of file diff --git a/input/pagecontent/basic-query-examples.md b/input/pagecontent/basic-query-examples.md deleted file mode 100644 index cebbe38..0000000 --- a/input/pagecontent/basic-query-examples.md +++ /dev/null @@ -1,31 +0,0 @@ -### Summary - -The [HAPI FHIR Starter Server](https://github.com/hapifhir/hapi-fhir-jpaserver-starter) is used to demostrate some basic REST capabilities in FHIR using examples within this implementation guide. - -#### Docker invocation of the HAPI Starter Project - -This command starts the server on port 8080 and use UUID (as opposed to sequential numbers) for resource ID's. For more options see this [config](https://github.com/hapifhir/hapi-fhir-jpaserver-starter/blob/master/src/main/resources/application.yaml). - -``` -docker run -p 8080:8080 -e hapi.fhir.daoconfig_client_id_strategy=UUID -e hapi.fhir.client_id_strategy=ANY hapiproject/hapi:latest -``` - -To pull the latest image, run - -``` -docker pull hapiproject/hapi:latest -``` - -#### Swagger - -The HAPI starter project provides an OAS interface to the supported FHIR API. Assuming the above docker command is used, this would be available at - -``` -http://localhost:8080/fhir/swagger-ui/index.html -``` - -#### Postman - -Some transaction and basic query examples are available in a [Postman collection](assets/postman/postman_collection.json). - -**NOTE:** Posting the SearchParameters first to the [HAPI FHIR Starter Server](https://github.com/hapifhir/hapi-fhir-jpaserver-starter) will allow them to index/load quicker so they work in the query examples. diff --git a/input/pagecontent/remove-patient-flag-record.md b/input/pagecontent/remove-patient-flag-record.md index 5ec01ea..47d3e55 100644 --- a/input/pagecontent/remove-patient-flag-record.md +++ b/input/pagecontent/remove-patient-flag-record.md @@ -13,7 +13,7 @@ For high level requirements, see [Key purposes of the Patient Flag](index.html#p ### 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. +In the following sequence diagram, a patient and/or practitioner decide to remove the patient flag.
@@ -21,11 +21,10 @@ In the following sequence diagram, a patient revokes consent. The Consent resou
-The following resource types will be deleted from the record if consent is not granted i.e. +The following resource types will be deleted from the record: * [Patient Flag](StructureDefinition-PatientFlag.html) -* [Programme Flag](StructureDefinition-ProgrammeFlag.html) -* [Condition Flag](StructureDefinition-FlagCondition.html) +* any resources detailing supporting information #### Example diff --git a/input/pagecontent/remove-reasonable-adjustment-condition.md b/input/pagecontent/remove-reasonable-adjustment-condition.md index c82cde4..5d1ecc5 100644 --- a/input/pagecontent/remove-reasonable-adjustment-condition.md +++ b/input/pagecontent/remove-reasonable-adjustment-condition.md @@ -1,6 +1,6 @@ ### Overview -For high level requirements, see [Key purposes of the Patient Flag](index.html#pf-key-purposes) +For high level requirements, see [Key purposes of the Reasonable Adjustment Flag](index.html#ra-key-purposes) #### UseCase @@ -13,7 +13,8 @@ For high level requirements, see [Key purposes of the Patient Flag](index.html#p ### 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. +In the following sequence diagram, a patient and/or practitioner decide to remove the condition information as supporting detail on th reasonable adjustment record. +
diff --git a/input/pagecontent/remove-reasonable-adjustment-record.md b/input/pagecontent/remove-reasonable-adjustment-record.md index a2487a5..97e3a8a 100644 --- a/input/pagecontent/remove-reasonable-adjustment-record.md +++ b/input/pagecontent/remove-reasonable-adjustment-record.md @@ -1,14 +1,12 @@ ### Overview -A patient may deny or revoke their consent to share adjustment or impairment information at any point. See [Consent to Share Information](consent-to-share-information.html) for details of requirements around consent. +A patient and/or practitioner decide to remove the reasonable adjustment record. For high level requirements, see [Key purposes of the Reasonable Adjustment Flag](index.html#ra-key-purposes) #### UseCase -If a patient denys consent, then this must be recorded and all adjustment records must be removed. -
{%include remove-ra-record-usecase.svg%} @@ -17,7 +15,7 @@ If a patient denys consent, then this must be recorded and all adjustment record ### 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. +In the following sequence diagram, a patient and/or practitioner decide to remove the reasonable adjustment record. All adjustment records are deleted.
diff --git a/input/pagecontent/remove-reasonable-adjustment.md b/input/pagecontent/remove-reasonable-adjustment.md index 467a142..4614d28 100644 --- a/input/pagecontent/remove-reasonable-adjustment.md +++ b/input/pagecontent/remove-reasonable-adjustment.md @@ -13,7 +13,7 @@ For high level requirements, see [Key purposes of the Patient Flag](index.html#p ### 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. +In the following sequence diagram, a patient and/or practitioner decide to remove an individual reasonable adjustment. The relevant England-Flag-PatientFlag-Adjustment resource is removed.
@@ -21,11 +21,9 @@ In the following sequence diagram, a patient revokes consent. The Consent resou
-The following resource types will be deleted from the record if consent is not granted i.e. +The following resource types will be deleted from the record: -* [Patient Flag](StructureDefinition-PatientFlag.html) * [Programme Flag](StructureDefinition-ProgrammeFlag.html) -* [Condition Flag](StructureDefinition-FlagCondition.html) #### Example diff --git a/sushi-config.yaml b/sushi-config.yaml index f1a958f..8cb2f22 100644 --- a/sushi-config.yaml +++ b/sushi-config.yaml @@ -92,9 +92,6 @@ menu: Remove Reasonable Adjustment: remove-reasonable-adjustment.html Add Reasonable Adjustment Condition: add-reasonable-adjustment-condition.html Remove Reasonable Adjustment Condition: remove-reasonable-adjustment-condition.html - Additional Examples: - CPIS/FGM demo: additional-examples.html - Basic Query Examples: basic-query-examples.html Artifacts: artifacts.html About: Downloads: todo.html