Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 107 additions & 0 deletions docs/user/opal/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,110 @@ Once a patient or caregiver obtains a registration code from the hospital’s ad
The Opal Patient Portal is a mobile application designed to empower patients with their medical information. The content created by clinicians via Opal Admin, as well as data from the healthcare systems the solution has established interfaces with, will be securely provided to patients in their mobile application. The patient portal can also be accessed via a browser.

For more information about Opal, refer to the [Opal website](https://www.opalmedapps.com/).

## Components used for registering a Patient Portal user

```mermaid
flowchart TD
%% ===== Nodes =====
Start([Start])
EndNo([End])
EndYes([End])

A[A patient is created/exists in the hospital system<br/>e.g., <b>OpenEMR, ADT</b>]

D{Patient consents<br/>to have <b>Opal</b>?}

B[Registration code generated in <b>Opal Admin</b> and displayed as a QR code to the user]

C[User completes their registration using the <b>Opal User Registration</b> website]

E[Patient data pulled from hospital source systems<br/>and stored in Opal's Patient Information Exchange system]

F[User accesses patient data on the <b>Opal Patient Portal</b>]

%% ===== Flow =====
Start --> A
A --> D
D -- No --> EndNo
D -- Yes --> B
B --> C
C --> E
E --> F
F --> EndYes

%% ===== Classes =====
class Start,EndNo,EndYes startEnd
class A,E hospital
class B opalAdmin
class C,F portal
class D decision

%% ===== Style Definitions =====
classDef startEnd fill:#E6E6E6,stroke:#333,stroke-width:1px,color:#000
classDef hospital fill:#7FB3FF,stroke:#1F4FBF,stroke-width:1px,color:#000
classDef opalAdmin fill:#B39DDB,stroke:#5E35B1,stroke-width:1px,color:#000
classDef portal fill:#8BC34A,stroke:#33691E,stroke-width:1px,color:#000
classDef decision fill:#E8F5E9,stroke:#558B2F,stroke-width:2px,color:#000
```

## Components used for appointment check in

```mermaid
flowchart TD
%% ===== Nodes =====
Start([Start])

A[An appointment is created/exists for a patient<br/>in the hospital system.<br/> e.g. <b>OpenEMR</b>]

B[Interfaces send appointment data to Opal's Patient Information Exchange system.<br/><b>Opal Admin</b> and <b>Opal RMS</b>]

D{Patient has <b>Opal<br/>Patient Portal</b>?}

C[Patient receives maps, reminders, preparation instructions as configured in <b>Opal Admin</b>]

E[Patient checks into their appointment using the <b>Opal Patient Portal</b> once within range of the hospital]

F[Clinician manages patient appointment call ins via <b>Opal RMS</b>, which notifies the patient by the </b><b>Opal Patient Portal</b> and the TV screens]

G[Patient checks in using the kiosk, SMS available with <b>Opal RMS</b> or at reception]

H[Clinician manages patient appointment call ins via <b>Opal RMS</b>, which notifies the patient by the TV screens and/or SMS]

EndYes([End])
EndNo([End])

%% ===== Flow =====
Start --> A
A --> B
B --> D

D -- Yes --> C
C --> E
E --> F
F --> EndYes

D -- No --> G
G --> H
H --> EndNo

%% ===== Classes =====
class Start,EndYes,EndNo startEnd
class A hospital
class B interfaces
class C admin
class D decision
class E portal
class F,H rms
class G rmsAlt

%% ===== Style Definitions =====
classDef startEnd fill:#E6E6E6,stroke:#333,stroke-width:1px,color:#000
classDef hospital fill:#7FB3FF,stroke:#1F4FBF,stroke-width:1px,color:#000
classDef interfaces fill:#BDBDBD,stroke:#616161,stroke-width:1px,color:#000
classDef admin fill:#9C8AD1,stroke:#512DA8,stroke-width:1px,color:#000
classDef portal fill:#8BC34A,stroke:#33691E,stroke-width:1px,color:#000
classDef rms fill:#F6A5A5,stroke:#C62828,stroke-width:1px,color:#000
classDef rmsAlt fill:#F6A5A5,stroke:#C62828,stroke-width:1px,color:#000
classDef decision fill:#E8F5E9,stroke:#558B2F,stroke-width:2px,color:#000
```
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ plugins:
- glightbox
# keep assets private
# https://squidfunk.github.io/mkdocs-material/plugins/privacy/
- privacy
- privacy:
enabled: !ENV [CI, false]
# https://github.com/manuzhang/mkdocs-htmlproofer-plugin#configuring
- htmlproofer:
# check all URLs before raising an error
Expand Down